summaryrefslogtreecommitdiff
path: root/includes/api/ApiQueryAllUsers.php
diff options
context:
space:
mode:
Diffstat (limited to 'includes/api/ApiQueryAllUsers.php')
-rw-r--r--includes/api/ApiQueryAllUsers.php141
1 files changed, 75 insertions, 66 deletions
diff --git a/includes/api/ApiQueryAllUsers.php b/includes/api/ApiQueryAllUsers.php
index 611fc98c..77f507fc 100644
--- a/includes/api/ApiQueryAllUsers.php
+++ b/includes/api/ApiQueryAllUsers.php
@@ -1,11 +1,10 @@
<?php
-
-/*
- * Created on July 7, 2007
- *
+/**
* API for MediaWiki 1.8+
*
- * Copyright (C) 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Created on July 7, 2007
+ *
+ * Copyright © 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -19,13 +18,15 @@
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
- require_once ( 'ApiQueryBase.php' );
+ require_once( 'ApiQueryBase.php' );
}
/**
@@ -34,9 +35,8 @@ if ( !defined( 'MEDIAWIKI' ) ) {
* @ingroup API
*/
class ApiQueryAllUsers extends ApiQueryBase {
-
public function __construct( $query, $moduleName ) {
- parent :: __construct( $query, $moduleName, 'au' );
+ parent::__construct( $query, $moduleName, 'au' );
}
public function execute() {
@@ -51,18 +51,23 @@ class ApiQueryAllUsers extends ApiQueryBase {
$fld_groups = isset( $prop['groups'] );
$fld_registration = isset( $prop['registration'] );
} else {
- $fld_blockinfo = $fld_editcount = $fld_groups = $fld_registration = false;
+ $fld_blockinfo = $fld_editcount = $fld_groups = $fld_registration = $fld_rights = false;
}
$limit = $params['limit'];
$this->addTables( 'user', 'u1' );
$useIndex = true;
- if ( !is_null( $params['from'] ) )
+ if ( !is_null( $params['from'] ) ) {
$this->addWhere( 'u1.user_name >= ' . $db->addQuotes( $this->keyToTitle( $params['from'] ) ) );
+ }
+ if ( !is_null( $params['to'] ) ) {
+ $this->addWhere( 'u1.user_name <= ' . $db->addQuotes( $this->keyToTitle( $params['to'] ) ) );
+ }
- if ( !is_null( $params['prefix'] ) )
+ if ( !is_null( $params['prefix'] ) ) {
$this->addWhere( 'u1.user_name' . $db->buildLike( $this->keyToTitle( $params['prefix'] ), $db->anyString() ) );
+ }
if ( !is_null( $params['group'] ) ) {
$useIndex = false;
@@ -73,8 +78,9 @@ class ApiQueryAllUsers extends ApiQueryBase {
'ug1.ug_group' => $params['group'] ) ) ) );
}
- if ( $params['witheditsonly'] )
+ if ( $params['witheditsonly'] ) {
$this->addWhere( 'u1.user_editcount > 0' );
+ }
if ( $fld_groups ) {
// Show the groups the given users belong to
@@ -89,19 +95,14 @@ class ApiQueryAllUsers extends ApiQueryBase {
} else {
$sqlLimit = $limit + 1;
}
- if ( $fld_blockinfo ) {
- $this->addTables( 'ipblocks' );
- $this->addTables( 'user', 'u2' );
- $u2 = $this->getAliasedName( 'user', 'u2' );
- $this->addJoinConds( array(
- 'ipblocks' => array( 'LEFT JOIN', 'ipb_user=u1.user_id' ),
- $u2 => array( 'LEFT JOIN', 'ipb_by=u2.user_id' ) ) );
- $this->addFields( array( 'ipb_reason', 'u2.user_name AS blocker_name' ) );
- }
+ $this->showHiddenUsersAddBlockInfo( $fld_blockinfo );
$this->addOption( 'LIMIT', $sqlLimit );
- $this->addFields( 'u1.user_name' );
+ $this->addFields( array(
+ 'u1.user_name',
+ 'u1.user_id'
+ ) );
$this->addFieldsIf( 'u1.user_editcount', $fld_editcount );
$this->addFieldsIf( 'u1.user_registration', $fld_registration );
@@ -113,7 +114,6 @@ class ApiQueryAllUsers extends ApiQueryBase {
$res = $this->select( __METHOD__ );
- $data = array ();
$count = 0;
$lastUserData = false;
$lastUser = false;
@@ -125,30 +125,25 @@ class ApiQueryAllUsers extends ApiQueryBase {
// Otherwise, the group of the new row is appended to the last entry.
// The setContinue... is more complex because of this, and takes into account the higher sql limit
// to make sure all rows that belong to the same user are received.
- //
- while ( true ) {
- $row = $db->fetchObject( $res );
+ foreach ( $res as $row ) {
$count++;
- if ( !$row || $lastUser !== $row->user_name ) {
+ if ( $lastUser !== $row->user_name ) {
// Save the last pass's user data
- if ( is_array( $lastUserData ) )
- {
+ if ( is_array( $lastUserData ) ) {
$fit = $result->addValue( array( 'query', $this->getModuleName() ),
null, $lastUserData );
- if ( !$fit )
- {
+
+ $lastUserData = null;
+
+ if ( !$fit ) {
$this->setContinueEnumParameter( 'from',
$this->keyToTitle( $lastUserData['name'] ) );
break;
}
}
- // No more rows left
- if ( !$row )
- break;
-
if ( $count > $limit ) {
// We've reached the one extra which shows that there are additional pages to be had. Stop here...
$this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->user_name ) );
@@ -157,23 +152,31 @@ class ApiQueryAllUsers extends ApiQueryBase {
// Record new user's data
$lastUser = $row->user_name;
- $lastUserData = array( 'name' => $lastUser );
- if ( $fld_blockinfo ) {
+ $lastUserData = array(
+ 'name' => $lastUser,
+ 'userid' => $row->user_id,
+ );
+ if ( $fld_blockinfo && !is_null( $row->blocker_name ) ) {
$lastUserData['blockedby'] = $row->blocker_name;
$lastUserData['blockreason'] = $row->ipb_reason;
}
- if ( $fld_editcount )
+ if ( $row->ipb_deleted ) {
+ $lastUserData['hidden'] = '';
+ }
+ if ( $fld_editcount ) {
$lastUserData['editcount'] = intval( $row->user_editcount );
- if ( $fld_registration )
+ }
+ if ( $fld_registration ) {
$lastUserData['registration'] = $row->user_registration ?
wfTimestamp( TS_ISO_8601, $row->user_registration ) : '';
+ }
}
if ( $sqlLimit == $count ) {
// BUG! database contains group name that User::getAllGroups() does not return
// TODO: should handle this more gracefully
- ApiBase :: dieDebug( __METHOD__,
+ ApiBase::dieDebug( __METHOD__,
'MediaWiki configuration error: the database contains more user groups than known to User::getAllGroups() function' );
}
@@ -185,57 +188,63 @@ class ApiQueryAllUsers extends ApiQueryBase {
}
if ( is_array( $lastUserData ) ) {
- $fit = $result->addValue( array( 'query', $this->getModuleName() ),
- null, $lastUserData );
- if ( !$fit ) {
- $this->setContinueEnumParameter( 'from',
- $this->keyToTitle( $lastUserData['name'] ) );
- }
+ $fit = $result->addValue( array( 'query', $this->getModuleName() ),
+ null, $lastUserData );
+ if ( !$fit ) {
+ $this->setContinueEnumParameter( 'from',
+ $this->keyToTitle( $lastUserData['name'] ) );
+ }
}
$result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'u' );
}
public function getCacheMode( $params ) {
- return 'public';
+ return 'anon-public-user-private';
}
public function getAllowedParams() {
- return array (
+ return array(
'from' => null,
+ 'to' => null,
'prefix' => null,
'group' => array(
- ApiBase :: PARAM_TYPE => User::getAllGroups()
+ ApiBase::PARAM_TYPE => User::getAllGroups()
),
- 'prop' => array (
- ApiBase :: PARAM_ISMULTI => true,
- ApiBase :: PARAM_TYPE => array (
+ 'prop' => array(
+ ApiBase::PARAM_ISMULTI => true,
+ ApiBase::PARAM_TYPE => array(
'blockinfo',
'groups',
'editcount',
'registration'
)
),
- 'limit' => array (
- ApiBase :: PARAM_DFLT => 10,
- ApiBase :: PARAM_TYPE => 'limit',
- ApiBase :: PARAM_MIN => 1,
- ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
- ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
+ 'limit' => array(
+ ApiBase::PARAM_DFLT => 10,
+ ApiBase::PARAM_TYPE => 'limit',
+ ApiBase::PARAM_MIN => 1,
+ ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
+ ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
),
'witheditsonly' => false,
);
}
public function getParamDescription() {
- return array (
- 'from' => 'The user name to start enumerating from.',
- 'prefix' => 'Search for all page titles that begin with this value.',
+ return array(
+ 'from' => 'The user name to start enumerating from',
+ 'to' => 'The user name to stop enumerating at',
+ 'prefix' => 'Search for all users that begin with this value',
'group' => 'Limit users to a given group name',
'prop' => array(
'What pieces of information to include.',
- '`groups` property uses more server resources and may return fewer results than the limit.' ),
- 'limit' => 'How many total user names to return.',
+ ' blockinfo - Adds the information about a current block on the user',
+ ' groups - Lists groups that the user is in',
+ ' editcount - Adds the edit count of the user',
+ ' registration - Adds the timestamp of when the user registered',
+ '`groups` property uses more server resources and may return fewer results than the limit' ),
+ 'limit' => 'How many total user names to return',
'witheditsonly' => 'Only list users who have made edits',
);
}
@@ -245,12 +254,12 @@ class ApiQueryAllUsers extends ApiQueryBase {
}
protected function getExamples() {
- return array (
+ return array(
'api.php?action=query&list=allusers&aufrom=Y',
);
}
public function getVersion() {
- return __CLASS__ . ': $Id: ApiQueryAllUsers.php 79562 2011-01-04 06:15:54Z tstarling $';
+ return __CLASS__ . ': $Id: ApiQueryAllUsers.php 85354 2011-04-04 18:25:31Z demon $';
}
}
generated by cgit v1.2.2 (git 2.25.0) at 2024-04-19 21:30:24 +0000