4 * Special page to allow managing user group membership
6 * @addtogroup SpecialPage
10 * A class to manage user levels rights.
11 * @addtogroup SpecialPage
13 class UserrightsPage
extends SpecialPage
{
14 # The target of the local right-adjuster's interest. Can be gotten from
15 # either a GET parameter or a subpage-style parameter, so have a member
18 protected $isself = false;
20 public function __construct() {
21 parent
::__construct( 'Userrights' );
24 public function isRestricted() {
28 public function userCanExecute( $user ) {
29 $available = $this->changeableGroups();
30 return !empty( $available['add'] )
31 or !empty( $available['remove'] )
33 (!empty( $available['add-self'] )
34 or !empty( $available['remove-self'] )));
38 * Manage forms to be shown according to posted data.
39 * Depending on the submit button used, call a form or a save function.
41 * @param mixed $par String if any subpage provided, else null
43 function execute( $par ) {
44 // If the visitor doesn't have permissions to assign or remove
45 // any groups, it's a bit silly to give them the user search prompt.
46 global $wgUser, $wgRequest;
49 $this->mTarget
= $par;
51 $this->mTarget
= $wgRequest->getVal( 'user' );
54 if (!$this->mTarget
) {
56 * If the user specified no target, and they can only
57 * edit their own groups, automatically set them as the
60 $available = $this->changeableGroups();
61 if (empty($available['add']) && empty($available['remove']))
62 $this->mTarget
= $wgUser->getName();
65 if ($this->mTarget
== $wgUser->getName())
68 if( !$this->userCanExecute( $wgUser ) ) {
69 // fixme... there may be intermediate groups we can mention.
71 $wgOut->showPermissionsErrorPage( array(
73 ?
'userrights-nologin'
74 : 'userrights-notallowed' ) );
80 $wgOut->readOnlyPage();
84 $this->outputHeader();
88 // show the general form
91 if( $wgRequest->wasPosted() ) {
93 if( $wgRequest->getCheck( 'saveusergroups' ) ) {
94 $reason = $wgRequest->getVal( 'user-reason' );
95 if( $wgUser->matchEditToken( $wgRequest->getVal( 'wpEditToken' ), $this->mTarget
) ) {
96 $this->saveUserGroups(
104 // show some more forms
105 if( $this->mTarget
) {
106 $this->editUserGroupsForm( $this->mTarget
);
111 * Save user groups changes in the database.
112 * Data comes from the editUserGroupsForm() form function
114 * @param string $username Username to apply changes to.
115 * @param string $reason Reason for group change
118 function saveUserGroups( $username, $reason = '') {
119 global $wgRequest, $wgUser, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
121 $user = $this->fetchUser( $username );
126 $allgroups = $this->getAllGroups();
128 $removegroup = array();
130 // This could possibly create a highly unlikely race condition if permissions are changed between
131 // when the form is loaded and when the form is saved. Ignoring it for the moment.
132 foreach ($allgroups as $group) {
133 // We'll tell it to remove all unchecked groups, and add all checked groups.
134 // Later on, this gets filtered for what can actually be removed
135 if ($wgRequest->getCheck( "wpGroup-$group" )) {
136 $addgroup[] = $group;
138 $removegroup[] = $group;
142 // Validate input set...
143 $changeable = $this->changeableGroups();
144 if ($wgUser->getId() != 0 && $wgUser->getId() == $user->getId()) {
145 $addable = array_merge($changeable['add'], $wgGroupsAddToSelf);
146 $removable = array_merge($changeable['remove'], $wgGroupsRemoveFromSelf);
148 $addable = $changeable['add'];
149 $removable = $changeable['remove'];
152 $removegroup = array_unique(
153 array_intersect( (array)$removegroup, $removable ) );
154 $addgroup = array_unique(
155 array_intersect( (array)$addgroup, $addable ) );
157 $oldGroups = $user->getGroups();
158 $newGroups = $oldGroups;
159 // remove then add groups
161 $newGroups = array_diff($newGroups, $removegroup);
162 foreach( $removegroup as $group ) {
163 $user->removeGroup( $group );
167 $newGroups = array_merge($newGroups, $addgroup);
168 foreach( $addgroup as $group ) {
169 $user->addGroup( $group );
172 $newGroups = array_unique( $newGroups );
174 // Ensure that caches are cleared
175 $user->invalidateCache();
177 wfDebug( 'oldGroups: ' . print_r( $oldGroups, true ) );
178 wfDebug( 'newGroups: ' . print_r( $newGroups, true ) );
179 if( $user instanceof User
) {
181 wfRunHooks( 'UserRights', array( &$user, $addgroup, $removegroup ) );
184 if( $newGroups != $oldGroups ) {
185 $this->addLogEntry( $user, $oldGroups, $newGroups );
190 * Add a rights log entry for an action.
192 function addLogEntry( $user, $oldGroups, $newGroups ) {
193 $log = new LogPage( 'rights' );
195 $log->addEntry( 'rights',
196 $user->getUserPage(),
197 $wgRequest->getText( 'user-reason' ),
199 $this->makeGroupNameList( $oldGroups ),
200 $this->makeGroupNameList( $newGroups )
206 * Edit user groups membership
207 * @param string $username Name of the user.
209 function editUserGroupsForm( $username ) {
212 $user = $this->fetchUser( $username );
217 $groups = $user->getGroups();
219 $this->showEditUserGroupsForm( $user, $groups );
221 // This isn't really ideal logging behavior, but let's not hide the
222 // interwiki logs if we're using them as is.
223 $this->showLogFragment( $user, $wgOut );
227 * Normalize the input username, which may be local or remote, and
228 * return a user (or proxy) object for manipulating it.
230 * Side effects: error output for invalid access
231 * @return mixed User, UserRightsProxy, or null
233 function fetchUser( $username ) {
234 global $wgOut, $wgUser;
236 $parts = explode( '@', $username );
237 if( count( $parts ) < 2 ) {
238 $name = trim( $username );
241 list( $name, $database ) = array_map( 'trim', $parts );
243 if( !$wgUser->isAllowed( 'userrights-interwiki' ) ) {
244 $wgOut->addWikiMsg( 'userrights-no-interwiki' );
247 if( !UserRightsProxy
::validDatabase( $database ) ) {
248 $wgOut->addWikiMsg( 'userrights-nodatabase', $database );
254 $wgOut->addWikiMsg( 'nouserspecified' );
258 if( $name{0} == '#' ) {
259 // Numeric ID can be specified...
260 // We'll do a lookup for the name internally.
261 $id = intval( substr( $name, 1 ) );
263 if( $database == '' ) {
264 $name = User
::whoIs( $id );
266 $name = UserRightsProxy
::whoIs( $database, $id );
270 $wgOut->addWikiMsg( 'noname' );
275 if( $database == '' ) {
276 $user = User
::newFromName( $name );
278 $user = UserRightsProxy
::newFromName( $database, $name );
281 if( !$user ||
$user->isAnon() ) {
282 $wgOut->addWikiMsg( 'nosuchusershort', $username );
289 function makeGroupNameList( $ids ) {
290 return implode( ', ', $ids );
294 * Output a form to allow searching for a user
296 function switchForm() {
297 global $wgOut, $wgScript;
299 Xml
::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript, 'name' => 'uluser', 'id' => 'mw-userrights-form1' ) ) .
300 Xml
::hidden( 'title', $this->getTitle() ) .
301 Xml
::openElement( 'fieldset' ) .
302 Xml
::element( 'legend', array(), wfMsg( 'userrights-lookup-user' ) ) .
303 Xml
::inputLabel( wfMsg( 'userrights-user-editname' ), 'user', 'username', 30, $this->mTarget
) . ' ' .
304 Xml
::submitButton( wfMsg( 'editusergroup' ) ) .
305 Xml
::closeElement( 'fieldset' ) .
306 Xml
::closeElement( 'form' ) . "\n"
311 * Go through used and available groups and return the ones that this
312 * form will be able to manipulate based on the current user's system
315 * @param $groups Array: list of groups the given user is in
316 * @return Array: Tuple of addable, then removable groups
318 protected function splitGroups( $groups ) {
319 global $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
320 list($addable, $removable) = array_values( $this->changeableGroups() );
322 $removable = array_intersect(
323 array_merge($this->isself ?
$wgGroupsRemoveFromSelf : array(), $removable),
324 $groups ); // Can't remove groups the user doesn't have
325 $addable = array_diff(
326 array_merge($this->isself ?
$wgGroupsAddToSelf : array(), $addable),
327 $groups ); // Can't add groups the user does have
329 return array( $addable, $removable );
333 * Show the form to edit group memberships.
335 * @param $user User or UserRightsProxy you're editing
336 * @param $groups Array: Array of groups the user is in
338 protected function showEditUserGroupsForm( $user, $groups ) {
339 global $wgOut, $wgUser;
341 list( $addable, $removable ) = $this->splitGroups( $groups );
344 foreach( $user->getGroups() as $group )
345 $list[] = self
::buildGroupLink( $group );
348 if( count( $list ) > 0 ) {
349 $grouplist = Xml
::tags( 'p', null, wfMsgHtml( 'userrights-groupsmember' ) . ' ' . implode( ', ', $list ) );
352 Xml
::openElement( 'form', array( 'method' => 'post', 'action' => $this->getTitle()->getLocalURL(), 'name' => 'editGroup', 'id' => 'mw-userrights-form2' ) ) .
353 Xml
::hidden( 'user', $this->mTarget
) .
354 Xml
::hidden( 'wpEditToken', $wgUser->editToken( $this->mTarget
) ) .
355 Xml
::openElement( 'fieldset' ) .
356 Xml
::element( 'legend', array(), wfMsg( 'userrights-editusergroup' ) ) .
357 wfMsgExt( 'editinguser', array( 'parse' ), wfEscapeWikiText( $user->getName() ) ) .
359 Xml
::tags( 'p', null, $this->groupCheckboxes( $groups ) ) .
360 Xml
::openElement( 'table', array( 'border' => '0', 'id' => 'mw-userrights-table-outer' ) ) .
363 $wgOut->parse( wfMsg( 'userrights-groups-help' ) ) .
367 <td class='mw-label'>" .
368 Xml
::label( wfMsg( 'userrights-reason' ), 'wpReason' ) .
370 <td class='mw-input'>" .
371 Xml
::input( 'user-reason', 60, false, array( 'id' => 'wpReason', 'maxlength' => 255 ) ) .
376 <td class='mw-submit'>" .
377 Xml
::submitButton( wfMsg( 'saveusergroups' ), array( 'name' => 'saveusergroups' ) ) .
380 Xml
::closeElement( 'table' ) . "\n" .
381 Xml
::closeElement( 'fieldset' ) .
382 Xml
::closeElement( 'form' ) . "\n"
387 * Format a link to a group description page
389 * @param string $group
392 private static function buildGroupLink( $group ) {
393 static $cache = array();
394 if( !isset( $cache[$group] ) )
395 $cache[$group] = User
::makeGroupLinkHtml( $group, User
::getGroupName( $group ) );
396 return $cache[$group];
400 * Returns an array of all groups that may be edited
401 * @return array Array of groups that may be edited.
403 protected static function getAllGroups() {
404 return User
::getAllGroups();
408 * Adds the <select> thingie where you can select what groups to add/remove
410 * @param array $groups The groups that can be added/removed
411 * @param string $name 'removable' or 'available'
412 * @return string XHTML <select> element
414 private function groupCheckboxes( $usergroups ) {
415 $allgroups = $this->getAllGroups();
420 $unsettable_col = '';
422 foreach ($allgroups as $group) {
423 $set = in_array( $group, $usergroups );
424 # Should the checkbox be disabled?
426 ( $set && $this->canRemove( $group ) ) ||
427 ( !$set && $this->canAdd( $group ) ) );
428 # Do we need to point out that this action is irreversible?
429 $irreversible = !$disabled && (
430 ($set && !$this->canAdd( $group )) ||
431 (!$set && !$this->canRemove( $group ) ) );
433 $attr = $disabled ?
array( 'disabled' => 'disabled' ) : array();
434 $text = $irreversible
435 ?
wfMsgHtml( 'userrights-irreversible-marker', User
::getGroupMember( $group ) )
436 : User
::getGroupMember( $group );
437 $checkbox = Xml
::checkLabel( $text, "wpGroup-$group",
438 "wpGroup-$group", $set, $attr );
439 $checkbox = $disabled ? Xml
::tags( 'span', array( 'class' => 'mw-userrights-disabled' ), $checkbox ) : $checkbox;
442 $unsettable_col .= "$checkbox<br/>\n";
444 $settable_col .= "$checkbox<br/>\n";
449 $ret .= Xml
::openElement( 'table', array( 'border' => '0', 'class' => 'mw-userrights-groups' ) ) .
452 if( $settable_col !== '' ) {
453 $ret .= xml
::element( 'th', null, wfMsg( 'userrights-changeable-col' ) );
455 if( $unsettable_col !== '' ) {
456 $ret .= xml
::element( 'th', null, wfMsg( 'userrights-unchangeable-col' ) );
461 if( $settable_col !== '' ) {
463 " <td style='vertical-align:top;'>
468 if( $unsettable_col !== '' ) {
470 " <td style='vertical-align:top;'>
475 $ret .= Xml
::closeElement( 'tr' ) . Xml
::closeElement( 'table' );
482 * @param string $group The name of the group to check
483 * @return bool Can we remove the group?
485 private function canRemove( $group ) {
486 // $this->changeableGroups()['remove'] doesn't work, of course. Thanks,
488 $groups = $this->changeableGroups();
489 return in_array( $group, $groups['remove'] ) ||
($this->isself
&& in_array( $group, $groups['remove-self'] ));
493 * @param string $group The name of the group to check
494 * @return bool Can we add the group?
496 private function canAdd( $group ) {
497 $groups = $this->changeableGroups();
498 return in_array( $group, $groups['add'] ) ||
($this->isself
&& in_array( $group, $groups['add-self'] ));
502 * Returns an array of the groups that the user can add/remove.
504 * @return Array array( 'add' => array( addablegroups ), 'remove' => array( removablegroups ) )
506 function changeableGroups() {
507 global $wgUser, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
509 if( $wgUser->isAllowed( 'userrights' ) ) {
510 // This group gives the right to modify everything (reverse-
511 // compatibility with old "userrights lets you change
513 // Using array_merge to make the groups reindexed
514 $all = array_merge( User
::getAllGroups() );
518 'add-self' => array(),
519 'remove-self' => array()
523 // Okay, it's not so simple, we will have to go through the arrays
527 'add-self' => $wgGroupsAddToSelf,
528 'remove-self' => $wgGroupsRemoveFromSelf);
529 $addergroups = $wgUser->getEffectiveGroups();
531 foreach ($addergroups as $addergroup) {
532 $groups = array_merge_recursive(
533 $groups, $this->changeableByGroup($addergroup)
535 $groups['add'] = array_unique( $groups['add'] );
536 $groups['remove'] = array_unique( $groups['remove'] );
542 * Returns an array of the groups that a particular group can add/remove.
544 * @param String $group The group to check for whether it can add/remove
545 * @return Array array( 'add' => array( addablegroups ), 'remove' => array( removablegroups ) )
547 private function changeableByGroup( $group ) {
548 global $wgAddGroups, $wgRemoveGroups;
550 $groups = array( 'add' => array(), 'remove' => array() );
551 if( empty($wgAddGroups[$group]) ) {
552 // Don't add anything to $groups
553 } elseif( $wgAddGroups[$group] === true ) {
554 // You get everything
555 $groups['add'] = User
::getAllGroups();
556 } elseif( is_array($wgAddGroups[$group]) ) {
557 $groups['add'] = $wgAddGroups[$group];
560 // Same thing for remove
561 if( empty($wgRemoveGroups[$group]) ) {
562 } elseif($wgRemoveGroups[$group] === true ) {
563 $groups['remove'] = User
::getAllGroups();
564 } elseif( is_array($wgRemoveGroups[$group]) ) {
565 $groups['remove'] = $wgRemoveGroups[$group];
571 * Show a rights log fragment for the specified user
573 * @param User $user User to show log for
574 * @param OutputPage $output OutputPage to use
576 protected function showLogFragment( $user, $output ) {
577 $output->addHtml( Xml
::element( 'h2', null, LogPage
::logName( 'rights' ) . "\n" ) );
578 LogEventsList
::showLogExtract( $output, 'rights', $user->getUserPage()->getPrefixedText() );