3 * StatusNet, the distributed open-source microblogging tool
5 * Show a user's timeline
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.
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.
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/>.
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/
37 if (!defined('STATUSNET')) {
42 * Returns the most recent notices (default 20) posted by the authenticating
43 * user. Another user's timeline can be requested via the id parameter. This
44 * is the API equivalent of the user profile web page.
48 * @author Craig Andrews <candrews@integralblue.com>
49 * @author Evan Prodromou <evan@status.net>
50 * @author Jeffery To <jeffery.to@gmail.com>
51 * @author mac65 <mac65@mac65.com>
52 * @author Mike Cochrane <mikec@mikenz.geek.nz>
53 * @author Robin Millette <robin@millette.info>
54 * @author Zach Copley <zach@status.net>
55 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
56 * @link http://status.net/
58 class ApiTimelineUserAction extends ApiBareAuthAction
65 * Take arguments for running
67 * @param array $args $_REQUEST args
69 * @return boolean success flag
71 protected function prepare(array $args=array())
73 parent::prepare($args);
75 $this->target = $this->getTargetProfile($this->arg('id'));
77 if (!($this->target instanceof Profile)) {
78 // TRANS: Client error displayed requesting most recent notices for a non-existing user.
79 $this->clientError(_('No such user.'), 404);
82 $this->notices = $this->getNotices();
90 * Just show the notices
94 protected function handle()
98 if ($this->isPost()) {
101 $this->showTimeline();
106 * Show the timeline of notices
110 function showTimeline()
112 // We'll use the shared params from the Atom stub
113 // for other feed types.
114 $atom = new AtomUserNoticeFeed($this->target->getUser(), $this->auth_user);
116 $link = common_local_url(
118 array('nickname' => $this->target->nickname)
121 $self = $this->getSelfUri();
123 // FriendFeed's SUP protocol
124 // Also added RSS and Atom feeds
126 $suplink = common_local_url('sup', null, null, $this->target->id);
127 header('X-SUP-ID: ' . $suplink);
131 $nextUrl = !empty($this->next_id)
132 ? common_local_url('ApiTimelineUser',
133 array('format' => $this->format,
134 'id' => $this->target->id),
135 array('max_id' => $this->next_id))
138 $prevExtra = array();
139 if (!empty($this->notices)) {
140 assert($this->notices[0] instanceof Notice);
141 $prevExtra['since_id'] = $this->notices[0]->id;
144 $prevUrl = common_local_url('ApiTimelineUser',
145 array('format' => $this->format,
146 'id' => $this->target->id),
148 $firstUrl = common_local_url('ApiTimelineUser',
149 array('format' => $this->format,
150 'id' => $this->target->id));
152 switch($this->format) {
154 $this->showXmlTimeline($this->notices);
157 $this->showRssTimeline(
168 header('Content-Type: application/atom+xml; charset=utf-8');
171 $atom->setSelfLink($self);
173 // Add navigation links: next, prev, first
174 // Note: we use IDs rather than pages for navigation; page boundaries
175 // change too quickly!
177 if (!empty($this->next_id)) {
178 $atom->addLink($nextUrl,
179 array('rel' => 'next',
180 'type' => 'application/atom+xml'));
183 if (($this->page > 1 || !empty($this->max_id)) && !empty($this->notices)) {
184 $atom->addLink($prevUrl,
185 array('rel' => 'prev',
186 'type' => 'application/atom+xml'));
189 if ($this->page > 1 || !empty($this->since_id) || !empty($this->max_id)) {
190 $atom->addLink($firstUrl,
191 array('rel' => 'first',
192 'type' => 'application/atom+xml'));
196 $atom->addEntryFromNotices($this->notices);
197 $this->raw($atom->getString());
201 $this->showJsonTimeline($this->notices);
204 header('Content-Type: ' . ActivityStreamJSONDocument::CONTENT_TYPE);
205 $doc = new ActivityStreamJSONDocument($this->auth_user);
206 $doc->setTitle($atom->title);
207 $doc->addLink($link, 'alternate', 'text/html');
208 $doc->addItemsFromNotices($this->notices);
210 if (!empty($this->next_id)) {
211 $doc->addLink($nextUrl,
212 array('rel' => 'next',
213 'type' => ActivityStreamJSONDocument::CONTENT_TYPE));
216 if (($this->page > 1 || !empty($this->max_id)) && !empty($this->notices)) {
217 $doc->addLink($prevUrl,
218 array('rel' => 'prev',
219 'type' => ActivityStreamJSONDocument::CONTENT_TYPE));
222 if ($this->page > 1 || !empty($this->since_id) || !empty($this->max_id)) {
223 $doc->addLink($firstUrl,
224 array('rel' => 'first',
225 'type' => ActivityStreamJSONDocument::CONTENT_TYPE));
228 $this->raw($doc->asString());
231 // TRANS: Client error displayed when coming across a non-supported API method.
232 $this->clientError(_('API method not found.'), 404);
239 * @return array notices
241 function getNotices()
245 $notice = $this->target->getNotices(($this->page-1) * $this->count,
251 while ($notice->fetch()) {
252 if (count($notices) < $this->count) {
253 $notices[] = clone($notice);
255 $this->next_id = $notice->id;
264 * We expose AtomPub here, so non-GET/HEAD reqs must be read/write.
266 * @param array $args other arguments
268 * @return boolean true
271 function isReadOnly(array $args=array())
273 return ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD');
277 * When was this feed last modified?
279 * @return string datestamp of the latest notice in the stream
281 function lastModified()
283 if (!empty($this->notices) && (count($this->notices) > 0)) {
284 return strtotime($this->notices[0]->created);
291 * An entity tag for this stream
293 * Returns an Etag based on the action name, language, user ID, and
294 * timestamps of the first and last notice in the timeline
296 * @return string etag
300 if (!empty($this->notices) && (count($this->notices) > 0)) {
301 $last = count($this->notices) - 1;
303 return '"' . implode(
305 array($this->arg('action'),
306 common_user_cache_hash($this->auth_user),
309 strtotime($this->notices[0]->created),
310 strtotime($this->notices[$last]->created))
318 function handlePost()
320 if (empty($this->auth_user) ||
321 $this->auth_user->id != $this->target->id) {
322 // TRANS: Client error displayed trying to add a notice to another user's timeline.
323 $this->clientError(_('Only the user can add to their own timeline.'));
326 // Only handle posts for Atom
327 if ($this->format != 'atom') {
328 // TRANS: Client error displayed when using another format than AtomPub.
329 $this->clientError(_('Only accept AtomPub for Atom feeds.'));
332 $xml = trim(file_get_contents('php://input'));
334 // TRANS: Client error displayed attempting to post an empty API notice.
335 $this->clientError(_('Atom post must not be empty.'));
338 $old = error_reporting(error_reporting() & ~(E_WARNING | E_NOTICE));
339 $dom = new DOMDocument();
340 $ok = $dom->loadXML($xml);
341 error_reporting($old);
343 // TRANS: Client error displayed attempting to post an API that is not well-formed XML.
344 $this->clientError(_('Atom post must be well-formed XML.'));
347 if ($dom->documentElement->namespaceURI != Activity::ATOM ||
348 $dom->documentElement->localName != 'entry') {
349 // TRANS: Client error displayed when not using an Atom entry.
350 $this->clientError(_('Atom post must be an Atom entry.'));
353 $activity = new Activity($dom->documentElement);
357 if (Event::handle('StartAtomPubNewActivity', array(&$activity, $this->target->getUser(), &$saved))) {
358 if ($activity->verb != ActivityVerb::POST) {
359 // TRANS: Client error displayed when not using the POST verb. Do not translate POST.
360 $this->clientError(_('Can only handle POST activities.'));
363 $note = $activity->objects[0];
365 if (!in_array($note->type, array(ActivityObject::NOTE,
366 ActivityObject::BLOGENTRY,
367 ActivityObject::STATUS))) {
368 // TRANS: Client error displayed when using an unsupported activity object type.
369 // TRANS: %s is the unsupported activity object type.
370 $this->clientError(sprintf(_('Cannot handle activity object type "%s".'),
374 $saved = $this->postNote($activity);
376 Event::handle('EndAtomPubNewActivity', array($activity, $this->target->getUser(), $saved));
379 if (!empty($saved)) {
380 header('HTTP/1.1 201 Created');
381 header("Location: " . common_local_url('ApiStatusesShow', array('id' => $saved->id,
382 'format' => 'atom')));
383 $this->showSingleAtomStatus($saved);
387 function postNote($activity)
389 $note = $activity->objects[0];
391 // Use summary as fallback for content
393 if (!empty($note->content)) {
394 $sourceContent = $note->content;
395 } else if (!empty($note->summary)) {
396 $sourceContent = $note->summary;
397 } else if (!empty($note->title)) {
398 $sourceContent = $note->title;
400 // @fixme fetch from $sourceUrl?
401 // TRANS: Client error displayed when posting a notice without content through the API.
402 // TRANS: %d is the notice ID (number).
403 $this->clientError(sprintf(_('No content for notice %d.'), $note->id));
406 // Get (safe!) HTML and text versions of the content
408 $rendered = $this->purify($sourceContent);
409 $content = common_strip_html($rendered);
411 $shortened = $this->auth_user->shortenLinks($content);
413 $options = array('is_local' => Notice::LOCAL_PUBLIC,
414 'rendered' => $rendered,
415 'replies' => array(),
420 // accept remote URI (not necessarily a good idea)
422 common_debug("Note ID is {$note->id}");
424 if (!empty($note->id)) {
425 $notice = Notice::getKV('uri', trim($note->id));
427 if (!empty($notice)) {
428 // TRANS: Client error displayed when using another format than AtomPub.
429 // TRANS: %s is the notice URI.
430 $this->clientError(sprintf(_('Notice with URI "%s" already exists.'), $note->id));
432 common_log(LOG_NOTICE, "Saving client-supplied notice URI '$note->id'");
433 $options['uri'] = $note->id;
436 // accept remote create time (also maybe not such a good idea)
438 if (!empty($activity->time)) {
439 common_log(LOG_NOTICE, "Saving client-supplied create time {$activity->time}");
440 $options['created'] = common_sql_date($activity->time);
443 // Check for optional attributes...
445 if ($activity->context instanceof ActivityContext) {
447 foreach ($activity->context->attention as $uri=>$type) {
449 $profile = Profile::fromUri($uri);
450 if ($profile->isGroup()) {
451 $options['groups'][] = $profile->id;
453 $options['replies'][] = $uri;
455 } catch (UnknownUriException $e) {
456 common_log(LOG_WARNING, sprintf('AtomPub post with unknown attention URI %s', $uri));
460 // Maintain direct reply associations
461 // @fixme what about conversation ID?
463 if (!empty($activity->context->replyToID)) {
464 $orig = Notice::getKV('uri',
465 $activity->context->replyToID);
467 $options['reply_to'] = $orig->id;
471 $location = $activity->context->location;
474 $options['lat'] = $location->lat;
475 $options['lon'] = $location->lon;
476 if ($location->location_id) {
477 $options['location_ns'] = $location->location_ns;
478 $options['location_id'] = $location->location_id;
483 // Atom categories <-> hashtags
485 foreach ($activity->categories as $cat) {
487 $term = common_canonical_tag($cat->term);
489 $options['tags'][] = $term;
494 // Atom enclosures -> attachment URLs
495 foreach ($activity->enclosures as $href) {
496 // @fixme save these locally or....?
497 $options['urls'][] = $href;
500 $saved = Notice::saveNew($this->target->id,
502 'atompub', // TODO: deal with this
508 function purify($content)
510 require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
512 $config = array('safe' => 1,
513 'deny_attribute' => 'id,style,on*');
514 return htmLawed($content, $config);