]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apitimelinefriends.php
updateWithKeys reworked to more reliable execution
[quix0rs-gnu-social.git] / actions / apitimelinefriends.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Show the friends timeline
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-2010 StatusNet, Inc.
32  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
33  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
34  * @link      http://status.net/
35  */
36
37 /* External API usage documentation. Please update when you change how this method works. */
38
39 /*! @page friendstimeline statuses/friends_timeline
40
41     @section Description
42     Returns the 20 most recent statuses posted by the authenticating
43     user and that user's friends. This is the equivalent of "You and
44     friends" page in the web interface.
45
46     @par URL patterns
47     @li /api/statuses/friends_timeline.:format
48     @li /api/statuses/friends_timeline/:id.:format
49
50     @par Formats (:format)
51     xml, json, rss, atom
52
53     @par ID (:id)
54     username, user id
55
56     @par HTTP Method(s)
57     GET
58
59     @par Requires Authentication
60     Sometimes (see: @ref authentication)
61
62     @param user_id (Optional) Specifies a user by ID
63     @param screen_name (Optional) Specifies a user by screename (nickname)
64     @param since_id (Optional) Returns only statuses with an ID greater
65     than (that is, more recent than) the specified ID.
66     @param max_id (Optional) Returns only statuses with an ID less than
67     (that is, older than) or equal to the specified ID.
68     @param count (Optional) Specifies the number of statuses to retrieve.
69     @param page (Optional) Specifies the page of results to retrieve.
70
71     @sa @ref authentication
72     @sa @ref apiroot
73
74     @subsection usagenotes Usage notes
75     @li The URL pattern is relative to the @ref apiroot.
76     @li The XML response uses <a href="http://georss.org/Main_Page">GeoRSS</a>
77     to encode the latitude and longitude (see example response below <georss:point>).
78
79     @subsection exampleusage Example usage
80
81     @verbatim
82     curl http://identi.ca/api/statuses/friends_timeline/evan.xml?count=1&page=2
83     @endverbatim
84
85     @subsection exampleresponse Example response
86
87     @verbatim
88     <?xml version="1.0"?>
89     <statuses type="array">
90       <status>
91         <text>back from the !yul !drupal meet with Evolving Web folk, @anarcat, @webchick and others, and an interesting refresher on SQL indexing</text>
92         <truncated>false</truncated>
93         <created_at>Wed Mar 31 01:33:02 +0000 2010</created_at>
94         <in_reply_to_status_id/>
95         <source>&lt;a href="http://code.google.com/p/microblog-purple/"&gt;mbpidgin&lt;/a&gt;</source>
96         <id>26674201</id>
97         <in_reply_to_user_id/>
98         <in_reply_to_screen_name/>
99         <geo/>
100         <favorited>false</favorited>
101         <user>
102           <id>246</id>
103           <name>Mark</name>
104           <screen_name>lambic</screen_name>
105           <location>Montreal, Canada</location>
106           <description>Geek</description>
107           <profile_image_url>http://avatar.identi.ca/246-48-20080702141545.png</profile_image_url>
108           <url>http://lambic.co.uk</url>
109           <protected>false</protected>
110           <followers_count>73</followers_count>
111           <profile_background_color>#F0F2F5</profile_background_color>
112           <profile_text_color/>
113           <profile_link_color>#002E6E</profile_link_color>
114           <profile_sidebar_fill_color>#CEE1E9</profile_sidebar_fill_color>
115           <profile_sidebar_border_color/>
116           <friends_count>58</friends_count>
117           <created_at>Wed Jul 02 14:12:15 +0000 2008</created_at>
118           <favourites_count>2</favourites_count>
119           <utc_offset>-14400</utc_offset>
120           <time_zone>US/Eastern</time_zone>
121           <profile_background_image_url/>
122           <profile_background_tile>false</profile_background_tile>
123           <statuses_count>933</statuses_count>
124           <following>false</following>
125           <notifications>false</notifications>
126         </user>
127       </status>
128     </statuses>
129     @endverbatim
130 */
131
132 if (!defined('STATUSNET')) {
133     exit(1);
134 }
135
136 /**
137  * Returns the most recent notices (default 20) posted by the target user.
138  * This is the equivalent of 'You and friends' page accessed via Web.
139  *
140  * @category API
141  * @package  StatusNet
142  * @author   Craig Andrews <candrews@integralblue.com>
143  * @author   Evan Prodromou <evan@status.net>
144  * @author   Jeffery To <jeffery.to@gmail.com>
145  * @author   mac65 <mac65@mac65.com>
146  * @author   Mike Cochrane <mikec@mikenz.geek.nz>
147  * @author   Robin Millette <robin@millette.info>
148  * @author   Zach Copley <zach@status.net>
149  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
150  * @link     http://status.net/
151  */
152 class ApiTimelineFriendsAction extends ApiBareAuthAction
153 {
154     var $notices  = null;
155
156     /**
157      * Take arguments for running
158      *
159      * @param array $args $_REQUEST args
160      *
161      * @return boolean success flag
162      *
163      */
164     protected function prepare(array $args=array())
165     {
166         parent::prepare($args);
167         $this->target = $this->getTargetProfile($this->arg('id'));
168
169         if (!($this->target instanceof Profile)) {
170             // TRANS: Client error displayed when requesting dents of a user and friends for a user that does not exist.
171             $this->clientError(_('No such user.'), 404);
172         }
173
174         $this->notices = $this->getNotices();
175
176         return true;
177     }
178
179     /**
180      * Handle the request
181      *
182      * Just show the notices
183      *
184      * @return void
185      */
186     protected function handle()
187     {
188         parent::handle();
189         $this->showTimeline();
190     }
191
192     /**
193      * Show the timeline of notices
194      *
195      * @return void
196      */
197     function showTimeline()
198     {
199         $sitename   = common_config('site', 'name');
200         // TRANS: Title of API timeline for a user and friends.
201         // TRANS: %s is a username.
202         $title      = sprintf(_("%s and friends"), $this->target->nickname);
203         $taguribase = TagURI::base();
204         $id         = "tag:$taguribase:FriendsTimeline:" . $this->target->id;
205
206         $subtitle = sprintf(
207             // TRANS: Message is used as a subtitle. %1$s is a user nickname, %2$s is a site name.
208             _('Updates from %1$s and friends on %2$s!'),
209             $this->target->nickname,
210             $sitename
211         );
212
213         $logo = $this->target->avatarUrl(AVATAR_PROFILE_SIZE);
214         $link = common_local_url('all',
215                     array('nickname' => $this->target->nickname));
216         $self = $this->getSelfUri();
217
218         switch($this->format) {
219         case 'xml':
220             $this->showXmlTimeline($this->notices);
221             break;
222         case 'rss':
223
224             $this->showRssTimeline(
225                 $this->notices,
226                 $title,
227                 $link,
228                 $subtitle,
229                 null,
230                 $logo,
231                 $self
232             );
233             break;
234         case 'atom':
235             header('Content-Type: application/atom+xml; charset=utf-8');
236
237             $atom = new AtomNoticeFeed($this->auth_user);
238
239             $atom->setId($id);
240             $atom->setTitle($title);
241             $atom->setSubtitle($subtitle);
242             $atom->setLogo($logo);
243             $atom->setUpdated('now');
244             $atom->addLink($link);
245             $atom->setSelfLink($self);
246
247             $atom->addEntryFromNotices($this->notices);
248
249             $this->raw($atom->getString());
250
251             break;
252         case 'json':
253             $this->showJsonTimeline($this->notices);
254             break;
255         case 'as':
256             header('Content-Type: ' . ActivityStreamJSONDocument::CONTENT_TYPE);
257             $doc = new ActivityStreamJSONDocument($this->auth_user, $title);
258             $doc->addLink($link, 'alternate', 'text/html');
259             $doc->addItemsFromNotices($this->notices);
260             $this->raw($doc->asString());
261             break;
262         default:
263             // TRANS: Client error displayed when coming across a non-supported API method.
264             $this->clientError(_('API method not found.'), 404);
265         }
266     }
267
268     /**
269      * Get notices
270      *
271      * @return array notices
272      */
273     function getNotices()
274     {
275         $notices = array();
276
277         $stream = new InboxNoticeStream($this->target, $this->scoped);
278         
279         $notice = $stream->getNotices(($this->page-1) * $this->count,
280                                       $this->count,
281                                       $this->since_id,
282                                       $this->max_id);
283
284         while ($notice->fetch()) {
285             $notices[] = clone($notice);
286         }
287
288         return $notices;
289     }
290
291     /**
292      * Is this action read only?
293      *
294      * @param array $args other arguments
295      *
296      * @return boolean true
297      */
298     function isReadOnly($args)
299     {
300         return true;
301     }
302
303     /**
304      * When was this feed last modified?
305      *
306      * @return string datestamp of the latest notice in the stream
307      */
308     function lastModified()
309     {
310         if (!empty($this->notices) && (count($this->notices) > 0)) {
311             return strtotime($this->notices[0]->created);
312         }
313
314         return null;
315     }
316
317     /**
318      * An entity tag for this stream
319      *
320      * Returns an Etag based on the action name, language, user ID, and
321      * timestamps of the first and last notice in the timeline
322      *
323      * @return string etag
324      */
325     function etag()
326     {
327         if (!empty($this->notices) && (count($this->notices) > 0)) {
328             $last = count($this->notices) - 1;
329
330             return '"' . implode(
331                                  ':',
332                                  array($this->arg('action'),
333                                        common_user_cache_hash($this->auth_user),
334                                        common_language(),
335                                        $this->target->id,
336                                        strtotime($this->notices[0]->created),
337                                        strtotime($this->notices[$last]->created))
338                                  )
339               . '"';
340         }
341
342         return null;
343     }
344 }