includes/api/ApiQueryAllUsers.php

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