3 * StatusNet, the distributed open-source microblogging tool
5 * Show the latest notices for a given tag
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 Zach Copley <zach@status.net>
28 * @copyright 2009 StatusNet, Inc.
29 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
30 * @link http://status.net/
33 if (!defined('STATUSNET')) {
37 require_once INSTALLDIR . '/lib/api.php';
40 * Returns the 20 most recent notices tagged by a given tag
44 * @author Craig Andrews <candrews@integralblue.com>
45 * @author Evan Prodromou <evan@status.net>
46 * @author Jeffery To <jeffery.to@gmail.com>
47 * @author Zach Copley <zach@status.net>
48 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
49 * @link http://status.net/
52 class ApiTimelineTagAction extends ApiAction
58 * Take arguments for running
60 * @param array $args $_REQUEST args
62 * @return boolean success flag
66 function prepare($args)
68 parent::prepare($args);
70 $this->tag = $this->arg('tag');
71 $this->notices = $this->getNotices();
79 * Just show the notices
81 * @param array $args $_REQUEST data (unused)
86 function handle($args)
88 parent::handle($args);
89 $this->showTimeline();
93 * Show the timeline of notices
98 function showTimeline()
100 $sitename = common_config('site', 'name');
101 $title = sprintf(_("Notices tagged with %s"), $this->tag);
102 $link = common_local_url(
104 array('tag' => $this->tag)
107 _('Updates tagged with %1$s on %2$s!'),
111 $taguribase = common_config('integration', 'taguri');
112 $id = "tag:$taguribase:TagTimeline:".$tag;
114 switch($this->format) {
116 $this->showXmlTimeline($this->notices);
119 $this->showRssTimeline($this->notices, $title, $link, $subtitle);
122 $selfuri = common_root_url() .
123 'api/statusnet/tags/timeline/' .
124 $this->tag . '.atom';
125 $this->showAtomTimeline(
136 $this->showJsonTimeline($this->notices);
139 $this->clientError(_('API method not found!'), $code = 404);
147 * @return array notices
150 function getNotices()
154 $notice = Notice_tag::getStream(
156 ($this->page - 1) * $this->count,
160 while ($notice->fetch()) {
161 $notices[] = clone($notice);
168 * Is this action read only?
170 * @param array $args other arguments
172 * @return boolean true
175 function isReadOnly($args)
181 * When was this feed last modified?
183 * @return string datestamp of the latest notice in the stream
186 function lastModified()
188 if (!empty($this->notices) && (count($this->notices) > 0)) {
189 return strtotime($this->notices[0]->created);
196 * An entity tag for this stream
198 * Returns an Etag based on the action name, language, and
199 * timestamps of the first and last notice in the timeline
201 * @return string etag
206 if (!empty($this->notices) && (count($this->notices) > 0)) {
208 $last = count($this->notices) - 1;
210 return '"' . implode(
212 array($this->arg('action'),
215 strtotime($this->notices[0]->created),
216 strtotime($this->notices[$last]->created))