X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=actions%2Fapitimelinepublic.php;h=07dcace942457b254660005ca48b18135c5e837d;hb=196df7d8a4141b64417b2002d04e4a7882c917eb;hp=49062e603e3d81142c799d0c4ea6aea71bac3d5a;hpb=c5b61078e1548fba2820620e2e8f5fcbbda611a8;p=quix0rs-gnu-social.git diff --git a/actions/apitimelinepublic.php b/actions/apitimelinepublic.php index 49062e603e..07dcace942 100644 --- a/actions/apitimelinepublic.php +++ b/actions/apitimelinepublic.php @@ -29,6 +29,7 @@ * @author Robin Millette * @author Zach Copley * @copyright 2009 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/ */ @@ -37,8 +38,6 @@ if (!defined('STATUSNET')) { exit(1); } -require_once INSTALLDIR . '/lib/apiprivateauth.php'; - /** * Returns the most recent notices (default 20) posted by everybody * @@ -55,9 +54,96 @@ require_once INSTALLDIR . '/lib/apiprivateauth.php'; * @link http://status.net/ */ +/* External API usage documentation. Please update when you change how this method works. */ + +/*! @page publictimeline statuses/public_timeline + + @section Description + Returns the 20 most recent notices from users throughout the system who have + uploaded their own avatars. Depending on configuration, it may or may not + not include notices from automatic posting services. + + @par URL patterns + @li /api/statuses/public_timeline.:format + + @par Formats (:format) + xml, json, rss, atom + + @par HTTP Method(s) + GET + + @par Requires Authentication + No + + @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 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 + + + + @skwashd oh, commbank reenabled me super quick both times. but disconcerting when you don't expect it though + false + Sat Apr 17 00:49:12 +0000 2010 + 28838393 + xmpp + 28838456 + 39303 + skwashd + + false + + 44517 + joshua may + notjosh + + + http://avatar.identi.ca/44517-48-20090321004106.jpeg + + false + 17 + + + + + + 20 + Sat Mar 21 00:40:25 +0000 2009 + 0 + 0 + UTC + + false + 100 + false + false + + + [....] + +@endverbatim +*/ class ApiTimelinePublicAction extends ApiPrivateAuthAction { - var $notices = null; /** @@ -68,8 +154,7 @@ class ApiTimelinePublicAction extends ApiPrivateAuthAction * @return boolean success flag * */ - - function prepare($args) + protected function prepare(array $args=array()) { parent::prepare($args); @@ -83,33 +168,37 @@ class ApiTimelinePublicAction extends ApiPrivateAuthAction * * Just show the notices * - * @param array $args $_REQUEST data (unused) - * * @return void */ - - function handle($args) + protected function handle() { - parent::handle($args); + parent::handle(); $this->showTimeline(); } + function title() + { + // TRANS: Title for site timeline. %s is the GNU social sitename. + return sprintf(_("%s public timeline"), common_config('site', 'name')); + } + /** * Show the timeline of notices * * @return void */ - function showTimeline() { - $sitename = common_config('site', 'name'); + $nonapi_action = substr($this->action, strlen('apitimeline')); // Just so we don't need to set this explicitly + $sitelogo = (common_config('site', 'logo')) ? common_config('site', 'logo') : Theme::path('logo.png'); - $title = sprintf(_("%s public timeline"), $sitename); + $title = $this->title(); $taguribase = TagURI::base(); - $id = "tag:$taguribase:PublicTimeline"; - $link = common_local_url('public'); + $id = "tag:$taguribase:" . ucfirst($nonapi_action) . 'Timeline'; // Public or Networkpublic probably + $link = common_local_url($nonapi_action); $self = $this->getSelfUri(); - $subtitle = sprintf(_("%s updates from everyone!"), $sitename); + // TRANS: Subtitle for site timeline. %s is the GNU social sitename. + $subtitle = sprintf(_("%s updates from everyone!"), common_config('site', 'name')); switch($this->format) { case 'xml': @@ -137,7 +226,7 @@ class ApiTimelinePublicAction extends ApiPrivateAuthAction $atom->setSubtitle($subtitle); $atom->setLogo($sitelogo); $atom->setUpdated('now'); - $atom->addLink(common_local_url('public')); + $atom->addLink(common_local_url($nonapi_action)); $atom->setSelfLink($self); $atom->addEntryFromNotices($this->notices); @@ -147,7 +236,16 @@ class ApiTimelinePublicAction extends ApiPrivateAuthAction case 'json': $this->showJsonTimeline($this->notices); break; + case 'as': + header('Content-Type: ' . ActivityStreamJSONDocument::CONTENT_TYPE); + $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; } @@ -158,23 +256,29 @@ class ApiTimelinePublicAction extends ApiPrivateAuthAction * * @return array notices */ - function getNotices() { $notices = array(); - $notice = Notice::publicStream( - ($this->page - 1) * $this->count, $this->count, $this->since_id, - $this->max_id - ); + $stream = $this->getStream(); - while ($notice->fetch()) { - $notices[] = clone($notice); - } + $notice = $stream->getNotices(($this->page - 1) * $this->count, + $this->count, + $this->since_id, + $this->max_id); + + $notices = $notice->fetchAll(); + + NoticeList::prefill($notices); return $notices; } + protected function getStream() + { + return new PublicNoticeStream($this->scoped); + } + /** * Is this action read only? * @@ -182,7 +286,6 @@ class ApiTimelinePublicAction extends ApiPrivateAuthAction * * @return boolean true */ - function isReadOnly($args) { return true; @@ -193,7 +296,6 @@ class ApiTimelinePublicAction extends ApiPrivateAuthAction * * @return string datestamp of the latest notice in the stream */ - function lastModified() { if (!empty($this->notices) && (count($this->notices) > 0)) { @@ -211,7 +313,6 @@ class ApiTimelinePublicAction extends ApiPrivateAuthAction * * @return string etag */ - function etag() { if (!empty($this->notices) && (count($this->notices) > 0)) { @@ -221,6 +322,7 @@ class ApiTimelinePublicAction extends ApiPrivateAuthAction return '"' . implode( ':', array($this->arg('action'), + common_user_cache_hash($this->auth_user), common_language(), strtotime($this->notices[0]->created), strtotime($this->notices[$last]->created)) @@ -230,5 +332,4 @@ class ApiTimelinePublicAction extends ApiPrivateAuthAction return null; } - }