]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/grantrole.php
Give NoticeListItem its own class
[quix0rs-gnu-social.git] / actions / grantrole.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Action class to grant user roles.
6  *
7  * PHP version 5
8  *
9  * LICENCE: This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU Affero General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU Affero General Public License for more details.
18  *
19  * You should have received a copy of the GNU Affero General Public License
20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21  *
22  * @category  Action
23  * @package   StatusNet
24  * @author    Evan Prodromou <evan@status.net>
25  * @copyright 2009 StatusNet, Inc.
26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27  * @link      http://status.net/
28  */
29
30 if (!defined('STATUSNET')) {
31     exit(1);
32 }
33
34 /**
35  * Assign role to user.
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 GrantRoleAction extends ProfileFormAction
44 {
45     /**
46      * Check parameters
47      *
48      * @param array $args action arguments (URL, GET, POST)
49      *
50      * @return boolean success flag
51      */
52     function prepare($args)
53     {
54         if (!parent::prepare($args)) {
55             return false;
56         }
57
58         $this->role = $this->arg('role');
59         if (!Profile_role::isValid($this->role)) {
60             // TRANS: Client error displayed when trying to assign an invalid role to a user.
61             $this->clientError(_('Invalid role.'));
62             return false;
63         }
64         if (!Profile_role::isSettable($this->role)) {
65             // TRANS: Client error displayed when trying to assign an reserved role to a user.
66             $this->clientError(_('This role is reserved and cannot be set.'));
67             return false;
68         }
69
70         $cur = common_current_user();
71
72         assert(!empty($cur)); // checked by parent
73
74         if (!$cur->hasRight(Right::GRANTROLE)) {
75             // TRANS: Client error displayed when trying to assign a role to a user while not being allowed to set roles.
76             $this->clientError(_('You cannot grant user roles on this site.'));
77             return false;
78         }
79
80         assert(!empty($this->profile)); // checked by parent
81
82         if ($this->profile->hasRole($this->role)) {
83             // TRANS: Client error displayed when trying to assign a role to a user that already has that role.
84             $this->clientError(_('User already has this role.'));
85             return false;
86         }
87
88         return true;
89     }
90
91     /**
92      * Sandbox a user.
93      *
94      * @return void
95      */
96     function handlePost()
97     {
98         $this->profile->grantRole($this->role);
99     }
100 }