3 * StatusNet, the distributed open-source microblogging tool
5 * Show information about a group
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 * @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 * Outputs detailed information about the group specified by ID
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 * @author Michele <macno@macno.org>
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/
51 class ApiGroupShowAction extends ApiPrivateAuthAction
56 * Take arguments for running
58 * @param array $args $_REQUEST args
60 * @return boolean success flag
62 function prepare($args)
64 parent::prepare($args);
66 $this->group = $this->getTargetGroup($this->arg('id'));
68 if (empty($this->group)) {
69 $alias = Group_alias::getKV(
71 common_canonical_nickname($this->arg('id'))
74 $args = array('id' => $alias->group_id, 'format' => $this->format);
75 common_redirect(common_local_url('ApiGroupShow', $args), 301);
78 // TRANS: Client error displayed when trying to show a group that could not be found.
79 _('Group not found.'),
93 * Check the format and show the user info
95 * @param array $args $_REQUEST data (unused)
99 function handle($args)
101 parent::handle($args);
103 switch($this->format) {
105 $this->showSingleXmlGroup($this->group);
108 $this->showSingleJsonGroup($this->group);
111 // TRANS: Client error displayed when coming across a non-supported API method.
112 $this->clientError(_('API method not found.'), 404, $this->format);
118 * When was this group last modified?
120 * @return string datestamp of the latest notice in the stream
122 function lastModified()
124 if (!empty($this->group)) {
125 return strtotime($this->group->modified);
132 * An entity tag for this group
134 * Returns an Etag based on the action name, language, and
135 * timestamps of the notice
137 * @return string etag
141 if (!empty($this->group)) {
143 return '"' . implode(
145 array($this->arg('action'),
146 common_user_cache_hash($this->auth_user),
149 strtotime($this->group->modified))
158 * Return true if read only.
162 * @param array $args other arguments
164 * @return boolean is read only action?
166 function isReadOnly($args)