3 * StatusNet, the distributed open-source microblogging tool
5 * Show the public 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/apiprivateauth.php';
44 * Returns the most recent notices (default 20) posted by everybody
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/
59 /* External API usage documentation. Please update when you change how this method works. */
61 /*! @page publictimeline statuses/public_timeline
64 Returns the 20 most recent notices from users throughout the system who have
65 uploaded their own avatars. Depending on configuration, it may or may not
66 not include notices from automatic posting services.
69 @li /api/statuses/public_timeline.:format
71 @par Formats (:format)
77 @par Requires Authentication
80 @param since_id (Optional) Returns only statuses with an ID greater
81 than (that is, more recent than) the specified ID.
82 @param max_id (Optional) Returns only statuses with an ID less than
83 (that is, older than) or equal to the specified ID.
84 @param count (Optional) Specifies the number of statuses to retrieve.
85 @param page (Optional) Specifies the page of results to retrieve.
89 @subsection usagenotes Usage notes
90 @li The URL pattern is relative to the @ref apiroot.
91 @li The XML response uses <a href="http://georss.org/Main_Page">GeoRSS</a>
92 to encode the latitude and longitude (see example response below <georss:point>).
94 @subsection exampleusage Example usage
97 curl http://identi.ca/api/statuses/friends_timeline/evan.xml?count=1&page=2
100 @subsection exampleresponse Example response
103 <?xml version="1.0" encoding="UTF-8"?>
104 <statuses type="array">
106 <text>@skwashd oh, commbank reenabled me super quick both times. but disconcerting when you don't expect it though</text>
107 <truncated>false</truncated>
108 <created_at>Sat Apr 17 00:49:12 +0000 2010</created_at>
109 <in_reply_to_status_id>28838393</in_reply_to_status_id>
110 <source>xmpp</source>
112 <in_reply_to_user_id>39303</in_reply_to_user_id>
113 <in_reply_to_screen_name>skwashd</in_reply_to_screen_name>
115 <favorited>false</favorited>
118 <name>joshua may</name>
119 <screen_name>notjosh</screen_name>
120 <location></location>
121 <description></description>
122 <profile_image_url>http://avatar.identi.ca/44517-48-20090321004106.jpeg</profile_image_url>
124 <protected>false</protected>
125 <followers_count>17</followers_count>
126 <profile_background_color></profile_background_color>
127 <profile_text_color></profile_text_color>
128 <profile_link_color></profile_link_color>
129 <profile_sidebar_fill_color></profile_sidebar_fill_color>
130 <profile_sidebar_border_color></profile_sidebar_border_color>
131 <friends_count>20</friends_count>
132 <created_at>Sat Mar 21 00:40:25 +0000 2009</created_at>
133 <favourites_count>0</favourites_count>
134 <utc_offset>0</utc_offset>
135 <time_zone>UTC</time_zone>
136 <profile_background_image_url></profile_background_image_url>
137 <profile_background_tile>false</profile_background_tile>
138 <statuses_count>100</statuses_count>
139 <following>false</following>
140 <notifications>false</notifications>
148 class ApiTimelinePublicAction extends ApiPrivateAuthAction
154 * Take arguments for running
156 * @param array $args $_REQUEST args
158 * @return boolean success flag
162 function prepare($args)
164 parent::prepare($args);
166 $this->notices = $this->getNotices();
174 * Just show the notices
176 * @param array $args $_REQUEST data (unused)
181 function handle($args)
183 parent::handle($args);
184 $this->showTimeline();
188 * Show the timeline of notices
193 function showTimeline()
195 $sitename = common_config('site', 'name');
196 $sitelogo = (common_config('site', 'logo')) ? common_config('site', 'logo') : Theme::path('logo.png');
197 $title = sprintf(_("%s public timeline"), $sitename);
198 $taguribase = TagURI::base();
199 $id = "tag:$taguribase:PublicTimeline";
200 $link = common_local_url('public');
201 $self = $this->getSelfUri();
202 $subtitle = sprintf(_("%s updates from everyone!"), $sitename);
204 switch($this->format) {
206 $this->showXmlTimeline($this->notices);
209 $this->showRssTimeline(
221 header('Content-Type: application/atom+xml; charset=utf-8');
223 $atom = new AtomNoticeFeed($this->auth_user);
226 $atom->setTitle($title);
227 $atom->setSubtitle($subtitle);
228 $atom->setLogo($sitelogo);
229 $atom->setUpdated('now');
230 $atom->addLink(common_local_url('public'));
231 $atom->setSelfLink($self);
232 $atom->addEntryFromNotices($this->notices);
234 $this->raw($atom->getString());
238 $this->showJsonTimeline($this->notices);
241 $this->clientError(_('API method not found.'), $code = 404);
249 * @return array notices
252 function getNotices()
256 $notice = Notice::publicStream(
257 ($this->page - 1) * $this->count, $this->count, $this->since_id,
261 while ($notice->fetch()) {
262 $notices[] = clone($notice);
269 * Is this action read only?
271 * @param array $args other arguments
273 * @return boolean true
276 function isReadOnly($args)
282 * When was this feed last modified?
284 * @return string datestamp of the latest notice in the stream
287 function lastModified()
289 if (!empty($this->notices) && (count($this->notices) > 0)) {
290 return strtotime($this->notices[0]->created);
297 * An entity tag for this stream
299 * Returns an Etag based on the action name, language, and
300 * timestamps of the first and last notice in the timeline
302 * @return string etag
307 if (!empty($this->notices) && (count($this->notices) > 0)) {
309 $last = count($this->notices) - 1;
311 return '"' . implode(
313 array($this->arg('action'),
315 strtotime($this->notices[0]->created),
316 strtotime($this->notices[$last]->created))