actions/block.php

   1 <?php
   2 /**
   3  * Block a user action class.
   4  *
   5  * PHP version 5
   6  *
   7  * @category Action
   8  * @package  StatusNet
   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/
  13  *
  14  * StatusNet - the distributed open-source microblogging tool
  15  * Copyright (C) 2008, 2009, StatusNet, Inc.
  16  *
  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.
  21  *
  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.
  26  *
  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/>.
  29  */
  30
  31 if (!defined('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * Block a user action class.
  37  *
  38  * @category Action
  39  * @package  StatusNet
  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/
  44  */
  45 class BlockAction extends ProfileFormAction
  46 {
  47     var $profile = null;
  48
  49     /**
  50      * Take arguments for running
  51      *
  52      * @param array $args $_REQUEST args
  53      *
  54      * @return boolean success flag
  55      */
  56     function prepare($args)
  57     {
  58         if (!parent::prepare($args)) {
  59             return false;
  60         }
  61
  62         $cur = common_current_user();
  63
  64         assert(!empty($cur)); // checked by parent
  65
  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.'));
  69         }
  70
  71         return true;
  72     }
  73
  74     /**
  75      * Handle request
  76      *
  77      * Shows a page with list of favorite notices
  78      *
  79      * @param array $args $_REQUEST args; handled in prepare()
  80      *
  81      * @return void
  82      */
  83     function handle($args)
  84     {
  85         if ($_SERVER['REQUEST_METHOD'] == 'POST') {
  86             if ($this->arg('no')) {
  87                 $this->returnToPrevious();
  88             } elseif ($this->arg('yes')) {
  89                 $this->handlePost();
  90                 $this->returnToPrevious();
  91             } else {
  92                 $this->showPage();
  93             }
  94         } else {
  95             $this->showPage();
  96         }
  97     }
  98
  99     function showContent() {
 100         $this->areYouSureForm();
 101     }
 102
 103     function title() {
 104         // TRANS: Title for block user page.
 105         return _('Block user');
 106     }
 107
 108     function showNoticeForm() {
 109         // nop
 110     }
 111
 112     /**
 113      * Confirm with user.
 114      *
 115      * Shows a confirmation form.
 116      *
 117      * @return void
 118      */
 119     function areYouSureForm()
 120     {
 121         // @fixme if we ajaxify the confirmation form, skip the preview on ajax hits
 122         $profile = new ArrayWrapper(array($this->profile));
 123         $preview = new ProfileList($profile, $this);
 124         $preview->show();
 125
 126
 127         $id = $this->profile->id;
 128         $this->elementStart('form', array('id' => 'block-' . $id,
 129                                            'method' => 'post',
 130                                            'class' => 'form_settings form_entity_block',
 131                                            'action' => common_local_url('block')));
 132         $this->elementStart('fieldset');
 133         $this->hidden('token', common_session_token());
 134         // TRANS: Legend for block user form.
 135         $this->element('legend', _('Block user'));
 136         $this->element('p', null,
 137                        // TRANS: Explanation of consequences when blocking a user on the block user page.
 138                        _('Are you sure you want to block this user? '.
 139                          'Afterwards, they will be unsubscribed from you, '.
 140                          'unable to subscribe to you in the future, and '.
 141                          'you will not be notified of any @-replies from them.'));
 142         $this->element('input', array('id' => 'blockto-' . $id,
 143                                       'name' => 'profileid',
 144                                       'type' => 'hidden',
 145                                       'value' => $id));
 146         foreach ($this->args as $k => $v) {
 147             if (substr($k, 0, 9) == 'returnto-') {
 148                 $this->hidden($k, $v);
 149             }
 150         }
 151         $this->submit('form_action-no',
 152                       // TRANS: Button label on the user block form.
 153                       _m('BUTTON','No'),
 154                       'submit form_action-primary',
 155                       'no',
 156                       // TRANS: Submit button title for 'No' when blocking a user.
 157                       _('Do not block this user.'));
 158         $this->submit('form_action-yes',
 159                       // TRANS: Button label on the user block form.
 160                       _m('BUTTON','Yes'),
 161                       'submit form_action-secondary',
 162                       'yes',
 163                       // TRANS: Submit button title for 'Yes' when blocking a user.
 164                       _('Block this user.'));
 165         $this->elementEnd('fieldset');
 166         $this->elementEnd('form');
 167     }
 168
 169     /**
 170      * Actually block a user.
 171      *
 172      * @return void
 173      */
 174
 175     function handlePost()
 176     {
 177         $cur = common_current_user();
 178
 179         if (Event::handle('StartBlockProfile', array($cur, $this->profile))) {
 180             $result = $cur->block($this->profile);
 181             if ($result) {
 182                 Event::handle('EndBlockProfile', array($cur, $this->profile));
 183             }
 184         }
 185
 186         if (!$result) {
 187             // TRANS: Server error displayed when blocking a user fails.
 188             $this->serverError(_('Failed to save block information.'));
 189         }
 190     }
 191
 192     function showScripts()
 193     {
 194         parent::showScripts();
 195         $this->autofocus('form_action-yes');
 196     }
 197
 198     /**
 199      * Override for form session token checks; on our first hit we're just
 200      * requesting confirmation, which doesn't need a token. We need to be
 201      * able to take regular GET requests from email!
 202      *
 203      * @throws ClientException if token is bad on POST request or if we have
 204      *         confirmation parameters which could trigger something.
 205      */
 206     function checkSessionToken()
 207     {
 208         if ($_SERVER['REQUEST_METHOD'] == 'POST' ||
 209             $this->arg('yes') ||
 210             $this->arg('no')) {
 211
 212             return parent::checkSessionToken();
 213         }
 214     }
 215
 216     /**
 217      * If we reached this form without returnto arguments, return to the
 218      * current user's subscription list.
 219      *
 220      * @return string URL
 221      */
 222     function defaultReturnTo()
 223     {
 224         $user = common_current_user();
 225         if ($user) {
 226             return common_local_url('subscribers',
 227                                     array('nickname' => $user->nickname));
 228         } else {
 229             return common_local_url('public');
 230         }
 231     }
 232 }