1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
<?php
/**
*
*
* Created on Mar 24, 2009
*
* Copyright © 2009 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
/**
* @ingroup API
*/
class ApiUserrights extends ApiBase {
private $mUser = null;
public function execute() {
$params = $this->extractRequestParams();
$user = $this->getUrUser( $params );
$form = new UserrightsPage;
$form->setContext( $this->getContext() );
$r['user'] = $user->getName();
$r['userid'] = $user->getId();
list( $r['added'], $r['removed'] ) = $form->doSaveUserGroups(
$user, (array)$params['add'],
(array)$params['remove'], $params['reason']
);
$result = $this->getResult();
$result->setIndexedTagName( $r['added'], 'group' );
$result->setIndexedTagName( $r['removed'], 'group' );
$result->addValue( null, $this->getModuleName(), $r );
}
/**
* @param array $params
* @return User
*/
private function getUrUser( array $params ) {
if ( $this->mUser !== null ) {
return $this->mUser;
}
$this->requireOnlyOneParameter( $params, 'user', 'userid' );
$user = isset( $params['user'] ) ? $params['user'] : '#' . $params['userid'];
$form = new UserrightsPage;
$form->setContext( $this->getContext() );
$status = $form->fetchUser( $user );
if ( !$status->isOK() ) {
$this->dieStatus( $status );
}
$this->mUser = $status->value;
return $status->value;
}
public function mustBePosted() {
return true;
}
public function isWriteMode() {
return true;
}
public function getAllowedParams() {
return array(
'user' => array(
ApiBase::PARAM_TYPE => 'string',
),
'userid' => array(
ApiBase::PARAM_TYPE => 'integer',
),
'add' => array(
ApiBase::PARAM_TYPE => User::getAllGroups(),
ApiBase::PARAM_ISMULTI => true
),
'remove' => array(
ApiBase::PARAM_TYPE => User::getAllGroups(),
ApiBase::PARAM_ISMULTI => true
),
'reason' => array(
ApiBase::PARAM_DFLT => ''
)
);
}
public function getParamDescription() {
return array(
'user' => 'User name',
'userid' => 'User id',
'add' => 'Add the user to these groups',
'remove' => 'Remove the user from these groups',
'token' => array(
/* Standard description automatically prepended */
'For compatibility, the token used in the web UI is also accepted.'
),
'reason' => 'Reason for the change',
);
}
public function getDescription() {
return 'Add/remove a user to/from groups.';
}
public function needsToken() {
return 'userrights';
}
protected function getWebUITokenSalt( array $params ) {
return $this->getUrUser( $params )->getName();
}
public function getExamples() {
return array(
'api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC',
'api.php?action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC'
);
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/API:User_group_membership';
}
}
|
