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
36 class ApiQueryUsers
extends ApiQueryBase
{
38 public function __construct( $query, $moduleName ) {
39 parent
:: __construct( $query, $moduleName, 'us' );
43 * Get an array mapping token names to their handler functions.
44 * The prototype for a token function is func($user)
45 * it should return a token or false (permission denied)
46 * @return array(tokenname => function)
48 protected function getTokenFunctions() {
49 // Don't call the hooks twice
50 if ( isset( $this->tokenFunctions
) )
51 return $this->tokenFunctions
;
53 // If we're in JSON callback mode, no tokens can be obtained
54 if ( !is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) )
57 $this->tokenFunctions
= array(
58 'userrights' => array( 'ApiQueryUsers', 'getUserrightsToken' ),
60 wfRunHooks( 'APIQueryUsersTokens', array( &$this->tokenFunctions
) );
61 return $this->tokenFunctions
;
64 public static function getUserrightsToken( $user )
67 // Since the permissions check for userrights is non-trivial,
68 // don't bother with it here
69 return $wgUser->editToken( $user->getName() );
72 public function execute() {
73 $params = $this->extractRequestParams();
74 $result = $this->getResult();
77 if ( !is_null( $params['prop'] ) ) {
78 $this->prop
= array_flip( $params['prop'] );
80 $this->prop
= array();
83 $users = (array)$params['users'];
84 $goodNames = $done = array();
85 $result = $this->getResult();
86 // Canonicalize user names
87 foreach ( $users as $u ) {
88 $n = User
::getCanonicalName( $u );
89 if ( $n === false ||
$n === '' )
91 $vals = array( 'name' => $u, 'invalid' => '' );
92 $fit = $result->addValue( array( 'query', $this->getModuleName() ),
96 $this->setContinueEnumParameter( 'users',
97 implode( '|', array_diff( $users, $done ) ) );
107 if ( count( $goodNames ) )
109 $db = $this->getDb();
110 $this->addTables( 'user', 'u1' );
111 $this->addFields( 'u1.*' );
112 $this->addWhereFld( 'u1.user_name', $goodNames );
114 if ( isset( $this->prop
['groups'] ) ) {
115 $this->addTables( 'user_groups' );
116 $this->addJoinConds( array( 'user_groups' => array( 'LEFT JOIN', 'ug_user=u1.user_id' ) ) );
117 $this->addFields( 'ug_group' );
119 if ( isset( $this->prop
['blockinfo'] ) ) {
120 $this->addTables( 'ipblocks' );
121 $this->addTables( 'user', 'u2' );
122 $u2 = $this->getAliasedName( 'user', 'u2' );
123 $this->addJoinConds( array(
124 'ipblocks' => array( 'LEFT JOIN', 'ipb_user=u1.user_id' ),
125 $u2 => array( 'LEFT JOIN', 'ipb_by=u2.user_id' ) ) );
126 $this->addFields( array( 'ipb_reason', 'u2.user_name AS blocker_name' ) );
130 $res = $this->select( __METHOD__
);
131 while ( ( $r = $db->fetchObject( $res ) ) ) {
132 $user = User
::newFromRow( $r );
133 $name = $user->getName();
134 $data[$name]['name'] = $name;
135 if ( isset( $this->prop
['editcount'] ) )
136 $data[$name]['editcount'] = intval( $user->getEditCount() );
137 if ( isset( $this->prop
['registration'] ) )
138 $data[$name]['registration'] = wfTimestampOrNull( TS_ISO_8601
, $user->getRegistration() );
139 if ( isset( $this->prop
['groups'] ) && !is_null( $r->ug_group
) )
140 // This row contains only one group, others will be added from other rows
141 $data[$name]['groups'][] = $r->ug_group
;
142 if ( isset( $this->prop
['blockinfo'] ) && !is_null( $r->blocker_name
) ) {
143 $data[$name]['blockedby'] = $r->blocker_name
;
144 $data[$name]['blockreason'] = $r->ipb_reason
;
146 if ( isset( $this->prop
['emailable'] ) && $user->canReceiveEmail() )
147 $data[$name]['emailable'] = '';
149 if ( isset( $this->prop
['gender'] ) ) {
150 $gender = $user->getOption( 'gender' );
151 if ( strval( $gender ) === '' ) {
154 $data[$name]['gender'] = $gender;
157 if ( !is_null( $params['token'] ) )
159 $tokenFunctions = $this->getTokenFunctions();
160 foreach ( $params['token'] as $t )
162 $val = call_user_func( $tokenFunctions[$t], $user );
163 if ( $val === false )
164 $this->setWarning( "Action '$t' is not allowed for the current user" );
166 $data[$name][$t . 'token'] = $val;
171 // Second pass: add result data to $retval
172 foreach ( $goodNames as $u ) {
173 if ( !isset( $data[$u] ) ) {
174 $data[$u] = array( 'name' => $u );
175 $urPage = new UserrightsPage
;
176 $iwUser = $urPage->fetchUser( $u );
177 if ( $iwUser instanceof UserRightsProxy
) {
178 $data[$u]['interwiki'] = '';
179 if ( !is_null( $params['token'] ) )
181 $tokenFunctions = $this->getTokenFunctions();
182 foreach ( $params['token'] as $t )
184 $val = call_user_func( $tokenFunctions[$t], $iwUser );
185 if ( $val === false )
186 $this->setWarning( "Action '$t' is not allowed for the current user" );
188 $data[$u][$t . 'token'] = $val;
192 $data[$u]['missing'] = '';
194 if ( isset( $this->prop
['groups'] ) && isset( $data[$u]['groups'] ) )
195 $this->getResult()->setIndexedTagName( $data[$u]['groups'], 'g' );
197 $fit = $result->addValue( array( 'query', $this->getModuleName() ),
201 $this->setContinueEnumParameter( 'users',
202 implode( '|', array_diff( $users, $done ) ) );
207 return $this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'user' );
210 public function getAllowedParams() {
213 ApiBase
:: PARAM_DFLT
=> null,
214 ApiBase
:: PARAM_ISMULTI
=> true,
215 ApiBase
:: PARAM_TYPE
=> array (
225 ApiBase
:: PARAM_ISMULTI
=> true
228 ApiBase
:: PARAM_TYPE
=> array_keys( $this->getTokenFunctions() ),
229 ApiBase
:: PARAM_ISMULTI
=> true
234 public function getParamDescription() {
237 'What pieces of information to include',
238 ' blockinfo - tags if the user is blocked, by whom, and for what reason',
239 ' groups - lists all the groups the user belongs to',
240 ' editcount - adds the user\'s edit count',
241 ' registration - adds the user\'s registration timestamp',
242 ' emailable - tags if the user can and wants to receive e-mail through [[Special:Emailuser]]',
243 ' gender - tags the gender of the user. Returns "male", "female", or "unknown"',
245 'users' => 'A list of users to obtain the same information for',
246 'token' => 'Which tokens to obtain for each user',
250 public function getDescription() {
251 return 'Get information about a list of users';
254 protected function getExamples() {
255 return 'api.php?action=query&list=users&ususers=brion|TimStarling&usprop=groups|editcount|gender';
258 public function getVersion() {
259 return __CLASS__
. ': $Id$';