Documentation
[mediawiki.git] / includes / SpecialUserrights.php
blob60a97f88731d93a5ec39a40d6e17acf99fe2adba
1 <?php
2 /**
3 * Provide an administration interface
4 * DO NOT USE: INSECURE.
6 * TODO : remove everything related to group editing (SpecialGrouplevels.php)
7 * @package MediaWiki
8 * @subpackage SpecialPage
9 */
11 /** */
12 require_once('HTMLForm.php');
14 /** Entry point */
15 function wfSpecialUserrights() {
16 global $wgRequest;
17 $form = new UserrightsForm($wgRequest);
18 $form->execute();
21 /**
22 * A class to manage user levels rights.
23 * @package MediaWiki
24 * @subpackage SpecialPage
26 class UserrightsForm extends HTMLForm {
27 var $mPosted, $mRequest, $mSaveprefs;
28 /** Escaped local url name*/
29 var $action;
31 /** Constructor*/
32 function UserrightsForm ( &$request ) {
33 $this->mPosted = $request->wasPosted();
34 $this->mRequest =& $request;
35 $this->mName = 'userrights';
37 $titleObj = Title::makeTitle( NS_SPECIAL, 'Userrights' );
38 $this->action = $titleObj->escapeLocalURL();
41 /**
42 * Manage forms to be shown according to posted data.
43 * Depending on the submit button used, call a form or a save function.
45 function execute() {
46 // show the general form
47 $this->switchForm();
48 if( $this->mPosted ) {
49 // show some more forms
50 if( $this->mRequest->getCheck( 'ssearchuser' ) ) {
51 $this->editUserGroupsForm( $this->mRequest->getVal( 'user-editname' ) );
54 // save settings
55 if( $this->mRequest->getCheck( 'saveusergroups' ) ) {
56 global $wgUser;
57 $username = $this->mRequest->getVal( 'user-editname' );
58 if( $wgUser->matchEditToken( $this->mRequest->getVal( 'wpEditToken' ), $username ) ) {
59 $this->saveUserGroups( $username,
60 $this->mRequest->getArray( 'member' ),
61 $this->mRequest->getArray( 'available' ) );
67 /**
68 * Save user groups changes in the database.
69 * Data comes from the editUserGroupsForm() form function
71 * @param string $username Username to apply changes to.
72 * @param array $removegroup id of groups to be removed.
73 * @param array $addgroup id of groups to be added.
76 function saveUserGroups( $username, $removegroup, $addgroup) {
77 global $wgOut;
78 $u = User::newFromName($username);
80 if(is_null($u)) {
81 $wgOut->addWikiText( wfMsg( 'nosuchusershort', htmlspecialchars( $username ) ) );
82 return;
85 if($u->getID() == 0) {
86 $wgOut->addWikiText( wfMsg( 'nosuchusershort', htmlspecialchars( $username ) ) );
87 return;
90 $oldGroups = $u->getGroups();
91 $newGroups = $oldGroups;
92 $logcomment = ' ';
93 // remove then add groups
94 if(isset($removegroup)) {
95 $newGroups = array_diff($newGroups, $removegroup);
96 foreach( $removegroup as $group ) {
97 $u->removeGroup( $group );
100 if(isset($addgroup)) {
101 $newGroups = array_merge($newGroups, $addgroup);
102 foreach( $addgroup as $group ) {
103 $u->addGroup( $group );
106 $newGroups = array_unique( $newGroups );
108 wfDebug( 'oldGroups: ' . print_r( $oldGroups, true ) );
109 wfDebug( 'newGroups: ' . print_r( $newGroups, true ) );
111 $log = new LogPage( 'rights' );
112 $log->addEntry( 'rights', Title::makeTitle( NS_USER, $u->getName() ), '', array( $this->makeGroupNameList( $oldGroups ),
113 $this->makeGroupNameList( $newGroups ) ) );
116 function makeGroupNameList( $ids ) {
117 return implode( ', ', $ids );
121 * The entry form
122 * It allows a user to look for a username and edit its groups membership
124 function switchForm() {
125 global $wgOut;
127 // user selection
128 $wgOut->addHTML( "<form name=\"uluser\" action=\"$this->action\" method=\"post\">\n" );
129 $wgOut->addHTML( $this->fieldset( 'lookup-user',
130 $this->textbox( 'user-editname' ) .
131 wfElement( 'input', array(
132 'type' => 'submit',
133 'name' => 'ssearchuser',
134 'value' => wfMsg( 'editusergroup' ) ) )
136 $wgOut->addHTML( "</form>\n" );
140 * Edit user groups membership
141 * @param string $username Name of the user.
143 function editUserGroupsForm($username) {
144 global $wgOut, $wgUser;
146 $user = User::newFromName($username);
147 if( is_null( $user ) || $user->getID() == 0 ) {
148 $wgOut->addWikiText( wfMsg( 'nosuchusershort', wfEscapeWikiText( $username ) ) );
149 return;
152 $groups = $user->getGroups();
154 $wgOut->addHTML( "<form name=\"editGroup\" action=\"$this->action\" method=\"post\">\n".
155 wfElement( 'input', array(
156 'type' => 'hidden',
157 'name' => 'user-editname',
158 'value' => $username ) ) .
159 wfElement( 'input', array(
160 'type' => 'hidden',
161 'name' => 'wpEditToken',
162 'value' => $wgUser->editToken( $username ) ) ) .
163 $this->fieldset( 'editusergroup',
164 $wgOut->parse( wfMsg('editing', $username ) ) .
165 '<table border="0" align="center"><tr><td>'.
166 HTMLSelectGroups('member', $this->mName.'-groupsmember', $groups,true,6).
167 '</td><td>'.
168 HTMLSelectGroups('available', $this->mName.'-groupsavailable', $groups,true,6,true).
169 '</td></tr></table>'."\n".
170 $wgOut->parse( wfMsg('userrights-groupshelp') ) .
171 wfElement( 'input', array(
172 'type' => 'submit',
173 'name' => 'saveusergroups',
174 'value' => wfMsg( 'saveusergroups' ) ) )
176 $wgOut->addHTML( "</form>\n" );
178 } // end class UserrightsForm