includes/api/ApiQueryAllUsers.php

   1 <?php
   2
   3 /*
   4  * Created on July 7, 2007
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if ( !defined( 'MEDIAWIKI' ) ) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ( 'ApiQueryBase.php' );
  29 }
  30
  31 /**
  32  * Query module to enumerate all registered users.
  33  *
  34  * @ingroup API
  35  */
  36 class ApiQueryAllUsers extends ApiQueryBase {
  37
  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_registration = isset( $prop['registration'] );
  53                 } else {
  54                         $fld_blockinfo = $fld_editcount = $fld_groups = $fld_registration = false;
  55                 }
  56
  57                 $limit = $params['limit'];
  58                 $this->addTables( 'user', 'u1' );
  59                 $useIndex = true;
  60
  61                 if ( !is_null( $params['from'] ) )
  62                         $this->addWhere( 'u1.user_name >= ' . $db->addQuotes( $this->keyToTitle( $params['from'] ) ) );
  63
  64                 if ( !is_null( $params['prefix'] ) )
  65                         $this->addWhere( 'u1.user_name' . $db->buildLike( $this->keyToTitle( $params['prefix'] ), $db->anyString() ) );
  66
  67                 if ( !is_null( $params['group'] ) ) {
  68                         $useIndex = false;
  69                         // Filter only users that belong to a given group
  70                         $this->addTables( 'user_groups', 'ug1' );
  71                         $ug1 = $this->getAliasedName( 'user_groups', 'ug1' );
  72                         $this->addJoinConds( array( $ug1 => array( 'INNER JOIN', array( 'ug1.ug_user=u1.user_id',
  73                                         'ug1.ug_group' => $params['group'] ) ) ) );
  74                 }
  75
  76                 if ( $params['witheditsonly'] )
  77                         $this->addWhere( 'user_editcount > 0' );
  78
  79                 if ( $fld_groups ) {
  80                         // Show the groups the given users belong to
  81                         // request more than needed to avoid not getting all rows that belong to one user
  82                         $groupCount = count( User::getAllGroups() );
  83                         $sqlLimit = $limit + $groupCount + 1;
  84
  85                         $this->addTables( 'user_groups', 'ug2' );
  86                         $tname = $this->getAliasedName( 'user_groups', 'ug2' );
  87                         $this->addJoinConds( array( $tname => array( 'LEFT JOIN', 'ug2.ug_user=u1.user_id' ) ) );
  88                         $this->addFields( 'ug2.ug_group ug_group2' );
  89                 } else {
  90                         $sqlLimit = $limit + 1;
  91                 }
  92                 if ( $fld_blockinfo ) {
  93                         $this->addTables( 'ipblocks' );
  94                         $this->addTables( 'user', 'u2' );
  95                         $u2 = $this->getAliasedName( 'user', 'u2' );
  96                         $this->addJoinConds( array(
  97                                 'ipblocks' => array( 'LEFT JOIN', 'ipb_user=u1.user_id' ),
  98                                 $u2 => array( 'LEFT JOIN', 'ipb_by=u2.user_id' ) ) );
  99                         $this->addFields( array( 'ipb_reason', 'u2.user_name AS blocker_name' ) );
 100                 }
 101
 102                 $this->addOption( 'LIMIT', $sqlLimit );
 103
 104                 $this->addFields( 'u1.user_name' );
 105                 $this->addFieldsIf( 'u1.user_editcount', $fld_editcount );
 106                 $this->addFieldsIf( 'u1.user_registration', $fld_registration );
 107
 108                 $this->addOption( 'ORDER BY', 'u1.user_name' );
 109                 if ( $useIndex ) {
 110                         $u1 = $this->getAliasedName( 'user', 'u1' );
 111                         $this->addOption( 'USE INDEX', array( $u1 => 'user_name' ) );
 112                 }
 113
 114                 $res = $this->select( __METHOD__ );
 115
 116                 $data = array ();
 117                 $count = 0;
 118                 $lastUserData = false;
 119                 $lastUser = false;
 120                 $result = $this->getResult();
 121
 122                 //
 123                 // This loop keeps track of the last entry.
 124                 // For each new row, if the new row is for different user then the last, the last entry is added to results.
 125                 // Otherwise, the group of the new row is appended to the last entry.
 126                 // The setContinue... is more complex because of this, and takes into account the higher sql limit
 127                 // to make sure all rows that belong to the same user are received.
 128                 //
 129                 while ( true ) {
 130
 131                         $row = $db->fetchObject( $res );
 132                         $count++;
 133
 134                         if ( !$row || $lastUser !== $row->user_name ) {
 135                                 // Save the last pass's user data
 136                                 if ( is_array( $lastUserData ) )
 137                                 {
 138                                         $fit = $result->addValue( array( 'query', $this->getModuleName() ),
 139                                                         null, $lastUserData );
 140                                         if ( !$fit )
 141                                         {
 142                                                 $this->setContinueEnumParameter( 'from',
 143                                                                 $this->keyToTitle( $lastUserData['name'] ) );
 144                                                 break;
 145                                         }
 146                                 }
 147
 148                                 // No more rows left
 149                                 if ( !$row )
 150                                         break;
 151
 152                                 if ( $count > $limit ) {
 153                                         // We've reached the one extra which shows that there are additional pages to be had. Stop here...
 154                                         $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->user_name ) );
 155                                         break;
 156                                 }
 157
 158                                 // Record new user's data
 159                                 $lastUser = $row->user_name;
 160                                 $lastUserData = array( 'name' => $lastUser );
 161                                 if ( $fld_blockinfo ) {
 162                                         $lastUserData['blockedby'] = $row->blocker_name;
 163                                         $lastUserData['blockreason'] = $row->ipb_reason;
 164                                 }
 165                                 if ( $fld_editcount )
 166                                         $lastUserData['editcount'] = intval( $row->user_editcount );
 167                                 if ( $fld_registration )
 168                                         $lastUserData['registration'] = $row->user_registration ?
 169                                                 wfTimestamp( TS_ISO_8601, $row->user_registration ) : '';
 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                 $db->freeResult( $res );
 188
 189                 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'u' );
 190         }
 191
 192         public function getAllowedParams() {
 193                 return array (
 194                         'from' => null,
 195                         'prefix' => null,
 196                         'group' => array(
 197                                 ApiBase :: PARAM_TYPE => User::getAllGroups()
 198                         ),
 199                         'prop' => array (
 200                                 ApiBase :: PARAM_ISMULTI => true,
 201                                 ApiBase :: PARAM_TYPE => array (
 202                                         'blockinfo',
 203                                         'groups',
 204                                         'editcount',
 205                                         'registration'
 206                                 )
 207                         ),
 208                         'limit' => array (
 209                                 ApiBase :: PARAM_DFLT => 10,
 210                                 ApiBase :: PARAM_TYPE => 'limit',
 211                                 ApiBase :: PARAM_MIN => 1,
 212                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 213                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 214                         ),
 215                         'witheditsonly' => false,
 216                 );
 217         }
 218
 219         public function getParamDescription() {
 220                 return array (
 221                         'from' => 'The user name to start enumerating from.',
 222                         'prefix' => 'Search for all page titles that begin with this value.',
 223                         'group' => 'Limit users to a given group name',
 224                         'prop' => array(
 225                                 'What pieces of information to include.',
 226                                 '`groups` property uses more server resources and may return fewer results than the limit.' ),
 227                         'limit' => 'How many total user names to return.',
 228                         'witheditsonly' => 'Only list users who have made edits',
 229                 );
 230         }
 231
 232         public function getDescription() {
 233                 return 'Enumerate all registered users';
 234         }
 235
 236         protected function getExamples() {
 237                 return array (
 238                         'api.php?action=query&list=allusers&aufrom=Y',
 239                 );
 240         }
 241
 242         public function getVersion() {
 243                 return __CLASS__ . ': $Id$';
 244         }
 245 }