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 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
33 * @link http://status.net/
36 if (!defined('STATUSNET')) {
40 require_once INSTALLDIR . '/lib/apiprivateauth.php';
43 * Returns the most recent notices (default 20) posted by everybody
47 * @author Craig Andrews <candrews@integralblue.com>
48 * @author Evan Prodromou <evan@status.net>
49 * @author Jeffery To <jeffery.to@gmail.com>
50 * @author mac65 <mac65@mac65.com>
51 * @author Mike Cochrane <mikec@mikenz.geek.nz>
52 * @author Robin Millette <robin@millette.info>
53 * @author Zach Copley <zach@status.net>
54 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
55 * @link http://status.net/
58 class ApiTimelinePublicAction extends ApiPrivateAuthAction
64 * Take arguments for running
66 * @param array $args $_REQUEST args
68 * @return boolean success flag
72 function prepare($args)
74 parent::prepare($args);
76 $this->notices = $this->getNotices();
84 * Just show the notices
86 * @param array $args $_REQUEST data (unused)
91 function handle($args)
93 parent::handle($args);
94 $this->showTimeline();
98 * Show the timeline of notices
103 function showTimeline()
105 $sitename = common_config('site', 'name');
106 $sitelogo = (common_config('site', 'logo')) ? common_config('site', 'logo') : Theme::path('logo.png');
107 $title = sprintf(_("%s public timeline"), $sitename);
108 $taguribase = common_config('integration', 'taguri');
109 $id = "tag:$taguribase:PublicTimeline";
110 $link = common_root_url();
111 $subtitle = sprintf(_("%s updates from everyone!"), $sitename);
113 switch($this->format) {
115 $this->showXmlTimeline($this->notices);
118 $this->showRssTimeline($this->notices, $title, $link, $subtitle, null, $sitelogo);
121 $selfuri = common_root_url() . 'api/statuses/public_timeline.atom';
122 $this->showAtomTimeline(
123 $this->notices, $title, $id, $link,
124 $subtitle, null, $selfuri, $sitelogo
128 $this->showJsonTimeline($this->notices);
131 $this->clientError(_('API method not found!'), $code = 404);
139 * @return array notices
142 function getNotices()
146 $notice = Notice::publicStream(
147 ($this->page - 1) * $this->count, $this->count, $this->since_id,
148 $this->max_id, $this->since
151 while ($notice->fetch()) {
152 $notices[] = clone($notice);
159 * Is this action read only?
161 * @param array $args other arguments
163 * @return boolean true
166 function isReadOnly($args)
172 * When was this feed last modified?
174 * @return string datestamp of the latest notice in the stream
177 function lastModified()
179 if (!empty($this->notices) && (count($this->notices) > 0)) {
180 return strtotime($this->notices[0]->created);
187 * An entity tag for this stream
189 * Returns an Etag based on the action name, language, and
190 * timestamps of the first and last notice in the timeline
192 * @return string etag
197 if (!empty($this->notices) && (count($this->notices) > 0)) {
199 $last = count($this->notices) - 1;
201 return '"' . implode(
203 array($this->arg('action'),
205 strtotime($this->notices[0]->created),
206 strtotime($this->notices[$last]->created))