more accurate documentation for addValue() method
[lhc/web/wiklou.git] / includes / api / ApiQueryUserInfo.php
index 3f4903b..eaa7cff 100644 (file)
@@ -1,9 +1,8 @@
 <?php
-
 /**
- * Created on July 30, 2007
  *
- * API for MediaWiki 1.8+
+ *
+ * Created on July 30, 2007
  *
  * Copyright © 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
  *
  * 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' ) ) {
@@ -35,6 +36,8 @@ if ( !defined( 'MEDIAWIKI' ) ) {
  */
 class ApiQueryUserInfo extends ApiQueryBase {
 
+       private $prop = array();
+
        public function __construct( $query, $moduleName ) {
                parent::__construct( $query, $moduleName, 'ui' );
        }
@@ -42,19 +45,17 @@ class ApiQueryUserInfo extends ApiQueryBase {
        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 );
        }
 
        protected function getCurrentUserInfo() {
-               global $wgUser;
+               global $wgUser, $wgRequest, $wgHiddenPrefs;
                $result = $this->getResult();
                $vals = array();
                $vals['id'] = intval( $wgUser->getId() );
@@ -76,10 +77,17 @@ 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
                }
 
+               if ( isset( $this->prop['implicitgroups'] ) ) {
+                       $vals['implicitgroups'] = ApiQueryUsers::getAutoGroups( $wgUser );
+                       $result->setIndexedTagName( $vals['implicitgroups'], '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() ) );
@@ -98,12 +106,10 @@ class ApiQueryUserInfo extends ApiQueryBase {
                        $vals['options'] = $wgUser->getOptions();
                }
 
-               if (
-                       isset( $this->prop['preferencestoken'] ) &&
+               if ( isset( $this->prop['preferencestoken'] ) &&
                        is_null( $this->getMain()->getRequest()->getVal( 'callback' ) )
-               )
-               {
-                       $vals['preferencestoken'] = $wgUser->editToken();
+               ) {
+                       $vals['preferencestoken'] = $wgUser->editToken( '', $this->getMain()->getRequest() );
                }
 
                if ( isset( $this->prop['editcount'] ) ) {
@@ -114,6 +120,10 @@ class ApiQueryUserInfo extends ApiQueryBase {
                        $vals['ratelimits'] = $this->getRateLimits();
                }
 
+               if ( isset( $this->prop['realname'] ) && !in_array( 'realname', $wgHiddenPrefs ) ) {
+                       $vals['realname'] = $wgUser->getRealName();
+               }
+
                if ( isset( $this->prop['email'] ) ) {
                        $vals['email'] = $wgUser->getEmail();
                        $auth = $wgUser->getEmailAuthenticationTimestamp();
@@ -121,6 +131,25 @@ class ApiQueryUserInfo extends ApiQueryBase {
                                $vals['emailauthenticated'] = wfTimestamp( TS_ISO_8601, $auth );
                        }
                }
+
+               if ( isset( $this->prop['registrationdate'] ) ) {
+                       $regDate = $wgUser->getRegistration();
+                       if ( $regDate !== false ) {
+                               $vals['registrationdate'] = wfTimestamp( TS_ISO_8601, $regDate );
+                       }
+               }
+
+               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;
        }
 
@@ -167,6 +196,7 @@ class ApiQueryUserInfo extends ApiQueryBase {
                                        'blockinfo',
                                        'hasmsg',
                                        'groups',
+                                       'implicitgroups',
                                        'rights',
                                        'changeablegroups',
                                        'options',
@@ -174,6 +204,9 @@ class ApiQueryUserInfo extends ApiQueryBase {
                                        'editcount',
                                        'ratelimits',
                                        'email',
+                                       'realname',
+                                       'acceptlang',
+                                       'registrationdate'
                                )
                        )
                );
@@ -183,15 +216,20 @@ class ApiQueryUserInfo extends ApiQueryBase {
                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',
-                               '  email      - adds the user\'s email address and email authentication date',
+                               '  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',
+                               '  implicitgroups   - Lists all the groups the current user is automatically a member of',
+                               '  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',
+                               '  preferencestoken - Get a token to change current user\'s preferences',
+                               '  editcount        - Adds the current user\'s edit count',
+                               '  ratelimits       - Lists all rate limits applying to the current user',
+                               '  realname         - Adds the user\'s real name',
+                               '  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',
+                               '  registrationdate - Adds the user\'s registration date',
                        )
                );
        }
@@ -200,13 +238,17 @@ class ApiQueryUserInfo extends ApiQueryBase {
                return 'Get information about the current user';
        }
 
-       protected function getExamples() {
+       public function getExamples() {
                return array(
                        'api.php?action=query&meta=userinfo',
                        'api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg',
                );
        }
 
+       public function getHelpUrls() {
+               return 'http://www.mediawiki.org/wiki/API:Meta#userinfo_.2F_ui';
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }