]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apitimelineuser.php
Merge branch 'master' into 0.9.x
[quix0rs-gnu-social.git] / actions / apitimelineuser.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Show a user's 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 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 if (!defined('STATUSNET')) {
38     exit(1);
39 }
40
41 require_once INSTALLDIR . '/lib/apibareauth.php';
42
43 /**
44  * Returns the most recent notices (default 20) posted by the authenticating
45  * user. Another user's timeline can be requested via the id parameter. This
46  * is the API equivalent of the user profile web page.
47  *
48  * @category API
49  * @package  StatusNet
50  * @author   Craig Andrews <candrews@integralblue.com>
51  * @author   Evan Prodromou <evan@status.net>
52  * @author   Jeffery To <jeffery.to@gmail.com>
53  * @author   mac65 <mac65@mac65.com>
54  * @author   Mike Cochrane <mikec@mikenz.geek.nz>
55  * @author   Robin Millette <robin@millette.info>
56  * @author   Zach Copley <zach@status.net>
57  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
58  * @link     http://status.net/
59  */
60 class ApiTimelineUserAction extends ApiBareAuthAction
61 {
62     var $notices = null;
63
64     /**
65      * Take arguments for running
66      *
67      * @param array $args $_REQUEST args
68      *
69      * @return boolean success flag
70      */
71     function prepare($args)
72     {
73         parent::prepare($args);
74
75         $this->user = $this->getTargetUser($this->arg('id'));
76
77         if (empty($this->user)) {
78             // TRANS: Client error displayed requesting most recent notices for a non-existing 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     function handle($args)
98     {
99         parent::handle($args);
100
101         if ($this->isPost()) {
102             $this->handlePost();
103         } else {
104             $this->showTimeline();
105         }
106     }
107
108     /**
109      * Show the timeline of notices
110      *
111      * @return void
112      */
113     function showTimeline()
114     {
115         $profile = $this->user->getProfile();
116
117         // We'll use the shared params from the Atom stub
118         // for other feed types.
119         $atom = new AtomUserNoticeFeed($this->user, $this->auth_user);
120
121         $link = common_local_url(
122                                  'showstream',
123                                  array('nickname' => $this->user->nickname)
124                                  );
125
126         $self = $this->getSelfUri();
127
128         // FriendFeed's SUP protocol
129         // Also added RSS and Atom feeds
130
131         $suplink = common_local_url('sup', null, null, $this->user->id);
132         header('X-SUP-ID: ' . $suplink);
133
134         switch($this->format) {
135         case 'xml':
136             $this->showXmlTimeline($this->notices);
137             break;
138         case 'rss':
139             $this->showRssTimeline(
140                                    $this->notices,
141                                    $atom->title,
142                                    $link,
143                                    $atom->subtitle,
144                                    $suplink,
145                                    $atom->logo,
146                                    $self
147                                    );
148             break;
149         case 'atom':
150             header('Content-Type: application/atom+xml; charset=utf-8');
151
152             $atom->setId($self);
153             $atom->setSelfLink($self);
154
155             // Add navigation links: next, prev, first
156             // Note: we use IDs rather than pages for navigation; page boundaries
157             // change too quickly!
158
159             if (!empty($this->next_id)) {
160                 $nextUrl = common_local_url('ApiTimelineUser',
161                                             array('format' => 'atom',
162                                                   'id' => $this->user->id),
163                                             array('max_id' => $this->next_id));
164
165                 $atom->addLink($nextUrl,
166                                array('rel' => 'next',
167                                      'type' => 'application/atom+xml'));
168             }
169
170             if (($this->page > 1 || !empty($this->max_id)) && !empty($this->notices)) {
171
172                 $lastNotice = $this->notices[0];
173                 $lastId     = $lastNotice->id;
174
175                 $prevUrl = common_local_url('ApiTimelineUser',
176                                             array('format' => 'atom',
177                                                   'id' => $this->user->id),
178                                             array('since_id' => $lastId));
179
180                 $atom->addLink($prevUrl,
181                                array('rel' => 'prev',
182                                      'type' => 'application/atom+xml'));
183             }
184
185             if ($this->page > 1 || !empty($this->since_id) || !empty($this->max_id)) {
186
187                 $firstUrl = common_local_url('ApiTimelineUser',
188                                             array('format' => 'atom',
189                                                   'id' => $this->user->id));
190
191                 $atom->addLink($firstUrl,
192                                array('rel' => 'first',
193                                      'type' => 'application/atom+xml'));
194
195             }
196
197             $atom->addEntryFromNotices($this->notices);
198             $this->raw($atom->getString());
199
200             break;
201         case 'json':
202             $this->showJsonTimeline($this->notices);
203             break;
204         default:
205             // TRANS: Client error displayed when trying to handle an unknown API method.
206             $this->clientError(_('API method not found.'), $code = 404);
207             break;
208         }
209     }
210
211     /**
212      * Get notices
213      *
214      * @return array notices
215      */
216     function getNotices()
217     {
218         $notices = array();
219
220         $notice = $this->user->getNotices(($this->page-1) * $this->count,
221                                           $this->count + 1,
222                                           $this->since_id,
223                                           $this->max_id);
224
225         while ($notice->fetch()) {
226             if (count($notices) < $this->count) {
227                 $notices[] = clone($notice);
228             } else {
229                 $this->next_id = $notice->id;
230                 break;
231             }
232         }
233
234         return $notices;
235     }
236
237     /**
238      * Is this action read only?
239      *
240      * @param array $args other arguments
241      *
242      * @return boolean true
243      */
244     
245     function isReadOnly($args)
246     {
247         if ($_SERVER['REQUEST_METHOD'] == 'GET') {
248             return true;
249         } else {
250             return false;
251         }
252     }
253
254     /**
255      * When was this feed last modified?
256      *
257      * @return string datestamp of the latest notice in the stream
258      */
259     function lastModified()
260     {
261         if (!empty($this->notices) && (count($this->notices) > 0)) {
262             return strtotime($this->notices[0]->created);
263         }
264
265         return null;
266     }
267
268     /**
269      * An entity tag for this stream
270      *
271      * Returns an Etag based on the action name, language, user ID, and
272      * timestamps of the first and last notice in the timeline
273      *
274      * @return string etag
275      */
276     function etag()
277     {
278         if (!empty($this->notices) && (count($this->notices) > 0)) {
279             $last = count($this->notices) - 1;
280
281             return '"' . implode(
282                                  ':',
283                                  array($this->arg('action'),
284                                        common_user_cache_hash($this->auth_user),
285                                        common_language(),
286                                        $this->user->id,
287                                        strtotime($this->notices[0]->created),
288                                        strtotime($this->notices[$last]->created))
289                                  )
290               . '"';
291         }
292
293         return null;
294     }
295
296     function handlePost()
297     {
298         if (empty($this->auth_user) ||
299             $this->auth_user->id != $this->user->id) {
300             $this->clientError(_("Only the user can add to their own timeline."));
301             return;
302         }
303
304         if ($this->format != 'atom') {
305             // Only handle posts for Atom
306             $this->clientError(_("Only accept AtomPub for atom feeds."));
307             return;
308         }
309
310         $xml = file_get_contents('php://input');
311
312         $dom = DOMDocument::loadXML($xml);
313
314         if ($dom->documentElement->namespaceURI != Activity::ATOM ||
315             $dom->documentElement->localName != 'entry') {
316             $this->clientError(_('Atom post must be an Atom entry.'));
317             return;
318         }
319
320         $activity = new Activity($dom->documentElement);
321
322         if (Event::handle('StartAtomPubNewActivity', array(&$activity))) {
323
324             if ($activity->verb != ActivityVerb::POST) {
325                 $this->clientError(_('Can only handle post activities.'));
326                 return;
327             }
328
329             $note = $activity->objects[0];
330
331             if (!in_array($note->type, array(ActivityObject::NOTE,
332                                              ActivityObject::BLOGENTRY,
333                                              ActivityObject::STATUS))) {
334                 $this->clientError(sprintf(_('Cannot handle activity object type "%s"',
335                                              $note->type)));
336                 return;
337             }
338
339             $saved = $this->postNote($activity);
340
341             Event::handle('EndAtomPubNewActivity', array($activity, $saved));
342         }
343
344         if (!empty($saved)) {
345             header("Location: " . common_local_url('ApiStatusesShow', array('notice_id' => $saved->id,
346                                                                             'format' => 'atom')));
347             $this->showSingleAtomStatus($saved);
348         }
349     }
350
351     function postNote($activity)
352     {
353         $note = $activity->objects[0];
354
355         // Use summary as fallback for content
356
357         if (!empty($note->content)) {
358             $sourceContent = $note->content;
359         } else if (!empty($note->summary)) {
360             $sourceContent = $note->summary;
361         } else if (!empty($note->title)) {
362             $sourceContent = $note->title;
363         } else {
364             // @fixme fetch from $sourceUrl?
365             // @todo i18n FIXME: use sprintf and add i18n.
366             $this->clientError("No content for notice {$note->id}.");
367             return;
368         }
369
370         // Get (safe!) HTML and text versions of the content
371
372         $rendered = $this->purify($sourceContent);
373         $content = html_entity_decode(strip_tags($rendered), ENT_QUOTES, 'UTF-8');
374
375         $shortened = common_shorten_links($content);
376
377         $options = array('is_local' => Notice::LOCAL_PUBLIC,
378                          'rendered' => $rendered,
379                          'replies' => array(),
380                          'groups' => array(),
381                          'tags' => array(),
382                          'urls' => array());
383
384         // accept remote URI (not necessarily a good idea)
385
386         common_debug("Note ID is {$note->id}");
387
388         if (!empty($note->id)) {
389             $notice = Notice::staticGet('uri', trim($note->id));
390
391             if (!empty($notice)) {
392                 $this->clientError(sprintf(_('Notice with URI "%s" already exists.'),
393                                            $note->id));
394                 return;
395             }
396             common_log(LOG_NOTICE, "Saving client-supplied notice URI '$note->id'");
397             $options['uri'] = $note->id;
398         }
399
400         // accept remote create time (also maybe not such a good idea)
401
402         if (!empty($activity->time)) {
403             common_log(LOG_NOTICE, "Saving client-supplied create time {$activity->time}");
404             $options['created'] = common_sql_date($activity->time);
405         }
406
407         // Check for optional attributes...
408
409         if (!empty($activity->context)) {
410
411             foreach ($activity->context->attention as $uri) {
412
413                 $profile = Profile::fromURI($uri);
414
415                 if (!empty($profile)) {
416                     $options['replies'] = $uri;
417                 } else {
418                     $group = User_group::staticGet('uri', $uri);
419                     if (!empty($group)) {
420                         $options['groups'] = $uri;
421                     } else {
422                         // @fixme: hook for discovery here
423                         common_log(LOG_WARNING, sprintf(_('AtomPub post with unknown attention URI %s'), $uri));
424                     }
425                 }
426             }
427
428             // Maintain direct reply associations
429             // @fixme what about conversation ID?
430
431             if (!empty($activity->context->replyToID)) {
432                 $orig = Notice::staticGet('uri',
433                                           $activity->context->replyToID);
434                 if (!empty($orig)) {
435                     $options['reply_to'] = $orig->id;
436                 }
437             }
438
439             $location = $activity->context->location;
440
441             if ($location) {
442                 $options['lat'] = $location->lat;
443                 $options['lon'] = $location->lon;
444                 if ($location->location_id) {
445                     $options['location_ns'] = $location->location_ns;
446                     $options['location_id'] = $location->location_id;
447                 }
448             }
449         }
450
451         // Atom categories <-> hashtags
452
453         foreach ($activity->categories as $cat) {
454             if ($cat->term) {
455                 $term = common_canonical_tag($cat->term);
456                 if ($term) {
457                     $options['tags'][] = $term;
458                 }
459             }
460         }
461
462         // Atom enclosures -> attachment URLs
463         foreach ($activity->enclosures as $href) {
464             // @fixme save these locally or....?
465             $options['urls'][] = $href;
466         }
467
468         $saved = Notice::saveNew($this->user->id,
469                                  $content,
470                                  'atompub', // TODO: deal with this
471                                  $options);
472
473         return $saved;
474     }
475
476     function purify($content)
477     {
478         require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
479
480         $config = array('safe' => 1,
481                         'deny_attribute' => 'id,style,on*');
482         return htmLawed($content, $config);
483     }
484 }