actions/groupblock.php

   1 <?php
   2 /**
   3  * Block a user from a group action class.
   4  *
   5  * PHP version 5
   6  *
   7  * @category Action
   8  * @package  StatusNet
   9  * @author   Evan Prodromou <evan@status.net>
  10  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  11  * @link     http://status.net/
  12  *
  13  * StatusNet - the distributed open-source microblogging tool
  14  * Copyright (C) 2008, 2009, StatusNet, Inc.
  15  *
  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.
  20  *
  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.
  25  *
  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/>.
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Block a user from a group
  36  *
  37  * @category Action
  38  * @package  StatusNet
  39  * @author   Evan Prodromou <evan@status.net>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  41  * @link     http://status.net/
  42  */
  43 class GroupblockAction extends RedirectingAction
  44 {
  45     var $profile = null;
  46     var $group = null;
  47
  48     /**
  49      * Take arguments for running
  50      *
  51      * @param array $args $_REQUEST args
  52      *
  53      * @return boolean success flag
  54      */
  55     function prepare($args)
  56     {
  57         parent::prepare($args);
  58         if (!common_logged_in()) {
  59             // TRANS: Client error displayed trying to block a user from a group while not logged in.
  60             $this->clientError(_('Not logged in.'));
  61             return false;
  62         }
  63         $token = $this->trimmed('token');
  64         if (empty($token) || $token != common_session_token()) {
  65             $this->clientError(_('There was a problem with your session token. Try again, please.'));
  66             return;
  67         }
  68         $id = $this->trimmed('blockto');
  69         if (empty($id)) {
  70             // TRANS: Client error displayed trying to block a user from a group while not specifying a to be blocked user profile.
  71             $this->clientError(_('No profile specified.'));
  72             return false;
  73         }
  74         $this->profile = Profile::staticGet('id', $id);
  75         if (empty($this->profile)) {
  76             // TRANS: Client error displayed trying to block a user from a group while specifying a non-existing profile.
  77             $this->clientError(_('No profile with that ID.'));
  78             return false;
  79         }
  80         $group_id = $this->trimmed('blockgroup');
  81         if (empty($group_id)) {
  82             // TRANS: Client error displayed trying to block a user from a group while not specifying a group to block a profile from.
  83             $this->clientError(_('No group specified.'));
  84             return false;
  85         }
  86         $this->group = User_group::staticGet('id', $group_id);
  87         if (empty($this->group)) {
  88             // TRANS: Client error displayed trying to block a user from a group while specifying a non-existing group.
  89             $this->clientError(_('No such group.'));
  90             return false;
  91         }
  92         $user = common_current_user();
  93         if (!$user->isAdmin($this->group)) {
  94             // TRANS: Client error displayed trying to block a user from a group while not being an admin user.
  95             $this->clientError(_('Only an admin can block group members.'), 401);
  96             return false;
  97         }
  98         if (Group_block::isBlocked($this->group, $this->profile)) {
  99             // TRANS: Client error displayed trying to block a user from a group while user is already blocked from the given group.
 100             $this->clientError(_('User is already blocked from group.'));
 101             return false;
 102         }
 103         // XXX: could have proactive blocks, but we don't have UI for it.
 104         if (!$this->profile->isMember($this->group)) {
 105             // TRANS: Client error displayed trying to block a user from a group while user is not a member of given group.
 106             $this->clientError(_('User is not a member of group.'));
 107             return false;
 108         }
 109         return true;
 110     }
 111
 112     /**
 113      * Handle request
 114      *
 115      * Shows a page with list of favorite notices
 116      *
 117      * @param array $args $_REQUEST args; handled in prepare()
 118      *
 119      * @return void
 120      */
 121     function handle($args)
 122     {
 123         parent::handle($args);
 124         if ($_SERVER['REQUEST_METHOD'] == 'POST') {
 125             if ($this->arg('no')) {
 126                 $this->returnToPrevious();
 127             } elseif ($this->arg('yes')) {
 128                 $this->blockProfile();
 129             } elseif ($this->arg('blockto')) {
 130                 $this->showPage();
 131             }
 132         }
 133     }
 134
 135     function showContent() {
 136         $this->areYouSureForm();
 137     }
 138
 139     function title() {
 140         // TRANS: Title for block user from group page.
 141         return _('Block user from group');
 142     }
 143
 144     function showNoticeForm() {
 145         // nop
 146     }
 147
 148     /**
 149      * Confirm with user.
 150      *
 151      * Shows a confirmation form.
 152      *
 153      * @return void
 154      */
 155     function areYouSureForm()
 156     {
 157         $id = $this->profile->id;
 158         $this->elementStart('form', array('id' => 'block-' . $id,
 159                                            'method' => 'post',
 160                                            'class' => 'form_settings form_entity_block',
 161                                            'action' => common_local_url('groupblock')));
 162         $this->elementStart('fieldset');
 163         $this->hidden('token', common_session_token());
 164         // TRANS: Fieldset legend for block user from group form.
 165         $this->element('legend', _('Block user'));
 166         $this->element('p', null,
 167                        // TRANS: Explanatory text for block user from group form before setting the block.
 168                        // TRANS: %1$s is that to be blocked user, %2$s is the group the user will be blocked from.
 169                        sprintf(_('Are you sure you want to block user "%1$s" from the group "%2$s"? '.
 170                                  'They will be removed from the group, unable to post, and '.
 171                                  'unable to subscribe to the group in the future.'),
 172                                $this->profile->getBestName(),
 173                                $this->group->getBestName()));
 174         $this->hidden('blockto-' . $this->profile->id,
 175                       $this->profile->id,
 176                       'blockto');
 177         $this->hidden('blockgroup-' . $this->group->id,
 178                       $this->group->id,
 179                       'blockgroup');
 180         foreach ($this->args as $k => $v) {
 181             if (substr($k, 0, 9) == 'returnto-') {
 182                 $this->hidden($k, $v);
 183             }
 184         }
 185         $this->submit('form_action-no',
 186                       // TRANS: Button label on the form to block a user from a group.
 187                       _m('BUTTON','No'),
 188                       'submit form_action-primary',
 189                       'no',
 190                       // TRANS: Submit button title for 'No' when blocking a user from a group.
 191                       _('Do not block this user from this group.'));
 192         $this->submit('form_action-yes',
 193                       // TRANS: Button label on the form to block a user from a group.
 194                       _m('BUTTON','Yes'),
 195                       'submit form_action-secondary',
 196                       'yes',
 197                       // TRANS: Submit button title for 'Yes' when blocking a user from a group.
 198                       _('Block this user from this group.'));
 199         $this->elementEnd('fieldset');
 200         $this->elementEnd('form');
 201     }
 202
 203     /**
 204      * Actually block a user.
 205      *
 206      * @return void
 207      */
 208     function blockProfile()
 209     {
 210         $block = Group_block::blockProfile($this->group, $this->profile,
 211                                            common_current_user());
 212
 213         if (empty($block)) {
 214             // TRANS: Server error displayed when trying to block a user from a group fails because of an application error.
 215             $this->serverError(_("Database error blocking user from group."));
 216             return false;
 217         }
 218
 219         $this->returnToPrevious();
 220     }
 221
 222     /**
 223      * If we reached this form without returnto arguments, default to
 224      * the top of the group's member list.
 225      *
 226      * @return string URL
 227      */
 228     function defaultReturnTo()
 229     {
 230         return common_local_url('groupmembers',
 231                                 array('nickname' => $this->group->nickname));
 232     }
 233
 234     function showScripts()
 235     {
 236         parent::showScripts();
 237         $this->autofocus('form_action-yes');
 238     }
 239 }