3 * Block a user from a group action class.
9 * @author Evan Prodromou <evan@status.net>
10 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
11 * @link http://status.net/
13 * StatusNet - the distributed open-source microblogging tool
14 * Copyright (C) 2008, 2009, StatusNet, Inc.
16 * This program is free software: you can redistribute it and/or modify
17 * it under the terms of the GNU Affero General Public License as published by
18 * the Free Software Foundation, either version 3 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU Affero General Public License for more details.
26 * You should have received a copy of the GNU Affero General Public License
27 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
35 * Block a user from a group
39 * @author Evan Prodromou <evan@status.net>
40 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
41 * @link http://status.net/
43 class GroupblockAction extends RedirectingAction
49 * Take arguments for running
51 * @param array $args $_REQUEST args
53 * @return boolean success flag
55 function prepare($args)
57 parent::prepare($args);
58 if (!common_logged_in()) {
59 // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
60 $this->clientError(_('Not logged in.'));
62 $token = $this->trimmed('token');
63 if (empty($token) || $token != common_session_token()) {
64 // TRANS: Client error displayed when the session token does not match or is not given.
65 $this->clientError(_('There was a problem with your session token. Try again, please.'));
67 $id = $this->trimmed('blockto');
69 // TRANS: Client error displayed trying to block a user from a group while not specifying a to be blocked user profile.
70 $this->clientError(_('No profile specified.'));
72 $this->profile = Profile::getKV('id', $id);
73 if (empty($this->profile)) {
74 // TRANS: Client error displayed trying to block a user from a group while specifying a non-existing profile.
75 $this->clientError(_('No profile with that ID.'));
77 $group_id = $this->trimmed('blockgroup');
78 if (empty($group_id)) {
79 // TRANS: Client error displayed trying to block a user from a group while not specifying a group to block a profile from.
80 $this->clientError(_('No group specified.'));
82 $this->group = User_group::getKV('id', $group_id);
83 if (empty($this->group)) {
84 // TRANS: Client error displayed trying to block a user from a group while specifying a non-existing group.
85 $this->clientError(_('No such group.'));
87 $user = common_current_user();
88 if (!$user->isAdmin($this->group)) {
89 // TRANS: Client error displayed trying to block a user from a group while not being an admin user.
90 $this->clientError(_('Only an admin can block group members.'), 401);
92 if (Group_block::isBlocked($this->group, $this->profile)) {
93 // TRANS: Client error displayed trying to block a user from a group while user is already blocked from the given group.
94 $this->clientError(_('User is already blocked from group.'));
96 // XXX: could have proactive blocks, but we don't have UI for it.
97 if (!$this->profile->isMember($this->group)) {
98 // TRANS: Client error displayed trying to block a user from a group while user is not a member of given group.
99 $this->clientError(_('User is not a member of group.'));
107 * Shows a page with list of favorite notices
109 * @param array $args $_REQUEST args; handled in prepare()
113 function handle($args)
115 parent::handle($args);
116 if ($_SERVER['REQUEST_METHOD'] == 'POST') {
117 if ($this->arg('no')) {
118 $this->returnToPrevious();
119 } elseif ($this->arg('yes')) {
120 $this->blockProfile();
121 } elseif ($this->arg('blockto')) {
127 function showContent() {
128 $this->areYouSureForm();
132 // TRANS: Title for block user from group page.
133 return _('Block user from group');
136 function showNoticeForm() {
143 * Shows a confirmation form.
147 function areYouSureForm()
149 $id = $this->profile->id;
150 $this->elementStart('form', array('id' => 'block-' . $id,
152 'class' => 'form_settings form_entity_block',
153 'action' => common_local_url('groupblock')));
154 $this->elementStart('fieldset');
155 $this->hidden('token', common_session_token());
156 // TRANS: Fieldset legend for block user from group form.
157 $this->element('legend', _('Block user'));
158 $this->element('p', null,
159 // TRANS: Explanatory text for block user from group form before setting the block.
160 // TRANS: %1$s is that to be blocked user, %2$s is the group the user will be blocked from.
161 sprintf(_('Are you sure you want to block user "%1$s" from the group "%2$s"? '.
162 'They will be removed from the group, unable to post, and '.
163 'unable to subscribe to the group in the future.'),
164 $this->profile->getBestName(),
165 $this->group->getBestName()));
166 $this->hidden('blockto-' . $this->profile->id,
169 $this->hidden('blockgroup-' . $this->group->id,
172 foreach ($this->args as $k => $v) {
173 if (substr($k, 0, 9) == 'returnto-') {
174 $this->hidden($k, $v);
177 $this->submit('form_action-no',
178 // TRANS: Button label on the form to block a user from a group.
180 'submit form_action-primary',
182 // TRANS: Submit button title for 'No' when blocking a user from a group.
183 _('Do not block this user from this group.'));
184 $this->submit('form_action-yes',
185 // TRANS: Button label on the form to block a user from a group.
187 'submit form_action-secondary',
189 // TRANS: Submit button title for 'Yes' when blocking a user from a group.
190 _('Block this user from this group.'));
191 $this->elementEnd('fieldset');
192 $this->elementEnd('form');
196 * Actually block a user.
200 function blockProfile()
202 $block = Group_block::blockProfile($this->group, $this->profile,
203 common_current_user());
206 // TRANS: Server error displayed when trying to block a user from a group fails because of an application error.
207 $this->serverError(_("Database error blocking user from group."));
210 $this->returnToPrevious();
214 * If we reached this form without returnto arguments, default to
215 * the top of the group's member list.
219 function defaultReturnTo()
221 return common_local_url('groupmembers',
222 array('nickname' => $this->group->nickname));
225 function showScripts()
227 parent::showScripts();
228 $this->autofocus('form_action-yes');