]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apigroupleave.php
Use array_merge instead of array_replace (same effect, and array_merge works with...
[quix0rs-gnu-social.git] / actions / apigroupleave.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Leave a group via the API
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/apiauth.php';
39
40 /**
41  * Removes the authenticated user from the group specified by ID
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 ApiGroupLeaveAction extends ApiAuthAction
53 {
54     var $group   = 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->auth_user;
68         $this->group = $this->getTargetGroup($this->arg('id'));
69
70         return true;
71     }
72
73     /**
74      * Handle the request
75      *
76      * Save the new message
77      *
78      * @param array $args $_REQUEST data (unused)
79      *
80      * @return void
81      */
82     function handle($args)
83     {
84         parent::handle($args);
85
86         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
87             $this->clientError(
88                 // TRANS: Client error. POST is a HTTP command. It should not be translated.
89                 _('This method requires a POST.'),
90                 400,
91                 $this->format
92             );
93             return;
94         }
95
96         if (empty($this->user)) {
97             // TRANS: Client error displayed when trying to have a non-existing user leave a group.
98             $this->clientError(_('No such user.'), 404, $this->format);
99             return;
100         }
101
102         if (empty($this->group)) {
103             // TRANS: Client error displayed when trying to leave a group that does not exist.
104             $this->clientError(_('Group not found.'), 404, $this->format);
105             return false;
106         }
107
108         $member = new Group_member();
109
110         $member->group_id   = $this->group->id;
111         $member->profile_id = $this->auth_user->id;
112
113         if (!$member->find(true)) {
114             // TRANS: Server error displayed when trying to leave a group the user is not a member of.
115             $this->serverError(_('You are not a member of this group.'));
116             return;
117         }
118
119         try {
120             $this->user->leaveGroup($this->group);
121         } catch (Exception $e) {
122             // TRANS: Server error displayed when leaving a group failed in the database.
123             // TRANS: %1$s is the leaving user's nickname, $2$s is the group nickname for which the leave failed.
124             $this->serverError(sprintf(_('Could not remove user %1$s from group %2$s.'),
125                                        $cur->nickname, $this->group->nickname));
126             return;
127         }
128         switch($this->format) {
129         case 'xml':
130             $this->showSingleXmlGroup($this->group);
131             break;
132         case 'json':
133             $this->showSingleJsonGroup($this->group);
134             break;
135         default:
136             $this->clientError(
137                 // TRANS: Client error displayed when coming across a non-supported API method.
138                 _('API method not found.'),
139                 404,
140                 $this->format
141             );
142             break;
143         }
144     }
145 }