includes/api/ApiQueryUserInfo.php

   1 <?php
   2
   3 /*
   4  * Created on July 30, 2007
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   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 the currently logged-in user
  33  *
  34  * @ingroup API
  35  */
  36 class ApiQueryUserInfo extends ApiQueryBase {
  37
  38         public function __construct($query, $moduleName) {
  39                 parent :: __construct($query, $moduleName, 'ui');
  40         }
  41
  42         public function execute() {
  43                 $params = $this->extractRequestParams();
  44                 $result = $this->getResult();
  45                 $r = array();
  46
  47                 if (!is_null($params['prop'])) {
  48                         $this->prop = array_flip($params['prop']);
  49                 } else {
  50                         $this->prop = array();
  51                 }
  52                 $r = $this->getCurrentUserInfo();
  53                 $result->addValue("query", $this->getModuleName(), $r);
  54         }
  55
  56         protected function getCurrentUserInfo() {
  57                 global $wgUser;
  58                 $result = $this->getResult();
  59                 $vals = array();
  60                 $vals['id'] = $wgUser->getId();
  61                 $vals['name'] = $wgUser->getName();
  62
  63                 if($wgUser->isAnon())
  64                         $vals['anon'] = '';
  65                 if (isset($this->prop['blockinfo'])) {
  66                         if ($wgUser->isBlocked()) {
  67                                 $vals['blockedby'] = User::whoIs($wgUser->blockedBy());
  68                                 $vals['blockreason'] = $wgUser->blockedFor();
  69                         }
  70                 }
  71                 if (isset($this->prop['hasmsg']) && $wgUser->getNewtalk()) {
  72                         $vals['messages'] = '';
  73                 }
  74                 if (isset($this->prop['groups'])) {
  75                         $vals['groups'] = $wgUser->getGroups();
  76                         $result->setIndexedTagName($vals['groups'], 'g');       // even if empty
  77                 }
  78                 if (isset($this->prop['rights'])) {
  79                         // User::getRights() may return duplicate values, strip them
  80                         $vals['rights'] = array_values(array_unique($wgUser->getRights()));
  81                         $result->setIndexedTagName($vals['rights'], 'r');       // even if empty
  82                 }
  83                 if (isset($this->prop['options'])) {
  84                         $vals['options'] = (is_null($wgUser->mOptions) ? User::getDefaultOptions() : $wgUser->mOptions);
  85                 }
  86                 if (isset($this->prop['preferencestoken']) && is_null($this->getMain()->getRequest()->getVal('callback'))) {
  87                         $vals['preferencestoken'] = $wgUser->editToken();
  88                 }
  89                 if (isset($this->prop['editcount'])) {
  90                         $vals['editcount'] = $wgUser->getEditCount();
  91                 }
  92                 if (isset($this->prop['ratelimits'])) {
  93                         $vals['ratelimits'] = $this->getRateLimits();
  94                 }
  95                 return $vals;
  96         }
  97
  98         protected function getRateLimits()
  99         {
 100                 global $wgUser, $wgRateLimits;
 101                 if(!$wgUser->isPingLimitable())
 102                         return array(); // No limits
 103
 104                 // Find out which categories we belong to
 105                 $categories = array();
 106                 if($wgUser->isAnon())
 107                         $categories[] = 'anon';
 108                 else
 109                         $categories[] = 'user';
 110                 if($wgUser->isNewBie())
 111                 {
 112                         $categories[] = 'ip';
 113                         $categories[] = 'subnet';
 114                         if(!$wgUser->isAnon())
 115                                 $categories[] = 'newbie';
 116                 }
 117                 $categories = array_merge($categories, $wgUser->getGroups());
 118
 119                 // Now get the actual limits
 120                 $retval = array();
 121                 foreach($wgRateLimits as $action => $limits)
 122                         foreach($categories as $cat)
 123                                 if(isset($limits[$cat]) && !is_null($limits[$cat]))
 124                                 {
 125                                         $retval[$action][$cat]['hits'] = $limits[$cat][0];
 126                                         $retval[$action][$cat]['seconds'] = $limits[$cat][1];
 127                                 }
 128                 return $retval;
 129         }
 130
 131         public function getAllowedParams() {
 132                 return array (
 133                         'prop' => array (
 134                                 ApiBase :: PARAM_DFLT => NULL,
 135                                 ApiBase :: PARAM_ISMULTI => true,
 136                                 ApiBase :: PARAM_TYPE => array (
 137                                         'blockinfo',
 138                                         'hasmsg',
 139                                         'groups',
 140                                         'rights',
 141                                         'options',
 142                                         'preferencestoken',
 143                                         'editcount',
 144                                         'ratelimits'
 145                                 )
 146                         )
 147                 );
 148         }
 149
 150         public function getParamDescription() {
 151                 return array (
 152                         'prop' => array(
 153                                 'What pieces of information to include',
 154                                 '  blockinfo  - tags if the current user is blocked, by whom, and for what reason',
 155                                 '  hasmsg     - adds a tag "message" if the current user has pending messages',
 156                                 '  groups     - lists all the groups the current user belongs to',
 157                                 '  rights     - lists of all rights the current user has',
 158                                 '  options    - lists all preferences the current user has set',
 159                                 '  editcount  - adds the current user\'s edit count',
 160                                 '  ratelimits - lists all rate limits applying to the current user'
 161                         )
 162                 );
 163         }
 164
 165         public function getDescription() {
 166                 return 'Get information about the current user';
 167         }
 168
 169         protected function getExamples() {
 170                 return array (
 171                         'api.php?action=query&meta=userinfo',
 172                         'api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg',
 173                 );
 174         }
 175
 176         public function getVersion() {
 177                 return __CLASS__ . ': $Id$';
 178         }
 179 }