groupblock.php 8.79 KB
Newer Older
Evan Prodromou's avatar
Evan Prodromou committed
1 2 3 4 5 6 7
<?php
/**
 * Block a user from a group action class.
 *
 * PHP version 5
 *
 * @category Action
8
 * @package  StatusNet
9
 * @author   Evan Prodromou <evan@status.net>
Evan Prodromou's avatar
Evan Prodromou committed
10
 * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
11
 * @link     http://status.net/
Evan Prodromou's avatar
Evan Prodromou committed
12
 *
13
 * StatusNet - the distributed open-source microblogging tool
14
 * Copyright (C) 2008, 2009, StatusNet, Inc.
Evan Prodromou's avatar
Evan Prodromou committed
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

30
if (!defined('STATUSNET') && !defined('LACONICA')) {
Evan Prodromou's avatar
Evan Prodromou committed
31 32 33 34 35 36 37
    exit(1);
}

/**
 * Block a user from a group
 *
 * @category Action
38
 * @package  StatusNet
39
 * @author   Evan Prodromou <evan@status.net>
Evan Prodromou's avatar
Evan Prodromou committed
40
 * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
41
 * @link     http://status.net/
Evan Prodromou's avatar
Evan Prodromou committed
42
 */
43
class GroupblockAction extends RedirectingAction
Evan Prodromou's avatar
Evan Prodromou committed
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
{
    var $profile = null;
    var $group = null;

    /**
     * Take arguments for running
     *
     * @param array $args $_REQUEST args
     *
     * @return boolean success flag
     */
    function prepare($args)
    {
        parent::prepare($args);
        if (!common_logged_in()) {
59
            // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
Evan Prodromou's avatar
Evan Prodromou committed
60 61 62 63 64
            $this->clientError(_('Not logged in.'));
            return false;
        }
        $token = $this->trimmed('token');
        if (empty($token) || $token != common_session_token()) {
65
            // TRANS: Client error displayed when the session token does not match or is not given.
Evan Prodromou's avatar
Evan Prodromou committed
66 67 68 69 70
            $this->clientError(_('There was a problem with your session token. Try again, please.'));
            return;
        }
        $id = $this->trimmed('blockto');
        if (empty($id)) {
71
            // TRANS: Client error displayed trying to block a user from a group while not specifying a to be blocked user profile.
Evan Prodromou's avatar
Evan Prodromou committed
72 73 74 75 76
            $this->clientError(_('No profile specified.'));
            return false;
        }
        $this->profile = Profile::staticGet('id', $id);
        if (empty($this->profile)) {
77
            // TRANS: Client error displayed trying to block a user from a group while specifying a non-existing profile.
Evan Prodromou's avatar
Evan Prodromou committed
78 79 80 81 82
            $this->clientError(_('No profile with that ID.'));
            return false;
        }
        $group_id = $this->trimmed('blockgroup');
        if (empty($group_id)) {
83
            // TRANS: Client error displayed trying to block a user from a group while not specifying a group to block a profile from.
Evan Prodromou's avatar
Evan Prodromou committed
84 85 86 87 88
            $this->clientError(_('No group specified.'));
            return false;
        }
        $this->group = User_group::staticGet('id', $group_id);
        if (empty($this->group)) {
89
            // TRANS: Client error displayed trying to block a user from a group while specifying a non-existing group.
Evan Prodromou's avatar
Evan Prodromou committed
90 91 92 93 94
            $this->clientError(_('No such group.'));
            return false;
        }
        $user = common_current_user();
        if (!$user->isAdmin($this->group)) {
95
            // TRANS: Client error displayed trying to block a user from a group while not being an admin user.
Evan Prodromou's avatar
Evan Prodromou committed
96 97 98 99
            $this->clientError(_('Only an admin can block group members.'), 401);
            return false;
        }
        if (Group_block::isBlocked($this->group, $this->profile)) {
100
            // TRANS: Client error displayed trying to block a user from a group while user is already blocked from the given group.
Evan Prodromou's avatar
Evan Prodromou committed
101 102 103
            $this->clientError(_('User is already blocked from group.'));
            return false;
        }
104
        // XXX: could have proactive blocks, but we don't have UI for it.
Evan Prodromou's avatar
Evan Prodromou committed
105
        if (!$this->profile->isMember($this->group)) {
106
            // TRANS: Client error displayed trying to block a user from a group while user is not a member of given group.
Evan Prodromou's avatar
Evan Prodromou committed
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
            $this->clientError(_('User is not a member of group.'));
            return false;
        }
        return true;
    }

    /**
     * Handle request
     *
     * Shows a page with list of favorite notices
     *
     * @param array $args $_REQUEST args; handled in prepare()
     *
     * @return void
     */
    function handle($args)
    {
        parent::handle($args);
        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
            if ($this->arg('no')) {
127
                $this->returnToPrevious();
Evan Prodromou's avatar
Evan Prodromou committed
128 129 130 131 132 133 134 135 136 137 138 139 140
            } elseif ($this->arg('yes')) {
                $this->blockProfile();
            } elseif ($this->arg('blockto')) {
                $this->showPage();
            }
        }
    }

    function showContent() {
        $this->areYouSureForm();
    }

    function title() {
141
        // TRANS: Title for block user from group page.
Evan Prodromou's avatar
Evan Prodromou committed
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
        return _('Block user from group');
    }

    function showNoticeForm() {
        // nop
    }

    /**
     * Confirm with user.
     *
     * Shows a confirmation form.
     *
     * @return void
     */
    function areYouSureForm()
    {
        $id = $this->profile->id;
159 160 161 162 163 164
        $this->elementStart('form', array('id' => 'block-' . $id,
                                           'method' => 'post',
                                           'class' => 'form_settings form_entity_block',
                                           'action' => common_local_url('groupblock')));
        $this->elementStart('fieldset');
        $this->hidden('token', common_session_token());
165
        // TRANS: Fieldset legend for block user from group form.
166
        $this->element('legend', _('Block user'));
Evan Prodromou's avatar
Evan Prodromou committed
167
        $this->element('p', null,
168 169
                       // TRANS: Explanatory text for block user from group form before setting the block.
                       // TRANS: %1$s is that to be blocked user, %2$s is the group the user will be blocked from.
170
                       sprintf(_('Are you sure you want to block user "%1$s" from the group "%2$s"? '.
Evan Prodromou's avatar
Evan Prodromou committed
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
                                 'They will be removed from the group, unable to post, and '.
                                 'unable to subscribe to the group in the future.'),
                               $this->profile->getBestName(),
                               $this->group->getBestName()));
        $this->hidden('blockto-' . $this->profile->id,
                      $this->profile->id,
                      'blockto');
        $this->hidden('blockgroup-' . $this->group->id,
                      $this->group->id,
                      'blockgroup');
        foreach ($this->args as $k => $v) {
            if (substr($k, 0, 9) == 'returnto-') {
                $this->hidden($k, $v);
            }
        }
186 187 188 189 190 191
        $this->submit('form_action-no',
                      // TRANS: Button label on the form to block a user from a group.
                      _m('BUTTON','No'),
                      'submit form_action-primary',
                      'no',
                      // TRANS: Submit button title for 'No' when blocking a user from a group.
192
                      _('Do not block this user from this group.'));
193 194 195 196 197 198
        $this->submit('form_action-yes',
                      // TRANS: Button label on the form to block a user from a group.
                      _m('BUTTON','Yes'),
                      'submit form_action-secondary',
                      'yes',
                      // TRANS: Submit button title for 'Yes' when blocking a user from a group.
199
                      _('Block this user from this group.'));
200
        $this->elementEnd('fieldset');
Evan Prodromou's avatar
Evan Prodromou committed
201 202 203 204 205 206 207 208 209 210 211 212 213 214
        $this->elementEnd('form');
    }

    /**
     * Actually block a user.
     *
     * @return void
     */
    function blockProfile()
    {
        $block = Group_block::blockProfile($this->group, $this->profile,
                                           common_current_user());

        if (empty($block)) {
215
            // TRANS: Server error displayed when trying to block a user from a group fails because of an application error.
Evan Prodromou's avatar
Evan Prodromou committed
216 217 218
            $this->serverError(_("Database error blocking user from group."));
            return false;
        }
219

220
        $this->returnToPrevious();
221
    }
Evan Prodromou's avatar
Evan Prodromou committed
222

223 224 225
    /**
     * If we reached this form without returnto arguments, default to
     * the top of the group's member list.
226
     *
227 228 229 230 231 232
     * @return string URL
     */
    function defaultReturnTo()
    {
        return common_local_url('groupmembers',
                                array('nickname' => $this->group->nickname));
Evan Prodromou's avatar
Evan Prodromou committed
233
    }
234 235 236 237 238 239

    function showScripts()
    {
        parent::showScripts();
        $this->autofocus('form_action-yes');
    }
Evan Prodromou's avatar
Evan Prodromou committed
240
}