86ce74c75d
* (bug 27549) action=query&list=users&usprop=groups doesn't show implicit groups if a user doesn't have explicit groups Also follows up r79556, where I'd done a couple of daft things... (accessing undefined objects)
323 lines
9.2 KiB
PHP
323 lines
9.2 KiB
PHP
<?php
|
|
/**
|
|
*
|
|
*
|
|
* Created on July 30, 2007
|
|
*
|
|
* Copyright © 2007 Roan Kattouw <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.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
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 {
|
|
|
|
private $tokenFunctions, $prop;
|
|
|
|
public function __construct( $query, $moduleName ) {
|
|
parent::__construct( $query, $moduleName, 'us' );
|
|
}
|
|
|
|
/**
|
|
* Get an array mapping token names to their handler functions.
|
|
* The prototype for a token function is func($user)
|
|
* it should return a token or false (permission denied)
|
|
* @return Array tokenname => function
|
|
*/
|
|
protected function getTokenFunctions() {
|
|
// Don't call the hooks twice
|
|
if ( isset( $this->tokenFunctions ) ) {
|
|
return $this->tokenFunctions;
|
|
}
|
|
|
|
// If we're in JSON callback mode, no tokens can be obtained
|
|
if ( !is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) ) {
|
|
return array();
|
|
}
|
|
|
|
$this->tokenFunctions = array(
|
|
'userrights' => array( 'ApiQueryUsers', 'getUserrightsToken' ),
|
|
);
|
|
wfRunHooks( 'APIQueryUsersTokens', array( &$this->tokenFunctions ) );
|
|
return $this->tokenFunctions;
|
|
}
|
|
|
|
/**
|
|
* @static
|
|
* @param $user User
|
|
* @return String
|
|
*/
|
|
public static function getUserrightsToken( $user ) {
|
|
global $wgUser;
|
|
// Since the permissions check for userrights is non-trivial,
|
|
// don't bother with it here
|
|
return $wgUser->editToken( $user->getName() );
|
|
}
|
|
|
|
public function execute() {
|
|
$params = $this->extractRequestParams();
|
|
|
|
if ( !is_null( $params['prop'] ) ) {
|
|
$this->prop = array_flip( $params['prop'] );
|
|
} else {
|
|
$this->prop = array();
|
|
}
|
|
|
|
$users = (array)$params['users'];
|
|
$goodNames = $done = array();
|
|
$result = $this->getResult();
|
|
// Canonicalize user names
|
|
foreach ( $users as $u ) {
|
|
$n = User::getCanonicalName( $u );
|
|
if ( $n === false || $n === '' ) {
|
|
$vals = array( 'name' => $u, 'invalid' => '' );
|
|
$fit = $result->addValue( array( 'query', $this->getModuleName() ),
|
|
null, $vals );
|
|
if ( !$fit ) {
|
|
$this->setContinueEnumParameter( 'users',
|
|
implode( '|', array_diff( $users, $done ) ) );
|
|
$goodNames = array();
|
|
break;
|
|
}
|
|
$done[] = $u;
|
|
} else {
|
|
$goodNames[] = $n;
|
|
}
|
|
}
|
|
|
|
$result = $this->getResult();
|
|
|
|
if ( count( $goodNames ) ) {
|
|
$this->addTables( 'user' );
|
|
$this->addFields( '*' );
|
|
$this->addWhereFld( 'user_name', $goodNames );
|
|
|
|
if ( isset( $this->prop['groups'] ) || isset( $this->prop['rights'] ) ) {
|
|
$this->addTables( 'user_groups' );
|
|
$this->addJoinConds( array( 'user_groups' => array( 'LEFT JOIN', 'ug_user=user_id' ) ) );
|
|
$this->addFields( 'ug_group' );
|
|
}
|
|
|
|
$this->showHiddenUsersAddBlockInfo( isset( $this->prop['blockinfo'] ) );
|
|
|
|
$data = array();
|
|
$res = $this->select( __METHOD__ );
|
|
|
|
foreach ( $res as $row ) {
|
|
$user = User::newFromRow( $row );
|
|
$name = $user->getName();
|
|
|
|
$data[$name]['userid'] = $user->getId();
|
|
$data[$name]['name'] = $name;
|
|
|
|
if ( isset( $this->prop['editcount'] ) ) {
|
|
$data[$name]['editcount'] = intval( $user->getEditCount() );
|
|
}
|
|
|
|
if ( isset( $this->prop['registration'] ) ) {
|
|
$data[$name]['registration'] = wfTimestampOrNull( TS_ISO_8601, $user->getRegistration() );
|
|
}
|
|
|
|
if ( isset( $this->prop['groups'] ) ) {
|
|
if ( !isset( $data[$name]['groups'] ) ) {
|
|
$data[$name]['groups'] = self::getAutoGroups( $user );
|
|
}
|
|
|
|
if ( !is_null( $row->ug_group ) ) {
|
|
// This row contains only one group, others will be added from other rows
|
|
$data[$name]['groups'][] = $row->ug_group;
|
|
}
|
|
}
|
|
|
|
if ( isset( $this->prop['rights'] ) ) {
|
|
if ( !isset( $data[$name]['rights'] ) ) {
|
|
$data[$name]['rights'] = User::getGroupPermissions( User::getImplicitGroups() );
|
|
}
|
|
|
|
if ( !is_null( $row->ug_group ) ) {
|
|
$data[$name]['rights'] = array_unique( array_merge( $data[$name]['rights'],
|
|
User::getGroupPermissions( array( $row->ug_group ) ) ) );
|
|
}
|
|
}
|
|
if ( $row->ipb_deleted ) {
|
|
$data[$name]['hidden'] = '';
|
|
}
|
|
if ( isset( $this->prop['blockinfo'] ) && !is_null( $row->ipb_by_text ) ) {
|
|
$data[$name]['blockedby'] = $row->ipb_by_text;
|
|
$data[$name]['blockreason'] = $row->ipb_reason;
|
|
$data[$name]['blockexpiry'] = $row->ipb_expiry;
|
|
}
|
|
|
|
if ( isset( $this->prop['emailable'] ) && $user->canReceiveEmail() ) {
|
|
$data[$name]['emailable'] = '';
|
|
}
|
|
|
|
if ( isset( $this->prop['gender'] ) ) {
|
|
$gender = $user->getOption( 'gender' );
|
|
if ( strval( $gender ) === '' ) {
|
|
$gender = 'unknown';
|
|
}
|
|
$data[$name]['gender'] = $gender;
|
|
}
|
|
|
|
if ( !is_null( $params['token'] ) ) {
|
|
$tokenFunctions = $this->getTokenFunctions();
|
|
foreach ( $params['token'] as $t ) {
|
|
$val = call_user_func( $tokenFunctions[$t], $user );
|
|
if ( $val === false ) {
|
|
$this->setWarning( "Action '$t' is not allowed for the current user" );
|
|
} else {
|
|
$data[$name][$t . 'token'] = $val;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Second pass: add result data to $retval
|
|
foreach ( $goodNames as $u ) {
|
|
if ( !isset( $data[$u] ) ) {
|
|
$data[$u] = array( 'name' => $u );
|
|
$urPage = new UserrightsPage;
|
|
$iwUser = $urPage->fetchUser( $u );
|
|
|
|
if ( $iwUser instanceof UserRightsProxy ) {
|
|
$data[$u]['interwiki'] = '';
|
|
|
|
if ( !is_null( $params['token'] ) ) {
|
|
$tokenFunctions = $this->getTokenFunctions();
|
|
|
|
foreach ( $params['token'] as $t ) {
|
|
$val = call_user_func( $tokenFunctions[$t], $iwUser );
|
|
if ( $val === false ) {
|
|
$this->setWarning( "Action '$t' is not allowed for the current user" );
|
|
} else {
|
|
$data[$u][$t . 'token'] = $val;
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
$data[$u]['missing'] = '';
|
|
}
|
|
} else {
|
|
if ( isset( $this->prop['groups'] ) && isset( $data[$u]['groups'] ) ) {
|
|
$result->setIndexedTagName( $data[$u]['groups'], 'g' );
|
|
}
|
|
if ( isset( $this->prop['rights'] ) && isset( $data[$u]['rights'] ) ) {
|
|
$result->setIndexedTagName( $data[$u]['rights'], 'r' );
|
|
}
|
|
}
|
|
|
|
$fit = $result->addValue( array( 'query', $this->getModuleName() ),
|
|
null, $data[$u] );
|
|
if ( !$fit ) {
|
|
$this->setContinueEnumParameter( 'users',
|
|
implode( '|', array_diff( $users, $done ) ) );
|
|
break;
|
|
}
|
|
$done[] = $u;
|
|
}
|
|
return $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'user' );
|
|
}
|
|
|
|
/**
|
|
* Gets all the groups that a user is automatically a member of
|
|
* @param $user User
|
|
* @return array
|
|
*/
|
|
public static function getAutoGroups( $user ) {
|
|
$groups = array( '*' );
|
|
|
|
if ( !$user->isAnon() ) {
|
|
$groups[] = 'user';
|
|
}
|
|
|
|
return array_merge( $groups, Autopromote::getAutopromoteGroups( $user ) );
|
|
}
|
|
|
|
public function getCacheMode( $params ) {
|
|
if ( isset( $params['token'] ) ) {
|
|
return 'private';
|
|
} else {
|
|
return 'anon-public-user-private';
|
|
}
|
|
}
|
|
|
|
public function getAllowedParams() {
|
|
return array(
|
|
'prop' => array(
|
|
ApiBase::PARAM_DFLT => null,
|
|
ApiBase::PARAM_ISMULTI => true,
|
|
ApiBase::PARAM_TYPE => array(
|
|
'blockinfo',
|
|
'groups',
|
|
'rights',
|
|
'editcount',
|
|
'registration',
|
|
'emailable',
|
|
'gender',
|
|
)
|
|
),
|
|
'users' => array(
|
|
ApiBase::PARAM_ISMULTI => true
|
|
),
|
|
'token' => array(
|
|
ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() ),
|
|
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(s) belongs to',
|
|
' rights - Lists all the rights the user(s) has',
|
|
' 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]]',
|
|
' gender - Tags the gender of the user. Returns "male", "female", or "unknown"',
|
|
),
|
|
'users' => 'A list of users to obtain the same information for',
|
|
'token' => 'Which tokens to obtain for each user',
|
|
);
|
|
}
|
|
|
|
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|gender';
|
|
}
|
|
|
|
public function getVersion() {
|
|
return __CLASS__ . ': $Id$';
|
|
}
|
|
}
|