X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=actions%2Fapitimelinefriends.php;h=ed4cce490812714d2464e97019817e57f03e41c0;hb=24e05350011eb1b4aa05c7cfa2b9e901bd7f9c2f;hp=9c6ffcf9c53536c03ab6626e9b013398e50c904b;hpb=a5de2152672f49ad95f114033ef6bf00ece9a0ab;p=quix0rs-gnu-social.git diff --git a/actions/apitimelinefriends.php b/actions/apitimelinefriends.php index 9c6ffcf9c5..ed4cce4908 100644 --- a/actions/apitimelinefriends.php +++ b/actions/apitimelinefriends.php @@ -28,17 +28,111 @@ * @author Mike Cochrane * @author Robin Millette * @author Zach Copley - * @copyright 2009 StatusNet, Inc. + * @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. @@ -55,7 +149,6 @@ require_once INSTALLDIR . '/lib/apibareauth.php'; * @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; @@ -68,13 +161,13 @@ class ApiTimelineFriendsAction extends ApiBareAuthAction * @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; } @@ -93,7 +186,6 @@ class ApiTimelineFriendsAction extends ApiBareAuthAction * * @return void */ - function handle($args) { parent::handle($args); @@ -105,17 +197,19 @@ class ApiTimelineFriendsAction extends ApiBareAuthAction * * @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 @@ -149,7 +243,6 @@ class ApiTimelineFriendsAction extends ApiBareAuthAction ); break; case 'atom': - header('Content-Type: application/atom+xml; charset=utf-8'); $atom = new AtomNoticeFeed($this->auth_user); @@ -170,8 +263,16 @@ class ApiTimelineFriendsAction extends ApiBareAuthAction case 'json': $this->showJsonTimeline($this->notices); break; + case 'as': + header('Content-Type: ' . ActivityStreamJSONDocument::CONTENT_TYPE); + $doc = new ActivityStreamJSONDocument($this->auth_user, $title); + $doc->addLink($link, 'alternate', 'text/html'); + $doc->addItemsFromNotices($this->notices); + $this->raw($doc->asString()); + break; default: - $this->clientError(_('API method not found.'), $code = 404); + // TRANS: Client error displayed when coming across a non-supported API method. + $this->clientError(_('API method not found.'), 404); break; } } @@ -181,21 +282,23 @@ class ApiTimelineFriendsAction extends ApiBareAuthAction * * @return array notices */ - function getNotices() { $notices = array(); - if (!empty($this->auth_user) && $this->auth_user->id == $this->user->id) { - $notice = $this->user->ownFriendsTimeline(($this->page-1) * $this->count, - $this->count, $this->since_id, - $this->max_id); - } else { - $notice = $this->user->friendsTimeline(($this->page-1) * $this->count, - $this->count, $this->since_id, - $this->max_id); + $profile = null; + + if (isset($this->auth_user)) { + $profile = $this->auth_user->getProfile(); } + $stream = new InboxNoticeStream($this->user, $profile); + + $notice = $stream->getNotices(($this->page-1) * $this->count, + $this->count, + $this->since_id, + $this->max_id); + while ($notice->fetch()) { $notices[] = clone($notice); } @@ -210,7 +313,6 @@ class ApiTimelineFriendsAction extends ApiBareAuthAction * * @return boolean true */ - function isReadOnly($args) { return true; @@ -221,7 +323,6 @@ class ApiTimelineFriendsAction extends ApiBareAuthAction * * @return string datestamp of the latest notice in the stream */ - function lastModified() { if (!empty($this->notices) && (count($this->notices) > 0)) { @@ -239,16 +340,15 @@ class ApiTimelineFriendsAction extends ApiBareAuthAction * * @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), @@ -259,5 +359,4 @@ class ApiTimelineFriendsAction extends ApiBareAuthAction return null; } - }