]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apitimelinementions.php
Pass auth user into Atom feed generators (needed for outputting favorited status...
[quix0rs-gnu-social.git] / actions / apitimelinementions.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Show notices mentioning a user (@nickname)
6  *
7  * PHP version 5
8  *
9  * LICENCE: This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU Affero General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU Affero General Public License for more details.
18  *
19  * You should have received a copy of the GNU Affero General Public License
20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21  *
22  * @category  API
23  * @package   StatusNet
24  * @author    Craig Andrews <candrews@integralblue.com>
25  * @author    Evan Prodromou <evan@status.net>
26  * @author    Jeffery To <jeffery.to@gmail.com>
27  * @author    mac65 <mac65@mac65.com>
28  * @author    Mike Cochrane <mikec@mikenz.geek.nz>
29  * @author    Robin Millette <robin@millette.info>
30  * @author    Zach Copley <zach@status.net>
31  * @copyright 2009 StatusNet, Inc.
32  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
33  * @link      http://status.net/
34  */
35
36 if (!defined('STATUSNET')) {
37     exit(1);
38 }
39
40 require_once INSTALLDIR . '/lib/apibareauth.php';
41
42 /**
43  * Returns the most recent (default 20) mentions (status containing @nickname)
44  *
45  * @category API
46  * @package  StatusNet
47  * @author   Craig Andrews <candrews@integralblue.com>
48  * @author   Evan Prodromou <evan@status.net>
49  * @author   Jeffery To <jeffery.to@gmail.com>
50  * @author   mac65 <mac65@mac65.com>
51  * @author   Mike Cochrane <mikec@mikenz.geek.nz>
52  * @author   Robin Millette <robin@millette.info>
53  * @author   Zach Copley <zach@status.net>
54  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
55  * @link     http://status.net/
56  */
57
58 class ApiTimelineMentionsAction extends ApiBareAuthAction
59 {
60
61     var $notices = null;
62
63     /**
64      * Take arguments for running
65      *
66      * @param array $args $_REQUEST args
67      *
68      * @return boolean success flag
69      *
70      */
71
72     function prepare($args)
73     {
74         parent::prepare($args);
75
76         $this->user = $this->getTargetUser($this->arg('id'));
77
78         if (empty($this->user)) {
79             $this->clientError(_('No such user.'), 404, $this->format);
80             return;
81         }
82
83         $this->notices = $this->getNotices();
84
85         return true;
86     }
87
88     /**
89      * Handle the request
90      *
91      * Just show the notices
92      *
93      * @param array $args $_REQUEST data (unused)
94      *
95      * @return void
96      */
97
98     function handle($args)
99     {
100         parent::handle($args);
101         $this->showTimeline();
102     }
103
104     /**
105      * Show the timeline of notices
106      *
107      * @return void
108      */
109
110     function showTimeline()
111     {
112         $profile = $this->user->getProfile();
113         $avatar     = $profile->getAvatar(AVATAR_PROFILE_SIZE);
114
115         $sitename   = common_config('site', 'name');
116         $title      = sprintf(
117             _('%1$s / Updates mentioning %2$s'),
118             $sitename, $this->user->nickname
119         );
120         $taguribase = TagURI::base();
121         $id         = "tag:$taguribase:Mentions:" . $this->user->id;
122         $link       = common_local_url(
123             'replies',
124             array('nickname' => $this->user->nickname)
125         );
126
127         $self = $this->getSelfUri();
128
129         $subtitle   = sprintf(
130             _('%1$s updates that reply to updates from %2$s / %3$s.'),
131             $sitename, $this->user->nickname, $profile->getBestName()
132         );
133         $logo = ($avatar) ? $avatar->displayUrl() : Avatar::defaultImage(AVATAR_PROFILE_SIZE);
134
135         switch($this->format) {
136         case 'xml':
137             $this->showXmlTimeline($this->notices);
138             break;
139         case 'rss':
140             $this->showRssTimeline(
141                 $this->notices,
142                 $title,
143                 $link,
144                 $subtitle,
145                 null,
146                 $logo,
147                 $self
148             );
149             break;
150         case 'atom':
151
152             header('Content-Type: application/atom+xml; charset=utf-8');
153
154             $atom = new AtomNoticeFeed($this->auth_user);
155
156             $atom->setId($id);
157             $atom->setTitle($title);
158             $atom->setSubtitle($subtitle);
159             $atom->setLogo($logo);
160             $atom->setUpdated('now');
161
162             $atom->addLink($link);
163             $atom->setSelfLink($self);
164
165             $atom->addEntryFromNotices($this->notices);
166             $this->raw($atom->getString());
167
168             break;
169         case 'json':
170             $this->showJsonTimeline($this->notices);
171             break;
172         default:
173             $this->clientError(_('API method not found.'), $code = 404);
174             break;
175         }
176     }
177
178     /**
179      * Get notices
180      *
181      * @return array notices
182      */
183
184     function getNotices()
185     {
186         $notices = array();
187
188         $notice = $this->user->getReplies(
189             ($this->page - 1) * $this->count, $this->count,
190             $this->since_id, $this->max_id
191         );
192
193         while ($notice->fetch()) {
194             $notices[] = clone($notice);
195         }
196
197         return $notices;
198     }
199
200     /**
201      * Is this action read only?
202      *
203      * @param array $args other arguments
204      *
205      * @return boolean true
206      */
207
208     function isReadOnly($args)
209     {
210         return true;
211     }
212
213     /**
214      * When was this feed last modified?
215      *
216      * @return string datestamp of the latest notice in the stream
217      */
218
219     function lastModified()
220     {
221         if (!empty($this->notices) && (count($this->notices) > 0)) {
222             return strtotime($this->notices[0]->created);
223         }
224
225         return null;
226     }
227
228     /**
229      * An entity tag for this stream
230      *
231      * Returns an Etag based on the action name, language, user ID, and
232      * timestamps of the first and last notice in the timeline
233      *
234      * @return string etag
235      */
236
237     function etag()
238     {
239         if (!empty($this->notices) && (count($this->notices) > 0)) {
240
241             $last = count($this->notices) - 1;
242
243             return '"' . implode(
244                 ':',
245                 array($this->arg('action'),
246                       common_language(),
247                       $this->user->id,
248                       strtotime($this->notices[0]->created),
249                       strtotime($this->notices[$last]->created))
250             )
251             . '"';
252         }
253
254         return null;
255     }
256
257 }