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-2010 StatusNet, Inc.
29 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
30 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
31 * @link http://status.net/
34 if (!defined('STATUSNET')) {
38 require_once INSTALLDIR . '/lib/apiprivateauth.php';
41 * Returns the 20 most recent notices tagged by a given tag
45 * @author Craig Andrews <candrews@integralblue.com>
46 * @author Evan Prodromou <evan@status.net>
47 * @author Jeffery To <jeffery.to@gmail.com>
48 * @author Zach Copley <zach@status.net>
49 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
50 * @link http://status.net/
52 class ApiTimelineTagAction extends ApiPrivateAuthAction
57 * Take arguments for running
59 * @param array $args $_REQUEST args
61 * @return boolean success flag
63 function prepare($args)
65 parent::prepare($args);
67 common_debug("apitimelinetag prepare()");
69 $this->tag = $this->arg('tag');
70 $this->notices = $this->getNotices();
78 * Just show the notices
80 * @param array $args $_REQUEST data (unused)
84 function handle($args)
86 parent::handle($args);
87 $this->showTimeline();
91 * Show the timeline of notices
95 function showTimeline()
97 $sitename = common_config('site', 'name');
98 $sitelogo = (common_config('site', 'logo')) ? common_config('site', 'logo') : Theme::path('logo.png');
99 // TRANS: Title for timeline with lastest notices with a given tag.
100 // TRANS: %s is the tag.
101 $title = sprintf(_("Notices tagged with %s"), $this->tag);
103 // TRANS: Subtitle for timeline with lastest notices with a given tag.
104 // TRANS: %1$s is the tag, $2$s is the StatusNet sitename.
105 _('Updates tagged with %1$s on %2$s!'),
109 $taguribase = TagURI::base();
110 $id = "tag:$taguribase:TagTimeline:".$tag;
112 $link = common_local_url(
114 array('tag' => $this->tag)
117 $self = $this->getSelfUri();
119 common_debug("self link is: $self");
121 switch($this->format) {
123 $this->showXmlTimeline($this->notices);
126 $this->showRssTimeline(
137 header('Content-Type: application/atom+xml; charset=utf-8');
139 $atom = new AtomNoticeFeed($this->auth_user);
142 $atom->setTitle($title);
143 $atom->setSubtitle($subtitle);
144 $atom->setLogo($logo);
145 $atom->setUpdated('now');
147 $atom->addLink($link);
148 $atom->setSelfLink($self);
150 $atom->addEntryFromNotices($this->notices);
151 $this->raw($atom->getString());
155 $this->showJsonTimeline($this->notices);
158 // TRANS: Client error displayed when trying to handle an unknown API method.
159 $this->clientError(_('API method not found.'), $code = 404);
167 * @return array notices
169 function getNotices()
173 $notice = Notice_tag::getStream(
175 ($this->page - 1) * $this->count,
179 while ($notice->fetch()) {
180 $notices[] = clone($notice);
187 * Is this action read only?
189 * @param array $args other arguments
191 * @return boolean true
193 function isReadOnly($args)
199 * When was this feed last modified?
201 * @return string datestamp of the latest notice in the stream
203 function lastModified()
205 if (!empty($this->notices) && (count($this->notices) > 0)) {
206 return strtotime($this->notices[0]->created);
213 * An entity tag for this stream
215 * Returns an Etag based on the action name, language, and
216 * timestamps of the first and last notice in the timeline
218 * @return string etag
222 if (!empty($this->notices) && (count($this->notices) > 0)) {
224 $last = count($this->notices) - 1;
226 return '"' . implode(
228 array($this->arg('action'),
229 common_user_cache_hash($this->auth_user),
232 strtotime($this->notices[0]->created),
233 strtotime($this->notices[$last]->created))