4 * Created on July 7, 2007
6 * API for MediaWiki 1.8+
8 * Copyright (C) 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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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'])));
64 if (!is_null($params['prefix']))
65 $this->addWhere('u1.user_name' . $db->buildLike($this->keyToTitle($params['prefix']), $db->anyString()));
67 if (!is_null($params['group'])) {
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']))));
76 if ($params['witheditsonly'])
77 $this->addWhere('user_editcount > 0');
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;
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');
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 blocker_name'));
102 $this->addOption('LIMIT', $sqlLimit);
104 $this->addFields('u1.user_name');
105 $this->addFieldsIf('u1.user_editcount', $fld_editcount);
106 $this->addFieldsIf('u1.user_registration', $fld_registration);
108 $this->addOption('ORDER BY', 'u1.user_name');
110 $u1 = $this->getAliasedName('user', 'u1');
111 $this->addOption('USE INDEX', array($u1 => 'user_name'));
114 $res = $this->select(__METHOD__
);
118 $lastUserData = false;
120 $result = $this->getResult();
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.
131 $row = $db->fetchObject($res);
134 if (!$row ||
$lastUser !== $row->user_name
) {
135 // Save the last pass's user data
136 if (is_array($lastUserData))
138 $fit = $result->addValue(array('query', $this->getModuleName()),
139 null, $lastUserData);
142 $this->setContinueEnumParameter('from',
143 $this->keyToTitle($lastUserData['name']));
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
));
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
;
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
) : '';
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');
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');
187 $db->freeResult($res);
189 $result->setIndexedTagName_internal(array('query', $this->getModuleName()), 'u');
192 public function getAllowedParams() {
197 ApiBase
:: PARAM_TYPE
=> User
::getAllGroups()
200 ApiBase
:: PARAM_ISMULTI
=> true,
201 ApiBase
:: PARAM_TYPE
=> 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
215 'witheditsonly' => false,
219 public function getParamDescription() {
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',
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',
232 public function getDescription() {
233 return 'Enumerate all registered users';
236 protected function getExamples() {
238 'api.php?action=query&list=allusers&aufrom=Y',
242 public function getVersion() {
243 return __CLASS__
. ': $Id$';