3 * StatusNet, the distributed open-source microblogging tool
5 * Show a group's notices
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 most recent notices (default 20) posted to the group specified by ID
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 ApiTimelineGroupAction extends ApiPrivateAuthAction
59 * Take arguments for running
61 * @param array $args $_REQUEST args
63 * @return boolean success flag
67 function prepare($args)
69 parent::prepare($args);
71 $this->group = $this->getTargetGroup($this->arg('id'));
79 * Just show the notices
81 * @param array $args $_REQUEST data (unused)
86 function handle($args)
88 parent::handle($args);
90 if (empty($this->group)) {
91 $this->clientError(_('Group not found!'), 404, $this->format);
95 $this->notices = $this->getNotices();
96 $this->showTimeline();
100 * Show the timeline of notices
105 function showTimeline()
107 // We'll pull common formatting out of this for other formats
108 $atom = new AtomGroupNoticeFeed($this->group);
110 $self = $this->getSelfUri();
112 switch($this->format) {
114 $this->showXmlTimeline($this->notices);
117 $this->showRssTimeline(
120 $this->group->homeUrl(),
129 header('Content-Type: application/atom+xml; charset=utf-8');
132 $atom->addAuthorRaw($this->group->asAtomAuthor());
133 $atom->setActivitySubject($this->group->asActivitySubject());
135 $atom->setSelfLink($self);
136 $atom->addEntryFromNotices($this->notices);
137 $this->raw($atom->getString());
138 } catch (Atom10FeedException $e) {
140 'Could not generate feed for group - ' . $e->getMessage()
147 $this->showJsonTimeline($this->notices);
151 _('API method not found.'),
162 * @return array notices
165 function getNotices()
169 $notice = $this->group->getNotices(
170 ($this->page-1) * $this->count,
176 while ($notice->fetch()) {
177 $notices[] = clone($notice);
184 * Is this action read only?
186 * @param array $args other arguments
188 * @return boolean true
191 function isReadOnly($args)
197 * When was this feed last modified?
199 * @return string datestamp of the latest notice in the stream
202 function lastModified()
204 if (!empty($this->notices) && (count($this->notices) > 0)) {
205 return strtotime($this->notices[0]->created);
212 * An entity tag for this stream
214 * Returns an Etag based on the action name, language, group ID and
215 * timestamps of the first and last notice in the timeline
217 * @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'),
231 strtotime($this->notices[0]->created),
232 strtotime($this->notices[$last]->created))