3 * Implements Special:Userrights
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
25 * Special page to allow managing user group membership
27 * @ingroup SpecialPage
29 class UserrightsPage
extends SpecialPage
{
31 * The target of the local right-adjuster's interest. Can be gotten from
32 * either a GET parameter or a subpage-style parameter, so have a member
34 * @var null|string $mTarget
38 * @var null|User $mFetchedUser The user object of the target username or null.
40 protected $mFetchedUser = null;
41 protected $isself = false;
43 public function __construct() {
44 parent
::__construct( 'Userrights' );
47 public function doesWrites() {
53 * @param bool $checkIfSelf
56 public function userCanChangeRights( $user, $checkIfSelf = true ) {
57 $available = $this->changeableGroups();
58 if ( $user->getId() == 0 ) {
62 return !empty( $available['add'] )
63 ||
!empty( $available['remove'] )
64 ||
( ( $this->isself ||
!$checkIfSelf ) &&
65 ( !empty( $available['add-self'] )
66 ||
!empty( $available['remove-self'] ) ) );
70 * Manage forms to be shown according to posted data.
71 * Depending on the submit button used, call a form or a save function.
73 * @param string|null $par String if any subpage provided, else null
74 * @throws UserBlockedError|PermissionsError
76 public function execute( $par ) {
77 $user = $this->getUser();
78 $request = $this->getRequest();
79 $session = $request->getSession();
80 $out = $this->getOutput();
82 if ( $par !== null ) {
83 $this->mTarget
= $par;
85 $this->mTarget
= $request->getVal( 'user' );
88 if ( is_string( $this->mTarget
) ) {
89 $this->mTarget
= trim( $this->mTarget
);
92 if ( $this->mTarget
!== null && User
::getCanonicalName( $this->mTarget
) === $user->getName() ) {
96 $fetchedStatus = $this->fetchUser( $this->mTarget
, true );
97 if ( $fetchedStatus->isOK() ) {
98 $this->mFetchedUser
= $fetchedStatus->value
;
99 if ( $this->mFetchedUser
instanceof User
) {
100 // Set the 'relevant user' in the skin, so it displays links like Contributions,
101 // User logs, UserRights, etc.
102 $this->getSkin()->setRelevantUser( $this->mFetchedUser
);
106 // show a successbox, if the user rights was saved successfully
108 $session->get( 'specialUserrightsSaveSuccess' ) &&
109 $this->mFetchedUser
!== null
111 // Remove session data for the success message
112 $session->remove( 'specialUserrightsSaveSuccess' );
114 $out->addModules( [ 'mediawiki.special.userrights' ] );
115 $out->addModuleStyles( 'mediawiki.notification.convertmessagebox.styles' );
120 'class' => 'mw-notify-success successbox',
121 'id' => 'mw-preferences-success',
122 'data-mw-autohide' => 'false',
127 $this->msg( 'savedrights', $this->mFetchedUser
->getName() )->text()
134 $this->outputHeader();
136 $out->addModuleStyles( 'mediawiki.special' );
137 $this->addHelpLink( 'Help:Assigning permissions' );
142 $request->wasPosted() &&
143 $request->getCheck( 'saveusergroups' ) &&
144 $this->mTarget
!== null &&
145 $user->matchEditToken( $request->getVal( 'wpEditToken' ), $this->mTarget
)
148 * If the user is blocked and they only have "partial" access
149 * (e.g. they don't have the userrights permission), then don't
150 * allow them to change any user rights.
152 if ( $user->isBlocked() && !$user->isAllowed( 'userrights' ) ) {
153 throw new UserBlockedError( $user->getBlock() );
156 $this->checkReadOnly();
159 if ( !$fetchedStatus->isOK() ) {
160 $this->getOutput()->addWikiText( $fetchedStatus->getWikiText() );
165 $targetUser = $this->mFetchedUser
;
166 if ( $targetUser instanceof User
) { // UserRightsProxy doesn't have this method (bug 61252)
167 $targetUser->clearInstanceCache(); // bug 38989
170 if ( $request->getVal( 'conflictcheck-originalgroups' )
171 !== implode( ',', $targetUser->getGroups() )
173 $out->addWikiMsg( 'userrights-conflict' );
175 $this->saveUserGroups(
177 $request->getVal( 'user-reason' ),
181 // Set session data for the success message
182 $session->set( 'specialUserrightsSaveSuccess', 1 );
184 $out->redirect( $this->getSuccessURL() );
190 // show some more forms
191 if ( $this->mTarget
!== null ) {
192 $this->editUserGroupsForm( $this->mTarget
);
196 function getSuccessURL() {
197 return $this->getPageTitle( $this->mTarget
)->getFullURL();
201 * Save user groups changes in the database.
202 * Data comes from the editUserGroupsForm() form function
204 * @param string $username Username to apply changes to.
205 * @param string $reason Reason for group change
206 * @param User|UserRightsProxy $user Target user object.
209 function saveUserGroups( $username, $reason, $user ) {
210 $allgroups = $this->getAllGroups();
214 // This could possibly create a highly unlikely race condition if permissions are changed between
215 // when the form is loaded and when the form is saved. Ignoring it for the moment.
216 foreach ( $allgroups as $group ) {
217 // We'll tell it to remove all unchecked groups, and add all checked groups.
218 // Later on, this gets filtered for what can actually be removed
219 if ( $this->getRequest()->getCheck( "wpGroup-$group" ) ) {
220 $addgroup[] = $group;
222 $removegroup[] = $group;
226 $this->doSaveUserGroups( $user, $addgroup, $removegroup, $reason );
230 * Save user groups changes in the database.
232 * @param User|UserRightsProxy $user
233 * @param array $add Array of groups to add
234 * @param array $remove Array of groups to remove
235 * @param string $reason Reason for group change
236 * @return array Tuple of added, then removed groups
238 function doSaveUserGroups( $user, $add, $remove, $reason = '' ) {
239 // Validate input set...
240 $isself = $user->getName() == $this->getUser()->getName();
241 $groups = $user->getGroups();
242 $changeable = $this->changeableGroups();
243 $addable = array_merge( $changeable['add'], $isself ?
$changeable['add-self'] : [] );
244 $removable = array_merge( $changeable['remove'], $isself ?
$changeable['remove-self'] : [] );
246 $remove = array_unique(
247 array_intersect( (array)$remove, $removable, $groups ) );
248 $add = array_unique( array_diff(
249 array_intersect( (array)$add, $addable ),
253 $oldGroups = $user->getGroups();
254 $newGroups = $oldGroups;
256 // Remove then add groups
258 foreach ( $remove as $index => $group ) {
259 if ( !$user->removeGroup( $group ) ) {
260 unset( $remove[$index] );
263 $newGroups = array_diff( $newGroups, $remove );
266 foreach ( $add as $index => $group ) {
267 if ( !$user->addGroup( $group ) ) {
268 unset( $add[$index] );
271 $newGroups = array_merge( $newGroups, $add );
273 $newGroups = array_unique( $newGroups );
275 // Ensure that caches are cleared
276 $user->invalidateCache();
278 // update groups in external authentication database
279 Hooks
::run( 'UserGroupsChanged', [ $user, $add, $remove, $this->getUser(), $reason ] );
280 MediaWiki\Auth\AuthManager
::callLegacyAuthPlugin(
281 'updateExternalDBGroups', [ $user, $add, $remove ]
284 wfDebug( 'oldGroups: ' . print_r( $oldGroups, true ) . "\n" );
285 wfDebug( 'newGroups: ' . print_r( $newGroups, true ) . "\n" );
286 // Deprecated in favor of UserGroupsChanged hook
287 Hooks
::run( 'UserRights', [ &$user, $add, $remove ], '1.26' );
289 if ( $newGroups != $oldGroups ) {
290 $this->addLogEntry( $user, $oldGroups, $newGroups, $reason );
293 return [ $add, $remove ];
297 * Add a rights log entry for an action.
299 * @param array $oldGroups
300 * @param array $newGroups
301 * @param array $reason
303 function addLogEntry( $user, $oldGroups, $newGroups, $reason ) {
304 $logEntry = new ManualLogEntry( 'rights', 'rights' );
305 $logEntry->setPerformer( $this->getUser() );
306 $logEntry->setTarget( $user->getUserPage() );
307 $logEntry->setComment( $reason );
308 $logEntry->setParameters( [
309 '4::oldgroups' => $oldGroups,
310 '5::newgroups' => $newGroups,
312 $logid = $logEntry->insert();
313 $logEntry->publish( $logid );
317 * Edit user groups membership
318 * @param string $username Name of the user.
320 function editUserGroupsForm( $username ) {
321 $status = $this->fetchUser( $username, true );
322 if ( !$status->isOK() ) {
323 $this->getOutput()->addWikiText( $status->getWikiText() );
327 $user = $status->value
;
330 $groups = $user->getGroups();
332 $this->showEditUserGroupsForm( $user, $groups );
334 // This isn't really ideal logging behavior, but let's not hide the
335 // interwiki logs if we're using them as is.
336 $this->showLogFragment( $user, $this->getOutput() );
340 * Normalize the input username, which may be local or remote, and
341 * return a user (or proxy) object for manipulating it.
343 * Side effects: error output for invalid access
344 * @param string $username
345 * @param bool $writing
348 public function fetchUser( $username, $writing = true ) {
349 $parts = explode( $this->getConfig()->get( 'UserrightsInterwikiDelimiter' ), $username );
350 if ( count( $parts ) < 2 ) {
351 $name = trim( $username );
354 list( $name, $database ) = array_map( 'trim', $parts );
356 if ( $database == wfWikiID() ) {
359 if ( $writing && !$this->getUser()->isAllowed( 'userrights-interwiki' ) ) {
360 return Status
::newFatal( 'userrights-no-interwiki' );
362 if ( !UserRightsProxy
::validDatabase( $database ) ) {
363 return Status
::newFatal( 'userrights-nodatabase', $database );
368 if ( $name === '' ) {
369 return Status
::newFatal( 'nouserspecified' );
372 if ( $name[0] == '#' ) {
373 // Numeric ID can be specified...
374 // We'll do a lookup for the name internally.
375 $id = intval( substr( $name, 1 ) );
377 if ( $database == '' ) {
378 $name = User
::whoIs( $id );
380 $name = UserRightsProxy
::whoIs( $database, $id );
384 return Status
::newFatal( 'noname' );
387 $name = User
::getCanonicalName( $name );
388 if ( $name === false ) {
390 return Status
::newFatal( 'nosuchusershort', $username );
394 if ( $database == '' ) {
395 $user = User
::newFromName( $name );
397 $user = UserRightsProxy
::newFromName( $database, $name );
400 if ( !$user ||
$user->isAnon() ) {
401 return Status
::newFatal( 'nosuchusershort', $username );
404 return Status
::newGood( $user );
414 public function makeGroupNameList( $ids ) {
415 if ( empty( $ids ) ) {
416 return $this->msg( 'rightsnone' )->inContentLanguage()->text();
418 return implode( ', ', $ids );
423 * Output a form to allow searching for a user
425 function switchForm() {
426 $this->getOutput()->addModules( 'mediawiki.userSuggest' );
428 $this->getOutput()->addHTML(
433 'action' => wfScript(),
435 'id' => 'mw-userrights-form1'
438 Html
::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) .
439 Xml
::fieldset( $this->msg( 'userrights-lookup-user' )->text() ) .
441 $this->msg( 'userrights-user-editname' )->text(),
445 str_replace( '_', ' ', $this->mTarget
),
447 'class' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
449 // Set autofocus on blank input and error input
450 $this->mFetchedUser
=== null ?
[ 'autofocus' => '' ] : []
454 $this->msg( 'editusergroup' )->text()
456 Html
::closeElement( 'fieldset' ) .
457 Html
::closeElement( 'form' ) . "\n"
462 * Go through used and available groups and return the ones that this
463 * form will be able to manipulate based on the current user's system
466 * @param array $groups List of groups the given user is in
467 * @return array Tuple of addable, then removable groups
469 protected function splitGroups( $groups ) {
470 list( $addable, $removable, $addself, $removeself ) = array_values( $this->changeableGroups() );
472 $removable = array_intersect(
473 array_merge( $this->isself ?
$removeself : [], $removable ),
475 ); // Can't remove groups the user doesn't have
476 $addable = array_diff(
477 array_merge( $this->isself ?
$addself : [], $addable ),
479 ); // Can't add groups the user does have
481 return [ $addable, $removable ];
485 * Show the form to edit group memberships.
487 * @param User|UserRightsProxy $user User or UserRightsProxy you're editing
488 * @param array $groups Array of groups the user is in
490 protected function showEditUserGroupsForm( $user, $groups ) {
493 foreach ( $groups as $group ) {
494 $list[] = self
::buildGroupLink( $group );
495 $membersList[] = self
::buildGroupMemberLink( $group );
499 $autoMembersList = [];
500 if ( $user instanceof User
) {
501 foreach ( Autopromote
::getAutopromoteGroups( $user ) as $group ) {
502 $autoList[] = self
::buildGroupLink( $group );
503 $autoMembersList[] = self
::buildGroupMemberLink( $group );
507 $language = $this->getLanguage();
508 $displayedList = $this->msg( 'userrights-groupsmember-type' )
510 $language->listToText( $list ),
511 $language->listToText( $membersList )
513 $displayedAutolist = $this->msg( 'userrights-groupsmember-type' )
515 $language->listToText( $autoList ),
516 $language->listToText( $autoMembersList )
520 $count = count( $list );
522 $grouplist = $this->msg( 'userrights-groupsmember' )
523 ->numParams( $count )
524 ->params( $user->getName() )
526 $grouplist = '<p>' . $grouplist . ' ' . $displayedList . "</p>\n";
529 $count = count( $autoList );
531 $autogrouplistintro = $this->msg( 'userrights-groupsmember-auto' )
532 ->numParams( $count )
533 ->params( $user->getName() )
535 $grouplist .= '<p>' . $autogrouplistintro . ' ' . $displayedAutolist . "</p>\n";
538 $userToolLinks = Linker
::userToolLinks(
541 false, /* default for redContribsWhenNoEdits */
542 Linker
::TOOL_LINKS_EMAIL
/* Add "send e-mail" link */
545 list( $groupCheckboxes, $canChangeAny ) = $this->groupCheckboxes( $groups, $user );
546 $this->getOutput()->addHTML(
551 'action' => $this->getPageTitle()->getLocalURL(),
552 'name' => 'editGroup',
553 'id' => 'mw-userrights-form2'
556 Html
::hidden( 'user', $this->mTarget
) .
557 Html
::hidden( 'wpEditToken', $this->getUser()->getEditToken( $this->mTarget
) ) .
559 'conflictcheck-originalgroups',
560 implode( ',', $user->getGroups() )
561 ) . // Conflict detection
562 Xml
::openElement( 'fieldset' ) .
567 $canChangeAny ?
'userrights-editusergroup' : 'userrights-viewusergroup',
572 $canChangeAny ?
'editinguser' : 'viewinguserrights'
573 )->params( wfEscapeWikiText( $user->getName() ) )
574 ->rawParams( $userToolLinks )->parse()
576 if ( $canChangeAny ) {
577 $this->getOutput()->addHTML(
578 $this->msg( 'userrights-groups-help', $user->getName() )->parse() .
581 Xml
::openElement( 'table', [ 'id' => 'mw-userrights-table-outer' ] ) .
583 <td class='mw-label'>" .
584 Xml
::label( $this->msg( 'userrights-reason' )->text(), 'wpReason' ) .
586 <td class='mw-input'>" .
587 Xml
::input( 'user-reason', 60, $this->getRequest()->getVal( 'user-reason', false ),
588 [ 'id' => 'wpReason', 'maxlength' => 255 ] ) .
593 <td class='mw-submit'>" .
594 Xml
::submitButton( $this->msg( 'saveusergroups', $user->getName() )->text(),
595 [ 'name' => 'saveusergroups' ] +
596 Linker
::tooltipAndAccesskeyAttribs( 'userrights-set' )
600 Xml
::closeElement( 'table' ) . "\n"
603 $this->getOutput()->addHTML( $grouplist );
605 $this->getOutput()->addHTML(
606 Xml
::closeElement( 'fieldset' ) .
607 Xml
::closeElement( 'form' ) . "\n"
612 * Format a link to a group description page
614 * @param string $group
617 private static function buildGroupLink( $group ) {
618 return User
::makeGroupLinkHTML( $group, User
::getGroupName( $group ) );
622 * Format a link to a group member description page
624 * @param string $group
627 private static function buildGroupMemberLink( $group ) {
628 return User
::makeGroupLinkHTML( $group, User
::getGroupMember( $group ) );
632 * Returns an array of all groups that may be edited
633 * @return array Array of groups that may be edited.
635 protected static function getAllGroups() {
636 return User
::getAllGroups();
640 * Adds a table with checkboxes where you can select what groups to add/remove
642 * @todo Just pass the username string?
643 * @param array $usergroups Groups the user belongs to
645 * @return Array with 2 elements: the XHTML table element with checkxboes, and
646 * whether any groups are changeable
648 private function groupCheckboxes( $usergroups, $user ) {
649 $allgroups = $this->getAllGroups();
652 // Put all column info into an associative array so that extensions can
653 // more easily manage it.
654 $columns = [ 'unchangeable' => [], 'changeable' => [] ];
656 foreach ( $allgroups as $group ) {
657 $set = in_array( $group, $usergroups );
658 // Should the checkbox be disabled?
660 ( $set && $this->canRemove( $group ) ) ||
661 ( !$set && $this->canAdd( $group ) ) );
662 // Do we need to point out that this action is irreversible?
663 $irreversible = !$disabled && (
664 ( $set && !$this->canAdd( $group ) ) ||
665 ( !$set && !$this->canRemove( $group ) ) );
669 'disabled' => $disabled,
670 'irreversible' => $irreversible
674 $columns['unchangeable'][$group] = $checkbox;
676 $columns['changeable'][$group] = $checkbox;
680 // Build the HTML table
681 $ret .= Xml
::openElement( 'table', [ 'class' => 'mw-userrights-groups' ] ) .
683 foreach ( $columns as $name => $column ) {
684 if ( $column === [] ) {
687 // Messages: userrights-changeable-col, userrights-unchangeable-col
688 $ret .= Xml
::element(
691 $this->msg( 'userrights-' . $name . '-col', count( $column ) )->text()
695 $ret .= "</tr>\n<tr>\n";
696 foreach ( $columns as $column ) {
697 if ( $column === [] ) {
700 $ret .= "\t<td style='vertical-align:top;'>\n";
701 foreach ( $column as $group => $checkbox ) {
702 $attr = $checkbox['disabled'] ?
[ 'disabled' => 'disabled' ] : [];
704 $member = User
::getGroupMember( $group, $user->getName() );
705 if ( $checkbox['irreversible'] ) {
706 $text = $this->msg( 'userrights-irreversible-marker', $member )->text();
710 $checkboxHtml = Xml
::checkLabel( $text, "wpGroup-" . $group,
711 "wpGroup-" . $group, $checkbox['set'], $attr );
712 $ret .= "\t\t" . ( $checkbox['disabled']
713 ? Xml
::tags( 'span', [ 'class' => 'mw-userrights-disabled' ], $checkboxHtml )
719 $ret .= Xml
::closeElement( 'tr' ) . Xml
::closeElement( 'table' );
721 return [ $ret, (bool)$columns['changeable'] ];
725 * @param string $group The name of the group to check
726 * @return bool Can we remove the group?
728 private function canRemove( $group ) {
729 $groups = $this->changeableGroups();
733 $groups['remove'] ) ||
( $this->isself
&& in_array( $group, $groups['remove-self'] )
738 * @param string $group The name of the group to check
739 * @return bool Can we add the group?
741 private function canAdd( $group ) {
742 $groups = $this->changeableGroups();
746 $groups['add'] ) ||
( $this->isself
&& in_array( $group, $groups['add-self'] )
751 * Returns $this->getUser()->changeableGroups()
753 * @return array Array(
754 * 'add' => array( addablegroups ),
755 * 'remove' => array( removablegroups ),
756 * 'add-self' => array( addablegroups to self ),
757 * 'remove-self' => array( removable groups from self )
760 function changeableGroups() {
761 return $this->getUser()->changeableGroups();
765 * Show a rights log fragment for the specified user
767 * @param User $user User to show log for
768 * @param OutputPage $output OutputPage to use
770 protected function showLogFragment( $user, $output ) {
771 $rightsLogPage = new LogPage( 'rights' );
772 $output->addHTML( Xml
::element( 'h2', null, $rightsLogPage->getName()->text() ) );
773 LogEventsList
::showLogExtract( $output, 'rights', $user->getUserPage() );
777 * Return an array of subpages beginning with $search that this special page will accept.
779 * @param string $search Prefix to search for
780 * @param int $limit Maximum number of results to return (usually 10)
781 * @param int $offset Number of results to skip (usually 0)
782 * @return string[] Matching subpages
784 public function prefixSearchSubpages( $search, $limit, $offset ) {
785 $user = User
::newFromName( $search );
787 // No prefix suggestion for invalid user
790 // Autocomplete subpage as user list - public to allow caching
791 return UserNamePrefixSearch
::search( 'public', $search, $limit, $offset );
794 protected function getGroupName() {