includes/api/ApiQueryAllUsers.php

   1 <?php
   2 /**
   3  * Copyright © 2007 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   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  */
  22
  23 /**
  24  * Query module to enumerate all registered users.
  25  *
  26  * @ingroup API
  27  */
  28 class ApiQueryAllUsers extends ApiQueryBase {
  29         public function __construct( ApiQuery $query, $moduleName ) {
  30                 parent::__construct( $query, $moduleName, 'au' );
  31         }
  32
  33         /**
  34          * This function converts the user name to a canonical form
  35          * which is stored in the database.
  36          * @param string $name
  37          * @return string
  38          */
  39         private function getCanonicalUserName( $name ) {
  40                 return strtr( $name, '_', ' ' );
  41         }
  42
  43         public function execute() {
  44                 global $wgActorTableSchemaMigrationStage;
  45
  46                 $params = $this->extractRequestParams();
  47                 $activeUserDays = $this->getConfig()->get( 'ActiveUserDays' );
  48
  49                 $db = $this->getDB();
  50                 $commentStore = CommentStore::getStore();
  51
  52                 $prop = $params['prop'];
  53                 if ( !is_null( $prop ) ) {
  54                         $prop = array_flip( $prop );
  55                         $fld_blockinfo = isset( $prop['blockinfo'] );
  56                         $fld_editcount = isset( $prop['editcount'] );
  57                         $fld_groups = isset( $prop['groups'] );
  58                         $fld_rights = isset( $prop['rights'] );
  59                         $fld_registration = isset( $prop['registration'] );
  60                         $fld_implicitgroups = isset( $prop['implicitgroups'] );
  61                         $fld_centralids = isset( $prop['centralids'] );
  62                 } else {
  63                         $fld_blockinfo = $fld_editcount = $fld_groups = $fld_registration =
  64                                 $fld_rights = $fld_implicitgroups = $fld_centralids = false;
  65                 }
  66
  67                 $limit = $params['limit'];
  68
  69                 $this->addTables( 'user' );
  70
  71                 $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
  72                 $from = is_null( $params['from'] ) ? null : $this->getCanonicalUserName( $params['from'] );
  73                 $to = is_null( $params['to'] ) ? null : $this->getCanonicalUserName( $params['to'] );
  74
  75                 # MySQL can't figure out that 'user_name' and 'qcc_title' are the same
  76                 # despite the JOIN condition, so manually sort on the correct one.
  77                 $userFieldToSort = $params['activeusers'] ? 'qcc_title' : 'user_name';
  78
  79                 # Some of these subtable joins are going to give us duplicate rows, so
  80                 # calculate the maximum number of duplicates we might see.
  81                 $maxDuplicateRows = 1;
  82
  83                 $this->addWhereRange( $userFieldToSort, $dir, $from, $to );
  84
  85                 if ( !is_null( $params['prefix'] ) ) {
  86                         $this->addWhere( $userFieldToSort .
  87                                 $db->buildLike( $this->getCanonicalUserName( $params['prefix'] ), $db->anyString() ) );
  88                 }
  89
  90                 if ( !is_null( $params['rights'] ) && count( $params['rights'] ) ) {
  91                         $groups = [];
  92                         foreach ( $params['rights'] as $r ) {
  93                                 $groups = array_merge( $groups, User::getGroupsWithPermission( $r ) );
  94                         }
  95
  96                         // no group with the given right(s) exists, no need for a query
  97                         if ( $groups === [] ) {
  98                                 $this->getResult()->addIndexedTagName( [ 'query', $this->getModuleName() ], '' );
  99
 100                                 return;
 101                         }
 102
 103                         $groups = array_unique( $groups );
 104
 105                         if ( is_null( $params['group'] ) ) {
 106                                 $params['group'] = $groups;
 107                         } else {
 108                                 $params['group'] = array_unique( array_merge( $params['group'], $groups ) );
 109                         }
 110                 }
 111
 112                 $this->requireMaxOneParameter( $params, 'group', 'excludegroup' );
 113
 114                 if ( !is_null( $params['group'] ) && count( $params['group'] ) ) {
 115                         // Filter only users that belong to a given group. This might
 116                         // produce as many rows-per-user as there are groups being checked.
 117                         $this->addTables( 'user_groups', 'ug1' );
 118                         $this->addJoinConds( [
 119                                 'ug1' => [
 120                                         'JOIN',
 121                                         [
 122                                                 'ug1.ug_user=user_id',
 123                                                 'ug1.ug_group' => $params['group'],
 124                                                 'ug1.ug_expiry IS NULL OR ug1.ug_expiry >= ' . $db->addQuotes( $db->timestamp() )
 125                                         ]
 126                                 ]
 127                         ] );
 128                         $maxDuplicateRows *= count( $params['group'] );
 129                 }
 130
 131                 if ( !is_null( $params['excludegroup'] ) && count( $params['excludegroup'] ) ) {
 132                         // Filter only users don't belong to a given group. This can only
 133                         // produce one row-per-user, because we only keep on "no match".
 134                         $this->addTables( 'user_groups', 'ug1' );
 135
 136                         if ( count( $params['excludegroup'] ) == 1 ) {
 137                                 $exclude = [ 'ug1.ug_group' => $params['excludegroup'][0] ];
 138                         } else {
 139                                 $exclude = [ $db->makeList(
 140                                         [ 'ug1.ug_group' => $params['excludegroup'] ],
 141                                         LIST_OR
 142                                 ) ];
 143                         }
 144                         $this->addJoinConds( [ 'ug1' => [ 'LEFT JOIN',
 145                                 array_merge( [
 146                                         'ug1.ug_user=user_id',
 147                                         'ug1.ug_expiry IS NULL OR ug1.ug_expiry >= ' . $db->addQuotes( $db->timestamp() )
 148                                 ], $exclude )
 149                         ] ] );
 150                         $this->addWhere( 'ug1.ug_user IS NULL' );
 151                 }
 152
 153                 if ( $params['witheditsonly'] ) {
 154                         $this->addWhere( 'user_editcount > 0' );
 155                 }
 156
 157                 $this->showHiddenUsersAddBlockInfo( $fld_blockinfo );
 158
 159                 if ( $fld_groups || $fld_rights ) {
 160                         $this->addFields( [ 'groups' =>
 161                                 $db->buildGroupConcatField( '|', 'user_groups', 'ug_group', [
 162                                         'ug_user=user_id',
 163                                         'ug_expiry IS NULL OR ug_expiry >= ' . $db->addQuotes( $db->timestamp() )
 164                                 ] )
 165                         ] );
 166                 }
 167
 168                 if ( $params['activeusers'] ) {
 169                         $activeUserSeconds = $activeUserDays * 86400;
 170
 171                         // Filter query to only include users in the active users cache.
 172                         // There shouldn't be any duplicate rows in querycachetwo here.
 173                         $this->addTables( 'querycachetwo' );
 174                         $this->addJoinConds( [ 'querycachetwo' => [
 175                                 'JOIN', [
 176                                         'qcc_type' => 'activeusers',
 177                                         'qcc_namespace' => NS_USER,
 178                                         'qcc_title=user_name',
 179                                 ],
 180                         ] ] );
 181
 182                         // Actually count the actions using a subquery (T66505 and T66507)
 183                         $tables = [ 'recentchanges' ];
 184                         $joins = [];
 185                         if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_OLD ) {
 186                                 $userCond = 'rc_user_text = user_name';
 187                         } else {
 188                                 $tables[] = 'actor';
 189                                 $joins['actor'] = [ 'JOIN', 'rc_actor = actor_id' ];
 190                                 $userCond = 'actor_user = user_id';
 191                         }
 192                         $timestamp = $db->timestamp( wfTimestamp( TS_UNIX ) - $activeUserSeconds );
 193                         $this->addFields( [
 194                                 'recentactions' => '(' . $db->selectSQLText(
 195                                         $tables,
 196                                         'COUNT(*)',
 197                                         [
 198                                                 $userCond,
 199                                                 'rc_type != ' . $db->addQuotes( RC_EXTERNAL ), // no wikidata
 200                                                 'rc_log_type IS NULL OR rc_log_type != ' . $db->addQuotes( 'newusers' ),
 201                                                 'rc_timestamp >= ' . $db->addQuotes( $timestamp ),
 202                                         ],
 203                                         __METHOD__,
 204                                         [],
 205                                         $joins
 206                                 ) . ')'
 207                         ] );
 208                 }
 209
 210                 $sqlLimit = $limit + $maxDuplicateRows;
 211                 $this->addOption( 'LIMIT', $sqlLimit );
 212
 213                 $this->addFields( [
 214                         'user_name',
 215                         'user_id'
 216                 ] );
 217                 $this->addFieldsIf( 'user_editcount', $fld_editcount );
 218                 $this->addFieldsIf( 'user_registration', $fld_registration );
 219
 220                 $res = $this->select( __METHOD__ );
 221                 $count = 0;
 222                 $countDuplicates = 0;
 223                 $lastUser = false;
 224                 $result = $this->getResult();
 225                 foreach ( $res as $row ) {
 226                         $count++;
 227
 228                         if ( $lastUser === $row->user_name ) {
 229                                 // Duplicate row due to one of the needed subtable joins.
 230                                 // Ignore it, but count the number of them to sanely handle
 231                                 // miscalculation of $maxDuplicateRows.
 232                                 $countDuplicates++;
 233                                 if ( $countDuplicates == $maxDuplicateRows ) {
 234                                         ApiBase::dieDebug( __METHOD__, 'Saw more duplicate rows than expected' );
 235                                 }
 236                                 continue;
 237                         }
 238
 239                         $countDuplicates = 0;
 240                         $lastUser = $row->user_name;
 241
 242                         if ( $count > $limit ) {
 243                                 // We've reached the one extra which shows that there are
 244                                 // additional pages to be had. Stop here...
 245                                 $this->setContinueEnumParameter( 'from', $row->user_name );
 246                                 break;
 247                         }
 248
 249                         if ( $count == $sqlLimit ) {
 250                                 // Should never hit this (either the $countDuplicates check or
 251                                 // the $count > $limit check should hit first), but check it
 252                                 // anyway just in case.
 253                                 ApiBase::dieDebug( __METHOD__, 'Saw more duplicate rows than expected' );
 254                         }
 255
 256                         if ( $params['activeusers'] && $row->recentactions === 0 ) {
 257                                 // activeusers cache was out of date
 258                                 continue;
 259                         }
 260
 261                         $data = [
 262                                 'userid' => (int)$row->user_id,
 263                                 'name' => $row->user_name,
 264                         ];
 265
 266                         if ( $fld_centralids ) {
 267                                 $data += ApiQueryUserInfo::getCentralUserInfo(
 268                                         $this->getConfig(), User::newFromId( $row->user_id ), $params['attachedwiki']
 269                                 );
 270                         }
 271
 272                         if ( $fld_blockinfo && !is_null( $row->ipb_by_text ) ) {
 273                                 $data['blockid'] = (int)$row->ipb_id;
 274                                 $data['blockedby'] = $row->ipb_by_text;
 275                                 $data['blockedbyid'] = (int)$row->ipb_by;
 276                                 $data['blockedtimestamp'] = wfTimestamp( TS_ISO_8601, $row->ipb_timestamp );
 277                                 $data['blockreason'] = $commentStore->getComment( 'ipb_reason', $row )->text;
 278                                 $data['blockexpiry'] = $row->ipb_expiry;
 279                         }
 280                         if ( $row->ipb_deleted ) {
 281                                 $data['hidden'] = true;
 282                         }
 283                         if ( $fld_editcount ) {
 284                                 $data['editcount'] = (int)$row->user_editcount;
 285                         }
 286                         if ( $params['activeusers'] ) {
 287                                 $data['recentactions'] = (int)$row->recentactions;
 288                         }
 289                         if ( $fld_registration ) {
 290                                 $data['registration'] = $row->user_registration ?
 291                                         wfTimestamp( TS_ISO_8601, $row->user_registration ) : '';
 292                         }
 293
 294                         if ( $fld_implicitgroups || $fld_groups || $fld_rights ) {
 295                                 $implicitGroups = User::newFromId( $row->user_id )->getAutomaticGroups();
 296                                 if ( isset( $row->groups ) && $row->groups !== '' ) {
 297                                         $groups = array_merge( $implicitGroups, explode( '|', $row->groups ) );
 298                                 } else {
 299                                         $groups = $implicitGroups;
 300                                 }
 301
 302                                 if ( $fld_groups ) {
 303                                         $data['groups'] = $groups;
 304                                         ApiResult::setIndexedTagName( $data['groups'], 'g' );
 305                                         ApiResult::setArrayType( $data['groups'], 'array' );
 306                                 }
 307
 308                                 if ( $fld_implicitgroups ) {
 309                                         $data['implicitgroups'] = $implicitGroups;
 310                                         ApiResult::setIndexedTagName( $data['implicitgroups'], 'g' );
 311                                         ApiResult::setArrayType( $data['implicitgroups'], 'array' );
 312                                 }
 313
 314                                 if ( $fld_rights ) {
 315                                         $data['rights'] = User::getGroupPermissions( $groups );
 316                                         ApiResult::setIndexedTagName( $data['rights'], 'r' );
 317                                         ApiResult::setArrayType( $data['rights'], 'array' );
 318                                 }
 319                         }
 320
 321                         $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $data );
 322                         if ( !$fit ) {
 323                                 $this->setContinueEnumParameter( 'from', $data['name'] );
 324                                 break;
 325                         }
 326                 }
 327
 328                 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'u' );
 329         }
 330
 331         public function getCacheMode( $params ) {
 332                 return 'anon-public-user-private';
 333         }
 334
 335         public function getAllowedParams() {
 336                 $userGroups = User::getAllGroups();
 337
 338                 return [
 339                         'from' => null,
 340                         'to' => null,
 341                         'prefix' => null,
 342                         'dir' => [
 343                                 ApiBase::PARAM_DFLT => 'ascending',
 344                                 ApiBase::PARAM_TYPE => [
 345                                         'ascending',
 346                                         'descending'
 347                                 ],
 348                         ],
 349                         'group' => [
 350                                 ApiBase::PARAM_TYPE => $userGroups,
 351                                 ApiBase::PARAM_ISMULTI => true,
 352                         ],
 353                         'excludegroup' => [
 354                                 ApiBase::PARAM_TYPE => $userGroups,
 355                                 ApiBase::PARAM_ISMULTI => true,
 356                         ],
 357                         'rights' => [
 358                                 ApiBase::PARAM_TYPE => User::getAllRights(),
 359                                 ApiBase::PARAM_ISMULTI => true,
 360                         ],
 361                         'prop' => [
 362                                 ApiBase::PARAM_ISMULTI => true,
 363                                 ApiBase::PARAM_TYPE => [
 364                                         'blockinfo',
 365                                         'groups',
 366                                         'implicitgroups',
 367                                         'rights',
 368                                         'editcount',
 369                                         'registration',
 370                                         'centralids',
 371                                 ],
 372                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
 373                         ],
 374                         'limit' => [
 375                                 ApiBase::PARAM_DFLT => 10,
 376                                 ApiBase::PARAM_TYPE => 'limit',
 377                                 ApiBase::PARAM_MIN => 1,
 378                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 379                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 380                         ],
 381                         'witheditsonly' => false,
 382                         'activeusers' => [
 383                                 ApiBase::PARAM_DFLT => false,
 384                                 ApiBase::PARAM_HELP_MSG => [
 385                                         'apihelp-query+allusers-param-activeusers',
 386                                         $this->getConfig()->get( 'ActiveUserDays' )
 387                                 ],
 388                         ],
 389                         'attachedwiki' => null,
 390                 ];
 391         }
 392
 393         protected function getExamplesMessages() {
 394                 return [
 395                         'action=query&list=allusers&aufrom=Y'
 396                                 => 'apihelp-query+allusers-example-y',
 397                 ];
 398         }
 399
 400         public function getHelpUrls() {
 401                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allusers';
 402         }
 403 }