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/apiprivateauth.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 ApiPrivateAuthAction
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 $sitelogo = (common_config('site', 'logo')) ? common_config('site', 'logo') : Theme::path('logo.png');
102 $title = sprintf(_("Notices tagged with %s"), $this->tag);
103 $link = common_local_url(
105 array('tag' => $this->tag)
108 _('Updates tagged with %1$s on %2$s!'),
112 $taguribase = common_config('integration', 'taguri');
113 $id = "tag:$taguribase:TagTimeline:".$tag;
115 switch($this->format) {
117 $this->showXmlTimeline($this->notices);
120 $this->showRssTimeline($this->notices, $title, $link, $subtitle, null, $sitelogo);
123 $selfuri = common_root_url() .
124 'api/statusnet/tags/timeline/' .
125 $this->tag . '.atom';
126 $this->showAtomTimeline(
138 $this->showJsonTimeline($this->notices);
141 $this->clientError(_('API method not found!'), $code = 404);
149 * @return array notices
152 function getNotices()
156 $notice = Notice_tag::getStream(
158 ($this->page - 1) * $this->count,
162 while ($notice->fetch()) {
163 $notices[] = clone($notice);
170 * Is this action read only?
172 * @param array $args other arguments
174 * @return boolean true
177 function isReadOnly($args)
183 * When was this feed last modified?
185 * @return string datestamp of the latest notice in the stream
188 function lastModified()
190 if (!empty($this->notices) && (count($this->notices) > 0)) {
191 return strtotime($this->notices[0]->created);
198 * An entity tag for this stream
200 * Returns an Etag based on the action name, language, and
201 * timestamps of the first and last notice in the timeline
203 * @return string etag
208 if (!empty($this->notices) && (count($this->notices) > 0)) {
210 $last = count($this->notices) - 1;
212 return '"' . implode(
214 array($this->arg('action'),
217 strtotime($this->notices[0]->created),
218 strtotime($this->notices[$last]->created))