<?php
-
-/*
- * Created on July 30, 2007
- *
+/**
* API for MediaWiki 1.8+
*
- * Copyright (C) 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Created on July 30, 2007
+ *
+ * Copyright © 2007 Yuri Astrakhan <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
*
* 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.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
*/
-if (!defined('MEDIAWIKI')) {
+if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
- require_once ('ApiQueryBase.php');
+ require_once( 'ApiQueryBase.php' );
}
/**
* Query module to get information about the currently logged-in user
- *
- * @addtogroup API
+ *
+ * @ingroup API
*/
class ApiQueryUserInfo extends ApiQueryBase {
- public function __construct($query, $moduleName) {
- parent :: __construct($query, $moduleName, 'ui');
+ private $prop = array();
+
+ public function __construct( $query, $moduleName ) {
+ parent::__construct( $query, $moduleName, 'ui' );
}
public function execute() {
-
- global $wgUser;
-
$params = $this->extractRequestParams();
$result = $this->getResult();
+ if ( !is_null( $params['prop'] ) ) {
+ $this->prop = array_flip( $params['prop'] );
+ }
+
+ $r = $this->getCurrentUserInfo();
+ $result->addValue( 'query', $this->getModuleName(), $r );
+ }
+
+ protected function getCurrentUserInfo() {
+ global $wgUser, $wgRequest;
+ $result = $this->getResult();
$vals = array();
+ $vals['id'] = intval( $wgUser->getId() );
$vals['name'] = $wgUser->getName();
- if( $wgUser->isAnon() ) $vals['anon'] = '';
+ if ( $wgUser->isAnon() ) {
+ $vals['anon'] = '';
+ }
- if (!is_null($params['prop'])) {
- $prop = array_flip($params['prop']);
- if (isset($prop['blockinfo'])) {
- if ($wgUser->isBlocked()) {
- $vals['blockedby'] = User::whoIs($wgUser->blockedBy());
- $vals['blockreason'] = $wgUser->blockedFor();
- }
- }
- if (isset($prop['hasmsg']) && $wgUser->getNewtalk()) {
- $vals['messages'] = '';
+ if ( isset( $this->prop['blockinfo'] ) ) {
+ if ( $wgUser->isBlocked() ) {
+ $vals['blockedby'] = User::whoIs( $wgUser->blockedBy() );
+ $vals['blockreason'] = $wgUser->blockedFor();
}
- if (isset($prop['groups'])) {
- $vals['groups'] = $wgUser->getGroups();
- $result->setIndexedTagName($vals['groups'], 'g'); // even if empty
+ }
+
+ if ( isset( $this->prop['hasmsg'] ) && $wgUser->getNewtalk() ) {
+ $vals['messages'] = '';
+ }
+
+ if ( isset( $this->prop['groups'] ) ) {
+ $autolist = ApiQueryUsers::getAutoGroups( $wgUser );
+
+ $vals['groups'] = array_merge( $autolist, $wgUser->getGroups() );
+ $result->setIndexedTagName( $vals['groups'], 'g' ); // even if empty
+ }
+
+ if ( isset( $this->prop['rights'] ) ) {
+ // User::getRights() may return duplicate values, strip them
+ $vals['rights'] = array_values( array_unique( $wgUser->getRights() ) );
+ $result->setIndexedTagName( $vals['rights'], 'r' ); // even if empty
+ }
+
+ if ( isset( $this->prop['changeablegroups'] ) ) {
+ $vals['changeablegroups'] = $wgUser->changeableGroups();
+ $result->setIndexedTagName( $vals['changeablegroups']['add'], 'g' );
+ $result->setIndexedTagName( $vals['changeablegroups']['remove'], 'g' );
+ $result->setIndexedTagName( $vals['changeablegroups']['add-self'], 'g' );
+ $result->setIndexedTagName( $vals['changeablegroups']['remove-self'], 'g' );
+ }
+
+ if ( isset( $this->prop['options'] ) ) {
+ $vals['options'] = $wgUser->getOptions();
+ }
+
+ if (
+ isset( $this->prop['preferencestoken'] ) &&
+ is_null( $this->getMain()->getRequest()->getVal( 'callback' ) )
+ )
+ {
+ $vals['preferencestoken'] = $wgUser->editToken();
+ }
+
+ if ( isset( $this->prop['editcount'] ) ) {
+ $vals['editcount'] = intval( $wgUser->getEditCount() );
+ }
+
+ if ( isset( $this->prop['ratelimits'] ) ) {
+ $vals['ratelimits'] = $this->getRateLimits();
+ }
+
+ if ( isset( $this->prop['email'] ) ) {
+ $vals['email'] = $wgUser->getEmail();
+ $auth = $wgUser->getEmailAuthenticationTimestamp();
+ if ( !is_null( $auth ) ) {
+ $vals['emailauthenticated'] = wfTimestamp( TS_ISO_8601, $auth );
}
- if (isset($prop['rights'])) {
- $vals['rights'] = $wgUser->getRights();
- $result->setIndexedTagName($vals['rights'], 'r'); // even if empty
+ }
+
+ if ( isset( $this->prop['acceptlang'] ) ) {
+ $langs = $wgRequest->getAcceptLang();
+ $acceptLang = array();
+ foreach ( $langs as $lang => $val ) {
+ $r = array( 'q' => $val );
+ ApiResult::setContent( $r, $lang );
+ $acceptLang[] = $r;
}
+ $result->setIndexedTagName( $acceptLang, 'lang' );
+ $vals['acceptlang'] = $acceptLang;
+ }
+ return $vals;
+ }
+
+ protected function getRateLimits() {
+ global $wgUser, $wgRateLimits;
+ if ( !$wgUser->isPingLimitable() ) {
+ return array(); // No limits
}
- if (!empty($params['option'])) {
- foreach( $params['option'] as $option ) {
- if (empty($option))
- $this->dieUsage('Empty value is not allowed for the option parameter', 'option');
- $vals['options'][$option] = $wgUser->getOption($option);
+ // Find out which categories we belong to
+ $categories = array();
+ if ( $wgUser->isAnon() ) {
+ $categories[] = 'anon';
+ } else {
+ $categories[] = 'user';
+ }
+ if ( $wgUser->isNewbie() ) {
+ $categories[] = 'ip';
+ $categories[] = 'subnet';
+ if ( !$wgUser->isAnon() )
+ $categories[] = 'newbie';
+ }
+ $categories = array_merge( $categories, $wgUser->getGroups() );
+
+ // Now get the actual limits
+ $retval = array();
+ foreach ( $wgRateLimits as $action => $limits ) {
+ foreach ( $categories as $cat ) {
+ if ( isset( $limits[$cat] ) && !is_null( $limits[$cat] ) ) {
+ $retval[$action][$cat]['hits'] = intval( $limits[$cat][0] );
+ $retval[$action][$cat]['seconds'] = intval( $limits[$cat][1] );
+ }
}
}
-
- $result->addValue(null, $this->getModuleName(), $vals);
+ return $retval;
}
- protected function getAllowedParams() {
- return array (
- 'prop' => array (
- ApiBase :: PARAM_DFLT => NULL,
- ApiBase :: PARAM_ISMULTI => true,
- ApiBase :: PARAM_TYPE => array (
+ public function getAllowedParams() {
+ return array(
+ 'prop' => array(
+ ApiBase::PARAM_DFLT => null,
+ ApiBase::PARAM_ISMULTI => true,
+ ApiBase::PARAM_TYPE => array(
'blockinfo',
'hasmsg',
'groups',
'rights',
- )),
- 'option' => array (
- ApiBase :: PARAM_DFLT => NULL,
- ApiBase :: PARAM_ISMULTI => true,
- ),
+ 'changeablegroups',
+ 'options',
+ 'preferencestoken',
+ 'editcount',
+ 'ratelimits',
+ 'email',
+ 'acceptlang',
+ )
+ )
);
}
- protected function getParamDescription() {
- return array (
+ 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',
- ' hasmsg - adds a tag "message" if user has pending messages',
- ' groups - lists all the groups the current user belongs to',
- ' rights - lists of all rights the current user has',
- ),
- 'option' => 'A list of user preference options to get',
+ ' blockinfo - Tags if the current user is blocked, by whom, and for what reason',
+ ' hasmsg - Adds a tag "message" if the current user has pending messages',
+ ' groups - Lists all the groups the current user belongs to',
+ ' rights - Lists all the rights the current user has',
+ ' changeablegroups - Lists the groups the current user can add to and remove from',
+ ' options - Lists all preferences the current user has set',
+ ' editcount - Adds the current user\'s edit count',
+ ' ratelimits - Lists all rate limits applying to the current user',
+ ' email - Adds the user\'s email address and email authentication date',
+ ' acceptlang - Echoes the Accept-Language header sent by the client in a structured format',
+ )
);
}
- protected function getDescription() {
+ public function getDescription() {
return 'Get information about the current user';
}
protected function getExamples() {
- return array (
+ return array(
'api.php?action=query&meta=userinfo',
'api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg',
- 'api.php?action=query&meta=userinfo&uioption=rememberpassword',
);
}
public function getVersion() {
- return __CLASS__ . ': $Id: ApiQueryUserInfo.php 24529 2007-08-01 20:11:29Z yurik $';
+ return __CLASS__ . ': $Id$';
}
}
-
scripts.mit.edu / autoinstalls / mediawiki.git / blobdiff