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')) {
39 * Returns the 20 most recent notices tagged by a given tag
43 * @author Craig Andrews <candrews@integralblue.com>
44 * @author Evan Prodromou <evan@status.net>
45 * @author Jeffery To <jeffery.to@gmail.com>
46 * @author Zach Copley <zach@status.net>
47 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
48 * @link http://status.net/
50 class ApiTimelineTagAction extends ApiPrivateAuthAction
54 protected function doPreparation()
56 $this->tag = $this->arg('tag');
57 $this->notices = $this->getNotices();
63 * Just show the notices
65 * @param array $args $_REQUEST data (unused)
69 protected function handle()
72 $this->showTimeline();
76 * Show the timeline of notices
80 function showTimeline()
82 $sitename = common_config('site', 'name');
83 $sitelogo = (common_config('site', 'logo')) ? common_config('site', 'logo') : Theme::path('logo.png');
84 // TRANS: Title for timeline with lastest notices with a given tag.
85 // TRANS: %s is the tag.
86 $title = sprintf(_("Notices tagged with %s"), $this->tag);
88 // TRANS: Subtitle for timeline with lastest notices with a given tag.
89 // TRANS: %1$s is the tag, $2$s is the StatusNet sitename.
90 _('Updates tagged with %1$s on %2$s!'),
94 $taguribase = TagURI::base();
95 $id = "tag:$taguribase:TagTimeline:".$this->tag;
97 $link = common_local_url(
99 array('tag' => $this->tag)
102 $self = $this->getSelfUri();
104 switch($this->format) {
106 $this->showXmlTimeline($this->notices);
109 $this->showRssTimeline(
120 header('Content-Type: application/atom+xml; charset=utf-8');
122 $atom = new AtomNoticeFeed($this->auth_user);
125 $atom->setTitle($title);
126 $atom->setSubtitle($subtitle);
127 $atom->setLogo($sitelogo);
128 $atom->setUpdated('now');
130 $atom->addLink($link);
131 $atom->setSelfLink($self);
133 $atom->addEntryFromNotices($this->notices);
134 $this->raw($atom->getString());
138 $this->showJsonTimeline($this->notices);
141 header('Content-Type: ' . ActivityStreamJSONDocument::CONTENT_TYPE);
142 $doc = new ActivityStreamJSONDocument($this->auth_user);
143 $doc->setTitle($title);
144 $doc->addLink($link, 'alternate', 'text/html');
145 $doc->addItemsFromNotices($this->notices);
146 $this->raw($doc->asString());
149 // TRANS: Client error displayed when coming across a non-supported API method.
150 $this->clientError(_('API method not found.'), $code = 404);
158 * @return array notices
160 function getNotices()
162 $notice = Notice_tag::getStream($this->tag)->getNotices(($this->page - 1) * $this->count,
167 return $notice->fetchAll();
171 * Is this action read only?
173 * @param array $args other arguments
175 * @return boolean true
177 function isReadOnly(array $args=array())
183 * When was this feed last modified?
185 * @return string datestamp of the latest notice in the stream
187 function lastModified()
189 if (!empty($this->notices) && (count($this->notices) > 0)) {
190 return strtotime($this->notices[0]->created);
197 * An entity tag for this stream
199 * Returns an Etag based on the action name, language, and
200 * timestamps of the first and last notice in the timeline
202 * @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'),
213 common_user_cache_hash($this->auth_user),
216 strtotime($this->notices[0]->created),
217 strtotime($this->notices[$last]->created))