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
|
<?php
/*
* Created on July 30, 2007
*
* API for MediaWiki 1.8+
*
* Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
*
* 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 get information about a list of users
*
* @ingroup API
*/
class ApiQueryUsers extends ApiQueryBase {
public function __construct($query, $moduleName) {
parent :: __construct($query, $moduleName, 'us');
}
public function execute() {
$params = $this->extractRequestParams();
$result = $this->getResult();
$r = array();
if (!is_null($params['prop'])) {
$this->prop = array_flip($params['prop']);
} else {
$this->prop = array();
}
if(is_array($params['users'])) {
$r = $this->getOtherUsersInfo($params['users']);
$result->setIndexedTagName($r, 'user');
}
$result->addValue("query", $this->getModuleName(), $r);
}
protected function getOtherUsersInfo($users) {
$goodNames = $retval = array();
// Canonicalize user names
foreach($users as $u) {
$n = User::getCanonicalName($u);
if($n === false || $n === '')
$retval[] = array('name' => $u, 'invalid' => '');
else
$goodNames[] = $n;
}
if(!count($goodNames))
return $retval;
$db = $this->getDB();
$this->addTables('user', 'u1');
$this->addFields('u1.*');
$this->addWhereFld('u1.user_name', $goodNames);
if(isset($this->prop['groups'])) {
$this->addTables('user_groups');
$this->addJoinConds(array('user_groups' => array('LEFT JOIN', 'ug_user=u1.user_id')));
$this->addFields('ug_group');
}
if(isset($this->prop['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'));
}
$data = array();
$res = $this->select(__METHOD__);
while(($r = $db->fetchObject($res))) {
$user = User::newFromRow($r);
$name = $user->getName();
$data[$name]['name'] = $name;
if(isset($this->prop['editcount']))
// No proper member function in User class for this
$data[$name]['editcount'] = $r->user_editcount;
if(isset($this->prop['registration']))
// Nor for this one
$data[$name]['registration'] = wfTimestampOrNull(TS_ISO_8601, $r->user_registration);
if(isset($this->prop['groups']))
// This row contains only one group, others will be added from other rows
if(!is_null($r->ug_group))
$data[$name]['groups'][] = $r->ug_group;
if(isset($this->prop['blockinfo']))
if(!is_null($r->blocker_name)) {
$data[$name]['blockedby'] = $r->blocker_name;
$data[$name]['blockreason'] = $r->ipb_reason;
}
if(isset($this->prop['emailable']) && $user->canReceiveEmail())
$data[$name]['emailable'] = '';
}
// Second pass: add result data to $retval
foreach($goodNames as $u) {
if(!isset($data[$u]))
$retval[] = array('name' => $u, 'missing' => '');
else {
if(isset($this->prop['groups']) && isset($data[$u]['groups']))
$this->getResult()->setIndexedTagName($data[$u]['groups'], 'g');
$retval[] = $data[$u];
}
}
return $retval;
}
public function getAllowedParams() {
return array (
'prop' => array (
ApiBase :: PARAM_DFLT => NULL,
ApiBase :: PARAM_ISMULTI => true,
ApiBase :: PARAM_TYPE => array (
'blockinfo',
'groups',
'editcount',
'registration',
'emailable',
)
),
'users' => array(
ApiBase :: PARAM_ISMULTI => true
)
);
}
public function getParamDescription() {
return array (
'prop' => array(
'What pieces of information to include',
' blockinfo - tags if the user is blocked, by whom, and for what reason',
' groups - lists all the groups the user belongs to',
' editcount - adds the user\'s edit count',
' registration - adds the user\'s registration timestamp',
' emailable - tags if the user can and wants to receive e-mail through [[Special:Emailuser]]',
),
'users' => 'A list of users to obtain the same information for'
);
}
public function getDescription() {
return 'Get information about a list of users';
}
protected function getExamples() {
return 'api.php?action=query&list=users&ususers=brion|TimStarling&usprop=groups|editcount';
}
public function getVersion() {
return __CLASS__ . ': $Id: ApiQueryUsers.php 44231 2008-12-04 14:42:30Z catrope $';
}
}
|
