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 Zach Copley <zach@status.net>
25 * @copyright 2009 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET')) {
34 require_once INSTALLDIR.'/lib/api.php';
37 * Returns the most recent notices (default 20) posted by everybody
41 * @author Zach Copley <zach@status.net>
42 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
43 * @link http://status.net/
46 class ApiTimelinePublicAction extends ApiAction
52 * Take arguments for running
54 * @param array $args $_REQUEST args
56 * @return boolean success flag
60 function prepare($args)
62 parent::prepare($args);
64 $this->page = (int)$this->arg('page', 1);
65 $this->count = (int)$this->arg('count', 20);
66 $this->max_id = (int)$this->arg('max_id', 0);
67 $this->since_id = (int)$this->arg('since_id', 0);
68 $this->since = $this->arg('since');
70 $this->notices = $this->getNotices();
78 * Just show the notices
80 * @param array $args $_REQUEST data (unused)
85 function handle($args)
87 parent::handle($args);
88 $this->showTimeline();
92 * Show the timeline of notices
97 function showTimeline()
99 $sitename = common_config('site', 'name');
100 $title = sprintf(_("%s public timeline"), $sitename);
101 $taguribase = common_config('integration', 'taguri');
102 $id = "tag:$taguribase:PublicTimeline";
103 $link = common_root_url();
104 $subtitle = sprintf(_("%s updates from everyone!"), $sitename);
106 switch($this->arg('format')) {
108 $this->show_xml_timeline($this->notices);
111 $this->show_rss_timeline($this->notices, $title, $link, $subtitle);
114 $selfuri = common_root_url() . 'api/statuses/public_timeline.atom';
115 $this->show_atom_timeline(
116 $this->notices, $title, $id, $link,
117 $subtitle, null, $selfuri
121 $this->show_json_timeline($this->notices);
124 $this->clientError(_('API method not found!'), $code = 404);
132 * @return array notices
135 function getNotices()
139 $notice = Notice::publicStream(
140 ($this->page - 1) * $this->count, $this->count, $this->since_id,
141 $this->max_id, $this->since
144 while ($notice->fetch()) {
145 $notices[] = clone($notice);
152 * Is this action read only?
154 * @param array $args other arguments
156 * @return boolean true
159 function isReadOnly($args)
165 * When was this feed last modified?
167 * @return string datestamp of the latest notice in the stream
170 function lastModified()
172 if (!empty($this->notices) && (count($this->notices) > 0)) {
173 return strtotime($this->notices[0]->created);
180 * An entity tag for this stream
182 * Returns an Etag based on the action name, language, and
183 * timestamps of the first and last notice in the timeline
185 * @return string etag
190 if (!empty($this->notices) && (count($this->notices) > 0)) {
192 $last = count($this->notices) - 1;
194 return '"' . implode(
196 array($this->arg('action'),
198 strtotime($this->notices[0]->created),
199 strtotime($this->notices[$last]->created))