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