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