includes/specials/SpecialUserrights.php

   1 <?php
   2 /**
   3  * Implements Special:Userrights
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 /**
  25  * Special page to allow managing user group membership
  26  *
  27  * @ingroup SpecialPage
  28  */
  29 class UserrightsPage extends SpecialPage {
  30         /**
  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
  33          * variable for it.
  34          * @var null|string $mTarget
  35          */
  36         protected $mTarget;
  37         /*
  38          * @var null|User $mFetchedUser The user object of the target username or null.
  39          */
  40         protected $mFetchedUser = null;
  41         protected $isself = false;
  42
  43         public function __construct() {
  44                 parent::__construct( 'Userrights' );
  45         }
  46
  47         public function doesWrites() {
  48                 return true;
  49         }
  50
  51         /**
  52          * Check whether the current user (from context) can change the target user's rights.
  53          *
  54          * @param User $targetUser User whose rights are being changed
  55          * @param bool $checkIfSelf If false, assume that the current user can add/remove groups defined
  56          *   in $wgGroupsAddToSelf / $wgGroupsRemoveFromSelf, without checking if it's the same as target
  57          *   user
  58          * @return bool
  59          */
  60         public function userCanChangeRights( $targetUser, $checkIfSelf = true ) {
  61                 $isself = $this->getUser()->equals( $targetUser );
  62
  63                 $available = $this->changeableGroups();
  64                 if ( $targetUser->getId() == 0 ) {
  65                         return false;
  66                 }
  67
  68                 return !empty( $available['add'] )
  69                         || !empty( $available['remove'] )
  70                         || ( ( $isself || !$checkIfSelf ) &&
  71                                 ( !empty( $available['add-self'] )
  72                                         || !empty( $available['remove-self'] ) ) );
  73         }
  74
  75         /**
  76          * Manage forms to be shown according to posted data.
  77          * Depending on the submit button used, call a form or a save function.
  78          *
  79          * @param string|null $par String if any subpage provided, else null
  80          * @throws UserBlockedError|PermissionsError
  81          */
  82         public function execute( $par ) {
  83                 $user = $this->getUser();
  84                 $request = $this->getRequest();
  85                 $session = $request->getSession();
  86                 $out = $this->getOutput();
  87
  88                 $out->addModules( [ 'mediawiki.special.userrights' ] );
  89
  90                 $this->mTarget = $par ?? $request->getVal( 'user' );
  91
  92                 if ( is_string( $this->mTarget ) ) {
  93                         $this->mTarget = trim( $this->mTarget );
  94                 }
  95
  96                 if ( $this->mTarget !== null && User::getCanonicalName( $this->mTarget ) === $user->getName() ) {
  97                         $this->isself = true;
  98                 }
  99
 100                 $fetchedStatus = $this->fetchUser( $this->mTarget, true );
 101                 if ( $fetchedStatus->isOK() ) {
 102                         $this->mFetchedUser = $fetchedStatus->value;
 103                         if ( $this->mFetchedUser instanceof User ) {
 104                                 // Set the 'relevant user' in the skin, so it displays links like Contributions,
 105                                 // User logs, UserRights, etc.
 106                                 $this->getSkin()->setRelevantUser( $this->mFetchedUser );
 107                         }
 108                 }
 109
 110                 // show a successbox, if the user rights was saved successfully
 111                 if (
 112                         $session->get( 'specialUserrightsSaveSuccess' ) &&
 113                         $this->mFetchedUser !== null
 114                 ) {
 115                         // Remove session data for the success message
 116                         $session->remove( 'specialUserrightsSaveSuccess' );
 117
 118                         $out->addModuleStyles( 'mediawiki.notification.convertmessagebox.styles' );
 119                         $out->addHTML(
 120                                 Html::rawElement(
 121                                         'div',
 122                                         [
 123                                                 'class' => 'mw-notify-success successbox',
 124                                                 'id' => 'mw-preferences-success',
 125                                                 'data-mw-autohide' => 'false',
 126                                         ],
 127                                         Html::element(
 128                                                 'p',
 129                                                 [],
 130                                                 $this->msg( 'savedrights', $this->mFetchedUser->getName() )->text()
 131                                         )
 132                                 )
 133                         );
 134                 }
 135
 136                 $this->setHeaders();
 137                 $this->outputHeader();
 138
 139                 $out->addModuleStyles( 'mediawiki.special' );
 140                 $this->addHelpLink( 'Help:Assigning permissions' );
 141
 142                 $this->switchForm();
 143
 144                 if (
 145                         $request->wasPosted() &&
 146                         $request->getCheck( 'saveusergroups' ) &&
 147                         $this->mTarget !== null &&
 148                         $user->matchEditToken( $request->getVal( 'wpEditToken' ), $this->mTarget )
 149                 ) {
 150                         /*
 151                         * If the user is blocked and they only have "partial" access
 152                         * (e.g. they don't have the userrights permission), then don't
 153                         * allow them to change any user rights.
 154                         */
 155                         if ( $user->isBlocked() && !$user->isAllowed( 'userrights' ) ) {
 156                                 throw new UserBlockedError( $user->getBlock() );
 157                         }
 158
 159                         $this->checkReadOnly();
 160
 161                         // save settings
 162                         if ( !$fetchedStatus->isOK() ) {
 163                                 $this->getOutput()->addWikiTextAsInterface( $fetchedStatus->getWikiText() );
 164
 165                                 return;
 166                         }
 167
 168                         $targetUser = $this->mFetchedUser;
 169                         if ( $targetUser instanceof User ) { // UserRightsProxy doesn't have this method (T63252)
 170                                 $targetUser->clearInstanceCache(); // T40989
 171                         }
 172
 173                         $conflictCheck = $request->getVal( 'conflictcheck-originalgroups' );
 174                         $conflictCheck = ( $conflictCheck === '' ) ? [] : explode( ',', $conflictCheck );
 175                         $userGroups = $targetUser->getGroups();
 176
 177                         if ( $userGroups !== $conflictCheck ) {
 178                                 $out->wrapWikiMsg( '<span class="error">$1</span>', 'userrights-conflict' );
 179                         } else {
 180                                 $status = $this->saveUserGroups(
 181                                         $this->mTarget,
 182                                         $request->getVal( 'user-reason' ),
 183                                         $targetUser
 184                                 );
 185
 186                                 if ( $status->isOK() ) {
 187                                         // Set session data for the success message
 188                                         $session->set( 'specialUserrightsSaveSuccess', 1 );
 189
 190                                         $out->redirect( $this->getSuccessURL() );
 191                                         return;
 192                                 } else {
 193                                         // Print an error message and redisplay the form
 194                                         $out->wrapWikiTextAsInterface( 'error', $status->getWikiText() );
 195                                 }
 196                         }
 197                 }
 198
 199                 // show some more forms
 200                 if ( $this->mTarget !== null ) {
 201                         $this->editUserGroupsForm( $this->mTarget );
 202                 }
 203         }
 204
 205         function getSuccessURL() {
 206                 return $this->getPageTitle( $this->mTarget )->getFullURL();
 207         }
 208
 209         /**
 210          * Returns true if this user rights form can set and change user group expiries.
 211          * Subclasses may wish to override this to return false.
 212          *
 213          * @return bool
 214          */
 215         public function canProcessExpiries() {
 216                 return true;
 217         }
 218
 219         /**
 220          * Converts a user group membership expiry string into a timestamp. Words like
 221          * 'existing' or 'other' should have been filtered out before calling this
 222          * function.
 223          *
 224          * @param string $expiry
 225          * @return string|null|false A string containing a valid timestamp, or null
 226          *   if the expiry is infinite, or false if the timestamp is not valid
 227          */
 228         public static function expiryToTimestamp( $expiry ) {
 229                 if ( wfIsInfinity( $expiry ) ) {
 230                         return null;
 231                 }
 232
 233                 $unix = strtotime( $expiry );
 234
 235                 if ( !$unix || $unix === -1 ) {
 236                         return false;
 237                 }
 238
 239                 // @todo FIXME: Non-qualified absolute times are not in users specified timezone
 240                 // and there isn't notice about it in the ui (see ProtectionForm::getExpiry)
 241                 return wfTimestamp( TS_MW, $unix );
 242         }
 243
 244         /**
 245          * Save user groups changes in the database.
 246          * Data comes from the editUserGroupsForm() form function
 247          *
 248          * @param string $username Username to apply changes to.
 249          * @param string $reason Reason for group change
 250          * @param User|UserRightsProxy $user Target user object.
 251          * @return Status
 252          */
 253         protected function saveUserGroups( $username, $reason, $user ) {
 254                 $allgroups = $this->getAllGroups();
 255                 $addgroup = [];
 256                 $groupExpiries = []; // associative array of (group name => expiry)
 257                 $removegroup = [];
 258                 $existingUGMs = $user->getGroupMemberships();
 259
 260                 // This could possibly create a highly unlikely race condition if permissions are changed between
 261                 //  when the form is loaded and when the form is saved. Ignoring it for the moment.
 262                 foreach ( $allgroups as $group ) {
 263                         // We'll tell it to remove all unchecked groups, and add all checked groups.
 264                         // Later on, this gets filtered for what can actually be removed
 265                         if ( $this->getRequest()->getCheck( "wpGroup-$group" ) ) {
 266                                 $addgroup[] = $group;
 267
 268                                 if ( $this->canProcessExpiries() ) {
 269                                         // read the expiry information from the request
 270                                         $expiryDropdown = $this->getRequest()->getVal( "wpExpiry-$group" );
 271                                         if ( $expiryDropdown === 'existing' ) {
 272                                                 continue;
 273                                         }
 274
 275                                         if ( $expiryDropdown === 'other' ) {
 276                                                 $expiryValue = $this->getRequest()->getVal( "wpExpiry-$group-other" );
 277                                         } else {
 278                                                 $expiryValue = $expiryDropdown;
 279                                         }
 280
 281                                         // validate the expiry
 282                                         $groupExpiries[$group] = self::expiryToTimestamp( $expiryValue );
 283
 284                                         if ( $groupExpiries[$group] === false ) {
 285                                                 return Status::newFatal( 'userrights-invalid-expiry', $group );
 286                                         }
 287
 288                                         // not allowed to have things expiring in the past
 289                                         if ( $groupExpiries[$group] && $groupExpiries[$group] < wfTimestampNow() ) {
 290                                                 return Status::newFatal( 'userrights-expiry-in-past', $group );
 291                                         }
 292
 293                                         // if the user can only add this group (not remove it), the expiry time
 294                                         // cannot be brought forward (T156784)
 295                                         if ( !$this->canRemove( $group ) &&
 296                                                 isset( $existingUGMs[$group] ) &&
 297                                                 ( $existingUGMs[$group]->getExpiry() ?: 'infinity' ) >
 298                                                         ( $groupExpiries[$group] ?: 'infinity' )
 299                                         ) {
 300                                                 return Status::newFatal( 'userrights-cannot-shorten-expiry', $group );
 301                                         }
 302                                 }
 303                         } else {
 304                                 $removegroup[] = $group;
 305                         }
 306                 }
 307
 308                 $this->doSaveUserGroups( $user, $addgroup, $removegroup, $reason, [], $groupExpiries );
 309
 310                 return Status::newGood();
 311         }
 312
 313         /**
 314          * Save user groups changes in the database. This function does not throw errors;
 315          * instead, it ignores groups that the performer does not have permission to set.
 316          *
 317          * @param User|UserRightsProxy $user
 318          * @param array $add Array of groups to add
 319          * @param array $remove Array of groups to remove
 320          * @param string $reason Reason for group change
 321          * @param array $tags Array of change tags to add to the log entry
 322          * @param array $groupExpiries Associative array of (group name => expiry),
 323          *   containing only those groups that are to have new expiry values set
 324          * @return array Tuple of added, then removed groups
 325          */
 326         function doSaveUserGroups( $user, array $add, array $remove, $reason = '',
 327                 array $tags = [], array $groupExpiries = []
 328         ) {
 329                 // Validate input set...
 330                 $isself = $user->getName() == $this->getUser()->getName();
 331                 $groups = $user->getGroups();
 332                 $ugms = $user->getGroupMemberships();
 333                 $changeable = $this->changeableGroups();
 334                 $addable = array_merge( $changeable['add'], $isself ? $changeable['add-self'] : [] );
 335                 $removable = array_merge( $changeable['remove'], $isself ? $changeable['remove-self'] : [] );
 336
 337                 $remove = array_unique(
 338                         array_intersect( (array)$remove, $removable, $groups ) );
 339                 $add = array_intersect( (array)$add, $addable );
 340
 341                 // add only groups that are not already present or that need their expiry updated,
 342                 // UNLESS the user can only add this group (not remove it) and the expiry time
 343                 // is being brought forward (T156784)
 344                 $add = array_filter( $add,
 345                         function ( $group ) use ( $groups, $groupExpiries, $removable, $ugms ) {
 346                                 if ( isset( $groupExpiries[$group] ) &&
 347                                         !in_array( $group, $removable ) &&
 348                                         isset( $ugms[$group] ) &&
 349                                         ( $ugms[$group]->getExpiry() ?: 'infinity' ) >
 350                                                 ( $groupExpiries[$group] ?: 'infinity' )
 351                                 ) {
 352                                         return false;
 353                                 }
 354                                 return !in_array( $group, $groups ) || array_key_exists( $group, $groupExpiries );
 355                         } );
 356
 357                 Hooks::run( 'ChangeUserGroups', [ $this->getUser(), $user, &$add, &$remove ] );
 358
 359                 $oldGroups = $groups;
 360                 $oldUGMs = $user->getGroupMemberships();
 361                 $newGroups = $oldGroups;
 362
 363                 // Remove groups, then add new ones/update expiries of existing ones
 364                 if ( $remove ) {
 365                         foreach ( $remove as $index => $group ) {
 366                                 if ( !$user->removeGroup( $group ) ) {
 367                                         unset( $remove[$index] );
 368                                 }
 369                         }
 370                         $newGroups = array_diff( $newGroups, $remove );
 371                 }
 372                 if ( $add ) {
 373                         foreach ( $add as $index => $group ) {
 374                                 $expiry = $groupExpiries[$group] ?? null;
 375                                 if ( !$user->addGroup( $group, $expiry ) ) {
 376                                         unset( $add[$index] );
 377                                 }
 378                         }
 379                         $newGroups = array_merge( $newGroups, $add );
 380                 }
 381                 $newGroups = array_unique( $newGroups );
 382                 $newUGMs = $user->getGroupMemberships();
 383
 384                 // Ensure that caches are cleared
 385                 $user->invalidateCache();
 386
 387                 // update groups in external authentication database
 388                 Hooks::run( 'UserGroupsChanged', [ $user, $add, $remove, $this->getUser(),
 389                         $reason, $oldUGMs, $newUGMs ] );
 390                 MediaWiki\Auth\AuthManager::callLegacyAuthPlugin(
 391                         'updateExternalDBGroups', [ $user, $add, $remove ]
 392                 );
 393
 394                 wfDebug( 'oldGroups: ' . print_r( $oldGroups, true ) . "\n" );
 395                 wfDebug( 'newGroups: ' . print_r( $newGroups, true ) . "\n" );
 396                 wfDebug( 'oldUGMs: ' . print_r( $oldUGMs, true ) . "\n" );
 397                 wfDebug( 'newUGMs: ' . print_r( $newUGMs, true ) . "\n" );
 398                 // Deprecated in favor of UserGroupsChanged hook
 399                 Hooks::run( 'UserRights', [ &$user, $add, $remove ], '1.26' );
 400
 401                 // Only add a log entry if something actually changed
 402                 if ( $newGroups != $oldGroups || $newUGMs != $oldUGMs ) {
 403                         $this->addLogEntry( $user, $oldGroups, $newGroups, $reason, $tags, $oldUGMs, $newUGMs );
 404                 }
 405
 406                 return [ $add, $remove ];
 407         }
 408
 409         /**
 410          * Serialise a UserGroupMembership object for storage in the log_params section
 411          * of the logging table. Only keeps essential data, removing redundant fields.
 412          *
 413          * @param UserGroupMembership|null $ugm May be null if things get borked
 414          * @return array
 415          */
 416         protected static function serialiseUgmForLog( $ugm ) {
 417                 if ( !$ugm instanceof UserGroupMembership ) {
 418                         return null;
 419                 }
 420                 return [ 'expiry' => $ugm->getExpiry() ];
 421         }
 422
 423         /**
 424          * Add a rights log entry for an action.
 425          * @param User|UserRightsProxy $user
 426          * @param array $oldGroups
 427          * @param array $newGroups
 428          * @param string $reason
 429          * @param array $tags Change tags for the log entry
 430          * @param array $oldUGMs Associative array of (group name => UserGroupMembership)
 431          * @param array $newUGMs Associative array of (group name => UserGroupMembership)
 432          */
 433         protected function addLogEntry( $user, array $oldGroups, array $newGroups, $reason,
 434                 array $tags, array $oldUGMs, array $newUGMs
 435         ) {
 436                 // make sure $oldUGMs and $newUGMs are in the same order, and serialise
 437                 // each UGM object to a simplified array
 438                 $oldUGMs = array_map( function ( $group ) use ( $oldUGMs ) {
 439                         return isset( $oldUGMs[$group] ) ?
 440                                 self::serialiseUgmForLog( $oldUGMs[$group] ) :
 441                                 null;
 442                 }, $oldGroups );
 443                 $newUGMs = array_map( function ( $group ) use ( $newUGMs ) {
 444                         return isset( $newUGMs[$group] ) ?
 445                                 self::serialiseUgmForLog( $newUGMs[$group] ) :
 446                                 null;
 447                 }, $newGroups );
 448
 449                 $logEntry = new ManualLogEntry( 'rights', 'rights' );
 450                 $logEntry->setPerformer( $this->getUser() );
 451                 $logEntry->setTarget( $user->getUserPage() );
 452                 $logEntry->setComment( $reason );
 453                 $logEntry->setParameters( [
 454                         '4::oldgroups' => $oldGroups,
 455                         '5::newgroups' => $newGroups,
 456                         'oldmetadata' => $oldUGMs,
 457                         'newmetadata' => $newUGMs,
 458                 ] );
 459                 $logid = $logEntry->insert();
 460                 if ( count( $tags ) ) {
 461                         $logEntry->setTags( $tags );
 462                 }
 463                 $logEntry->publish( $logid );
 464         }
 465
 466         /**
 467          * Edit user groups membership
 468          * @param string $username Name of the user.
 469          */
 470         function editUserGroupsForm( $username ) {
 471                 $status = $this->fetchUser( $username, true );
 472                 if ( !$status->isOK() ) {
 473                         $this->getOutput()->addWikiTextAsInterface( $status->getWikiText() );
 474
 475                         return;
 476                 } else {
 477                         $user = $status->value;
 478                 }
 479
 480                 $groups = $user->getGroups();
 481                 $groupMemberships = $user->getGroupMemberships();
 482                 $this->showEditUserGroupsForm( $user, $groups, $groupMemberships );
 483
 484                 // This isn't really ideal logging behavior, but let's not hide the
 485                 // interwiki logs if we're using them as is.
 486                 $this->showLogFragment( $user, $this->getOutput() );
 487         }
 488
 489         /**
 490          * Normalize the input username, which may be local or remote, and
 491          * return a user (or proxy) object for manipulating it.
 492          *
 493          * Side effects: error output for invalid access
 494          * @param string $username
 495          * @param bool $writing
 496          * @return Status
 497          */
 498         public function fetchUser( $username, $writing = true ) {
 499                 $parts = explode( $this->getConfig()->get( 'UserrightsInterwikiDelimiter' ), $username );
 500                 if ( count( $parts ) < 2 ) {
 501                         $name = trim( $username );
 502                         $wikiId = '';
 503                 } else {
 504                         list( $name, $wikiId ) = array_map( 'trim', $parts );
 505
 506                         if ( WikiMap::isCurrentWikiId( $wikiId ) ) {
 507                                 $wikiId = '';
 508                         } else {
 509                                 if ( $writing && !$this->getUser()->isAllowed( 'userrights-interwiki' ) ) {
 510                                         return Status::newFatal( 'userrights-no-interwiki' );
 511                                 }
 512                                 if ( !UserRightsProxy::validDatabase( $wikiId ) ) {
 513                                         return Status::newFatal( 'userrights-nodatabase', $wikiId );
 514                                 }
 515                         }
 516                 }
 517
 518                 if ( $name === '' ) {
 519                         return Status::newFatal( 'nouserspecified' );
 520                 }
 521
 522                 if ( $name[0] == '#' ) {
 523                         // Numeric ID can be specified...
 524                         // We'll do a lookup for the name internally.
 525                         $id = intval( substr( $name, 1 ) );
 526
 527                         if ( $wikiId == '' ) {
 528                                 $name = User::whoIs( $id );
 529                         } else {
 530                                 $name = UserRightsProxy::whoIs( $wikiId, $id );
 531                         }
 532
 533                         if ( !$name ) {
 534                                 return Status::newFatal( 'noname' );
 535                         }
 536                 } else {
 537                         $name = User::getCanonicalName( $name );
 538                         if ( $name === false ) {
 539                                 // invalid name
 540                                 return Status::newFatal( 'nosuchusershort', $username );
 541                         }
 542                 }
 543
 544                 if ( $wikiId == '' ) {
 545                         $user = User::newFromName( $name );
 546                 } else {
 547                         $user = UserRightsProxy::newFromName( $wikiId, $name );
 548                 }
 549
 550                 if ( !$user || $user->isAnon() ) {
 551                         return Status::newFatal( 'nosuchusershort', $username );
 552                 }
 553
 554                 return Status::newGood( $user );
 555         }
 556
 557         /**
 558          * @since 1.15
 559          *
 560          * @param array $ids
 561          *
 562          * @return string
 563          */
 564         public function makeGroupNameList( $ids ) {
 565                 if ( empty( $ids ) ) {
 566                         return $this->msg( 'rightsnone' )->inContentLanguage()->text();
 567                 } else {
 568                         return implode( ', ', $ids );
 569                 }
 570         }
 571
 572         /**
 573          * Output a form to allow searching for a user
 574          */
 575         function switchForm() {
 576                 $this->getOutput()->addModules( 'mediawiki.userSuggest' );
 577
 578                 $this->getOutput()->addHTML(
 579                         Html::openElement(
 580                                 'form',
 581                                 [
 582                                         'method' => 'get',
 583                                         'action' => wfScript(),
 584                                         'name' => 'uluser',
 585                                         'id' => 'mw-userrights-form1'
 586                                 ]
 587                         ) .
 588                         Html::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) .
 589                         Xml::fieldset( $this->msg( 'userrights-lookup-user' )->text() ) .
 590                         Xml::inputLabel(
 591                                 $this->msg( 'userrights-user-editname' )->text(),
 592                                 'user',
 593                                 'username',
 594                                 30,
 595                                 str_replace( '_', ' ', $this->mTarget ),
 596                                 [
 597                                         'class' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
 598                                 ] + (
 599                                         // Set autofocus on blank input and error input
 600                                         $this->mFetchedUser === null ? [ 'autofocus' => '' ] : []
 601                                 )
 602                         ) . ' ' .
 603                         Xml::submitButton(
 604                                 $this->msg( 'editusergroup' )->text()
 605                         ) .
 606                         Html::closeElement( 'fieldset' ) .
 607                         Html::closeElement( 'form' ) . "\n"
 608                 );
 609         }
 610
 611         /**
 612          * Show the form to edit group memberships.
 613          *
 614          * @param User|UserRightsProxy $user User or UserRightsProxy you're editing
 615          * @param array $groups Array of groups the user is in. Not used by this implementation
 616          *   anymore, but kept for backward compatibility with subclasses
 617          * @param array $groupMemberships Associative array of (group name => UserGroupMembership
 618          *   object) containing the groups the user is in
 619          */
 620         protected function showEditUserGroupsForm( $user, $groups, $groupMemberships ) {
 621                 $list = $membersList = $tempList = $tempMembersList = [];
 622                 foreach ( $groupMemberships as $ugm ) {
 623                         $linkG = UserGroupMembership::getLink( $ugm, $this->getContext(), 'html' );
 624                         $linkM = UserGroupMembership::getLink( $ugm, $this->getContext(), 'html',
 625                                 $user->getName() );
 626                         if ( $ugm->getExpiry() ) {
 627                                 $tempList[] = $linkG;
 628                                 $tempMembersList[] = $linkM;
 629                         } else {
 630                                 $list[] = $linkG;
 631                                 $membersList[] = $linkM;
 632
 633                         }
 634                 }
 635
 636                 $autoList = [];
 637                 $autoMembersList = [];
 638                 if ( $user instanceof User ) {
 639                         foreach ( Autopromote::getAutopromoteGroups( $user ) as $group ) {
 640                                 $autoList[] = UserGroupMembership::getLink( $group, $this->getContext(), 'html' );
 641                                 $autoMembersList[] = UserGroupMembership::getLink( $group, $this->getContext(),
 642                                         'html', $user->getName() );
 643                         }
 644                 }
 645
 646                 $language = $this->getLanguage();
 647                 $displayedList = $this->msg( 'userrights-groupsmember-type' )
 648                         ->rawParams(
 649                                 $language->commaList( array_merge( $tempList, $list ) ),
 650                                 $language->commaList( array_merge( $tempMembersList, $membersList ) )
 651                         )->escaped();
 652                 $displayedAutolist = $this->msg( 'userrights-groupsmember-type' )
 653                         ->rawParams(
 654                                 $language->commaList( $autoList ),
 655                                 $language->commaList( $autoMembersList )
 656                         )->escaped();
 657
 658                 $grouplist = '';
 659                 $count = count( $list ) + count( $tempList );
 660                 if ( $count > 0 ) {
 661                         $grouplist = $this->msg( 'userrights-groupsmember' )
 662                                 ->numParams( $count )
 663                                 ->params( $user->getName() )
 664                                 ->parse();
 665                         $grouplist = '<p>' . $grouplist . ' ' . $displayedList . "</p>\n";
 666                 }
 667
 668                 $count = count( $autoList );
 669                 if ( $count > 0 ) {
 670                         $autogrouplistintro = $this->msg( 'userrights-groupsmember-auto' )
 671                                 ->numParams( $count )
 672                                 ->params( $user->getName() )
 673                                 ->parse();
 674                         $grouplist .= '<p>' . $autogrouplistintro . ' ' . $displayedAutolist . "</p>\n";
 675                 }
 676
 677                 $userToolLinks = Linker::userToolLinks(
 678                         $user->getId(),
 679                         $user->getName(),
 680                         false, /* default for redContribsWhenNoEdits */
 681                         Linker::TOOL_LINKS_EMAIL /* Add "send e-mail" link */
 682                 );
 683
 684                 list( $groupCheckboxes, $canChangeAny ) =
 685                         $this->groupCheckboxes( $groupMemberships, $user );
 686                 $this->getOutput()->addHTML(
 687                         Xml::openElement(
 688                                 'form',
 689                                 [
 690                                         'method' => 'post',
 691                                         'action' => $this->getPageTitle()->getLocalURL(),
 692                                         'name' => 'editGroup',
 693                                         'id' => 'mw-userrights-form2'
 694                                 ]
 695                         ) .
 696                         Html::hidden( 'user', $this->mTarget ) .
 697                         Html::hidden( 'wpEditToken', $this->getUser()->getEditToken( $this->mTarget ) ) .
 698                         Html::hidden(
 699                                 'conflictcheck-originalgroups',
 700                                 implode( ',', $user->getGroups() )
 701                         ) . // Conflict detection
 702                         Xml::openElement( 'fieldset' ) .
 703                         Xml::element(
 704                                 'legend',
 705                                 [],
 706                                 $this->msg(
 707                                         $canChangeAny ? 'userrights-editusergroup' : 'userrights-viewusergroup',
 708                                         $user->getName()
 709                                 )->text()
 710                         ) .
 711                         $this->msg(
 712                                 $canChangeAny ? 'editinguser' : 'viewinguserrights'
 713                         )->params( wfEscapeWikiText( $user->getName() ) )
 714                                 ->rawParams( $userToolLinks )->parse()
 715                 );
 716                 if ( $canChangeAny ) {
 717                         $this->getOutput()->addHTML(
 718                                 $this->msg( 'userrights-groups-help', $user->getName() )->parse() .
 719                                 $grouplist .
 720                                 $groupCheckboxes .
 721                                 Xml::openElement( 'table', [ 'id' => 'mw-userrights-table-outer' ] ) .
 722                                         "<tr>
 723                                                 <td class='mw-label'>" .
 724                                                         Xml::label( $this->msg( 'userrights-reason' )->text(), 'wpReason' ) .
 725                                                 "</td>
 726                                                 <td class='mw-input'>" .
 727                                                         Xml::input( 'user-reason', 60, $this->getRequest()->getVal( 'user-reason', false ), [
 728                                                                 'id' => 'wpReason',
 729                                                                 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
 730                                                                 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
 731                                                                 // Unicode codepoints.
 732                                                                 'maxlength' => CommentStore::COMMENT_CHARACTER_LIMIT,
 733                                                         ] ) .
 734                                                 "</td>
 735                                         </tr>
 736                                         <tr>
 737                                                 <td></td>
 738                                                 <td class='mw-submit'>" .
 739                                                         Xml::submitButton( $this->msg( 'saveusergroups', $user->getName() )->text(),
 740                                                                 [ 'name' => 'saveusergroups' ] +
 741                                                                         Linker::tooltipAndAccesskeyAttribs( 'userrights-set' )
 742                                                         ) .
 743                                                 "</td>
 744                                         </tr>" .
 745                                 Xml::closeElement( 'table' ) . "\n"
 746                         );
 747                 } else {
 748                         $this->getOutput()->addHTML( $grouplist );
 749                 }
 750                 $this->getOutput()->addHTML(
 751                         Xml::closeElement( 'fieldset' ) .
 752                         Xml::closeElement( 'form' ) . "\n"
 753                 );
 754         }
 755
 756         /**
 757          * Returns an array of all groups that may be edited
 758          * @return array Array of groups that may be edited.
 759          */
 760         protected static function getAllGroups() {
 761                 return User::getAllGroups();
 762         }
 763
 764         /**
 765          * Adds a table with checkboxes where you can select what groups to add/remove
 766          *
 767          * @param UserGroupMembership[] $usergroups Associative array of (group name as string =>
 768          *   UserGroupMembership object) for groups the user belongs to
 769          * @param User $user
 770          * @return array Array with 2 elements: the XHTML table element with checkxboes, and
 771          * whether any groups are changeable
 772          */
 773         private function groupCheckboxes( $usergroups, $user ) {
 774                 $allgroups = $this->getAllGroups();
 775                 $ret = '';
 776
 777                 // Get the list of preset expiry times from the system message
 778                 $expiryOptionsMsg = $this->msg( 'userrights-expiry-options' )->inContentLanguage();
 779                 $expiryOptions = $expiryOptionsMsg->isDisabled() ?
 780                         [] :
 781                         explode( ',', $expiryOptionsMsg->text() );
 782
 783                 // Put all column info into an associative array so that extensions can
 784                 // more easily manage it.
 785                 $columns = [ 'unchangeable' => [], 'changeable' => [] ];
 786
 787                 foreach ( $allgroups as $group ) {
 788                         $set = isset( $usergroups[$group] );
 789                         // Users who can add the group, but not remove it, can only lengthen
 790                         // expiries, not shorten them. So they should only see the expiry
 791                         // dropdown if the group currently has a finite expiry
 792                         $canOnlyLengthenExpiry = ( $set && $this->canAdd( $group ) &&
 793                                  !$this->canRemove( $group ) && $usergroups[$group]->getExpiry() );
 794                         // Should the checkbox be disabled?
 795                         $disabledCheckbox = !(
 796                                 ( $set && $this->canRemove( $group ) ) ||
 797                                 ( !$set && $this->canAdd( $group ) ) );
 798                         // Should the expiry elements be disabled?
 799                         $disabledExpiry = $disabledCheckbox && !$canOnlyLengthenExpiry;
 800                         // Do we need to point out that this action is irreversible?
 801                         $irreversible = !$disabledCheckbox && (
 802                                 ( $set && !$this->canAdd( $group ) ) ||
 803                                 ( !$set && !$this->canRemove( $group ) ) );
 804
 805                         $checkbox = [
 806                                 'set' => $set,
 807                                 'disabled' => $disabledCheckbox,
 808                                 'disabled-expiry' => $disabledExpiry,
 809                                 'irreversible' => $irreversible
 810                         ];
 811
 812                         if ( $disabledCheckbox && $disabledExpiry ) {
 813                                 $columns['unchangeable'][$group] = $checkbox;
 814                         } else {
 815                                 $columns['changeable'][$group] = $checkbox;
 816                         }
 817                 }
 818
 819                 // Build the HTML table
 820                 $ret .= Xml::openElement( 'table', [ 'class' => 'mw-userrights-groups' ] ) .
 821                         "<tr>\n";
 822                 foreach ( $columns as $name => $column ) {
 823                         if ( $column === [] ) {
 824                                 continue;
 825                         }
 826                         // Messages: userrights-changeable-col, userrights-unchangeable-col
 827                         $ret .= Xml::element(
 828                                 'th',
 829                                 null,
 830                                 $this->msg( 'userrights-' . $name . '-col', count( $column ) )->text()
 831                         );
 832                 }
 833
 834                 $ret .= "</tr>\n<tr>\n";
 835                 foreach ( $columns as $column ) {
 836                         if ( $column === [] ) {
 837                                 continue;
 838                         }
 839                         $ret .= "\t<td style='vertical-align:top;'>\n";
 840                         foreach ( $column as $group => $checkbox ) {
 841                                 $attr = [ 'class' => 'mw-userrights-groupcheckbox' ];
 842                                 if ( $checkbox['disabled'] ) {
 843                                         $attr['disabled'] = 'disabled';
 844                                 }
 845
 846                                 $member = UserGroupMembership::getGroupMemberName( $group, $user->getName() );
 847                                 if ( $checkbox['irreversible'] ) {
 848                                         $text = $this->msg( 'userrights-irreversible-marker', $member )->text();
 849                                 } elseif ( $checkbox['disabled'] && !$checkbox['disabled-expiry'] ) {
 850                                         $text = $this->msg( 'userrights-no-shorten-expiry-marker', $member )->text();
 851                                 } else {
 852                                         $text = $member;
 853                                 }
 854                                 $checkboxHtml = Xml::checkLabel( $text, "wpGroup-" . $group,
 855                                         "wpGroup-" . $group, $checkbox['set'], $attr );
 856
 857                                 if ( $this->canProcessExpiries() ) {
 858                                         $uiUser = $this->getUser();
 859                                         $uiLanguage = $this->getLanguage();
 860
 861                                         $currentExpiry = isset( $usergroups[$group] ) ?
 862                                                 $usergroups[$group]->getExpiry() :
 863                                                 null;
 864
 865                                         // If the user can't modify the expiry, print the current expiry below
 866                                         // it in plain text. Otherwise provide UI to set/change the expiry
 867                                         if ( $checkbox['set'] &&
 868                                                 ( $checkbox['irreversible'] || $checkbox['disabled-expiry'] )
 869                                         ) {
 870                                                 if ( $currentExpiry ) {
 871                                                         $expiryFormatted = $uiLanguage->userTimeAndDate( $currentExpiry, $uiUser );
 872                                                         $expiryFormattedD = $uiLanguage->userDate( $currentExpiry, $uiUser );
 873                                                         $expiryFormattedT = $uiLanguage->userTime( $currentExpiry, $uiUser );
 874                                                         $expiryHtml = $this->msg( 'userrights-expiry-current' )->params(
 875                                                                 $expiryFormatted, $expiryFormattedD, $expiryFormattedT )->text();
 876                                                 } else {
 877                                                         $expiryHtml = $this->msg( 'userrights-expiry-none' )->text();
 878                                                 }
 879                                                 // T171345: Add a hidden form element so that other groups can still be manipulated,
 880                                                 // otherwise saving errors out with an invalid expiry time for this group.
 881                                                 $expiryHtml .= Html::hidden( "wpExpiry-$group",
 882                                                         $currentExpiry ? 'existing' : 'infinite' );
 883                                                 $expiryHtml .= "<br />\n";
 884                                         } else {
 885                                                 $expiryHtml = Xml::element( 'span', null,
 886                                                         $this->msg( 'userrights-expiry' )->text() );
 887                                                 $expiryHtml .= Xml::openElement( 'span' );
 888
 889                                                 // add a form element to set the expiry date
 890                                                 $expiryFormOptions = new XmlSelect(
 891                                                         "wpExpiry-$group",
 892                                                         "mw-input-wpExpiry-$group", // forward compatibility with HTMLForm
 893                                                         $currentExpiry ? 'existing' : 'infinite'
 894                                                 );
 895                                                 if ( $checkbox['disabled-expiry'] ) {
 896                                                         $expiryFormOptions->setAttribute( 'disabled', 'disabled' );
 897                                                 }
 898
 899                                                 if ( $currentExpiry ) {
 900                                                         $timestamp = $uiLanguage->userTimeAndDate( $currentExpiry, $uiUser );
 901                                                         $d = $uiLanguage->userDate( $currentExpiry, $uiUser );
 902                                                         $t = $uiLanguage->userTime( $currentExpiry, $uiUser );
 903                                                         $existingExpiryMessage = $this->msg( 'userrights-expiry-existing',
 904                                                                 $timestamp, $d, $t );
 905                                                         $expiryFormOptions->addOption( $existingExpiryMessage->text(), 'existing' );
 906                                                 }
 907
 908                                                 $expiryFormOptions->addOption(
 909                                                         $this->msg( 'userrights-expiry-none' )->text(),
 910                                                         'infinite'
 911                                                 );
 912                                                 $expiryFormOptions->addOption(
 913                                                         $this->msg( 'userrights-expiry-othertime' )->text(),
 914                                                         'other'
 915                                                 );
 916                                                 foreach ( $expiryOptions as $option ) {
 917                                                         if ( strpos( $option, ":" ) === false ) {
 918                                                                 $displayText = $value = $option;
 919                                                         } else {
 920                                                                 list( $displayText, $value ) = explode( ":", $option );
 921                                                         }
 922                                                         $expiryFormOptions->addOption( $displayText, htmlspecialchars( $value ) );
 923                                                 }
 924
 925                                                 // Add expiry dropdown
 926                                                 $expiryHtml .= $expiryFormOptions->getHTML() . '<br />';
 927
 928                                                 // Add custom expiry field
 929                                                 $attribs = [
 930                                                         'id' => "mw-input-wpExpiry-$group-other",
 931                                                         'class' => 'mw-userrights-expiryfield',
 932                                                 ];
 933                                                 if ( $checkbox['disabled-expiry'] ) {
 934                                                         $attribs['disabled'] = 'disabled';
 935                                                 }
 936                                                 $expiryHtml .= Xml::input( "wpExpiry-$group-other", 30, '', $attribs );
 937
 938                                                 // If the user group is set but the checkbox is disabled, mimic a
 939                                                 // checked checkbox in the form submission
 940                                                 if ( $checkbox['set'] && $checkbox['disabled'] ) {
 941                                                         $expiryHtml .= Html::hidden( "wpGroup-$group", 1 );
 942                                                 }
 943
 944                                                 $expiryHtml .= Xml::closeElement( 'span' );
 945                                         }
 946
 947                                         $divAttribs = [
 948                                                 'id' => "mw-userrights-nested-wpGroup-$group",
 949                                                 'class' => 'mw-userrights-nested',
 950                                         ];
 951                                         $checkboxHtml .= "\t\t\t" . Xml::tags( 'div', $divAttribs, $expiryHtml ) . "\n";
 952                                 }
 953                                 $ret .= "\t\t" . ( ( $checkbox['disabled'] && $checkbox['disabled-expiry'] )
 954                                         ? Xml::tags( 'div', [ 'class' => 'mw-userrights-disabled' ], $checkboxHtml )
 955                                         : Xml::tags( 'div', [], $checkboxHtml )
 956                                 ) . "\n";
 957                         }
 958                         $ret .= "\t</td>\n";
 959                 }
 960                 $ret .= Xml::closeElement( 'tr' ) . Xml::closeElement( 'table' );
 961
 962                 return [ $ret, (bool)$columns['changeable'] ];
 963         }
 964
 965         /**
 966          * @param string $group The name of the group to check
 967          * @return bool Can we remove the group?
 968          */
 969         private function canRemove( $group ) {
 970                 $groups = $this->changeableGroups();
 971
 972                 return in_array(
 973                         $group,
 974                         $groups['remove'] ) || ( $this->isself && in_array( $group, $groups['remove-self'] )
 975                 );
 976         }
 977
 978         /**
 979          * @param string $group The name of the group to check
 980          * @return bool Can we add the group?
 981          */
 982         private function canAdd( $group ) {
 983                 $groups = $this->changeableGroups();
 984
 985                 return in_array(
 986                         $group,
 987                         $groups['add'] ) || ( $this->isself && in_array( $group, $groups['add-self'] )
 988                 );
 989         }
 990
 991         /**
 992          * Returns $this->getUser()->changeableGroups()
 993          *
 994          * @return array Array(
 995          *   'add' => array( addablegroups ),
 996          *   'remove' => array( removablegroups ),
 997          *   'add-self' => array( addablegroups to self ),
 998          *   'remove-self' => array( removable groups from self )
 999          *  )
1000          */
1001         function changeableGroups() {
1002                 return $this->getUser()->changeableGroups();
1003         }
1004
1005         /**
1006          * Show a rights log fragment for the specified user
1007          *
1008          * @param User $user User to show log for
1009          * @param OutputPage $output OutputPage to use
1010          */
1011         protected function showLogFragment( $user, $output ) {
1012                 $rightsLogPage = new LogPage( 'rights' );
1013                 $output->addHTML( Xml::element( 'h2', null, $rightsLogPage->getName()->text() ) );
1014                 LogEventsList::showLogExtract( $output, 'rights', $user->getUserPage() );
1015         }
1016
1017         /**
1018          * Return an array of subpages beginning with $search that this special page will accept.
1019          *
1020          * @param string $search Prefix to search for
1021          * @param int $limit Maximum number of results to return (usually 10)
1022          * @param int $offset Number of results to skip (usually 0)
1023          * @return string[] Matching subpages
1024          */
1025         public function prefixSearchSubpages( $search, $limit, $offset ) {
1026                 $user = User::newFromName( $search );
1027                 if ( !$user ) {
1028                         // No prefix suggestion for invalid user
1029                         return [];
1030                 }
1031                 // Autocomplete subpage as user list - public to allow caching
1032                 return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
1033         }
1034
1035         protected function getGroupName() {
1036                 return 'users';
1037         }
1038 }