includes/api/ApiQueryAllUsers.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on July 7, 2007
   6  *
   7  * Copyright © 2007 Yuri Astrakhan <Firstname><Lastname>@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  */
  26
  27 if ( !defined( 'MEDIAWIKI' ) ) {
  28         // Eclipse helper - will be ignored in production
  29         require_once( 'ApiQueryBase.php' );
  30 }
  31
  32 /**
  33  * Query module to enumerate all registered users.
  34  *
  35  * @ingroup API
  36  */
  37 class ApiQueryAllUsers extends ApiQueryBase {
  38         public function __construct( $query, $moduleName ) {
  39                 parent::__construct( $query, $moduleName, 'au' );
  40         }
  41
  42         public function execute() {
  43                 $db = $this->getDB();
  44                 $params = $this->extractRequestParams();
  45
  46                 $prop = $params['prop'];
  47                 if ( !is_null( $prop ) ) {
  48                         $prop = array_flip( $prop );
  49                         $fld_blockinfo = isset( $prop['blockinfo'] );
  50                         $fld_editcount = isset( $prop['editcount'] );
  51                         $fld_groups = isset( $prop['groups'] );
  52                         $fld_rights = isset( $prop['rights'] );
  53                         $fld_registration = isset( $prop['registration'] );
  54                 } else {
  55                         $fld_blockinfo = $fld_editcount = $fld_groups = $fld_registration = $fld_rights = false;
  56                 }
  57
  58                 $limit = $params['limit'];
  59                 $this->addTables( 'user' );
  60                 $useIndex = true;
  61
  62                 if ( !is_null( $params['from'] ) ) {
  63                         $this->addWhere( 'user_name >= ' . $db->addQuotes( $this->keyToTitle( $params['from'] ) ) );
  64                 }
  65                 if ( !is_null( $params['to'] ) ) {
  66                         $this->addWhere( 'user_name <= ' . $db->addQuotes( $this->keyToTitle( $params['to'] ) ) );
  67                 }
  68
  69                 if ( !is_null( $params['prefix'] ) ) {
  70                         $this->addWhere( 'user_name' . $db->buildLike( $this->keyToTitle( $params['prefix'] ), $db->anyString() ) );
  71                 }
  72
  73                 if ( !is_null( $params['rights'] ) ) {
  74                         $groups = array();
  75                         foreach( $params['rights'] as $r ) {
  76                                 $groups = array_merge( $groups, User::getGroupsWithPermission( $r ) );
  77                         }
  78
  79                         $groups = array_diff( array_unique( $groups ), User::getImplicitGroups() );
  80
  81                         if ( is_null( $params['group'] ) ) {
  82                                 $params['group'] = $groups;
  83                         } else {
  84                                 $params['group'] = array_unique( array_merge( $params['group'], $groups ) );
  85                         }
  86                 }
  87
  88                 if ( !is_null( $params['group'] ) ) {
  89                         $useIndex = false;
  90                         // Filter only users that belong to a given group
  91                         $this->addTables( 'user_groups', 'ug1' );
  92                         $ug1 = $this->getAliasedName( 'user_groups', 'ug1' );
  93                         $this->addJoinConds( array( $ug1 => array( 'INNER JOIN', array( 'ug1.ug_user=user_id',
  94                                         'ug1.ug_group' => $params['group'] ) ) ) );
  95                 }
  96
  97                 if ( $params['witheditsonly'] ) {
  98                         $this->addWhere( 'user_editcount > 0' );
  99                 }
 100
 101                 if ( $fld_groups || $fld_rights ) {
 102                         // Show the groups the given users belong to
 103                         // request more than needed to avoid not getting all rows that belong to one user
 104                         $groupCount = count( User::getAllGroups() );
 105                         $sqlLimit = $limit + $groupCount + 1;
 106
 107                         $this->addTables( 'user_groups', 'ug2' );
 108                         $tname = $this->getAliasedName( 'user_groups', 'ug2' );
 109                         $this->addJoinConds( array( $tname => array( 'LEFT JOIN', 'ug2.ug_user=user_id' ) ) );
 110                         $this->addFields( 'ug2.ug_group ug_group2' );
 111                 } else {
 112                         $sqlLimit = $limit + 1;
 113                 }
 114
 115                 if ( $fld_blockinfo ) {
 116                         $this->addTables( 'ipblocks' );
 117                         $this->addJoinConds( array(
 118                                 'ipblocks' => array( 'LEFT JOIN', 'ipb_user=user_id' ),
 119                         ) );
 120                         $this->addFields( array( 'ipb_reason', 'ipb_by_text', 'ipb_expiry' ) );
 121                 }
 122
 123                 $this->addOption( 'LIMIT', $sqlLimit );
 124
 125                 $this->addFields( array(
 126                         'user_name',
 127                         'user_id'
 128                 ) );
 129                 $this->addFieldsIf( 'user_editcount', $fld_editcount );
 130                 $this->addFieldsIf( 'user_registration', $fld_registration );
 131
 132                 $this->addOption( 'ORDER BY', 'user_name' );
 133                 if ( $useIndex ) {
 134                         $this->addOption( 'USE INDEX', array( 'user' => 'user_name' ) );
 135                 }
 136
 137                 $res = $this->select( __METHOD__ );
 138
 139                 $count = 0;
 140                 $lastUserData = false;
 141                 $lastUser = false;
 142                 $result = $this->getResult();
 143
 144                 //
 145                 // This loop keeps track of the last entry.
 146                 // For each new row, if the new row is for different user then the last, the last entry is added to results.
 147                 // Otherwise, the group of the new row is appended to the last entry.
 148                 // The setContinue... is more complex because of this, and takes into account the higher sql limit
 149                 // to make sure all rows that belong to the same user are received.
 150
 151                 foreach ( $res as $row ) {
 152                         $count++;
 153
 154                         if ( $lastUser !== $row->user_name ) {
 155                                 // Save the last pass's user data
 156                                 if ( is_array( $lastUserData ) ) {
 157                                         $fit = $result->addValue( array( 'query', $this->getModuleName() ),
 158                                                         null, $lastUserData );
 159
 160                                         $lastUserData = null;
 161
 162                                         if ( !$fit ) {
 163                                                 $this->setContinueEnumParameter( 'from',
 164                                                                 $this->keyToTitle( $lastUserData['name'] ) );
 165                                                 break;
 166                                         }
 167                                 }
 168
 169                                 if ( $count > $limit ) {
 170                                         // We've reached the one extra which shows that there are additional pages to be had. Stop here...
 171                                         $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->user_name ) );
 172                                         break;
 173                                 }
 174
 175                                 // Record new user's data
 176                                 $lastUser = $row->user_name;
 177                                 $lastUserData = array(
 178                                         'name' => $lastUser,
 179                                         'userid' => $row->user_id,
 180                                 );
 181                                 if ( $fld_blockinfo && !is_null( $row->ipb_by_text ) ) {
 182                                         $lastUserData['blockedby'] = $row->ipb_by_text;
 183                                         $lastUserData['blockreason'] = $row->ipb_reason;
 184                                         $lastUserData['blockexpiry'] = $row->ipb_expiry;
 185                                 }
 186                                 if ( $fld_editcount ) {
 187                                         $lastUserData['editcount'] = intval( $row->user_editcount );
 188                                 }
 189                                 if ( $fld_registration ) {
 190                                         $lastUserData['registration'] = $row->user_registration ?
 191                                                 wfTimestamp( TS_ISO_8601, $row->user_registration ) : '';
 192                                 }
 193
 194                         }
 195
 196                         if ( $sqlLimit == $count ) {
 197                                 // BUG!  database contains group name that User::getAllGroups() does not return
 198                                 // TODO: should handle this more gracefully
 199                                 ApiBase::dieDebug( __METHOD__,
 200                                         'MediaWiki configuration error: the database contains more user groups than known to User::getAllGroups() function' );
 201                         }
 202
 203                         // Add user's group info
 204                         if ( $fld_groups && !is_null( $row->ug_group2 ) ) {
 205                                 if ( !isset( $lastUserData['groups'] ) ) {
 206                                         $lastUserData['groups'] = ApiQueryUsers::getAutoGroups( User::newFromName( $lastUser ) );
 207                                 }
 208
 209                                 $lastUserData['groups'][] = $row->ug_group2;
 210                                 $result->setIndexedTagName( $lastUserData['groups'], 'g' );
 211                         }
 212
 213                         if ( $fld_rights && !is_null( $row->ug_group2 ) ) {
 214                                 if ( !isset( $lastUserData['rights'] ) ) {
 215                                         $lastUserData['rights'] = User::getGroupPermissions( User::getImplicitGroups() );
 216                                 }
 217
 218                                 $lastUserData['rights'] = array_unique( array_merge( $lastUserData['rights'],
 219                                         User::getGroupPermissions( array( $row->ug_group2 ) ) ) );
 220                                 $result->setIndexedTagName( $lastUserData['rights'], 'r' );
 221                         }
 222                 }
 223
 224                 if ( is_array( $lastUserData ) ) {
 225                         $fit = $result->addValue( array( 'query', $this->getModuleName() ),
 226                                 null, $lastUserData );
 227                         if ( !$fit ) {
 228                                 $this->setContinueEnumParameter( 'from',
 229                                         $this->keyToTitle( $lastUserData['name'] ) );
 230                         }
 231                 }
 232
 233                 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'u' );
 234         }
 235
 236         public function getCacheMode( $params ) {
 237                 return 'public';
 238         }
 239
 240         public function getAllowedParams() {
 241                 return array(
 242                         'from' => null,
 243                         'to' => null,
 244                         'prefix' => null,
 245                         'group' => array(
 246                                 ApiBase::PARAM_TYPE => User::getAllGroups(),
 247                                 ApiBase::PARAM_ISMULTI => true,
 248                         ),
 249                         'rights' => array(
 250                                 ApiBase::PARAM_TYPE => User::getAllRights(),
 251                                 ApiBase::PARAM_ISMULTI => true,
 252                         ),
 253                         'prop' => array(
 254                                 ApiBase::PARAM_ISMULTI => true,
 255                                 ApiBase::PARAM_TYPE => array(
 256                                         'blockinfo',
 257                                         'groups',
 258                                         'rights',
 259                                         'editcount',
 260                                         'registration'
 261                                 )
 262                         ),
 263                         'limit' => array(
 264                                 ApiBase::PARAM_DFLT => 10,
 265                                 ApiBase::PARAM_TYPE => 'limit',
 266                                 ApiBase::PARAM_MIN => 1,
 267                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 268                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 269                         ),
 270                         'witheditsonly' => false,
 271                 );
 272         }
 273
 274         public function getParamDescription() {
 275                 return array(
 276                         'from' => 'The user name to start enumerating from',
 277                         'to' => 'The user name to stop enumerating at',
 278                         'prefix' => 'Search for all users that begin with this value',
 279                         'group' => 'Limit users to given group name(s)',
 280                         'rights' => 'Limit users to given right(s)',
 281                         'prop' => array(
 282                                 'What pieces of information to include.',
 283                                 ' blockinfo     - Adds the information about a current block on the user',
 284                                 ' groups        - Lists groups that the user is in. This uses more server resources and may return fewer results than the limit',
 285                                 ' rights        - Lists rights that the user has',
 286                                 ' editcount     - Adds the edit count of the user',
 287                                 ' registration  - Adds the timestamp of when the user registered',
 288                                 ),
 289                         'limit' => 'How many total user names to return',
 290                         'witheditsonly' => 'Only list users who have made edits',
 291                 );
 292         }
 293
 294         public function getDescription() {
 295                 return 'Enumerate all registered users';
 296         }
 297
 298         protected function getExamples() {
 299                 return array(
 300                         'api.php?action=query&list=allusers&aufrom=Y',
 301                 );
 302         }
 303
 304         public function getVersion() {
 305                 return __CLASS__ . ': $Id$';
 306         }
 307 }