. * * @category API * @package StatusNet * @author Craig Andrews * @author Evan Prodromou * @author Jeffery To * @author mac65 * @author Mike Cochrane * @author Robin Millette * @author Zach Copley * @copyright 2009-2010 StatusNet, Inc. * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @link http://status.net/ */ /* External API usage documentation. Please update when you change how this method works. */ /*! @page friendstimeline statuses/friends_timeline @section Description Returns the 20 most recent statuses posted by the authenticating user and that user's friends. This is the equivalent of "You and friends" page in the web interface. @par URL patterns @li /api/statuses/friends_timeline.:format @li /api/statuses/friends_timeline/:id.:format @par Formats (:format) xml, json, rss, atom @par ID (:id) username, user id @par HTTP Method(s) GET @par Requires Authentication Sometimes (see: @ref authentication) @param user_id (Optional) Specifies a user by ID @param screen_name (Optional) Specifies a user by screename (nickname) @param since_id (Optional) Returns only statuses with an ID greater than (that is, more recent than) the specified ID. @param max_id (Optional) Returns only statuses with an ID less than (that is, older than) or equal to the specified ID. @param count (Optional) Specifies the number of statuses to retrieve. @param page (Optional) Specifies the page of results to retrieve. @sa @ref authentication @sa @ref apiroot @subsection usagenotes Usage notes @li The URL pattern is relative to the @ref apiroot. @li The XML response uses GeoRSS to encode the latitude and longitude (see example response below ). @subsection exampleusage Example usage @verbatim curl http://identi.ca/api/statuses/friends_timeline/evan.xml?count=1&page=2 @endverbatim @subsection exampleresponse Example response @verbatim back from the !yul !drupal meet with Evolving Web folk, @anarcat, @webchick and others, and an interesting refresher on SQL indexing false Wed Mar 31 01:33:02 +0000 2010 <a href="http://code.google.com/p/microblog-purple/">mbpidgin</a> 26674201 false 246 Mark lambic Montreal, Canada Geek http://avatar.identi.ca/246-48-20080702141545.png http://lambic.co.uk false 73 #F0F2F5 #002E6E #CEE1E9 58 Wed Jul 02 14:12:15 +0000 2008 2 -14400 US/Eastern false 933 false false @endverbatim */ if (!defined('STATUSNET')) { exit(1); } require_once INSTALLDIR . '/lib/apibareauth.php'; /** * Returns the most recent notices (default 20) posted by the target user. * This is the equivalent of 'You and friends' page accessed via Web. * * @category API * @package StatusNet * @author Craig Andrews * @author Evan Prodromou * @author Jeffery To * @author mac65 * @author Mike Cochrane * @author Robin Millette * @author Zach Copley * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @link http://status.net/ */ class ApiTimelineFriendsAction extends ApiBareAuthAction { var $notices = null; /** * Take arguments for running * * @param array $args $_REQUEST args * * @return boolean success flag * */ function prepare($args) { parent::prepare($args); $this->user = $this->getTargetUser($this->arg('id')); if (empty($this->user)) { // TRANS: Client error displayed when requesting dents of a user and friends for a user that does not exist. $this->clientError(_('No such user.'), 404, $this->format); return; } $this->notices = $this->getNotices(); return true; } /** * Handle the request * * Just show the notices * * @param array $args $_REQUEST data (unused) * * @return void */ function handle($args) { parent::handle($args); $this->showTimeline(); } /** * Show the timeline of notices * * @return void */ function showTimeline() { $profile = $this->user->getProfile(); $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE); $sitename = common_config('site', 'name'); // TRANS: Title of API timeline for a user and friends. // TRANS: %s is a username. $title = sprintf(_("%s and friends"), $this->user->nickname); $taguribase = TagURI::base(); $id = "tag:$taguribase:FriendsTimeline:" . $this->user->id; $subtitle = sprintf( // TRANS: Message is used as a subtitle. %1$s is a user nickname, %2$s is a site name. _('Updates from %1$s and friends on %2$s!'), $this->user->nickname, $sitename ); $link = common_local_url( 'all', array('nickname' => $this->user->nickname) ); $self = $this->getSelfUri(); $logo = (!empty($avatar)) ? $avatar->displayUrl() : Avatar::defaultImage(AVATAR_PROFILE_SIZE); switch($this->format) { case 'xml': $this->showXmlTimeline($this->notices); break; case 'rss': $this->showRssTimeline( $this->notices, $title, $link, $subtitle, null, $logo, $self ); break; case 'atom': header('Content-Type: application/atom+xml; charset=utf-8'); $atom = new AtomNoticeFeed($this->auth_user); $atom->setId($id); $atom->setTitle($title); $atom->setSubtitle($subtitle); $atom->setLogo($logo); $atom->setUpdated('now'); $atom->addLink($link); $atom->setSelfLink($self); $atom->addEntryFromNotices($this->notices); $this->raw($atom->getString()); break; case 'json': $this->showJsonTimeline($this->notices); break; case 'as': header('Content-Type: application/json; charset=utf-8'); $doc = new ActivityStreamJSONDocument($this->auth_user); $doc->setTitle($title); $doc->addLink($link,'alternate', 'text/html'); $doc->addItemsFromNotices($this->notices); $this->raw($doc->asString()); break; default: // TRANS: Client error displayed when coming across a non-supported API method. $this->clientError(_('API method not found.'), $code = 404); break; } } /** * Get notices * * @return array notices */ function getNotices() { $notices = array(); $stream = new InboxNoticeStream($this->user); $notice = $stream->getNotices(($this->page-1) * $this->count, $this->count, $this->since_id, $this->max_id); while ($notice->fetch()) { $notices[] = clone($notice); } return $notices; } /** * Is this action read only? * * @param array $args other arguments * * @return boolean true */ function isReadOnly($args) { return true; } /** * When was this feed last modified? * * @return string datestamp of the latest notice in the stream */ function lastModified() { if (!empty($this->notices) && (count($this->notices) > 0)) { return strtotime($this->notices[0]->created); } return null; } /** * An entity tag for this stream * * Returns an Etag based on the action name, language, user ID, and * timestamps of the first and last notice in the timeline * * @return string etag */ function etag() { if (!empty($this->notices) && (count($this->notices) > 0)) { $last = count($this->notices) - 1; return '"' . implode( ':', array($this->arg('action'), common_user_cache_hash($this->auth_user), common_language(), $this->user->id, strtotime($this->notices[0]->created), strtotime($this->notices[$last]->created)) ) . '"'; } return null; } }