3 * StatusNet, the distributed open-source microblogging tool
5 * Join a group via the API
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 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/
34 if (!defined('STATUSNET')) {
39 * Joins the authenticated user to the group speicified by ID
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/
50 class ApiGroupJoinAction extends ApiAuthAction
55 * Take arguments for running
57 * @param array $args $_REQUEST args
59 * @return boolean success flag
61 function prepare($args)
63 parent::prepare($args);
65 $this->user = $this->auth_user;
66 $this->group = $this->getTargetGroup($this->arg('id'));
74 * Save the new message
76 * @param array $args $_REQUEST data (unused)
80 function handle($args)
82 parent::handle($args);
84 if ($_SERVER['REQUEST_METHOD'] != 'POST') {
86 // TRANS: Client error. POST is a HTTP command. It should not be translated.
87 _('This method requires a POST.'),
94 if (empty($this->user)) {
95 // TRANS: Client error displayed when trying to have a non-existing user join a group.
96 $this->clientError(_('No such user.'), 404, $this->format);
100 if (empty($this->group)) {
101 // TRANS: Client error displayed when trying to join a group that does not exist.
102 $this->clientError(_('Group not found.'), 404, $this->format);
106 if ($this->user->isMember($this->group)) {
108 // TRANS: Server error displayed when trying to join a group the user is already a member of.
109 _('You are already a member of that group.'),
116 if (Group_block::isBlocked($this->group, $this->user->getProfile())) {
118 // TRANS: Server error displayed when trying to join a group the user is blocked from joining.
119 _('You have been blocked from that group by the admin.'),
127 $this->user->joinGroup($this->group);
128 } catch (Exception $e) {
129 // TRANS: Server error displayed when joining a group failed in the database.
130 // TRANS: %1$s is the joining user's nickname, $2$s is the group nickname for which the join failed.
131 $this->serverError(sprintf(_('Could not join user %1$s to group %2$s.'),
132 $cur->nickname, $this->group->nickname));
136 switch($this->format) {
138 $this->showSingleXmlGroup($this->group);
141 $this->showSingleJsonGroup($this->group);
145 // TRANS: Client error displayed when coming across a non-supported API method.
146 _('API method not found.'),