]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apigroupleave.php
Stronger typing and fixes in RequireValidatedEmail
[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 /**
39  * Removes the authenticated user from the group specified by ID
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 ApiGroupLeaveAction extends ApiAuthAction
51 {
52     protected $needPost = true;
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     protected function prepare(array $args=array())
64     {
65         parent::prepare($args);
66
67         $this->group = $this->getTargetGroup($this->arg('id'));
68
69         return true;
70     }
71
72     /**
73      * Handle the request
74      *
75      * Save the new message
76      *
77      * @return void
78      */
79     protected function handle()
80     {
81         parent::handle();
82
83         if (!$this->scoped instanceof Profile) {
84             // TRANS: Client error displayed when trying to have a non-existing user leave a group.
85             $this->clientError(_('No such user.'), 404);
86         }
87
88         if (!$this->group instanceof User_group) {
89             // TRANS: Client error displayed when trying to leave a group that does not exist.
90             $this->clientError(_('Group not found.'), 404);
91         }
92
93         $member = new Group_member();
94
95         $member->group_id   = $this->group->id;
96         $member->profile_id = $this->scoped->id;
97
98         if (!$member->find(true)) {
99             // TRANS: Server error displayed when trying to leave a group the user is not a member of.
100             $this->serverError(_('You are not a member of this group.'));
101         }
102
103         try {
104             $this->user->leaveGroup($this->group);
105         } catch (Exception $e) {
106             // TRANS: Server error displayed when leaving a group failed in the database.
107             // TRANS: %1$s is the leaving user's nickname, $2$s is the group nickname for which the leave failed.
108             $this->serverError(sprintf(_('Could not remove user %1$s from group %2$s.'),
109                                        $this->scoped->getNickname(), $this->group->nickname));
110         }
111         switch($this->format) {
112         case 'xml':
113             $this->showSingleXmlGroup($this->group);
114             break;
115         case 'json':
116             $this->showSingleJsonGroup($this->group);
117             break;
118         default:
119             // TRANS: Client error displayed when coming across a non-supported API method.
120             $this->clientError(_('API method not found.'), 404);
121         }
122     }
123 }