]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - includes/api/ApiQueryUserInfo.php
MediaWiki 1.17.0
[autoinstallsdev/mediawiki.git] / includes / api / ApiQueryUserInfo.php
index 42cb47b90f72fb37173bdfbfa59635eb82ebae92..ec7b74b3f85e9d93b706a6ac89e0a477c1b8e322 100644 (file)
@@ -1,11 +1,10 @@
 <?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' ) ) {
        // Eclipse helper - will be ignored in production
-       require_once ( 'ApiQueryBase.php' );
+       require_once( 'ApiQueryBase.php' );
 }
 
 /**
@@ -35,33 +36,34 @@ if ( !defined( 'MEDIAWIKI' ) ) {
  */
 class ApiQueryUserInfo extends ApiQueryBase {
 
+       private $prop = array();
+
        public function __construct( $query, $moduleName ) {
-               parent :: __construct( $query, $moduleName, 'ui' );
+               parent::__construct( $query, $moduleName, 'ui' );
        }
 
        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();
                }
+
                $r = $this->getCurrentUserInfo();
-               $result->addValue( "query", $this->getModuleName(), $r );
+               $result->addValue( 'query', $this->getModuleName(), $r );
        }
 
        protected function getCurrentUserInfo() {
-               global $wgUser;
+               global $wgUser, $wgRequest;
                $result = $this->getResult();
                $vals = array();
                $vals['id'] = intval( $wgUser->getId() );
                $vals['name'] = $wgUser->getName();
 
-               if ( $wgUser->isAnon() )
+               if ( $wgUser->isAnon() ) {
                        $vals['anon'] = '';
+               }
 
                if ( isset( $this->prop['blockinfo'] ) ) {
                        if ( $wgUser->isBlocked() ) {
@@ -75,7 +77,9 @@ class ApiQueryUserInfo extends ApiQueryBase {
                }
 
                if ( isset( $this->prop['groups'] ) ) {
-                       $vals['groups'] = $wgUser->getGroups();
+                       $autolist = ApiQueryUsers::getAutoGroups( $wgUser );
+
+                       $vals['groups'] = array_merge( $autolist, $wgUser->getGroups() );
                        $result->setIndexedTagName( $vals['groups'], 'g' );     // even if empty
                }
 
@@ -97,7 +101,11 @@ class ApiQueryUserInfo extends ApiQueryBase {
                        $vals['options'] = $wgUser->getOptions();
                }
 
-               if ( isset( $this->prop['preferencestoken'] ) && is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) ) {
+               if (
+                       isset( $this->prop['preferencestoken'] ) &&
+                       is_null( $this->getMain()->getRequest()->getVal( 'callback' ) )
+               )
+               {
                        $vals['preferencestoken'] = $wgUser->editToken();
                }
 
@@ -112,26 +120,39 @@ class ApiQueryUserInfo extends ApiQueryBase {
                if ( isset( $this->prop['email'] ) ) {
                        $vals['email'] = $wgUser->getEmail();
                        $auth = $wgUser->getEmailAuthenticationTimestamp();
-                       if ( !is_null( $auth ) )
+                       if ( !is_null( $auth ) ) {
                                $vals['emailauthenticated'] = wfTimestamp( TS_ISO_8601, $auth );
+                       }
+               }
+
+               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()
-       {
+       protected function getRateLimits() {
                global $wgUser, $wgRateLimits;
-               if ( !$wgUser->isPingLimitable() )
+               if ( !$wgUser->isPingLimitable() ) {
                        return array(); // No limits
+               }
 
                // Find out which categories we belong to
                $categories = array();
-               if ( $wgUser->isAnon() )
+               if ( $wgUser->isAnon() ) {
                        $categories[] = 'anon';
-               else
+               } else {
                        $categories[] = 'user';
-               if ( $wgUser->isNewBie() )
-               {
+               }
+               if ( $wgUser->isNewbie() ) {
                        $categories[] = 'ip';
                        $categories[] = 'subnet';
                        if ( !$wgUser->isAnon() )
@@ -141,22 +162,23 @@ class ApiQueryUserInfo extends ApiQueryBase {
 
                // Now get the actual limits
                $retval = array();
-               foreach ( $wgRateLimits as $action => $limits )
-                       foreach ( $categories as $cat )
-                               if ( isset( $limits[$cat] ) && !is_null( $limits[$cat] ) )
-                               {
+               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] );
                                }
+                       }
+               }
                return $retval;
        }
 
        public function getAllowedParams() {
-               return array (
-                       'prop' => array (
-                               ApiBase :: PARAM_DFLT => null,
-                               ApiBase :: PARAM_ISMULTI => true,
-                               ApiBase :: PARAM_TYPE => array (
+               return array(
+                       'prop' => array(
+                               ApiBase::PARAM_DFLT => null,
+                               ApiBase::PARAM_ISMULTI => true,
+                               ApiBase::PARAM_TYPE => array(
                                        'blockinfo',
                                        'hasmsg',
                                        'groups',
@@ -167,23 +189,26 @@ class ApiQueryUserInfo extends ApiQueryBase {
                                        'editcount',
                                        'ratelimits',
                                        'email',
+                                       'acceptlang',
                                )
                        )
                );
        }
 
        public function getParamDescription() {
-               return array (
+               return array(
                        'prop' => array(
                                'What pieces of information to include',
-                               '  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'
+                               '  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',
                        )
                );
        }
@@ -193,13 +218,13 @@ class ApiQueryUserInfo extends ApiQueryBase {
        }
 
        protected function getExamples() {
-               return array (
+               return array(
                        'api.php?action=query&meta=userinfo',
                        'api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg',
                );
        }
 
        public function getVersion() {
-               return __CLASS__ . ': $Id: ApiQueryUserInfo.php 69578 2010-07-20 02:46:20Z tstarling $';
+               return __CLASS__ . ': $Id: ApiQueryUserInfo.php 75937 2010-11-03 17:01:21Z reedy $';
        }
 }