From: Roan Kattouw Date: Sun, 27 Jan 2008 20:28:36 +0000 (+0000) Subject: API: Splitting of uiuser part of meta=userinfo to list=users, as discussed on the... X-Git-Tag: 1.31.0-rc.0~49753 X-Git-Url: http://git.cyclocoop.org/data/Luca_Pacioli_%28Gemaelde%29.jpeg?a=commitdiff_plain;h=a81bd8ad8fe07c09718d4fc08dde04a04a31d695;p=lhc%2Fweb%2Fwiklou.git API: Splitting of uiuser part of meta=userinfo to list=users, as discussed on the API list. --- diff --git a/RELEASE-NOTES b/RELEASE-NOTES index c2cc5408dc..4488c69a14 100644 --- a/RELEASE-NOTES +++ b/RELEASE-NOTES @@ -472,7 +472,7 @@ Full API documentation is available at http://www.mediawiki.org/wiki/API * Added iiurlwidth and iiurlheight parameters to prop=imageinfo * Added format=txt and format=dbg, imported from query.php * Added uiprop=editcount to meta=userinfo -* meta=userinfo can now fetch information on other users as well, through the uiusers parameter +* Added list=users which fetches user information === Languages updated in 1.12 === diff --git a/includes/AutoLoader.php b/includes/AutoLoader.php index e3d3b9ef38..e7c9f1bfd2 100644 --- a/includes/AutoLoader.php +++ b/includes/AutoLoader.php @@ -356,6 +356,7 @@ function __autoload($className) { 'ApiQuerySearch' => 'includes/api/ApiQuerySearch.php', 'ApiQueryAllmessages' => 'includes/api/ApiQueryAllmessages.php', 'ApiQuerySiteinfo' => 'includes/api/ApiQuerySiteinfo.php', + 'ApiQueryUsers' => 'includes/api/ApiQueryUsers.php', 'ApiQueryUserInfo' => 'includes/api/ApiQueryUserInfo.php', 'ApiQueryWatchlist' => 'includes/api/ApiQueryWatchlist.php', 'ApiResult' => 'includes/api/ApiResult.php', diff --git a/includes/api/ApiQuery.php b/includes/api/ApiQuery.php index 7ff6e67e9a..5f6c88bc80 100644 --- a/includes/api/ApiQuery.php +++ b/includes/api/ApiQuery.php @@ -74,6 +74,7 @@ class ApiQuery extends ApiBase { 'usercontribs' => 'ApiQueryContributions', 'watchlist' => 'ApiQueryWatchlist', 'exturlusage' => 'ApiQueryExtLinksUsage', + 'users' => 'ApiQueryUsers', ); private $mQueryMetaModules = array ( diff --git a/includes/api/ApiQueryUserInfo.php b/includes/api/ApiQueryUserInfo.php index 1211797261..1cc8cbac41 100644 --- a/includes/api/ApiQueryUserInfo.php +++ b/includes/api/ApiQueryUserInfo.php @@ -49,76 +49,10 @@ class ApiQueryUserInfo extends ApiQueryBase { } else { $this->prop = array(); } - $r['currentuser'] = $this->getCurrentUserInfo(); - - if(is_array($params['users'])) { - $r['users'] = $this->getOtherUsersInfo($params['users']); - $result->setIndexedTagName($r['users'], 'user'); - } + $r = $this->getCurrentUserInfo(); $result->addValue("query", $this->getModuleName(), $r); } - protected function getOtherUsersInfo($users) { - $goodNames = $retval = array(); - // Canonicalize user names - foreach($users as $u) { - $n = User::getCanonicalName($u); - if($n === false) - $retval[] = array('name' => $u, 'invalid' => ''); - else - $goodNames[] = $n; - } - - $db = $this->getDb(); - $userTable = $db->tableName('user'); - $tables = "$userTable AS u1"; - $this->addFields('u1.user_name'); - $this->addWhereFld('u1.user_name', $goodNames); - $this->addFieldsIf('u1.user_editcount', isset($this->prop['editcount'])); - - if(isset($this->prop['groups'])) { - $ug = $db->tableName('user_groups'); - $tables = "$tables LEFT JOIN $ug ON ug_user=u1.user_id"; - $this->addFields('ug_group'); - } - if(isset($this->prop['blockinfo'])) { - $ipb = $db->tableName('ipblocks'); - $tables = "$tables LEFT JOIN $ipb ON ipb_user=u1.user_id"; - $tables = "$tables LEFT JOIN $userTable AS u2 ON ipb_by=u2.user_id"; - $this->addFields(array('ipb_reason', 'u2.user_name AS blocker_name')); - } - $this->addTables($tables); - - $data = array(); - $res = $this->select(__METHOD__); - while(($r = $db->fetchObject($res))) { - $data[$r->user_name]['name'] = $r->user_name; - if(isset($this->prop['editcount'])) - $data[$r->user_name]['editcount'] = $r->user_editcount; - if(isset($this->prop['groups'])) - // This row contains only one group, others will be added from other rows - if(!is_null($r->ug_group)) - $data[$r->user_name]['groups'][] = $r->ug_group; - if(isset($this->prop['blockinfo'])) - if(!is_null($r->blocker_name)) { - $data[$r->user_name]['blockedby'] = $r->blocker_name; - $data[$r->user_name]['blockreason'] = $r->ipb_reason; - } - } - - // Second pass: add result data to $retval - foreach($goodNames as $u) { - if(!isset($data[$u])) - $retval[] = array('name' => $u, 'missing' => ''); - else { - if(isset($this->prop['groups']) && isset($data[$u]['groups'])) - $this->getResult()->setIndexedTagName($data[$u]['groups'], 'g'); - $retval[] = $data[$u]; - } - } - return $retval; - } - protected function getCurrentUserInfo() { global $wgUser; $result = $this->getResult(); @@ -178,10 +112,10 @@ class ApiQueryUserInfo extends ApiQueryBase { '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 (current user only)', + ' hasmsg - adds a tag "message" if user has pending messages', ' groups - lists all the groups the user belongs to', - ' rights - lists of all rights the user has (current user only)', - ' options - lists all preferences the user has set (current user only)', + ' rights - lists of all rights the user has', + ' options - lists all preferences the user has set', ' editcount - adds the user\'s edit count' ), 'users' => 'A list of other users to obtain the same information for' @@ -189,7 +123,7 @@ class ApiQueryUserInfo extends ApiQueryBase { } protected function getDescription() { - return 'Get information about the current user and other users'; + return 'Get information about the current user'; } protected function getExamples() { diff --git a/includes/api/ApiQueryUsers.php b/includes/api/ApiQueryUsers.php new file mode 100644 index 0000000000..20bad51e4c --- /dev/null +++ b/includes/api/ApiQueryUsers.php @@ -0,0 +1,162 @@ +.@home.nl + * + * 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 a list of users + * + * @addtogroup API + */ + + class ApiQueryUsers extends ApiQueryBase { + + public function __construct($query, $moduleName) { + parent :: __construct($query, $moduleName, 'us'); + } + + public function execute() { + $params = $this->extractRequestParams(); + $result = $this->getResult(); + $r = array(); + + if (!is_null($params['prop'])) { + $this->prop = array_flip($params['prop']); + } else { + $this->prop = array(); + } + + if(is_array($params['users'])) { + $r = $this->getOtherUsersInfo($params['users']); + $result->setIndexedTagName($r, 'user'); + } + $result->addValue("query", $this->getModuleName(), $r); + } + + protected function getOtherUsersInfo($users) { + $goodNames = $retval = array(); + // Canonicalize user names + foreach($users as $u) { + $n = User::getCanonicalName($u); + if($n === false) + $retval[] = array('name' => $u, 'invalid' => ''); + else + $goodNames[] = $n; + } + + $db = $this->getDb(); + $userTable = $db->tableName('user'); + $tables = "$userTable AS u1"; + $this->addFields('u1.user_name'); + $this->addWhereFld('u1.user_name', $goodNames); + $this->addFieldsIf('u1.user_editcount', isset($this->prop['editcount'])); + + if(isset($this->prop['groups'])) { + $ug = $db->tableName('user_groups'); + $tables = "$tables LEFT JOIN $ug ON ug_user=u1.user_id"; + $this->addFields('ug_group'); + } + if(isset($this->prop['blockinfo'])) { + $ipb = $db->tableName('ipblocks'); + $tables = "$tables LEFT JOIN $ipb ON ipb_user=u1.user_id"; + $tables = "$tables LEFT JOIN $userTable AS u2 ON ipb_by=u2.user_id"; + $this->addFields(array('ipb_reason', 'u2.user_name AS blocker_name')); + } + $this->addTables($tables); + + $data = array(); + $res = $this->select(__METHOD__); + while(($r = $db->fetchObject($res))) { + $data[$r->user_name]['name'] = $r->user_name; + if(isset($this->prop['editcount'])) + $data[$r->user_name]['editcount'] = $r->user_editcount; + if(isset($this->prop['groups'])) + // This row contains only one group, others will be added from other rows + if(!is_null($r->ug_group)) + $data[$r->user_name]['groups'][] = $r->ug_group; + if(isset($this->prop['blockinfo'])) + if(!is_null($r->blocker_name)) { + $data[$r->user_name]['blockedby'] = $r->blocker_name; + $data[$r->user_name]['blockreason'] = $r->ipb_reason; + } + } + + // Second pass: add result data to $retval + foreach($goodNames as $u) { + if(!isset($data[$u])) + $retval[] = array('name' => $u, 'missing' => ''); + else { + if(isset($this->prop['groups']) && isset($data[$u]['groups'])) + $this->getResult()->setIndexedTagName($data[$u]['groups'], 'g'); + $retval[] = $data[$u]; + } + } + return $retval; + } + + protected function getAllowedParams() { + return array ( + 'prop' => array ( + ApiBase :: PARAM_DFLT => NULL, + ApiBase :: PARAM_ISMULTI => true, + ApiBase :: PARAM_TYPE => array ( + 'blockinfo', + 'groups', + 'editcount' + ) + ), + 'users' => array( + 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', + ' groups - lists all the groups the user belongs to', + ' editcount - adds the user\'s edit count' + ), + 'users' => 'A list of users to obtain the same information for' + ); + } + + protected function getDescription() { + return 'Get information about a list of users'; + } + + protected function getExamples() { + return 'api.php?action=query&list=users&ususers=brion|TimStarling&usprop=groups|editcount'; + } + + public function getVersion() { + return __CLASS__ . ': $Id: ApiQueryUserInfo.php 30128 2008-01-24 17:59:07Z catrope $'; + } +}