3 * StatusNet, the distributed open-source microblogging tool
5 * Check to see whether a user a member of 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')) {
38 require_once INSTALLDIR . '/lib/apibareauth.php';
41 * Returns whether a user is a member of a specified group.
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 ApiGroupListAction extends ApiBareAuthAction
58 * Take arguments for running
60 * @param array $args $_REQUEST args
62 * @return boolean success flag
66 function prepare($args)
68 parent::prepare($args);
70 $this->user = $this->getTargetUser(null);
72 if (empty($this->user)) {
73 $this->clientError(_('No such user.'), 404, $this->format);
77 $this->groups = $this->getGroups();
85 * Show the user's groups
87 * @param array $args $_REQUEST data (unused)
92 function handle($args)
94 parent::handle($args);
96 $sitename = common_config('site', 'name');
97 // TRANS: %s is a user name
98 $title = sprintf(_("%s's groups"), $this->user->nickname);
99 $taguribase = TagURI::base();
100 $id = "tag:$taguribase:Groups";
101 $link = common_local_url(
103 array('nickname' => $this->user->nickname)
107 // TRANS: Meant to convey the user %2$s is a member of each of the groups listed on site %1$s
108 _("%1\$s groups %2\$s is a member of."),
110 $this->user->nickname
113 switch($this->format) {
115 $this->showXmlGroups($this->groups);
118 $this->showRssGroups($this->groups, $title, $link, $subtitle);
121 $selfuri = common_root_url() . 'api/statusnet/groups/list/' .
122 $this->user->id . '.atom';
123 $this->showAtomGroups(
133 $this->showJsonGroups($this->groups);
137 _('API method not found.'),
149 * @return array groups
156 $group = $this->user->getGroups(
157 ($this->page - 1) * $this->count,
163 while ($group->fetch()) {
164 $groups[] = clone($group);
171 * Is this action read only?
173 * @param array $args other arguments
175 * @return boolean true
178 function isReadOnly($args)
184 * When was this feed last modified?
186 * @return string datestamp of the latest group the user has joined
189 function lastModified()
191 if (!empty($this->groups) && (count($this->groups) > 0)) {
192 return strtotime($this->groups[0]->created);
199 * An entity tag for this list of groups
201 * Returns an Etag based on the action name, language, user ID and
202 * timestamps of the first and last group the user has joined
204 * @return string etag
209 if (!empty($this->groups) && (count($this->groups) > 0)) {
211 $last = count($this->groups) - 1;
213 return '"' . implode(
215 array($this->arg('action'),
216 common_user_cache_hash($this->auth_user),
219 strtotime($this->groups[0]->created),
220 strtotime($this->groups[$last]->created))