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-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 most recent notices (default 20) posted to the group specified by ID
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/
53 class ApiTimelineGroupAction extends ApiPrivateAuthAction
60 * Take arguments for running
62 * @param array $args $_REQUEST args
64 * @return boolean success flag
68 function prepare($args)
70 parent::prepare($args);
72 $this->group = $this->getTargetGroup($this->arg('id'));
80 * Just show the notices
82 * @param array $args $_REQUEST data (unused)
87 function handle($args)
89 parent::handle($args);
91 if (empty($this->group)) {
92 $this->clientError(_('Group not found.'), 404, $this->format);
96 $this->notices = $this->getNotices();
97 $this->showTimeline();
101 * Show the timeline of notices
106 function showTimeline()
108 // We'll pull common formatting out of this for other formats
109 $atom = new AtomGroupNoticeFeed($this->group, $this->auth_user);
111 $self = $this->getSelfUri();
113 switch($this->format) {
115 $this->showXmlTimeline($this->notices);
118 $this->showRssTimeline(
121 $this->group->homeUrl(),
130 header('Content-Type: application/atom+xml; charset=utf-8');
133 $atom->addAuthorRaw($this->group->asAtomAuthor());
134 $atom->setActivitySubject($this->group->asActivitySubject());
136 $atom->setSelfLink($self);
137 $atom->addEntryFromNotices($this->notices);
138 $this->raw($atom->getString());
139 } catch (Atom10FeedException $e) {
141 'Could not generate feed for group - ' . $e->getMessage(),
150 $this->showJsonTimeline($this->notices);
154 _('API method not found.'),
165 * @return array notices
168 function getNotices()
172 $notice = $this->group->getNotices(
173 ($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
194 function isReadOnly($args)
200 * When was this feed last modified?
202 * @return string datestamp of the latest notice in the stream
205 function lastModified()
207 if (!empty($this->notices) && (count($this->notices) > 0)) {
208 return strtotime($this->notices[0]->created);
215 * An entity tag for this stream
217 * Returns an Etag based on the action name, language, group ID and
218 * timestamps of the first and last notice in the timeline
220 * @return string etag
225 if (!empty($this->notices) && (count($this->notices) > 0)) {
227 $last = count($this->notices) - 1;
229 return '"' . implode(
231 array($this->arg('action'),
232 common_user_cache_hash($this->auth_user),
235 strtotime($this->notices[0]->created),
236 strtotime($this->notices[$last]->created))