4 * Created on July 30, 2007
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
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 get information about a list of users
37 class ApiQueryUsers
extends ApiQueryBase
{
39 public function __construct($query, $moduleName) {
40 parent
:: __construct($query, $moduleName, 'us');
43 public function execute() {
44 $params = $this->extractRequestParams();
45 $result = $this->getResult();
48 if (!is_null($params['prop'])) {
49 $this->prop
= array_flip($params['prop']);
51 $this->prop
= array();
54 if(is_array($params['users'])) {
55 $r = $this->getOtherUsersInfo($params['users']);
56 $result->setIndexedTagName($r, 'user');
58 $result->addValue("query", $this->getModuleName(), $r);
61 protected function getOtherUsersInfo($users) {
62 $goodNames = $retval = array();
63 // Canonicalize user names
64 foreach($users as $u) {
65 $n = User
::getCanonicalName($u);
66 if($n === false ||
$n === '')
67 $retval[] = array('name' => $u, 'invalid' => '');
71 if(!count($goodNames))
75 $this->addTables('user', 'u1');
76 $this->addFields('u1.*');
77 $this->addWhereFld('u1.user_name', $goodNames);
79 if(isset($this->prop
['groups'])) {
80 $this->addTables('user_groups');
81 $this->addJoinConds(array('user_groups' => array('LEFT JOIN', 'ug_user=u1.user_id')));
82 $this->addFields('ug_group');
84 if(isset($this->prop
['blockinfo'])) {
85 $this->addTables('ipblocks');
86 $this->addTables('user', 'u2');
87 $u2 = $this->getAliasedName('user', 'u2');
88 $this->addJoinConds(array(
89 'ipblocks' => array('LEFT JOIN', 'ipb_user=u1.user_id'),
90 $u2 => array('LEFT JOIN', 'ipb_by=u2.user_id')));
91 $this->addFields(array('ipb_reason', 'u2.user_name blocker_name'));
95 $res = $this->select(__METHOD__
);
96 while(($r = $db->fetchObject($res))) {
97 $user = User
::newFromRow($r);
98 $name = $user->getName();
99 $data[$name]['name'] = $name;
100 if(isset($this->prop
['editcount']))
101 // No proper member function in User class for this
102 $data[$name]['editcount'] = $r->user_editcount
;
103 if(isset($this->prop
['registration']))
105 $data[$name]['registration'] = wfTimestampOrNull(TS_ISO_8601
, $r->user_registration
);
106 if(isset($this->prop
['groups']))
107 // This row contains only one group, others will be added from other rows
108 if(!is_null($r->ug_group
))
109 $data[$name]['groups'][] = $r->ug_group
;
110 if(isset($this->prop
['blockinfo']))
111 if(!is_null($r->blocker_name
)) {
112 $data[$name]['blockedby'] = $r->blocker_name
;
113 $data[$name]['blockreason'] = $r->ipb_reason
;
115 if(isset($this->prop
['emailable']) && $user->canReceiveEmail())
116 $data[$name]['emailable'] = '';
119 // Second pass: add result data to $retval
120 foreach($goodNames as $u) {
121 if(!isset($data[$u]))
122 $retval[] = array('name' => $u, 'missing' => '');
124 if(isset($this->prop
['groups']) && isset($data[$u]['groups']))
125 $this->getResult()->setIndexedTagName($data[$u]['groups'], 'g');
126 $retval[] = $data[$u];
132 public function getAllowedParams() {
135 ApiBase
:: PARAM_DFLT
=> NULL,
136 ApiBase
:: PARAM_ISMULTI
=> true,
137 ApiBase
:: PARAM_TYPE
=> array (
146 ApiBase
:: PARAM_ISMULTI
=> true
151 public function getParamDescription() {
154 'What pieces of information to include',
155 ' blockinfo - tags if the user is blocked, by whom, and for what reason',
156 ' groups - lists all the groups the user belongs to',
157 ' editcount - adds the user\'s edit count',
158 ' registration - adds the user\'s registration timestamp',
159 ' emailable - tags if the user can and wants to receive e-mail through [[Special:Emailuser]]',
161 'users' => 'A list of users to obtain the same information for'
165 public function getDescription() {
166 return 'Get information about a list of users';
169 protected function getExamples() {
170 return 'api.php?action=query&list=users&ususers=brion|TimStarling&usprop=groups|editcount';
173 public function getVersion() {
174 return __CLASS__
. ': $Id$';