3 * Block a user action class.
9 * @author Evan Prodromou <evan@status.net>
10 * @author Robin Millette <millette@status.net>
11 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
12 * @link http://status.net/
14 * StatusNet - the distributed open-source microblogging tool
15 * Copyright (C) 2008, 2009, StatusNet, Inc.
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU Affero General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU Affero General Public License for more details.
27 * You should have received a copy of the GNU Affero General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 if (!defined('STATUSNET') && !defined('LACONICA')) {
36 * Block a user action class.
40 * @author Evan Prodromou <evan@status.net>
41 * @author Robin Millette <millette@status.net>
42 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
43 * @link http://status.net/
45 class BlockAction extends ProfileFormAction
50 * Take arguments for running
52 * @param array $args $_REQUEST args
54 * @return boolean success flag
56 function prepare($args)
58 if (!parent::prepare($args)) {
62 $cur = common_current_user();
64 assert(!empty($cur)); // checked by parent
66 if ($cur->hasBlocked($this->profile)) {
67 // TRANS: Client error displayed when blocking a user that has already been blocked.
68 $this->clientError(_('You already blocked that user.'));
77 * @param array $args $_REQUEST args; handled in prepare()
81 function handle($args)
83 if ($_SERVER['REQUEST_METHOD'] == 'POST') {
84 if ($this->arg('no')) {
85 $this->returnToPrevious();
86 } elseif ($this->arg('yes')) {
88 $this->returnToPrevious();
97 function showContent() {
98 $this->areYouSureForm();
102 // TRANS: Title for block user page.
103 return _('Block user');
106 function showNoticeForm() {
113 * Shows a confirmation form.
117 function areYouSureForm()
119 // @fixme if we ajaxify the confirmation form, skip the preview on ajax hits
120 $profile = new ArrayWrapper(array($this->profile));
121 $preview = new ProfileList($profile, $this);
125 $id = $this->profile->id;
126 $this->elementStart('form', array('id' => 'block-' . $id,
128 'class' => 'form_settings form_entity_block',
129 'action' => common_local_url('block')));
130 $this->elementStart('fieldset');
131 $this->hidden('token', common_session_token());
132 // TRANS: Legend for block user form.
133 $this->element('legend', _('Block user'));
134 $this->element('p', null,
135 // TRANS: Explanation of consequences when blocking a user on the block user page.
136 _('Are you sure you want to block this user? '.
137 'Afterwards, they will be unsubscribed from you, '.
138 'unable to subscribe to you in the future, and '.
139 'you will not be notified of any @-replies from them.'));
140 $this->element('input', array('id' => 'blockto-' . $id,
141 'name' => 'profileid',
144 foreach ($this->args as $k => $v) {
145 if (substr($k, 0, 9) == 'returnto-') {
146 $this->hidden($k, $v);
149 $this->submit('form_action-no',
150 // TRANS: Button label on the user block form.
152 'submit form_action-primary',
154 // TRANS: Submit button title for 'No' when blocking a user.
155 _('Do not block this user.'));
156 $this->submit('form_action-yes',
157 // TRANS: Button label on the user block form.
159 'submit form_action-secondary',
161 // TRANS: Submit button title for 'Yes' when blocking a user.
162 _('Block this user.'));
163 $this->elementEnd('fieldset');
164 $this->elementEnd('form');
168 * Actually block a user.
173 function handlePost()
175 $cur = common_current_user();
177 if (Event::handle('StartBlockProfile', array($cur, $this->profile))) {
178 $result = $cur->block($this->profile);
180 Event::handle('EndBlockProfile', array($cur, $this->profile));
185 // TRANS: Server error displayed when blocking a user fails.
186 $this->serverError(_('Failed to save block information.'));
190 function showScripts()
192 parent::showScripts();
193 $this->autofocus('form_action-yes');
197 * Override for form session token checks; on our first hit we're just
198 * requesting confirmation, which doesn't need a token. We need to be
199 * able to take regular GET requests from email!
201 * @throws ClientException if token is bad on POST request or if we have
202 * confirmation parameters which could trigger something.
204 function checkSessionToken()
206 if ($_SERVER['REQUEST_METHOD'] == 'POST' ||
210 return parent::checkSessionToken();
215 * If we reached this form without returnto arguments, return to the
216 * current user's subscription list.
220 function defaultReturnTo()
222 $user = common_current_user();
224 if ($user instanceof User) {
225 return common_local_url('subscribers',
226 array('nickname' => $user->nickname));
228 return common_local_url('public');