3 * API for MediaWiki 1.8+
5 * Created on July 7, 2007
7 * Copyright © 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
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.
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.
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
27 if ( !defined( 'MEDIAWIKI' ) ) {
28 // Eclipse helper - will be ignored in production
29 require_once( 'ApiQueryBase.php' );
33 * Query module to enumerate all registered users.
37 class ApiQueryAllUsers
extends ApiQueryBase
{
39 public function __construct( $query, $moduleName ) {
40 parent
::__construct( $query, $moduleName, 'au' );
43 public function execute() {
45 $params = $this->extractRequestParams();
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'] );
55 $fld_blockinfo = $fld_editcount = $fld_groups = $fld_registration = false;
58 $limit = $params['limit'];
59 $this->addTables( 'user', 'u1' );
62 if ( !is_null( $params['from'] ) ) {
63 $this->addWhere( 'u1.user_name >= ' . $db->addQuotes( $this->keyToTitle( $params['from'] ) ) );
65 if ( !is_null( $params['to'] ) ) {
66 $this->addWhere( 'u1.user_name <= ' . $db->addQuotes( $this->keyToTitle( $params['to'] ) ) );
69 if ( !is_null( $params['prefix'] ) ) {
70 $this->addWhere( 'u1.user_name' . $db->buildLike( $this->keyToTitle( $params['prefix'] ), $db->anyString() ) );
73 if ( !is_null( $params['group'] ) ) {
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'] ) ) ) );
82 if ( $params['witheditsonly'] ) {
83 $this->addWhere( 'u1.user_editcount > 0' );
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;
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' );
97 $sqlLimit = $limit +
1;
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' ) );
109 $this->addOption( 'LIMIT', $sqlLimit );
111 $this->addFields( array(
115 $this->addFieldsIf( 'u1.user_editcount', $fld_editcount );
116 $this->addFieldsIf( 'u1.user_registration', $fld_registration );
118 $this->addOption( 'ORDER BY', 'u1.user_name' );
120 $u1 = $this->getAliasedName( 'user', 'u1' );
121 $this->addOption( 'USE INDEX', array( $u1 => 'user_name' ) );
124 $res = $this->select( __METHOD__
);
127 $lastUserData = false;
129 $result = $this->getResult();
132 // This loop keeps track of the last entry.
133 // For each new row, if the new row is for different user then the last, the last entry is added to results.
134 // Otherwise, the group of the new row is appended to the last entry.
135 // The setContinue... is more complex because of this, and takes into account the higher sql limit
136 // to make sure all rows that belong to the same user are received.
138 foreach ( $res as $row ) {
141 if ( $lastUser !== $row->user_name
) {
142 // Save the last pass's user data
143 if ( is_array( $lastUserData ) ) {
144 $fit = $result->addValue( array( 'query', $this->getModuleName() ),
145 null, $lastUserData );
147 $this->setContinueEnumParameter( 'from',
148 $this->keyToTitle( $lastUserData['name'] ) );
153 if ( $count > $limit ) {
154 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
155 $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->user_name
) );
159 // Record new user's data
160 $lastUser = $row->user_name
;
161 $lastUserData = array(
163 'userid' => $row->user_id
,
165 if ( $fld_blockinfo && !is_null( $row->blocker_name
) ) {
166 $lastUserData['blockedby'] = $row->blocker_name
;
167 $lastUserData['blockreason'] = $row->ipb_reason
;
169 if ( $fld_editcount ) {
170 $lastUserData['editcount'] = intval( $row->user_editcount
);
172 if ( $fld_registration ) {
173 $lastUserData['registration'] = $row->user_registration ?
174 wfTimestamp( TS_ISO_8601
, $row->user_registration
) : '';
179 if ( $sqlLimit == $count ) {
180 // BUG! database contains group name that User::getAllGroups() does not return
181 // TODO: should handle this more gracefully
182 ApiBase
::dieDebug( __METHOD__
,
183 'MediaWiki configuration error: the database contains more user groups than known to User::getAllGroups() function' );
186 // Add user's group info
187 if ( $fld_groups && !is_null( $row->ug_group2
) ) {
188 $lastUserData['groups'][] = $row->ug_group2
;
189 $result->setIndexedTagName( $lastUserData['groups'], 'g' );
193 if ( is_array( $lastUserData ) ) {
194 $fit = $result->addValue( array( 'query', $this->getModuleName() ),
195 null, $lastUserData );
197 $this->setContinueEnumParameter( 'from',
198 $this->keyToTitle( $lastUserData['name'] ) );
202 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'u' );
205 public function getCacheMode( $params ) {
209 public function getAllowedParams() {
215 ApiBase
::PARAM_TYPE
=> User
::getAllGroups()
218 ApiBase
::PARAM_ISMULTI
=> true,
219 ApiBase
::PARAM_TYPE
=> array(
227 ApiBase
::PARAM_DFLT
=> 10,
228 ApiBase
::PARAM_TYPE
=> 'limit',
229 ApiBase
::PARAM_MIN
=> 1,
230 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
231 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
233 'witheditsonly' => false,
237 public function getParamDescription() {
239 'from' => 'The user name to start enumerating from',
240 'to' => 'The user name to stop enumerating at',
241 'prefix' => 'Search for all users that begin with this value',
242 'group' => 'Limit users to a given group name',
244 'What pieces of information to include.',
245 ' blockinfo - Adds the information about a current block on the user',
246 ' groups - Lists groups that the user is in',
247 ' editcount - Adds the edit count of the user',
248 ' registration - Adds the timestamp of when the user registered',
249 '`groups` property uses more server resources and may return fewer results than the limit' ),
250 'limit' => 'How many total user names to return',
251 'witheditsonly' => 'Only list users who have made edits',
255 public function getDescription() {
256 return 'Enumerate all registered users';
259 protected function getExamples() {
261 'api.php?action=query&list=allusers&aufrom=Y',
265 public function getVersion() {
266 return __CLASS__
. ': $Id$';