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 $sitename = common_config('site', 'name');
108 $avatar = $this->group->homepage_logo;
109 $title = sprintf(_("%s timeline"), $this->group->nickname);
110 $taguribase = common_config('integration', 'taguri');
111 $id = "tag:$taguribase:GroupTimeline:" . $this->group->id;
112 $link = common_local_url(
114 array('nickname' => $this->group->nickname)
117 _('Updates from %1$s on %2$s!'),
118 $this->group->nickname,
121 $logo = ($avatar) ? $avatar : User_group::defaultLogo(AVATAR_PROFILE_SIZE);
123 switch($this->format) {
125 $this->showXmlTimeline($this->notices);
128 $this->showRssTimeline($this->notices, $title, $link, $subtitle, null, $logo);
131 $selfuri = common_root_url() .
132 'api/statusnet/groups/timeline/' .
133 $this->group->nickname . '.atom';
134 $this->showAtomTimeline(
146 $this->showJsonTimeline($this->notices);
150 _('API method not found!'),
161 * @return array notices
164 function getNotices()
168 $notice = $this->group->getNotices(
169 ($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))