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 Zach Copley <zach@status.net>
25 * @copyright 2009 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET')) {
34 require_once INSTALLDIR . '/lib/apibareauth.php';
37 * Returns whether a user is a member of a specified group.
41 * @author Zach Copley <zach@status.net>
42 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
43 * @link http://status.net/
46 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 if ($this->requiresAuth()) {
71 if ($this->checkBasicAuthUser() == false) {
76 $this->page = (int)$this->arg('page', 1);
77 $this->count = (int)$this->arg('count', 20);
78 $this->max_id = (int)$this->arg('max_id', 0);
79 $this->since_id = (int)$this->arg('since_id', 0);
80 $this->since = $this->arg('since');
82 $this->user = $this->getTargetUser($id);
83 $this->format = $this->arg('format');
84 $this->groups = $this->getGroups();
92 * Show the user's groups
94 * @param array $args $_REQUEST data (unused)
99 function handle($args)
101 parent::handle($args);
103 if (empty($this->user)) {
104 $this->clientError(_('No such user!'), 404, $this->format);
108 $sitename = common_config('site', 'name');
109 $title = sprintf(_("%s's groups"), $this->user->nickname);
110 $taguribase = common_config('integration', 'taguri');
111 $id = "tag:$taguribase:Groups";
112 $link = common_local_url(
114 array('nickname' => $this->user->nickname)
117 _("Groups %s is a member of on %s."),
118 $this->user->nickname,
122 switch($this->format) {
124 $this->show_xml_groups($this->groups);
127 $this->show_rss_groups($this->groups, $title, $link, $subtitle);
130 $selfuri = common_root_url() . 'api/statusnet/groups/list/' .
131 $this->user->id . '.atom';
132 $this->show_atom_groups(
142 $this->show_json_groups($this->groups);
146 _('API method not found!'),
158 * @return array groups
165 $group = $this->user->getGroups(
166 ($this->page - 1) * $this->count,
173 while ($group->fetch()) {
174 $groups[] = clone($group);
181 * Is this action read only?
183 * @param array $args other arguments
185 * @return boolean true
188 function isReadOnly($args)
194 * When was this feed last modified?
196 * @return string datestamp of the latest group the user has joined
199 function lastModified()
201 if (!empty($this->groups) && (count($this->groups) > 0)) {
202 return strtotime($this->groups[0]->created);
209 * An entity tag for this list of groups
211 * Returns an Etag based on the action name, language, user ID and
212 * timestamps of the first and last group the user has joined
214 * @return string etag
219 if (!empty($this->groups) && (count($this->groups) > 0)) {
221 $last = count($this->groups) - 1;
223 return '"' . implode(
225 array($this->arg('action'),
228 strtotime($this->groups[0]->created),
229 strtotime($this->groups[$last]->created))