includes/specials/SpecialListusers.php

   1 <?php
   2 /**
   3  * Implements Special:Listusers
   4  *
   5  * Copyright © 2004 Brion Vibber, lcrocker, Tim Starling,
   6  * Domas Mituzas, Antoine Musso, Jens Frank, Zhengzhu,
   7  * 2006 Rob Church <robchur@gmail.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  * @ingroup SpecialPage
  26  */
  27
  28 /**
  29  * This class is used to get a list of user. The ones with specials
  30  * rights (sysop, bureaucrat, developer) will have them displayed
  31  * next to their names.
  32  *
  33  * @ingroup SpecialPage
  34  */
  35 class UsersPager extends AlphabeticPager {
  36
  37         /**
  38          * @var array A array with user ids as key and a array of groups as value
  39          */
  40         protected $userGroupCache;
  41
  42         /**
  43          * @param IContextSource $context
  44          * @param array $par (Default null)
  45          * @param bool $including Whether this page is being transcluded in
  46          * another page
  47          */
  48         function __construct( IContextSource $context = null, $par = null, $including = null ) {
  49                 if ( $context ) {
  50                         $this->setContext( $context );
  51                 }
  52
  53                 $request = $this->getRequest();
  54                 $par = ( $par !== null ) ? $par : '';
  55                 $parms = explode( '/', $par );
  56                 $symsForAll = [ '*', 'user' ];
  57
  58                 if ( $parms[0] != '' &&
  59                         ( in_array( $par, User::getAllGroups() ) || in_array( $par, $symsForAll ) )
  60                 ) {
  61                         $this->requestedGroup = $par;
  62                         $un = $request->getText( 'username' );
  63                 } elseif ( count( $parms ) == 2 ) {
  64                         $this->requestedGroup = $parms[0];
  65                         $un = $parms[1];
  66                 } else {
  67                         $this->requestedGroup = $request->getVal( 'group' );
  68                         $un = ( $par != '' ) ? $par : $request->getText( 'username' );
  69                 }
  70
  71                 if ( in_array( $this->requestedGroup, $symsForAll ) ) {
  72                         $this->requestedGroup = '';
  73                 }
  74                 $this->editsOnly = $request->getBool( 'editsOnly' );
  75                 $this->creationSort = $request->getBool( 'creationSort' );
  76                 $this->including = $including;
  77                 $this->mDefaultDirection = $request->getBool( 'desc' )
  78                         ? IndexPager::DIR_DESCENDING
  79                         : IndexPager::DIR_ASCENDING;
  80
  81                 $this->requestedUser = '';
  82
  83                 if ( $un != '' ) {
  84                         $username = Title::makeTitleSafe( NS_USER, $un );
  85
  86                         if ( !is_null( $username ) ) {
  87                                 $this->requestedUser = $username->getText();
  88                         }
  89                 }
  90
  91                 parent::__construct();
  92         }
  93
  94         /**
  95          * @return string
  96          */
  97         function getIndexField() {
  98                 return $this->creationSort ? 'user_id' : 'user_name';
  99         }
 100
 101         /**
 102          * @return array
 103          */
 104         function getQueryInfo() {
 105                 $dbr = wfGetDB( DB_SLAVE );
 106                 $conds = [];
 107
 108                 // Don't show hidden names
 109                 if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
 110                         $conds[] = 'ipb_deleted IS NULL OR ipb_deleted = 0';
 111                 }
 112
 113                 $options = [];
 114
 115                 if ( $this->requestedGroup != '' ) {
 116                         $conds['ug_group'] = $this->requestedGroup;
 117                 }
 118
 119                 if ( $this->requestedUser != '' ) {
 120                         # Sorted either by account creation or name
 121                         if ( $this->creationSort ) {
 122                                 $conds[] = 'user_id >= ' . intval( User::idFromName( $this->requestedUser ) );
 123                         } else {
 124                                 $conds[] = 'user_name >= ' . $dbr->addQuotes( $this->requestedUser );
 125                         }
 126                 }
 127
 128                 if ( $this->editsOnly ) {
 129                         $conds[] = 'user_editcount > 0';
 130                 }
 131
 132                 $options['GROUP BY'] = $this->creationSort ? 'user_id' : 'user_name';
 133
 134                 $query = [
 135                         'tables' => [ 'user', 'user_groups', 'ipblocks' ],
 136                         'fields' => [
 137                                 'user_name' => $this->creationSort ? 'MAX(user_name)' : 'user_name',
 138                                 'user_id' => $this->creationSort ? 'user_id' : 'MAX(user_id)',
 139                                 'edits' => 'MAX(user_editcount)',
 140                                 'creation' => 'MIN(user_registration)',
 141                                 'ipb_deleted' => 'MAX(ipb_deleted)' // block/hide status
 142                         ],
 143                         'options' => $options,
 144                         'join_conds' => [
 145                                 'user_groups' => [ 'LEFT JOIN', 'user_id=ug_user' ],
 146                                 'ipblocks' => [
 147                                         'LEFT JOIN', [
 148                                                 'user_id=ipb_user',
 149                                                 'ipb_auto' => 0
 150                                         ]
 151                                 ],
 152                         ],
 153                         'conds' => $conds
 154                 ];
 155
 156                 Hooks::run( 'SpecialListusersQueryInfo', [ $this, &$query ] );
 157
 158                 return $query;
 159         }
 160
 161         /**
 162          * @param stdClass $row
 163          * @return string
 164          */
 165         function formatRow( $row ) {
 166                 if ( $row->user_id == 0 ) { # Bug 16487
 167                         return '';
 168                 }
 169
 170                 $userName = $row->user_name;
 171
 172                 $ulinks = Linker::userLink( $row->user_id, $userName );
 173                 $ulinks .= Linker::userToolLinksRedContribs(
 174                         $row->user_id,
 175                         $userName,
 176                         (int)$row->edits
 177                 );
 178
 179                 $lang = $this->getLanguage();
 180
 181                 $groups = '';
 182                 $groups_list = self::getGroups( intval( $row->user_id ), $this->userGroupCache );
 183
 184                 if ( !$this->including && count( $groups_list ) > 0 ) {
 185                         $list = [];
 186                         foreach ( $groups_list as $group ) {
 187                                 $list[] = self::buildGroupLink( $group, $userName );
 188                         }
 189                         $groups = $lang->commaList( $list );
 190                 }
 191
 192                 $item = $lang->specialList( $ulinks, $groups );
 193
 194                 if ( $row->ipb_deleted ) {
 195                         $item = "<span class=\"deleted\">$item</span>";
 196                 }
 197
 198                 $edits = '';
 199                 if ( !$this->including && $this->getConfig()->get( 'Edititis' ) ) {
 200                         $count = $this->msg( 'usereditcount' )->numParams( $row->edits )->escaped();
 201                         $edits = $this->msg( 'word-separator' )->escaped() . $this->msg( 'brackets', $count )->escaped();
 202                 }
 203
 204                 $created = '';
 205                 # Some rows may be null
 206                 if ( !$this->including && $row->creation ) {
 207                         $user = $this->getUser();
 208                         $d = $lang->userDate( $row->creation, $user );
 209                         $t = $lang->userTime( $row->creation, $user );
 210                         $created = $this->msg( 'usercreated', $d, $t, $row->user_name )->escaped();
 211                         $created = ' ' . $this->msg( 'parentheses' )->rawParams( $created )->escaped();
 212                 }
 213                 $blocked = !is_null( $row->ipb_deleted ) ?
 214                         ' ' . $this->msg( 'listusers-blocked', $userName )->escaped() :
 215                         '';
 216
 217                 Hooks::run( 'SpecialListusersFormatRow', [ &$item, $row ] );
 218
 219                 return Html::rawElement( 'li', [], "{$item}{$edits}{$created}{$blocked}" );
 220         }
 221
 222         function doBatchLookups() {
 223                 $batch = new LinkBatch();
 224                 $userIds = [];
 225                 # Give some pointers to make user links
 226                 foreach ( $this->mResult as $row ) {
 227                         $batch->add( NS_USER, $row->user_name );
 228                         $batch->add( NS_USER_TALK, $row->user_name );
 229                         $userIds[] = $row->user_id;
 230                 }
 231
 232                 // Lookup groups for all the users
 233                 $dbr = wfGetDB( DB_SLAVE );
 234                 $groupRes = $dbr->select(
 235                         'user_groups',
 236                         [ 'ug_user', 'ug_group' ],
 237                         [ 'ug_user' => $userIds ],
 238                         __METHOD__
 239                 );
 240                 $cache = [];
 241                 $groups = [];
 242                 foreach ( $groupRes as $row ) {
 243                         $cache[intval( $row->ug_user )][] = $row->ug_group;
 244                         $groups[$row->ug_group] = true;
 245                 }
 246                 $this->userGroupCache = $cache;
 247
 248                 // Add page of groups to link batch
 249                 foreach ( $groups as $group => $unused ) {
 250                         $groupPage = User::getGroupPage( $group );
 251                         if ( $groupPage ) {
 252                                 $batch->addObj( $groupPage );
 253                         }
 254                 }
 255
 256                 $batch->execute();
 257                 $this->mResult->rewind();
 258         }
 259
 260         /**
 261          * @return string
 262          */
 263         function getPageHeader() {
 264                 list( $self ) = explode( '/', $this->getTitle()->getPrefixedDBkey() );
 265
 266                 $this->getOutput()->addModules( 'mediawiki.userSuggest' );
 267
 268                 # Form tag
 269                 $out = Xml::openElement(
 270                         'form',
 271                         [ 'method' => 'get', 'action' => wfScript(), 'id' => 'mw-listusers-form' ]
 272                 ) .
 273                         Xml::fieldset( $this->msg( 'listusers' )->text() ) .
 274                         Html::hidden( 'title', $self );
 275
 276                 # Username field (with autocompletion support)
 277                 $out .= Xml::label( $this->msg( 'listusersfrom' )->text(), 'offset' ) . ' ' .
 278                         Html::input(
 279                                 'username',
 280                                 $this->requestedUser,
 281                                 'text',
 282                                 [
 283                                         'class' => 'mw-autocomplete-user',
 284                                         'id' => 'offset',
 285                                         'size' => 20,
 286                                         'autofocus' => $this->requestedUser === ''
 287                                 ]
 288                         ) . ' ';
 289
 290                 # Group drop-down list
 291                 $sel = new XmlSelect( 'group', 'group', $this->requestedGroup );
 292                 $sel->addOption( $this->msg( 'group-all' )->text(), '' );
 293                 foreach ( $this->getAllGroups() as $group => $groupText ) {
 294                         $sel->addOption( $groupText, $group );
 295                 }
 296
 297                 $out .= Xml::label( $this->msg( 'group' )->text(), 'group' ) . ' ';
 298                 $out .= $sel->getHTML() . '<br />';
 299                 $out .= Xml::checkLabel(
 300                         $this->msg( 'listusers-editsonly' )->text(),
 301                         'editsOnly',
 302                         'editsOnly',
 303                         $this->editsOnly
 304                 );
 305                 $out .= '&#160;';
 306                 $out .= Xml::checkLabel(
 307                         $this->msg( 'listusers-creationsort' )->text(),
 308                         'creationSort',
 309                         'creationSort',
 310                         $this->creationSort
 311                 );
 312                 $out .= '&#160;';
 313                 $out .= Xml::checkLabel(
 314                         $this->msg( 'listusers-desc' )->text(),
 315                         'desc',
 316                         'desc',
 317                         $this->mDefaultDirection
 318                 );
 319                 $out .= '<br />';
 320
 321                 Hooks::run( 'SpecialListusersHeaderForm', [ $this, &$out ] );
 322
 323                 # Submit button and form bottom
 324                 $out .= Html::hidden( 'limit', $this->mLimit );
 325                 $out .= Xml::submitButton( $this->msg( 'listusers-submit' )->text() );
 326                 Hooks::run( 'SpecialListusersHeader', [ $this, &$out ] );
 327                 $out .= Xml::closeElement( 'fieldset' ) .
 328                         Xml::closeElement( 'form' );
 329
 330                 return $out;
 331         }
 332
 333         /**
 334          * Get a list of all explicit groups
 335          * @return array
 336          */
 337         function getAllGroups() {
 338                 $result = [];
 339                 foreach ( User::getAllGroups() as $group ) {
 340                         $result[$group] = User::getGroupName( $group );
 341                 }
 342                 asort( $result );
 343
 344                 return $result;
 345         }
 346
 347         /**
 348          * Preserve group and username offset parameters when paging
 349          * @return array
 350          */
 351         function getDefaultQuery() {
 352                 $query = parent::getDefaultQuery();
 353                 if ( $this->requestedGroup != '' ) {
 354                         $query['group'] = $this->requestedGroup;
 355                 }
 356                 if ( $this->requestedUser != '' ) {
 357                         $query['username'] = $this->requestedUser;
 358                 }
 359                 Hooks::run( 'SpecialListusersDefaultQuery', [ $this, &$query ] );
 360
 361                 return $query;
 362         }
 363
 364         /**
 365          * Get a list of groups the specified user belongs to
 366          *
 367          * @param int $uid User id
 368          * @param array|null $cache
 369          * @return array
 370          */
 371         protected static function getGroups( $uid, $cache = null ) {
 372                 if ( $cache === null ) {
 373                         $user = User::newFromId( $uid );
 374                         $effectiveGroups = $user->getEffectiveGroups();
 375                 } else {
 376                         $effectiveGroups = isset( $cache[$uid] ) ? $cache[$uid] : [];
 377                 }
 378                 $groups = array_diff( $effectiveGroups, User::getImplicitGroups() );
 379
 380                 return $groups;
 381         }
 382
 383         /**
 384          * Format a link to a group description page
 385          *
 386          * @param string $group Group name
 387          * @param string $username Username
 388          * @return string
 389          */
 390         protected static function buildGroupLink( $group, $username ) {
 391                 return User::makeGroupLinkHTML(
 392                         $group,
 393                         User::getGroupMember( $group, $username )
 394                 );
 395         }
 396 }
 397
 398 /**
 399  * @ingroup SpecialPage
 400  */
 401 class SpecialListUsers extends IncludableSpecialPage {
 402         /**
 403          * Constructor
 404          */
 405         public function __construct() {
 406                 parent::__construct( 'Listusers' );
 407         }
 408
 409         /**
 410          * Show the special page
 411          *
 412          * @param string $par (optional) A group to list users from
 413          */
 414         public function execute( $par ) {
 415                 $this->setHeaders();
 416                 $this->outputHeader();
 417
 418                 $up = new UsersPager( $this->getContext(), $par, $this->including() );
 419
 420                 # getBody() first to check, if empty
 421                 $usersbody = $up->getBody();
 422
 423                 $s = '';
 424                 if ( !$this->including() ) {
 425                         $s = $up->getPageHeader();
 426                 }
 427
 428                 if ( $usersbody ) {
 429                         $s .= $up->getNavigationBar();
 430                         $s .= Html::rawElement( 'ul', [], $usersbody );
 431                         $s .= $up->getNavigationBar();
 432                 } else {
 433                         $s .= $this->msg( 'listusers-noresult' )->parseAsBlock();
 434                 }
 435
 436                 $this->getOutput()->addHTML( $s );
 437         }
 438
 439         /**
 440          * Return an array of subpages that this special page will accept.
 441          *
 442          * @return string[] subpages
 443          */
 444         public function getSubpagesForPrefixSearch() {
 445                 return User::getAllGroups();
 446         }
 447
 448         protected function getGroupName() {
 449                 return 'users';
 450         }
 451 }
 452
 453 /**
 454  * Redirect page: Special:ListAdmins --> Special:ListUsers/sysop.
 455  *
 456  * @ingroup SpecialPage
 457  */
 458 class SpecialListAdmins extends SpecialRedirectToSpecial {
 459         function __construct() {
 460                 parent::__construct( 'Listadmins', 'Listusers', 'sysop' );
 461         }
 462 }
 463
 464 /**
 465  * Redirect page: Special:ListBots --> Special:ListUsers/bot.
 466  *
 467  * @ingroup SpecialPage
 468  */
 469 class SpecialListBots extends SpecialRedirectToSpecial {
 470         function __construct() {
 471                 parent::__construct( 'Listbots', 'Listusers', 'bot' );
 472         }
 473 }