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 if (!$this->target->isLocal()) {
83 $this->serverError(_('Remote user timelines are not available here yet.'), 501);
86 $this->notices = $this->getNotices();
94 * Just show the notices
98 protected function handle()
102 if ($this->isPost()) {
105 $this->showTimeline();
110 * Show the timeline of notices
114 function showTimeline()
116 // We'll use the shared params from the Atom stub
117 // for other feed types.
118 $atom = new AtomUserNoticeFeed($this->target->getUser(), $this->auth_user);
120 $link = common_local_url(
122 array('nickname' => $this->target->nickname)
125 $self = $this->getSelfUri();
127 // FriendFeed's SUP protocol
128 // Also added RSS and Atom feeds
130 $suplink = common_local_url('sup', null, null, $this->target->id);
131 header('X-SUP-ID: ' . $suplink);
135 $nextUrl = !empty($this->next_id)
136 ? common_local_url('ApiTimelineUser',
137 array('format' => $this->format,
138 'id' => $this->target->id),
139 array('max_id' => $this->next_id))
142 $prevExtra = array();
143 if (!empty($this->notices)) {
144 assert($this->notices[0] instanceof Notice);
145 $prevExtra['since_id'] = $this->notices[0]->id;
148 $prevUrl = common_local_url('ApiTimelineUser',
149 array('format' => $this->format,
150 'id' => $this->target->id),
152 $firstUrl = common_local_url('ApiTimelineUser',
153 array('format' => $this->format,
154 'id' => $this->target->id));
156 switch($this->format) {
158 $this->showXmlTimeline($this->notices);
161 $this->showRssTimeline(
172 header('Content-Type: application/atom+xml; charset=utf-8');
175 $atom->setSelfLink($self);
177 // Add navigation links: next, prev, first
178 // Note: we use IDs rather than pages for navigation; page boundaries
179 // change too quickly!
181 if (!empty($this->next_id)) {
182 $atom->addLink($nextUrl,
183 array('rel' => 'next',
184 'type' => 'application/atom+xml'));
187 if (($this->page > 1 || !empty($this->max_id)) && !empty($this->notices)) {
188 $atom->addLink($prevUrl,
189 array('rel' => 'prev',
190 'type' => 'application/atom+xml'));
193 if ($this->page > 1 || !empty($this->since_id) || !empty($this->max_id)) {
194 $atom->addLink($firstUrl,
195 array('rel' => 'first',
196 'type' => 'application/atom+xml'));
200 $atom->addEntryFromNotices($this->notices);
201 $this->raw($atom->getString());
205 $this->showJsonTimeline($this->notices);
208 header('Content-Type: ' . ActivityStreamJSONDocument::CONTENT_TYPE);
209 $doc = new ActivityStreamJSONDocument($this->auth_user);
210 $doc->setTitle($atom->title);
211 $doc->addLink($link, 'alternate', 'text/html');
212 $doc->addItemsFromNotices($this->notices);
214 if (!empty($this->next_id)) {
215 $doc->addLink($nextUrl,
216 array('rel' => 'next',
217 'type' => ActivityStreamJSONDocument::CONTENT_TYPE));
220 if (($this->page > 1 || !empty($this->max_id)) && !empty($this->notices)) {
221 $doc->addLink($prevUrl,
222 array('rel' => 'prev',
223 'type' => ActivityStreamJSONDocument::CONTENT_TYPE));
226 if ($this->page > 1 || !empty($this->since_id) || !empty($this->max_id)) {
227 $doc->addLink($firstUrl,
228 array('rel' => 'first',
229 'type' => ActivityStreamJSONDocument::CONTENT_TYPE));
232 $this->raw($doc->asString());
235 // TRANS: Client error displayed when coming across a non-supported API method.
236 $this->clientError(_('API method not found.'), 404);
243 * @return array notices
245 function getNotices()
249 $notice = $this->target->getNotices(($this->page-1) * $this->count,
255 while ($notice->fetch()) {
256 if (count($notices) < $this->count) {
257 $notices[] = clone($notice);
259 $this->next_id = $notice->id;
268 * We expose AtomPub here, so non-GET/HEAD reqs must be read/write.
270 * @param array $args other arguments
272 * @return boolean true
275 function isReadOnly(array $args=array())
277 return ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD');
281 * When was this feed last modified?
283 * @return string datestamp of the latest notice in the stream
285 function lastModified()
287 if (!empty($this->notices) && (count($this->notices) > 0)) {
288 return strtotime($this->notices[0]->created);
295 * An entity tag for this stream
297 * Returns an Etag based on the action name, language, user ID, and
298 * timestamps of the first and last notice in the timeline
300 * @return string etag
304 if (!empty($this->notices) && (count($this->notices) > 0)) {
305 $last = count($this->notices) - 1;
307 return '"' . implode(
309 array($this->arg('action'),
310 common_user_cache_hash($this->auth_user),
313 strtotime($this->notices[0]->created),
314 strtotime($this->notices[$last]->created))
322 function handlePost()
324 if (empty($this->auth_user) ||
325 $this->auth_user->id != $this->target->id) {
326 // TRANS: Client error displayed trying to add a notice to another user's timeline.
327 $this->clientError(_('Only the user can add to their own timeline.'));
330 // Only handle posts for Atom
331 if ($this->format != 'atom') {
332 // TRANS: Client error displayed when using another format than AtomPub.
333 $this->clientError(_('Only accept AtomPub for Atom feeds.'));
336 $xml = trim(file_get_contents('php://input'));
338 // TRANS: Client error displayed attempting to post an empty API notice.
339 $this->clientError(_('Atom post must not be empty.'));
342 $old = error_reporting(error_reporting() & ~(E_WARNING | E_NOTICE));
343 $dom = new DOMDocument();
344 $ok = $dom->loadXML($xml);
345 error_reporting($old);
347 // TRANS: Client error displayed attempting to post an API that is not well-formed XML.
348 $this->clientError(_('Atom post must be well-formed XML.'));
351 if ($dom->documentElement->namespaceURI != Activity::ATOM ||
352 $dom->documentElement->localName != 'entry') {
353 // TRANS: Client error displayed when not using an Atom entry.
354 $this->clientError(_('Atom post must be an Atom entry.'));
357 $activity = new Activity($dom->documentElement);
361 if (Event::handle('StartAtomPubNewActivity', array(&$activity, $this->target->getUser(), &$saved))) {
362 if ($activity->verb != ActivityVerb::POST) {
363 // TRANS: Client error displayed when not using the POST verb. Do not translate POST.
364 $this->clientError(_('Can only handle POST activities.'));
367 $note = $activity->objects[0];
369 if (!in_array($note->type, array(ActivityObject::NOTE,
370 ActivityObject::BLOGENTRY,
371 ActivityObject::STATUS))) {
372 // TRANS: Client error displayed when using an unsupported activity object type.
373 // TRANS: %s is the unsupported activity object type.
374 $this->clientError(sprintf(_('Cannot handle activity object type "%s".'),
378 $saved = $this->postNote($activity);
380 Event::handle('EndAtomPubNewActivity', array($activity, $this->target->getUser(), $saved));
383 if (!empty($saved)) {
384 header('HTTP/1.1 201 Created');
385 header("Location: " . common_local_url('ApiStatusesShow', array('id' => $saved->id,
386 'format' => 'atom')));
387 $this->showSingleAtomStatus($saved);
391 function postNote($activity)
393 $note = $activity->objects[0];
395 // Use summary as fallback for content
397 if (!empty($note->content)) {
398 $sourceContent = $note->content;
399 } else if (!empty($note->summary)) {
400 $sourceContent = $note->summary;
401 } else if (!empty($note->title)) {
402 $sourceContent = $note->title;
404 // @fixme fetch from $sourceUrl?
405 // TRANS: Client error displayed when posting a notice without content through the API.
406 // TRANS: %d is the notice ID (number).
407 $this->clientError(sprintf(_('No content for notice %d.'), $note->id));
410 // Get (safe!) HTML and text versions of the content
412 $rendered = common_purify($sourceContent);
413 $content = common_strip_html($rendered);
415 $shortened = $this->auth_user->shortenLinks($content);
417 $options = array('is_local' => Notice::LOCAL_PUBLIC,
418 'rendered' => $rendered,
419 'replies' => array(),
424 // accept remote URI (not necessarily a good idea)
426 common_debug("Note ID is {$note->id}");
428 if (!empty($note->id)) {
429 $notice = Notice::getKV('uri', trim($note->id));
431 if (!empty($notice)) {
432 // TRANS: Client error displayed when using another format than AtomPub.
433 // TRANS: %s is the notice URI.
434 $this->clientError(sprintf(_('Notice with URI "%s" already exists.'), $note->id));
436 common_log(LOG_NOTICE, "Saving client-supplied notice URI '$note->id'");
437 $options['uri'] = $note->id;
440 // accept remote create time (also maybe not such a good idea)
442 if (!empty($activity->time)) {
443 common_log(LOG_NOTICE, "Saving client-supplied create time {$activity->time}");
444 $options['created'] = common_sql_date($activity->time);
447 // Check for optional attributes...
449 if ($activity->context instanceof ActivityContext) {
451 foreach ($activity->context->attention as $uri=>$type) {
453 $profile = Profile::fromUri($uri);
454 if ($profile->isGroup()) {
455 $options['groups'][] = $profile->id;
457 $options['replies'][] = $uri;
459 } catch (UnknownUriException $e) {
460 common_log(LOG_WARNING, sprintf('AtomPub post with unknown attention URI %s', $uri));
464 // Maintain direct reply associations
465 // @fixme what about conversation ID?
467 if (!empty($activity->context->replyToID)) {
468 $orig = Notice::getKV('uri',
469 $activity->context->replyToID);
471 $options['reply_to'] = $orig->id;
475 $location = $activity->context->location;
478 $options['lat'] = $location->lat;
479 $options['lon'] = $location->lon;
480 if ($location->location_id) {
481 $options['location_ns'] = $location->location_ns;
482 $options['location_id'] = $location->location_id;
487 // Atom categories <-> hashtags
489 foreach ($activity->categories as $cat) {
491 $term = common_canonical_tag($cat->term);
493 $options['tags'][] = $term;
498 // Atom enclosures -> attachment URLs
499 foreach ($activity->enclosures as $href) {
500 // @fixme save these locally or....?
501 $options['urls'][] = $href;
504 $saved = Notice::saveNew($this->target->id,
506 'atompub', // TODO: deal with this