From c4aad95b10ed877e4a8c4f1b0cf9a1f1ee77edf2 Mon Sep 17 00:00:00 2001 From: Yuri Astrakhan Date: Tue, 31 Jul 2007 17:53:37 +0000 Subject: [PATCH] API: Added meta=userinfo module to get data about the currently logged-in user. --- includes/AutoLoader.php | 1 + includes/api/ApiMain.php | 3 +- includes/api/ApiQuery.php | 2 +- includes/api/ApiQuerySiteinfo.php | 1 + includes/api/ApiQueryUserInfo.php | 134 ++++++++++++++++++++++++++++++ 5 files changed, 138 insertions(+), 3 deletions(-) create mode 100644 includes/api/ApiQueryUserInfo.php diff --git a/includes/AutoLoader.php b/includes/AutoLoader.php index c5b933c9fc..628e102e60 100644 --- a/includes/AutoLoader.php +++ b/includes/AutoLoader.php @@ -330,6 +330,7 @@ function __autoload($className) { 'ApiQueryRevisions' => 'includes/api/ApiQueryRevisions.php', 'ApiQuerySearch' => 'includes/api/ApiQuerySearch.php', 'ApiQuerySiteinfo' => 'includes/api/ApiQuerySiteinfo.php', + 'ApiQueryUserInfo' => 'includes/api/ApiQueryUserInfo.php', 'ApiQueryWatchlist' => 'includes/api/ApiQueryWatchlist.php', 'ApiResult' => 'includes/api/ApiResult.php', ); diff --git a/includes/api/ApiMain.php b/includes/api/ApiMain.php index 24ba75cd1b..b33e762119 100644 --- a/includes/api/ApiMain.php +++ b/includes/api/ApiMain.php @@ -456,8 +456,7 @@ class ApiMain extends ApiBase { public function isSysop() { if (!isset ($this->mIsSysop)) { global $wgUser; - $this->mIsSysop = in_array( 'sysop', - $wgUser->getGroups()); + $this->mIsSysop = in_array( 'sysop', $wgUser->getGroups()); } return $this->mIsSysop; diff --git a/includes/api/ApiQuery.php b/includes/api/ApiQuery.php index f640ece518..0223f6fb79 100644 --- a/includes/api/ApiQuery.php +++ b/includes/api/ApiQuery.php @@ -75,7 +75,7 @@ class ApiQuery extends ApiBase { private $mQueryMetaModules = array ( 'siteinfo' => 'ApiQuerySiteinfo', - // 'userinfo' => 'ApiQueryUserinfo', + 'userinfo' => 'ApiQueryUserInfo', ); private $mSlaveDB = null; diff --git a/includes/api/ApiQuerySiteinfo.php b/includes/api/ApiQuerySiteinfo.php index c3bfbc0959..9d1371ac53 100644 --- a/includes/api/ApiQuerySiteinfo.php +++ b/includes/api/ApiQuerySiteinfo.php @@ -99,6 +99,7 @@ class ApiQuerySiteinfo extends ApiQueryBase { protected function appendInterwikiMap($property, $filter) { + $this->resetQueryParams(); $this->addTables('interwiki'); $this->addFields(array('iw_prefix', 'iw_local', 'iw_url')); diff --git a/includes/api/ApiQueryUserInfo.php b/includes/api/ApiQueryUserInfo.php new file mode 100644 index 0000000000..6968b0b814 --- /dev/null +++ b/includes/api/ApiQueryUserInfo.php @@ -0,0 +1,134 @@ +@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., + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * http://www.gnu.org/copyleft/gpl.html + */ + +if (!defined('MEDIAWIKI')) { + // Eclipse helper - will be ignored in production + require_once ('ApiQueryBase.php'); +} + +/** + * Query module to get information about the currently logged-in user + * + * @addtogroup API + */ +class ApiQueryUserInfo extends ApiQueryBase { + + public function __construct($query, $moduleName) { + parent :: __construct($query, $moduleName, 'ui'); + } + + public function execute() { + + global $wgUser; + + $params = $this->extractRequestParams(); + $result = $this->getResult(); + + $vals = array(); + $vals['name'] = $wgUser->getName(); + + if( $wgUser->isAnon() ) $vals['anon'] = ''; + + if (!is_null($params['prop'])) { + $prop = array_flip($params['prop']); + if (isset($prop['blockinfo'])) { + if ($wgUser->isBlocked()) { + $id = $wgUser->blockedBy(); + $vals['blockedby'] = is_numeric($id) ? User::whoIs($id) : $id; + $vals['blockreason'] = $wgUser->blockedFor(); + } + } + if (isset($prop['hasmsg']) && $wgUser->getNewtalk()) { + $vals['messages'] = ''; + } + if (isset($prop['groups'])) { + $vals['groups'] = $wgUser->getGroups(); + $result->setIndexedTagName($vals['groups'], 'g'); // even if empty + } + if (isset($prop['rights'])) { + $vals['rights'] = $wgUser->getRights(); + $result->setIndexedTagName($vals['rights'], 'r'); // even if empty + } + } + + 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); + } + } + + $result->addValue(null, $this->getModuleName(), $vals); + } + + protected 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, + ), + ); + } + + protected 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', + ); + } + + protected function getDescription() { + return 'Get information about the current user'; + } + + protected function getExamples() { + 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$'; + } +} + -- 2.20.1