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  * @addtogroup API
  35  */
  36
  37  class ApiQueryUsers extends ApiQueryBase {
  38
  39         public function __construct($query, $moduleName) {
  40                 parent :: __construct($query, $moduleName, 'us');
  41         }
  42
  43         public function execute() {
  44                 $params = $this->extractRequestParams();
  45                 $result = $this->getResult();
  46                 $r = array();
  47
  48                 if (!is_null($params['prop'])) {
  49                         $this->prop = array_flip($params['prop']);
  50                 } else {
  51                         $this->prop = array();
  52                 }
  53
  54                 if(is_array($params['users'])) {
  55                         $r = $this->getOtherUsersInfo($params['users']);
  56                         $result->setIndexedTagName($r, 'user');
  57                 }
  58                 $result->addValue("query", $this->getModuleName(), $r);
  59         }
  60
  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)
  67                                 $retval[] = array('name' => $u, 'invalid' => '');
  68                          else
  69                                 $goodNames[] = $n;
  70                 }
  71
  72                 $db = $this->getDb();
  73                 $userTable = $db->tableName('user');
  74                 $tables = "$userTable AS u1";
  75                 $this->addFields('u1.user_name');
  76                 $this->addWhereFld('u1.user_name', $goodNames);
  77                 $this->addFieldsIf('u1.user_editcount', isset($this->prop['editcount']));
  78
  79                 if(isset($this->prop['groups'])) {
  80                         $ug = $db->tableName('user_groups');
  81                         $tables = "$tables LEFT JOIN $ug ON ug_user=u1.user_id";
  82                         $this->addFields('ug_group');
  83                 }
  84                 if(isset($this->prop['blockinfo'])) {
  85                         $ipb = $db->tableName('ipblocks');
  86                         $tables = "$tables LEFT JOIN $ipb ON ipb_user=u1.user_id";
  87                         $tables = "$tables LEFT JOIN $userTable AS u2 ON ipb_by=u2.user_id";
  88                         $this->addFields(array('ipb_reason', 'u2.user_name AS blocker_name'));
  89                 }
  90                 $this->addTables($tables);
  91
  92                 $data = array();
  93                 $res = $this->select(__METHOD__);
  94                 while(($r = $db->fetchObject($res))) {
  95                         $data[$r->user_name]['name'] = $r->user_name;
  96                         if(isset($this->prop['editcount']))
  97                                 $data[$r->user_name]['editcount'] = $r->user_editcount;
  98                         if(isset($this->prop['groups']))
  99                                 // This row contains only one group, others will be added from other rows
 100                                 if(!is_null($r->ug_group))
 101                                         $data[$r->user_name]['groups'][] = $r->ug_group;
 102                         if(isset($this->prop['blockinfo']))
 103                                 if(!is_null($r->blocker_name)) {
 104                                         $data[$r->user_name]['blockedby'] = $r->blocker_name;
 105                                         $data[$r->user_name]['blockreason'] = $r->ipb_reason;
 106                                 }
 107                 }
 108
 109                 // Second pass: add result data to $retval
 110                 foreach($goodNames as $u) {
 111                         if(!isset($data[$u]))
 112                                 $retval[] = array('name' => $u, 'missing' => '');
 113                         else {
 114                                 if(isset($this->prop['groups']) && isset($data[$u]['groups']))
 115                                         $this->getResult()->setIndexedTagName($data[$u]['groups'], 'g');
 116                                 $retval[] = $data[$u];
 117                         }
 118                 }
 119                 return $retval;
 120         }
 121
 122         public function getAllowedParams() {
 123                 return array (
 124                         'prop' => array (
 125                                 ApiBase :: PARAM_DFLT => NULL,
 126                                 ApiBase :: PARAM_ISMULTI => true,
 127                                 ApiBase :: PARAM_TYPE => array (
 128                                         'blockinfo',
 129                                         'groups',
 130                                         'editcount'
 131                                 )
 132                         ),
 133                         'users' => array(
 134                                 ApiBase :: PARAM_ISMULTI => true
 135                         )
 136                 );
 137         }
 138
 139         public function getParamDescription() {
 140                 return array (
 141                         'prop' => array(
 142                                 'What pieces of information to include',
 143                                 '  blockinfo - tags if the user is blocked, by whom, and for what reason',
 144                                 '  groups    - lists all the groups the user belongs to',
 145                                 '  editcount - adds the user\'s edit count'
 146                         ),
 147                         'users' => 'A list of users to obtain the same information for'
 148                 );
 149         }
 150
 151         public function getDescription() {
 152                 return 'Get information about a list of users';
 153         }
 154
 155         protected function getExamples() {
 156                 return 'api.php?action=query&list=users&ususers=brion|TimStarling&usprop=groups|editcount';
 157         }
 158
 159         public function getVersion() {
 160                 return __CLASS__ . ': $Id$';
 161         }
 162 }