]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apigrouplist.php
Merge branch '1.0.x' into profile-fixups
[quix0rs-gnu-social.git] / actions / apigrouplist.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Check to see whether a user a member of a group
6  *
7  * PHP version 5
8  *
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.
13  *
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.
18  *
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/>.
21  *
22  * @category  API
23  * @package   StatusNet
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/
32  */
33
34 if (!defined('STATUSNET')) {
35     exit(1);
36 }
37
38 require_once INSTALLDIR . '/lib/apibareauth.php';
39
40 /**
41  * Returns whether a user is a member of a specified group.
42  *
43  * @category API
44  * @package  StatusNet
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/
51  */
52 class ApiGroupListAction extends ApiBareAuthAction
53 {
54     var $groups   = null;
55
56     /**
57      * Take arguments for running
58      *
59      * @param array $args $_REQUEST args
60      *
61      * @return boolean success flag
62      */
63     function prepare($args)
64     {
65         parent::prepare($args);
66
67         $this->user   = $this->getTargetUser(null);
68
69         if (empty($this->user)) {
70             $this->clientError(_('No such user.'), 404, $this->format);
71             return false;
72         }
73
74         $this->groups = $this->getGroups();
75
76         return true;
77     }
78
79     /**
80      * Handle the request
81      *
82      * Show the user's groups
83      *
84      * @param array $args $_REQUEST data (unused)
85      *
86      * @return void
87      */
88     function handle($args)
89     {
90         parent::handle($args);
91
92         $sitename   = common_config('site', 'name');
93         // TRANS: Used as title in check for group membership. %s is a user name.
94         $title      = sprintf(_("%s's groups"), $this->user->nickname);
95         $taguribase = TagURI::base();
96         $id         = "tag:$taguribase:Groups";
97         $link       = common_local_url(
98             'usergroups',
99             array('nickname' => $this->user->nickname)
100         );
101
102         $subtitle   = sprintf(
103             // TRANS: Used as subtitle in check for group membership. %1$s is the site name, %2$s is a user name.
104             _('%1$s groups %2$s is a member of.'),
105             $sitename,
106             $this->user->nickname
107         );
108
109         switch($this->format) {
110         case 'xml':
111             $this->showXmlGroups($this->groups);
112             break;
113         case 'rss':
114             $this->showRssGroups($this->groups, $title, $link, $subtitle);
115             break;
116         case 'atom':
117             $selfuri = common_root_url() . 'api/statusnet/groups/list/' .
118                 $this->user->id . '.atom';
119             $this->showAtomGroups(
120                 $this->groups,
121                 $title,
122                 $id,
123                 $link,
124                 $subtitle,
125                 $selfuri
126             );
127             break;
128         case 'json':
129             $this->showJsonGroups($this->groups);
130             break;
131         default:
132             $this->clientError(
133                 // TRANS: Client error displayed trying to execute an unknown API method checking group membership.
134                 _('API method not found.'),
135                 404,
136                 $this->format
137             );
138             break;
139         }
140     }
141
142     /**
143      * Get groups
144      *
145      * @return array groups
146      */
147     function getGroups()
148     {
149         $groups = array();
150
151         $group = $this->user->getGroups(
152             ($this->page - 1) * $this->count,
153             $this->count,
154             $this->since_id,
155             $this->max_id
156         );
157
158         while ($group->fetch()) {
159             $groups[] = clone($group);
160         }
161
162         return $groups;
163     }
164
165     /**
166      * Is this action read only?
167      *
168      * @param array $args other arguments
169      *
170      * @return boolean true
171      */
172     function isReadOnly($args)
173     {
174         return true;
175     }
176
177     /**
178      * When was this feed last modified?
179      *
180      * @return string datestamp of the latest group the user has joined
181      */
182
183     function lastModified()
184     {
185         if (!empty($this->groups) && (count($this->groups) > 0)) {
186             return strtotime($this->groups[0]->created);
187         }
188
189         return null;
190     }
191
192     /**
193      * An entity tag for this list of groups
194      *
195      * Returns an Etag based on the action name, language, user ID and
196      * timestamps of the first and last group the user has joined
197      *
198      * @return string etag
199      */
200     function etag()
201     {
202         if (!empty($this->groups) && (count($this->groups) > 0)) {
203
204             $last = count($this->groups) - 1;
205
206             return '"' . implode(
207                 ':',
208                 array($this->arg('action'),
209                       common_user_cache_hash($this->auth_user),
210                       common_language(),
211                       $this->user->id,
212                       strtotime($this->groups[0]->created),
213                       strtotime($this->groups[$last]->created))
214             )
215             . '"';
216         }
217
218         return null;
219     }
220 }