1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
<?php
/*
* Created on July 7, 2007
*
* API for MediaWiki 1.8+
*
* Copyright (C) 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
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* 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.
* http://www.gnu.org/copyleft/gpl.html
*/
if (!defined('MEDIAWIKI')) {
// Eclipse helper - will be ignored in production
require_once ('ApiQueryBase.php');
}
/**
* Query module to enumerate all registered users.
*
* @ingroup API
*/
class ApiQueryAllUsers extends ApiQueryBase {
public function __construct($query, $moduleName) {
parent :: __construct($query, $moduleName, 'au');
}
public function execute() {
$db = $this->getDB();
$params = $this->extractRequestParams();
$prop = $params['prop'];
if (!is_null($prop)) {
$prop = array_flip($prop);
$fld_blockinfo = isset($prop['blockinfo']);
$fld_editcount = isset($prop['editcount']);
$fld_groups = isset($prop['groups']);
$fld_registration = isset($prop['registration']);
} else {
$fld_blockinfo = $fld_editcount = $fld_groups = $fld_registration = false;
}
$limit = $params['limit'];
$this->addTables('user', 'u1');
if (!is_null($params['from']))
$this->addWhere('u1.user_name >= ' . $db->addQuotes($this->keyToTitle($params['from'])));
if (!is_null($params['prefix']))
$this->addWhere('u1.user_name LIKE "' . $db->escapeLike($this->keyToTitle( $params['prefix'])) . '%"');
if (!is_null($params['group'])) {
// Filter only users that belong to a given group
$this->addTables('user_groups', 'ug1');
$this->addWhere('ug1.ug_user=u1.user_id');
$this->addWhereFld('ug1.ug_group', $params['group']);
}
if ($params['witheditsonly'])
$this->addWhere('user_editcount > 0');
if ($fld_groups) {
// Show the groups the given users belong to
// request more than needed to avoid not getting all rows that belong to one user
$groupCount = count(User::getAllGroups());
$sqlLimit = $limit+$groupCount+1;
$this->addTables('user_groups', 'ug2');
$tname = $this->getAliasedName('user_groups', 'ug2');
$this->addJoinConds(array($tname => array('LEFT JOIN', 'ug2.ug_user=u1.user_id')));
$this->addFields('ug2.ug_group ug_group2');
} 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 blocker_name'));
}
$this->addOption('LIMIT', $sqlLimit);
$this->addFields('u1.user_name');
$this->addFieldsIf('u1.user_editcount', $fld_editcount);
$this->addFieldsIf('u1.user_registration', $fld_registration);
$this->addOption('ORDER BY', 'u1.user_name');
$res = $this->select(__METHOD__);
$data = array ();
$count = 0;
$lastUserData = false;
$lastUser = false;
$result = $this->getResult();
//
// This loop keeps track of the last entry.
// For each new row, if the new row is for different user then the last, the last entry is added to results.
// 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);
$count++;
if (!$row || $lastUser !== $row->user_name) {
// Save the last pass's user data
if (is_array($lastUserData))
{
$fit = $result->addValue(array('query', $this->getModuleName()),
null, $lastUserData);
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));
break;
}
// Record new user's data
$lastUser = $row->user_name;
$lastUserData = array( 'name' => $lastUser );
if ($fld_blockinfo) {
$lastUserData['blockedby'] = $row->blocker_name;
$lastUserData['blockreason'] = $row->ipb_reason;
}
if ($fld_editcount)
$lastUserData['editcount'] = intval($row->user_editcount);
if ($fld_registration)
$lastUserData['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__,
'MediaWiki configuration error: the database contains more user groups than known to User::getAllGroups() function');
}
// Add user's group info
if ($fld_groups && !is_null($row->ug_group2)) {
$lastUserData['groups'][] = $row->ug_group2;
$result->setIndexedTagName($lastUserData['groups'], 'g');
}
}
$db->freeResult($res);
$result->setIndexedTagName_internal(array('query', $this->getModuleName()), 'u');
}
public function getAllowedParams() {
return array (
'from' => null,
'prefix' => null,
'group' => array(
ApiBase :: PARAM_TYPE => User::getAllGroups()
),
'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
),
'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.',
'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.',
'witheditsonly' => 'Only list users who have made edits',
);
}
public function getDescription() {
return 'Enumerate all registered users';
}
protected function getExamples() {
return array (
'api.php?action=query&list=allusers&aufrom=Y',
);
}
public function getVersion() {
return __CLASS__ . ': $Id: ApiQueryAllUsers.php 46845 2009-02-05 14:30:59Z catrope $';
}
}
|
