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