MediaWiki 1.30.2

[autoinstalls/mediawiki.git] / includes / api / ApiQueryUsers.php

diff --git a/includes/api/ApiQueryUsers.php b/includes/api/ApiQueryUsers.php
index b8aa60e716f6ca83afeda1909437be277b8b626e..fbf1f9ebfb999fd1d560d63630c43bde0f45e6b8 100644 (file)
--- a/includes/api/ApiQueryUsers.php
+++ b/includes/api/ApiQueryUsers.php
@@ -1,11 +1,10 @@
 <?php
 <?php

-
-/*
- * Created on July 30, 2007
+/**

  *
  *

- * API for MediaWiki 1.8+

  *
  *

- * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * Created on July 30, 2007
+ *
+ * Copyright © 2007 Roan Kattouw "<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
  *
  * 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


@@ -19,167 +18,392 @@
  *
  * 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.,
  *
  * 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
  * http://www.gnu.org/copyleft/gpl.html

+ *
+ * @file

  */
 
  */
 

-if (!defined('MEDIAWIKI')) {
-       // Eclipse helper - will be ignored in production
-       require_once ('ApiQueryBase.php');
-}
-

 /**
  * Query module to get information about a list of users
  *
  * @ingroup API
  */
 /**
  * Query module to get information about a list of users
  *
  * @ingroup API
  */

+class ApiQueryUsers extends ApiQueryBase {
+
+       private $tokenFunctions, $prop;

 
 

- class ApiQueryUsers extends ApiQueryBase {
+       /**
+        * Properties whose contents does not depend on who is looking at them. If the usprops field
+        * contains anything not listed here, the cache mode will never be public for logged-in users.
+        * @var array
+        */
+       protected static $publicProps = [
+               // everything except 'blockinfo' which might show hidden records if the user
+               // making the request has the appropriate permissions
+               'groups',
+               'groupmemberships',
+               'implicitgroups',
+               'rights',
+               'editcount',
+               'registration',
+               'emailable',
+               'gender',
+               'centralids',
+               'cancreate',
+       ];

 
 

-       public function __construct($query, $moduleName) {
-               parent :: __construct($query, $moduleName, 'us');
+       public function __construct( ApiQuery $query, $moduleName ) {
+               parent::__construct( $query, $moduleName, 'us' );
+       }
+
+       /**
+        * Get an array mapping token names to their handler functions.
+        * The prototype for a token function is func($user)
+        * it should return a token or false (permission denied)
+        * @deprecated since 1.24
+        * @return array Array of tokenname => function
+        */
+       protected function getTokenFunctions() {
+               // Don't call the hooks twice
+               if ( isset( $this->tokenFunctions ) ) {
+                       return $this->tokenFunctions;
+               }
+
+               // If we're in a mode that breaks the same-origin policy, no tokens can
+               // be obtained
+               if ( $this->lacksSameOriginSecurity() ) {
+                       return [];
+               }
+
+               $this->tokenFunctions = [
+                       'userrights' => [ 'ApiQueryUsers', 'getUserrightsToken' ],
+               ];
+               Hooks::run( 'APIQueryUsersTokens', [ &$this->tokenFunctions ] );
+
+               return $this->tokenFunctions;
+       }
+
+       /**
+        * @deprecated since 1.24
+        * @param User $user
+        * @return string
+        */
+       public static function getUserrightsToken( $user ) {
+               global $wgUser;
+
+               // Since the permissions check for userrights is non-trivial,
+               // don't bother with it here
+               return $wgUser->getEditToken( $user->getName() );

        }
 
        public function execute() {
        }
 
        public function execute() {

+               $db = $this->getDB();
+               $commentStore = new CommentStore( 'ipb_reason' );
+

                $params = $this->extractRequestParams();
                $params = $this->extractRequestParams();

-               $result = $this->getResult();
-               $r = array();
+               $this->requireMaxOneParameter( $params, 'userids', 'users' );

 
 

-               if (!is_null($params['prop'])) {
-                       $this->prop = array_flip($params['prop']);
+               if ( !is_null( $params['prop'] ) ) {
+                       $this->prop = array_flip( $params['prop'] );

                } else {
                } else {

-                       $this->prop = array();
+                       $this->prop = [];

                }
                }

+               $useNames = !is_null( $params['users'] );

 
                $users = (array)$params['users'];
 
                $users = (array)$params['users'];

-               $goodNames = $done = array();
+               $userids = (array)$params['userids'];
+
+               $goodNames = $done = [];

                $result = $this->getResult();
                // Canonicalize user names
                $result = $this->getResult();
                // Canonicalize user names

-               foreach($users as $u) {
-                       $n = User::getCanonicalName($u);
-                       if($n === false || $n === '')
-                       {
-                               $vals = array('name' => $u, 'invalid' => '');
-                               $fit = $result->addValue(array('query', $this->getModuleName()),
-                                               null, $vals);
-                               if(!$fit)
-                               {
-                                       $this->setContinueEnumParameter('users',
-                                                       implode('|', array_diff($users, $done)));
-                                       $goodNames = array();
+               foreach ( $users as $u ) {
+                       $n = User::getCanonicalName( $u );
+                       if ( $n === false || $n === '' ) {
+                               $vals = [ 'name' => $u, 'invalid' => true ];
+                               $fit = $result->addValue( [ 'query', $this->getModuleName() ],
+                                       null, $vals );
+                               if ( !$fit ) {
+                                       $this->setContinueEnumParameter( 'users',
+                                               implode( '|', array_diff( $users, $done ) ) );
+                                       $goodNames = [];

                                        break;
                                }
                                $done[] = $u;
                                        break;
                                }
                                $done[] = $u;

-                       }
-                        else
+                       } else {

                                $goodNames[] = $n;
                                $goodNames[] = $n;

+                       }
+               }
+
+               if ( $useNames ) {
+                       $parameters = &$goodNames;
+               } else {
+                       $parameters = &$userids;

                }
                }

-               if(count($goodNames))
-               {
-                       $db = $this->getDb();
-                       $this->addTables('user', 'u1');
-                       $this->addFields('u1.*');
-                       $this->addWhereFld('u1.user_name', $goodNames);
-
-                       if(isset($this->prop['groups'])) {
-                               $this->addTables('user_groups');
-                               $this->addJoinConds(array('user_groups' => array('LEFT JOIN', 'ug_user=u1.user_id')));
-                               $this->addFields('ug_group');
+
+               $result = $this->getResult();
+
+               if ( count( $parameters ) ) {
+                       $this->addTables( 'user' );
+                       $this->addFields( User::selectFields() );
+                       if ( $useNames ) {
+                               $this->addWhereFld( 'user_name', $goodNames );
+                       } else {
+                               $this->addWhereFld( 'user_id', $userids );

                        }
                        }

-                       if(isset($this->prop['blockinfo'])) {
-                               $this->addTables('ipblocks');
-                               $this->addTables('user', 'u2');
-                               $u2 = $this->getAliasedName('user', 'u2');
-                               $this->addJoinConds(array(
-                                       'ipblocks' => array('LEFT JOIN', 'ipb_user=u1.user_id'),
-                                       $u2 => array('LEFT JOIN', 'ipb_by=u2.user_id')));
-                               $this->addFields(array('ipb_reason', 'u2.user_name AS blocker_name'));
+
+                       $this->showHiddenUsersAddBlockInfo( isset( $this->prop['blockinfo'] ) );
+
+                       $data = [];
+                       $res = $this->select( __METHOD__ );
+                       $this->resetQueryParams();
+
+                       // get user groups if needed
+                       if ( isset( $this->prop['groups'] ) || isset( $this->prop['rights'] ) ) {
+                               $userGroups = [];
+
+                               $this->addTables( 'user' );
+                               if ( $useNames ) {
+                                       $this->addWhereFld( 'user_name', $goodNames );
+                               } else {
+                                       $this->addWhereFld( 'user_id', $userids );
+                               }
+
+                               $this->addTables( 'user_groups' );
+                               $this->addJoinConds( [ 'user_groups' => [ 'INNER JOIN', 'ug_user=user_id' ] ] );
+                               $this->addFields( [ 'user_name' ] );
+                               $this->addFields( UserGroupMembership::selectFields() );
+                               $this->addWhere( 'ug_expiry IS NULL OR ug_expiry >= ' .
+                                       $db->addQuotes( $db->timestamp() ) );
+                               $userGroupsRes = $this->select( __METHOD__ );
+
+                               foreach ( $userGroupsRes as $row ) {
+                                       $userGroups[$row->user_name][] = $row;
+                               }

                        }
 
                        }
 

-                       $data = array();
-                       $res = $this->select(__METHOD__);
-                       while(($r = $db->fetchObject($res))) {
-                               $user = User::newFromRow($r);
-                               $name = $user->getName();
-                               $data[$name]['name'] = $name;
-                               if(isset($this->prop['editcount']))
-                                       $data[$name]['editcount'] = intval($user->getEditCount());
-                               if(isset($this->prop['registration']))
-                                       $data[$name]['registration'] = wfTimestampOrNull(TS_ISO_8601, $user->getRegistration());
-                               if(isset($this->prop['groups']) && !is_null($r->ug_group))
-                                       // This row contains only one group, others will be added from other rows
-                                       $data[$name]['groups'][] = $r->ug_group;
-                               if(isset($this->prop['blockinfo']) && !is_null($r->blocker_name)) {
-                                       $data[$name]['blockedby'] = $r->blocker_name;
-                                       $data[$name]['blockreason'] = $r->ipb_reason;
-                               }
-                               if(isset($this->prop['emailable']) && $user->canReceiveEmail())
-                                       $data[$name]['emailable'] = '';
+                       foreach ( $res as $row ) {
+                               // create user object and pass along $userGroups if set
+                               // that reduces the number of database queries needed in User dramatically
+                               if ( !isset( $userGroups ) ) {
+                                       $user = User::newFromRow( $row );
+                               } else {
+                                       if ( !isset( $userGroups[$row->user_name] ) || !is_array( $userGroups[$row->user_name] ) ) {
+                                               $userGroups[$row->user_name] = [];
+                                       }
+                                       $user = User::newFromRow( $row, [ 'user_groups' => $userGroups[$row->user_name] ] );
+                               }
+                               if ( $useNames ) {
+                                       $key = $user->getName();
+                               } else {
+                                       $key = $user->getId();
+                               }
+                               $data[$key]['userid'] = $user->getId();
+                               $data[$key]['name'] = $user->getName();
+
+                               if ( isset( $this->prop['editcount'] ) ) {
+                                       $data[$key]['editcount'] = $user->getEditCount();
+                               }
+
+                               if ( isset( $this->prop['registration'] ) ) {
+                                       $data[$key]['registration'] = wfTimestampOrNull( TS_ISO_8601, $user->getRegistration() );
+                               }
+
+                               if ( isset( $this->prop['groups'] ) ) {
+                                       $data[$key]['groups'] = $user->getEffectiveGroups();
+                               }
+
+                               if ( isset( $this->prop['groupmemberships'] ) ) {
+                                       $data[$key]['groupmemberships'] = array_map( function ( $ugm ) {
+                                               return [
+                                                       'group' => $ugm->getGroup(),
+                                                       'expiry' => ApiResult::formatExpiry( $ugm->getExpiry() ),
+                                               ];
+                                       }, $user->getGroupMemberships() );
+                               }
+
+                               if ( isset( $this->prop['implicitgroups'] ) ) {
+                                       $data[$key]['implicitgroups'] = $user->getAutomaticGroups();
+                               }
+
+                               if ( isset( $this->prop['rights'] ) ) {
+                                       $data[$key]['rights'] = $user->getRights();
+                               }
+                               if ( $row->ipb_deleted ) {
+                                       $data[$key]['hidden'] = true;
+                               }
+                               if ( isset( $this->prop['blockinfo'] ) && !is_null( $row->ipb_by_text ) ) {
+                                       $data[$key]['blockid'] = (int)$row->ipb_id;
+                                       $data[$key]['blockedby'] = $row->ipb_by_text;
+                                       $data[$key]['blockedbyid'] = (int)$row->ipb_by;
+                                       $data[$key]['blockedtimestamp'] = wfTimestamp( TS_ISO_8601, $row->ipb_timestamp );
+                                       $data[$key]['blockreason'] = $commentStore->getComment( $row )->text;
+                                       $data[$key]['blockexpiry'] = $row->ipb_expiry;
+                               }
+
+                               if ( isset( $this->prop['emailable'] ) ) {
+                                       $data[$key]['emailable'] = $user->canReceiveEmail();
+                               }
+
+                               if ( isset( $this->prop['gender'] ) ) {
+                                       $gender = $user->getOption( 'gender' );
+                                       if ( strval( $gender ) === '' ) {
+                                               $gender = 'unknown';
+                                       }
+                                       $data[$key]['gender'] = $gender;
+                               }
+
+                               if ( isset( $this->prop['centralids'] ) ) {
+                                       $data[$key] += ApiQueryUserInfo::getCentralUserInfo(
+                                               $this->getConfig(), $user, $params['attachedwiki']
+                                       );
+                               }
+
+                               if ( !is_null( $params['token'] ) ) {
+                                       $tokenFunctions = $this->getTokenFunctions();
+                                       foreach ( $params['token'] as $t ) {
+                                               $val = call_user_func( $tokenFunctions[$t], $user );
+                                               if ( $val === false ) {
+                                                       $this->addWarning( [ 'apiwarn-tokennotallowed', $t ] );
+                                               } else {
+                                                       $data[$key][$t . 'token'] = $val;
+                                               }
+                                       }
+                               }

                        }
                }
                        }
                }

+
+               $context = $this->getContext();

                // Second pass: add result data to $retval
                // Second pass: add result data to $retval

-               foreach($goodNames as $u) {
-                       if(!isset($data[$u]))
-                               $data[$u] = array('name' => $u, 'missing' => '');
-                       else {
-                               if(isset($this->prop['groups']) && isset($data[$u]['groups']))
-                                       $this->getResult()->setIndexedTagName($data[$u]['groups'], 'g');
+               foreach ( $parameters as $u ) {
+                       if ( !isset( $data[$u] ) ) {
+                               if ( $useNames ) {
+                                       $data[$u] = [ 'name' => $u ];
+                                       $urPage = new UserrightsPage;
+                                       $urPage->setContext( $context );
+
+                                       $iwUser = $urPage->fetchUser( $u );
+
+                                       if ( $iwUser instanceof UserRightsProxy ) {
+                                               $data[$u]['interwiki'] = true;
+
+                                               if ( !is_null( $params['token'] ) ) {
+                                                       $tokenFunctions = $this->getTokenFunctions();
+
+                                                       foreach ( $params['token'] as $t ) {
+                                                               $val = call_user_func( $tokenFunctions[$t], $iwUser );
+                                                               if ( $val === false ) {
+                                                                       $this->addWarning( [ 'apiwarn-tokennotallowed', $t ] );
+                                                               } else {
+                                                                       $data[$u][$t . 'token'] = $val;
+                                                               }
+                                                       }
+                                               }
+                                       } else {
+                                               $data[$u]['missing'] = true;
+                                               if ( isset( $this->prop['cancreate'] ) ) {
+                                                       $status = MediaWiki\Auth\AuthManager::singleton()->canCreateAccount( $u );
+                                                       $data[$u]['cancreate'] = $status->isGood();
+                                                       if ( !$status->isGood() ) {
+                                                               $data[$u]['cancreateerror'] = $this->getErrorFormatter()->arrayFromStatus( $status );
+                                                       }
+                                               }
+                                       }
+                               } else {
+                                       $data[$u] = [ 'userid' => $u, 'missing' => true ];
+                               }
+
+                       } else {
+                               if ( isset( $this->prop['groups'] ) && isset( $data[$u]['groups'] ) ) {
+                                       ApiResult::setArrayType( $data[$u]['groups'], 'array' );
+                                       ApiResult::setIndexedTagName( $data[$u]['groups'], 'g' );
+                               }
+                               if ( isset( $this->prop['groupmemberships'] ) && isset( $data[$u]['groupmemberships'] ) ) {
+                                       ApiResult::setArrayType( $data[$u]['groupmemberships'], 'array' );
+                                       ApiResult::setIndexedTagName( $data[$u]['groupmemberships'], 'groupmembership' );
+                               }
+                               if ( isset( $this->prop['implicitgroups'] ) && isset( $data[$u]['implicitgroups'] ) ) {
+                                       ApiResult::setArrayType( $data[$u]['implicitgroups'], 'array' );
+                                       ApiResult::setIndexedTagName( $data[$u]['implicitgroups'], 'g' );
+                               }
+                               if ( isset( $this->prop['rights'] ) && isset( $data[$u]['rights'] ) ) {
+                                       ApiResult::setArrayType( $data[$u]['rights'], 'array' );
+                                       ApiResult::setIndexedTagName( $data[$u]['rights'], 'r' );
+                               }

                        }
                        }

-                       $fit = $result->addValue(array('query', $this->getModuleName()),
-                                       null, $data[$u]);
-                       if(!$fit)
-                       {
-                               $this->setContinueEnumParameter('users',
-                                               implode('|', array_diff($users, $done)));
+
+                       $fit = $result->addValue( [ 'query', $this->getModuleName() ],
+                               null, $data[$u] );
+                       if ( !$fit ) {
+                               if ( $useNames ) {
+                                       $this->setContinueEnumParameter( 'users',
+                                               implode( '|', array_diff( $users, $done ) ) );
+                               } else {
+                                       $this->setContinueEnumParameter( 'userids',
+                                               implode( '|', array_diff( $userids, $done ) ) );
+                               }

                                break;
                        }
                        $done[] = $u;
                }
                                break;
                        }
                        $done[] = $u;
                }

-               return $this->getResult()->setIndexedTagName_internal(array('query', $this->getModuleName()), 'user');
+               $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'user' );
+       }
+
+       public function getCacheMode( $params ) {
+               if ( isset( $params['token'] ) ) {
+                       return 'private';
+               } elseif ( array_diff( (array)$params['prop'], static::$publicProps ) ) {
+                       return 'anon-public-user-private';
+               } else {
+                       return 'public';
+               }

        }
 
        public function getAllowedParams() {
        }
 
        public function getAllowedParams() {

-               return array (
-                       'prop' => array (
-                               ApiBase :: PARAM_DFLT => NULL,
-                               ApiBase :: PARAM_ISMULTI => true,
-                               ApiBase :: PARAM_TYPE => array (
+               return [
+                       'prop' => [
+                               ApiBase::PARAM_ISMULTI => true,
+                               ApiBase::PARAM_TYPE => [

                                        'blockinfo',
                                        'groups',
                                        'blockinfo',
                                        'groups',

+                                       'groupmemberships',
+                                       'implicitgroups',
+                                       'rights',

                                        'editcount',
                                        'registration',
                                        'emailable',
                                        'editcount',
                                        'registration',
                                        'emailable',

-                               )
-                       ),
-                       'users' => array(
-                               ApiBase :: PARAM_ISMULTI => true
-                       )
-               );
-       }
-
-       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',
-                               '  groups       - lists all the groups the user belongs to',
-                               '  editcount    - adds the user\'s edit count',
-                               '  registration - adds the user\'s registration timestamp',
-                               '  emailable    - tags if the user can and wants to receive e-mail through [[Special:Emailuser]]',
-                       ),
-                       'users' => 'A list of users to obtain the same information for'
-               );
-       }
-
-       public function getDescription() {
-               return 'Get information about a list of users';
+                                       'gender',
+                                       'centralids',
+                                       'cancreate',
+                                       // When adding a prop, consider whether it should be added
+                                       // to self::$publicProps
+                               ],
+                               ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
+                       ],
+                       'attachedwiki' => null,
+                       'users' => [
+                               ApiBase::PARAM_ISMULTI => true
+                       ],
+                       'userids' => [
+                               ApiBase::PARAM_ISMULTI => true,
+                               ApiBase::PARAM_TYPE => 'integer'
+                       ],
+                       'token' => [
+                               ApiBase::PARAM_DEPRECATED => true,
+                               ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() ),
+                               ApiBase::PARAM_ISMULTI => true
+                       ],
+               ];

        }
 
        }
 

-       protected function getExamples() {
-               return 'api.php?action=query&list=users&ususers=brion|TimStarling&usprop=groups|editcount';
+       protected function getExamplesMessages() {
+               return [
+                       'action=query&list=users&ususers=Example&usprop=groups|editcount|gender'
+                               => 'apihelp-query+users-example-simple',
+               ];

        }
 
        }
 

-       public function getVersion() {
-               return __CLASS__ . ': $Id: ApiQueryUsers.php 50094 2009-05-01 06:24:09Z tstarling $';
+       public function getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Users';

        }
 }
        }
 }