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')) {
41 require_once INSTALLDIR . '/lib/apibareauth.php';
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.
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/
60 class ApiTimelineUserAction extends ApiBareAuthAction
65 * Take arguments for running
67 * @param array $args $_REQUEST args
69 * @return boolean success flag
71 function prepare($args)
73 parent::prepare($args);
75 $this->user = $this->getTargetUser($this->arg('id'));
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);
83 $this->notices = $this->getNotices();
91 * Just show the notices
93 * @param array $args $_REQUEST data (unused)
97 function handle($args)
99 parent::handle($args);
101 if ($this->isPost()) {
104 $this->showTimeline();
109 * Show the timeline of notices
113 function showTimeline()
115 $profile = $this->user->getProfile();
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);
121 $link = common_local_url(
123 array('nickname' => $this->user->nickname)
126 $self = $this->getSelfUri();
128 // FriendFeed's SUP protocol
129 // Also added RSS and Atom feeds
131 $suplink = common_local_url('sup', null, null, $this->user->id);
132 header('X-SUP-ID: ' . $suplink);
134 switch($this->format) {
136 $this->showXmlTimeline($this->notices);
139 $this->showRssTimeline(
150 header('Content-Type: application/atom+xml; charset=utf-8');
153 $atom->setSelfLink($self);
155 // Add navigation links: next, prev, first
156 // Note: we use IDs rather than pages for navigation; page boundaries
157 // change too quickly!
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));
165 $atom->addLink($nextUrl,
166 array('rel' => 'next',
167 'type' => 'application/atom+xml'));
170 if (($this->page > 1 || !empty($this->max_id)) && !empty($this->notices)) {
172 $lastNotice = $this->notices[0];
173 $lastId = $lastNotice->id;
175 $prevUrl = common_local_url('ApiTimelineUser',
176 array('format' => 'atom',
177 'id' => $this->user->id),
178 array('since_id' => $lastId));
180 $atom->addLink($prevUrl,
181 array('rel' => 'prev',
182 'type' => 'application/atom+xml'));
185 if ($this->page > 1 || !empty($this->since_id) || !empty($this->max_id)) {
187 $firstUrl = common_local_url('ApiTimelineUser',
188 array('format' => 'atom',
189 'id' => $this->user->id));
191 $atom->addLink($firstUrl,
192 array('rel' => 'first',
193 'type' => 'application/atom+xml'));
197 $atom->addEntryFromNotices($this->notices);
198 $this->raw($atom->getString());
202 $this->showJsonTimeline($this->notices);
205 // TRANS: Client error displayed when trying to handle an unknown API method.
206 $this->clientError(_('API method not found.'), $code = 404);
214 * @return array notices
216 function getNotices()
220 $notice = $this->user->getNotices(($this->page-1) * $this->count,
225 while ($notice->fetch()) {
226 if (count($notices) < $this->count) {
227 $notices[] = clone($notice);
229 $this->next_id = $notice->id;
238 * We expose AtomPub here, so non-GET/HEAD reqs must be read/write.
240 * @param array $args other arguments
242 * @return boolean true
245 function isReadOnly($args)
247 return ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD');
251 * When was this feed last modified?
253 * @return string datestamp of the latest notice in the stream
255 function lastModified()
257 if (!empty($this->notices) && (count($this->notices) > 0)) {
258 return strtotime($this->notices[0]->created);
265 * An entity tag for this stream
267 * Returns an Etag based on the action name, language, user ID, and
268 * timestamps of the first and last notice in the timeline
270 * @return string etag
274 if (!empty($this->notices) && (count($this->notices) > 0)) {
275 $last = count($this->notices) - 1;
277 return '"' . implode(
279 array($this->arg('action'),
280 common_user_cache_hash($this->auth_user),
283 strtotime($this->notices[0]->created),
284 strtotime($this->notices[$last]->created))
292 function handlePost()
294 if (empty($this->auth_user) ||
295 $this->auth_user->id != $this->user->id) {
296 // TRANS: Client error displayed trying to add a notice to another user's timeline.
297 $this->clientError(_('Only the user can add to their own timeline.'));
301 // Only handle posts for Atom
302 if ($this->format != 'atom') {
303 // TRANS: Client error displayed when using another format than AtomPub.
304 $this->clientError(_('Only accept AtomPub for Atom feeds.'));
308 $xml = trim(file_get_contents('php://input'));
310 // TRANS: Client error displayed attempting to post an empty API notice.
311 $this->clientError(_('Atom post must not be empty.'));
314 $dom = DOMDocument::loadXML($xml);
316 // TRANS: Client error displayed attempting to post an API that is not well-formed XML.
317 $this->clientError(_('Atom post must be well-formed XML.'));
320 if ($dom->documentElement->namespaceURI != Activity::ATOM ||
321 $dom->documentElement->localName != 'entry') {
322 // TRANS: Client error displayed when not using an Atom entry.
323 $this->clientError(_('Atom post must be an Atom entry.'));
327 $activity = new Activity($dom->documentElement);
331 if (Event::handle('StartAtomPubNewActivity', array(&$activity, $this->user, &$saved))) {
333 if ($activity->verb != ActivityVerb::POST) {
334 // TRANS: Client error displayed when not using the POST verb. Do not translate POST.
335 $this->clientError(_('Can only handle POST activities.'));
339 $note = $activity->objects[0];
341 if (!in_array($note->type, array(ActivityObject::NOTE,
342 ActivityObject::BLOGENTRY,
343 ActivityObject::STATUS))) {
344 // TRANS: Client error displayed when using an unsupported activity object type.
345 // TRANS: %s is the unsupported activity object type.
346 $this->clientError(sprintf(_('Cannot handle activity object type "%s".'),
351 $saved = $this->postNote($activity);
353 Event::handle('EndAtomPubNewActivity', array($activity, $this->user, $saved));
356 if (!empty($saved)) {
357 header('HTTP/1.1 201 Created');
358 header("Location: " . common_local_url('ApiStatusesShow', array('id' => $saved->id,
359 'format' => 'atom')));
360 $this->showSingleAtomStatus($saved);
364 function postNote($activity)
366 $note = $activity->objects[0];
368 // Use summary as fallback for content
370 if (!empty($note->content)) {
371 $sourceContent = $note->content;
372 } else if (!empty($note->summary)) {
373 $sourceContent = $note->summary;
374 } else if (!empty($note->title)) {
375 $sourceContent = $note->title;
377 // @fixme fetch from $sourceUrl?
378 // TRANS: Client error displayed when posting a notice without content through the API.
379 // TRANS: %d is the notice ID (number).
380 $this->clientError(sprintf(_('No content for notice %d.'),
385 // Get (safe!) HTML and text versions of the content
387 $rendered = $this->purify($sourceContent);
388 $content = html_entity_decode(strip_tags($rendered), ENT_QUOTES, 'UTF-8');
390 $shortened = $this->auth_user->shortenLinks($content);
392 $options = array('is_local' => Notice::LOCAL_PUBLIC,
393 'rendered' => $rendered,
394 'replies' => array(),
399 // accept remote URI (not necessarily a good idea)
401 common_debug("Note ID is {$note->id}");
403 if (!empty($note->id)) {
404 $notice = Notice::staticGet('uri', trim($note->id));
406 if (!empty($notice)) {
407 // TRANS: Client error displayed when using another format than AtomPub.
408 $this->clientError(sprintf(_('Notice with URI "%s" already exists.'),
412 common_log(LOG_NOTICE, "Saving client-supplied notice URI '$note->id'");
413 $options['uri'] = $note->id;
416 // accept remote create time (also maybe not such a good idea)
418 if (!empty($activity->time)) {
419 common_log(LOG_NOTICE, "Saving client-supplied create time {$activity->time}");
420 $options['created'] = common_sql_date($activity->time);
423 // Check for optional attributes...
425 if (!empty($activity->context)) {
427 foreach ($activity->context->attention as $uri) {
429 $profile = Profile::fromURI($uri);
431 if (!empty($profile)) {
432 $options['replies'][] = $uri;
434 $group = User_group::staticGet('uri', $uri);
435 if (!empty($group)) {
436 $options['groups'][] = $uri;
438 // @fixme: hook for discovery here
439 common_log(LOG_WARNING, sprintf('AtomPub post with unknown attention URI %s', $uri));
444 // Maintain direct reply associations
445 // @fixme what about conversation ID?
447 if (!empty($activity->context->replyToID)) {
448 $orig = Notice::staticGet('uri',
449 $activity->context->replyToID);
451 $options['reply_to'] = $orig->id;
455 $location = $activity->context->location;
458 $options['lat'] = $location->lat;
459 $options['lon'] = $location->lon;
460 if ($location->location_id) {
461 $options['location_ns'] = $location->location_ns;
462 $options['location_id'] = $location->location_id;
467 // Atom categories <-> hashtags
469 foreach ($activity->categories as $cat) {
471 $term = common_canonical_tag($cat->term);
473 $options['tags'][] = $term;
478 // Atom enclosures -> attachment URLs
479 foreach ($activity->enclosures as $href) {
480 // @fixme save these locally or....?
481 $options['urls'][] = $href;
484 $saved = Notice::saveNew($this->user->id,
486 'atompub', // TODO: deal with this
492 function purify($content)
494 require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
496 $config = array('safe' => 1,
497 'deny_attribute' => 'id,style,on*');
498 return htmLawed($content, $config);