4 * Created on July 7, 2007
6 * API for MediaWiki 1.8+
8 * Copyright © 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
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.
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.
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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if ( !defined( 'MEDIAWIKI' ) ) {
27 // Eclipse helper - will be ignored in production
28 require_once( 'ApiQueryBase.php' );
32 * Query module to enumerate all registered users.
36 class ApiQueryAllUsers
extends ApiQueryBase
{
38 public function __construct( $query, $moduleName ) {
39 parent
::__construct( $query, $moduleName, 'au' );
42 public function execute() {
44 $params = $this->extractRequestParams();
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'] );
54 $fld_blockinfo = $fld_editcount = $fld_groups = $fld_registration = false;
57 $limit = $params['limit'];
58 $this->addTables( 'user', 'u1' );
61 if ( !is_null( $params['from'] ) ) {
62 $this->addWhere( 'u1.user_name >= ' . $db->addQuotes( $this->keyToTitle( $params['from'] ) ) );
65 if ( !is_null( $params['prefix'] ) ) {
66 $this->addWhere( 'u1.user_name' . $db->buildLike( $this->keyToTitle( $params['prefix'] ), $db->anyString() ) );
69 if ( !is_null( $params['group'] ) ) {
71 // Filter only users that belong to a given group
72 $this->addTables( 'user_groups', 'ug1' );
73 $ug1 = $this->getAliasedName( 'user_groups', 'ug1' );
74 $this->addJoinConds( array( $ug1 => array( 'INNER JOIN', array( 'ug1.ug_user=u1.user_id',
75 'ug1.ug_group' => $params['group'] ) ) ) );
78 if ( $params['witheditsonly'] ) {
79 $this->addWhere( 'u1.user_editcount > 0' );
83 // Show the groups the given users belong to
84 // request more than needed to avoid not getting all rows that belong to one user
85 $groupCount = count( User
::getAllGroups() );
86 $sqlLimit = $limit +
$groupCount +
1;
88 $this->addTables( 'user_groups', 'ug2' );
89 $tname = $this->getAliasedName( 'user_groups', 'ug2' );
90 $this->addJoinConds( array( $tname => array( 'LEFT JOIN', 'ug2.ug_user=u1.user_id' ) ) );
91 $this->addFields( 'ug2.ug_group ug_group2' );
93 $sqlLimit = $limit +
1;
95 if ( $fld_blockinfo ) {
96 $this->addTables( 'ipblocks' );
97 $this->addTables( 'user', 'u2' );
98 $u2 = $this->getAliasedName( 'user', 'u2' );
99 $this->addJoinConds( array(
100 'ipblocks' => array( 'LEFT JOIN', 'ipb_user=u1.user_id' ),
101 $u2 => array( 'LEFT JOIN', 'ipb_by=u2.user_id' ) ) );
102 $this->addFields( array( 'ipb_reason', 'u2.user_name AS blocker_name' ) );
105 $this->addOption( 'LIMIT', $sqlLimit );
107 $this->addFields( 'u1.user_name' );
108 $this->addFieldsIf( 'u1.user_editcount', $fld_editcount );
109 $this->addFieldsIf( 'u1.user_registration', $fld_registration );
111 $this->addOption( 'ORDER BY', 'u1.user_name' );
113 $u1 = $this->getAliasedName( 'user', 'u1' );
114 $this->addOption( 'USE INDEX', array( $u1 => 'user_name' ) );
117 $res = $this->select( __METHOD__
);
120 $lastUserData = false;
122 $result = $this->getResult();
125 // This loop keeps track of the last entry.
126 // For each new row, if the new row is for different user then the last, the last entry is added to results.
127 // Otherwise, the group of the new row is appended to the last entry.
128 // The setContinue... is more complex because of this, and takes into account the higher sql limit
129 // to make sure all rows that belong to the same user are received.
131 $row = $db->fetchObject( $res );
132 foreach ( $res as $row ) {
135 if ( $lastUser !== $row->user_name
) {
136 // Save the last pass's user data
137 if ( is_array( $lastUserData ) ) {
138 $fit = $result->addValue( array( 'query', $this->getModuleName() ),
139 null, $lastUserData );
141 $this->setContinueEnumParameter( 'from',
142 $this->keyToTitle( $lastUserData['name'] ) );
147 if ( $count > $limit ) {
148 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
149 $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->user_name
) );
153 // Record new user's data
154 $lastUser = $row->user_name
;
155 $lastUserData = array( 'name' => $lastUser );
156 if ( $fld_blockinfo ) {
157 $lastUserData['blockedby'] = $row->blocker_name
;
158 $lastUserData['blockreason'] = $row->ipb_reason
;
160 if ( $fld_editcount ) {
161 $lastUserData['editcount'] = intval( $row->user_editcount
);
163 if ( $fld_registration ) {
164 $lastUserData['registration'] = $row->user_registration ?
165 wfTimestamp( TS_ISO_8601
, $row->user_registration
) : '';
170 if ( $sqlLimit == $count ) {
171 // BUG! database contains group name that User::getAllGroups() does not return
172 // TODO: should handle this more gracefully
173 ApiBase
::dieDebug( __METHOD__
,
174 'MediaWiki configuration error: the database contains more user groups than known to User::getAllGroups() function' );
177 // Add user's group info
178 if ( $fld_groups && !is_null( $row->ug_group2
) ) {
179 $lastUserData['groups'][] = $row->ug_group2
;
180 $result->setIndexedTagName( $lastUserData['groups'], 'g' );
184 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'u' );
187 public function getAllowedParams() {
192 ApiBase
::PARAM_TYPE
=> User
::getAllGroups()
195 ApiBase
::PARAM_ISMULTI
=> true,
196 ApiBase
::PARAM_TYPE
=> array(
204 ApiBase
::PARAM_DFLT
=> 10,
205 ApiBase
::PARAM_TYPE
=> 'limit',
206 ApiBase
::PARAM_MIN
=> 1,
207 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
208 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
210 'witheditsonly' => false,
214 public function getParamDescription() {
216 'from' => 'The user name to start enumerating from',
217 'prefix' => 'Search for all page titles that begin with this value',
218 'group' => 'Limit users to a given group name',
220 'What pieces of information to include.',
221 ' blockinfo - Adds the information about a current block on the user',
222 ' groups - Lists groups that the user is in',
223 ' editcount - Adds the edit count of the user',
224 ' registration - Adds the timestamp of when the user registered',
225 '`groups` property uses more server resources and may return fewer results than the limit' ),
226 'limit' => 'How many total user names to return',
227 'witheditsonly' => 'Only list users who have made edits',
231 public function getDescription() {
232 return 'Enumerate all registered users';
235 protected function getExamples() {
237 'api.php?action=query&list=allusers&aufrom=Y',
241 public function getVersion() {
242 return __CLASS__
. ': $Id$';