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')) {
39 * Returns whether a user is a member of a specified group.
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 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
48 * @link http://status.net/
50 class ApiGroupListAction extends ApiBareAuthAction
55 * Take arguments for running
57 * @param array $args $_REQUEST args
59 * @return boolean success flag
61 protected function prepare(array $args=array())
63 parent::prepare($args);
65 //TODO: Make sure this doesn't leak unwantedly for federated users
66 $this->target = $this->getTargetProfile(null);
68 if (!($this->target instanceof Profile)) {
69 // TRANS: Client error displayed when user not found for an action.
70 $this->clientError(_('No such user.'), 404);
73 $this->groups = $this->getGroups();
81 * Show the user's groups
85 protected function handle()
89 $sitename = common_config('site', 'name');
90 // TRANS: Used as title in check for group membership. %s is a user name.
91 $title = sprintf(_("%s's groups"), $this->target->nickname);
92 $taguribase = TagURI::base();
93 $id = "tag:$taguribase:Groups";
94 $link = common_local_url(
96 array('nickname' => $this->target->nickname)
100 // TRANS: Used as subtitle in check for group membership. %1$s is the site name, %2$s is a user name.
101 _('%1$s groups %2$s is a member of.'),
103 $this->target->nickname
106 switch($this->format) {
108 $this->showXmlGroups($this->groups);
111 $this->showRssGroups($this->groups, $title, $link, $subtitle);
114 $selfuri = common_local_url('ApiGroupList', array('id'=>$this->target->id, 'format'=>'atom'));
115 $this->showAtomGroups(
125 $this->showJsonGroups($this->groups);
128 // TRANS: Client error displayed when coming across a non-supported API method.
129 $this->clientError(_('API method not found.'), 404);
136 * @return array groups
142 $group = $this->target->getGroups(
143 ($this->page - 1) * $this->count,
149 while ($group->fetch()) {
150 $groups[] = clone($group);
157 * Is this action read only?
159 * @param array $args other arguments
161 * @return boolean true
163 function isReadOnly($args)
169 * When was this feed last modified?
171 * @return string datestamp of the latest group the user has joined
174 function lastModified()
176 if (!empty($this->groups) && (count($this->groups) > 0)) {
177 return strtotime($this->groups[0]->created);
184 * An entity tag for this list of groups
186 * Returns an Etag based on the action name, language, user ID and
187 * timestamps of the first and last group the user has joined
189 * @return string etag
193 if (!empty($this->groups) && (count($this->groups) > 0)) {
195 $last = count($this->groups) - 1;
197 return '"' . implode(
199 array($this->arg('action'),
200 common_user_cache_hash($this->auth_user),
203 strtotime($this->groups[0]->created),
204 strtotime($this->groups[$last]->created))