includes/api/ApiQueryUsers.php

   1 <?php
   2
   3 /*
   4  * Created on July 30, 2007
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
   9  *
  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.
  14  *
  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.
  19  *
  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
  24  */
  25
  26 if (!defined('MEDIAWIKI')) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ('ApiQueryBase.php');
  29 }
  30
  31 /**
  32  * Query module to get information about a list of users
  33  *
  34  * @ingroup API
  35  */
  36
  37  class ApiQueryUsers extends ApiQueryBase {
  38
  39         public function __construct($query, $moduleName) {
  40                 parent :: __construct($query, $moduleName, 'us');
  41         }
  42
  43         /**
  44          * Get an array mapping token names to their handler functions.
  45          * The prototype for a token function is func($user)
  46          * it should return a token or false (permission denied)
  47          * @return array(tokenname => function)
  48          */
  49         protected function getTokenFunctions() {
  50                 // Don't call the hooks twice
  51                 if(isset($this->tokenFunctions))
  52                         return $this->tokenFunctions;
  53
  54                 // If we're in JSON callback mode, no tokens can be obtained
  55                 if(!is_null($this->getMain()->getRequest()->getVal('callback')))
  56                         return array();
  57
  58                 $this->tokenFunctions = array(
  59                         'userrights' => array( 'ApiQueryUsers', 'getUserrightsToken' ),
  60                 );
  61                 wfRunHooks('APIQueryUsersTokens', array(&$this->tokenFunctions));
  62                 return $this->tokenFunctions;
  63         }
  64
  65         public static function getUserrightsToken($user)
  66         {
  67                 global $wgUser;
  68                 // Since the permissions check for userrights is non-trivial,
  69                 // don't bother with it here
  70                 return $wgUser->editToken($user->getName());
  71         }
  72
  73         public function execute() {
  74                 $params = $this->extractRequestParams();
  75                 $result = $this->getResult();
  76                 $r = array();
  77
  78                 if (!is_null($params['prop'])) {
  79                         $this->prop = array_flip($params['prop']);
  80                 } else {
  81                         $this->prop = array();
  82                 }
  83
  84                 $users = (array)$params['users'];
  85                 $goodNames = $done = array();
  86                 $result = $this->getResult();
  87                 // Canonicalize user names
  88                 foreach($users as $u) {
  89                         $n = User::getCanonicalName($u);
  90                         if($n === false || $n === '')
  91                         {
  92                                 $vals = array('name' => $u, 'invalid' => '');
  93                                 $fit = $result->addValue(array('query', $this->getModuleName()),
  94                                                 null, $vals);
  95                                 if(!$fit)
  96                                 {
  97                                         $this->setContinueEnumParameter('users',
  98                                                         implode('|', array_diff($users, $done)));
  99                                         $goodNames = array();
 100                                         break;
 101                                 }
 102                                 $done[] = $u;
 103                         }
 104                          else
 105                                 $goodNames[] = $n;
 106                 }
 107                 if(count($goodNames))
 108                 {
 109                         $db = $this->getDb();
 110                         $this->addTables('user', 'u1');
 111                         $this->addFields('u1.*');
 112                         $this->addWhereFld('u1.user_name', $goodNames);
 113
 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');
 118                         }
 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'));
 127                         }
 128
 129                         $data = array();
 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;
 145                                 }
 146                                 if(isset($this->prop['emailable']) && $user->canReceiveEmail())
 147                                         $data[$name]['emailable'] = '';
 148                                 if(isset($this->prop['gender']))
 149                                         $data[$name]['gender'] = $user->getOption( 'gender' );
 150                                 if(!is_null($params['token']))
 151                                 {
 152                                         $tokenFunctions = $this->getTokenFunctions();
 153                                         foreach($params['token'] as $t)
 154                                         {
 155                                                 $val = call_user_func($tokenFunctions[$t], $user);
 156                                                 if($val === false)
 157                                                         $this->setWarning("Action '$t' is not allowed for the current user");
 158                                                 else
 159                                                         $data[$name][$t . 'token'] = $val;
 160                                         }
 161                                 }
 162                         }
 163                 }
 164                 // Second pass: add result data to $retval
 165                 foreach($goodNames as $u) {
 166                         if(!isset($data[$u]))
 167                                 $data[$u] = array('name' => $u, 'missing' => '');
 168                         else {
 169                                 if(isset($this->prop['groups']) && isset($data[$u]['groups']))
 170                                         $this->getResult()->setIndexedTagName($data[$u]['groups'], 'g');
 171                         }
 172                         $fit = $result->addValue(array('query', $this->getModuleName()),
 173                                         null, $data[$u]);
 174                         if(!$fit)
 175                         {
 176                                 $this->setContinueEnumParameter('users',
 177                                                 implode('|', array_diff($users, $done)));
 178                                 break;
 179                         }
 180                         $done[] = $u;
 181                 }
 182                 return $this->getResult()->setIndexedTagName_internal(array('query', $this->getModuleName()), 'user');
 183         }
 184
 185         public function getAllowedParams() {
 186                 return array (
 187                         'prop' => array (
 188                                 ApiBase :: PARAM_DFLT => NULL,
 189                                 ApiBase :: PARAM_ISMULTI => true,
 190                                 ApiBase :: PARAM_TYPE => array (
 191                                         'blockinfo',
 192                                         'groups',
 193                                         'editcount',
 194                                         'registration',
 195                                         'emailable',
 196                                         'gender',
 197                                 )
 198                         ),
 199                         'users' => array(
 200                                 ApiBase :: PARAM_ISMULTI => true
 201                         ),
 202                         'token' => array(
 203                                 ApiBase :: PARAM_TYPE => array_keys($this->getTokenFunctions()),
 204                                 ApiBase :: PARAM_ISMULTI => true
 205                         ),
 206                 );
 207         }
 208
 209         public function getParamDescription() {
 210                 return array (
 211                         'prop' => array(
 212                                 'What pieces of information to include',
 213                                 '  blockinfo    - tags if the user is blocked, by whom, and for what reason',
 214                                 '  groups       - lists all the groups the user belongs to',
 215                                 '  editcount    - adds the user\'s edit count',
 216                                 '  registration - adds the user\'s registration timestamp',
 217                                 '  emailable    - tags if the user can and wants to receive e-mail through [[Special:Emailuser]]',
 218                                 '  gender       - tags the gender of the user. Returns "male", "female", or "unknown"',
 219                         ),
 220                         'users' => 'A list of users to obtain the same information for',
 221                         'token' => 'Which tokens to obtain for each user',
 222                 );
 223         }
 224
 225         public function getDescription() {
 226                 return 'Get information about a list of users';
 227         }
 228
 229         protected function getExamples() {
 230                 return 'api.php?action=query&list=users&ususers=brion|TimStarling&usprop=groups|editcount|gender';
 231         }
 232
 233         public function getVersion() {
 234                 return __CLASS__ . ': $Id$';
 235         }
 236 }