Merge "Wrap auto-numbering for section heading in a classed span (bug 33450)"
[lhc/web/wiklou.git] / includes / api / ApiQueryInfo.php
index 5b0d325..a6c0ed5 100644 (file)
  * @file
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-       // Eclipse helper - will be ignored in production
-       require_once( 'ApiQueryBase.php' );
-}
-
 /**
  * A query module to show basic page information.
  *
@@ -76,7 +71,7 @@ class ApiQueryInfo extends ApiQueryBase {
         * Get an array mapping token names to their handler functions.
         * The prototype for a token function is func($pageid, $title)
         * it should return a token or false (permission denied)
-        * @return array(tokenname => function)
+        * @return array array(tokenname => function)
         */
        protected function getTokenFunctions() {
                // Don't call the hooks twice
@@ -98,6 +93,7 @@ class ApiQueryInfo extends ApiQueryBase {
                        'unblock' => array( 'ApiQueryInfo', 'getUnblockToken' ),
                        'email' => array( 'ApiQueryInfo', 'getEmailToken' ),
                        'import' => array( 'ApiQueryInfo', 'getImportToken' ),
+                       'watch' => array( 'ApiQueryInfo', 'getWatchToken'),
                );
                wfRunHooks( 'APIQueryInfoTokens', array( &$this->tokenFunctions ) );
                return $this->tokenFunctions;
@@ -118,7 +114,7 @@ class ApiQueryInfo extends ApiQueryBase {
                        return $cachedEditToken;
                }
 
-               $cachedEditToken = $wgUser->editToken();
+               $cachedEditToken = $wgUser->getEditToken();
                return $cachedEditToken;
        }
 
@@ -133,7 +129,7 @@ class ApiQueryInfo extends ApiQueryBase {
                        return $cachedDeleteToken;
                }
 
-               $cachedDeleteToken = $wgUser->editToken();
+               $cachedDeleteToken = $wgUser->getEditToken();
                return $cachedDeleteToken;
        }
 
@@ -148,7 +144,7 @@ class ApiQueryInfo extends ApiQueryBase {
                        return $cachedProtectToken;
                }
 
-               $cachedProtectToken = $wgUser->editToken();
+               $cachedProtectToken = $wgUser->getEditToken();
                return $cachedProtectToken;
        }
 
@@ -163,7 +159,7 @@ class ApiQueryInfo extends ApiQueryBase {
                        return $cachedMoveToken;
                }
 
-               $cachedMoveToken = $wgUser->editToken();
+               $cachedMoveToken = $wgUser->getEditToken();
                return $cachedMoveToken;
        }
 
@@ -178,7 +174,7 @@ class ApiQueryInfo extends ApiQueryBase {
                        return $cachedBlockToken;
                }
 
-               $cachedBlockToken = $wgUser->editToken();
+               $cachedBlockToken = $wgUser->getEditToken();
                return $cachedBlockToken;
        }
 
@@ -198,13 +194,13 @@ class ApiQueryInfo extends ApiQueryBase {
                        return $cachedEmailToken;
                }
 
-               $cachedEmailToken = $wgUser->editToken();
+               $cachedEmailToken = $wgUser->getEditToken();
                return $cachedEmailToken;
        }
 
        public static function getImportToken( $pageid, $title ) {
                global $wgUser;
-               if ( !$wgUser->isAllowed( 'import' ) ) {
+               if ( !$wgUser->isAllowedAny( 'import', 'importupload' ) ) {
                        return false;
                }
 
@@ -213,10 +209,40 @@ class ApiQueryInfo extends ApiQueryBase {
                        return $cachedImportToken;
                }
 
-               $cachedImportToken = $wgUser->editToken();
+               $cachedImportToken = $wgUser->getEditToken();
                return $cachedImportToken;
        }
 
+       public static function getWatchToken( $pageid, $title ) {
+               global $wgUser;
+               if ( !$wgUser->isLoggedIn() ) {
+                       return false;
+               }
+
+               static $cachedWatchToken = null;
+               if ( !is_null( $cachedWatchToken ) ) {
+                       return $cachedWatchToken;
+               }
+
+               $cachedWatchToken = $wgUser->getEditToken( 'watch' );
+               return $cachedWatchToken;
+       }
+
+       public static function getOptionsToken( $pageid, $title ) {
+               global $wgUser;
+               if ( !$wgUser->isLoggedIn() ) {
+                       return false;
+               }
+
+               static $cachedOptionsToken = null;
+               if ( !is_null( $cachedOptionsToken ) ) {
+                       return $cachedOptionsToken;
+               }
+
+               $cachedOptionsToken = $wgUser->getEditToken();
+               return $cachedOptionsToken;
+       }
+
        public function execute() {
                $this->params = $this->extractRequestParams();
                if ( !is_null( $this->params['prop'] ) ) {
@@ -311,7 +337,10 @@ class ApiQueryInfo extends ApiQueryBase {
         */
        private function extractPageInfo( $pageid, $title ) {
                $pageInfo = array();
-               if ( $title->exists() ) {
+               $titleExists = $pageid > 0; //$title->exists() needs pageid, which is not set for all title objects
+               $ns = $title->getNamespace();
+               $dbkey = $title->getDBkey();
+               if ( $titleExists ) {
                        global $wgDisableCounters;
 
                        $pageInfo['touched'] = wfTimestamp( TS_ISO_8601, $this->pageTouched[$pageid] );
@@ -344,35 +373,35 @@ class ApiQueryInfo extends ApiQueryBase {
 
                if ( $this->fld_protection ) {
                        $pageInfo['protection'] = array();
-                       if ( isset( $this->protections[$title->getNamespace()][$title->getDBkey()] ) ) {
+                       if ( isset( $this->protections[$ns][$dbkey] ) ) {
                                $pageInfo['protection'] =
-                                       $this->protections[$title->getNamespace()][$title->getDBkey()];
+                                       $this->protections[$ns][$dbkey];
                        }
                        $this->getResult()->setIndexedTagName( $pageInfo['protection'], 'pr' );
                }
 
-               if ( $this->fld_watched && isset( $this->watched[$title->getNamespace()][$title->getDBkey()] ) ) {
+               if ( $this->fld_watched && isset( $this->watched[$ns][$dbkey] ) ) {
                        $pageInfo['watched'] = '';
                }
 
-               if ( $this->fld_talkid && isset( $this->talkids[$title->getNamespace()][$title->getDBkey()] ) ) {
-                       $pageInfo['talkid'] = $this->talkids[$title->getNamespace()][$title->getDBkey()];
+               if ( $this->fld_talkid && isset( $this->talkids[$ns][$dbkey] ) )        {
+                       $pageInfo['talkid'] = $this->talkids[$ns][$dbkey];
                }
 
-               if ( $this->fld_subjectid && isset( $this->subjectids[$title->getNamespace()][$title->getDBkey()] ) ) {
-                       $pageInfo['subjectid'] = $this->subjectids[$title->getNamespace()][$title->getDBkey()];
+               if ( $this->fld_subjectid && isset( $this->subjectids[$ns][$dbkey] ) ) {
+                       $pageInfo['subjectid'] = $this->subjectids[$ns][$dbkey];
                }
 
                if ( $this->fld_url ) {
-                       $pageInfo['fullurl'] = $title->getFullURL();
-                       $pageInfo['editurl'] = $title->getFullURL( 'action=edit' );
+                       $pageInfo['fullurl'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
+                       $pageInfo['editurl'] = wfExpandUrl( $title->getFullURL( 'action=edit' ), PROTO_CURRENT );
                }
-               if ( $this->fld_readable && $title->userCanRead() ) {
+               if ( $this->fld_readable && $title->userCan( 'read' ) ) {
                        $pageInfo['readable'] = '';
                }
 
                if ( $this->fld_preload ) {
-                       if ( $title->exists() ) {
+                       if ( $titleExists ) {
                                $pageInfo['preload'] = '';
                        } else {
                                $text = null;
@@ -383,8 +412,8 @@ class ApiQueryInfo extends ApiQueryBase {
                }
 
                if ( $this->fld_displaytitle ) {
-                       if ( isset( $this->displaytitles[$title->getArticleId()] ) ) {
-                               $pageInfo['displaytitle'] = $this->displaytitles[$title->getArticleId()];
+                       if ( isset( $this->displaytitles[$pageid] ) ) {
+                               $pageInfo['displaytitle'] = $this->displaytitles[$pageid];
                        } else {
                                $pageInfo['displaytitle'] = $title->getPrefixedText();
                        }
@@ -603,9 +632,9 @@ class ApiQueryInfo extends ApiQueryBase {
         * Get information about watched status and put it in $this->watched
         */
        private function getWatchedInfo() {
-               global $wgUser;
+               $user = $this->getUser();
 
-               if ( $wgUser->isAnon() || count( $this->everything ) == 0 ) {
+               if ( $user->isAnon() || count( $this->everything ) == 0 ) {
                        return;
                }
 
@@ -619,7 +648,7 @@ class ApiQueryInfo extends ApiQueryBase {
                $this->addFields( array( 'wl_title', 'wl_namespace' ) );
                $this->addWhere( array(
                        $lb->constructSet( 'wl', $db ),
-                       'wl_user' => $wgUser->getID()
+                       'wl_user' => $user->getID()
                ) );
 
                $res = $this->select( __METHOD__ );
@@ -695,6 +724,59 @@ class ApiQueryInfo extends ApiQueryBase {
                );
        }
 
+       public function getResultProperties() {
+               $props = array(
+                       ApiBase::PROP_LIST => false,
+                       '' => array(
+                               'touched' => 'timestamp',
+                               'lastrevid' => 'integer',
+                               'counter' => array(
+                                       ApiBase::PROP_TYPE => 'integer',
+                                       ApiBase::PROP_NULLABLE => true
+                               ),
+                               'length' => 'integer',
+                               'redirect' => 'boolean',
+                               'new' => 'boolean',
+                               'starttimestamp' => array(
+                                       ApiBase::PROP_TYPE => 'timestamp',
+                                       ApiBase::PROP_NULLABLE => true
+                               )
+                       ),
+                       'watched' => array(
+                               'watched' => 'boolean'
+                       ),
+                       'talkid' => array(
+                               'talkid' => array(
+                                       ApiBase::PROP_TYPE => 'integer',
+                                       ApiBase::PROP_NULLABLE => true
+                               )
+                       ),
+                       'subjectid' => array(
+                               'subjectid' => array(
+                                       ApiBase::PROP_TYPE => 'integer',
+                                       ApiBase::PROP_NULLABLE => true
+                               )
+                       ),
+                       'url' => array(
+                               'fullurl' => 'string',
+                               'editurl' => 'string'
+                       ),
+                       'readable' => array(
+                               'readable' => 'boolean'
+                       ),
+                       'preload' => array(
+                               'preload' => 'string'
+                       ),
+                       'displaytitle' => array(
+                               'displaytitle' => 'string'
+                       )
+               );
+
+               self::addTokenProperties( $props, $this->getTokenFunctions() );
+
+               return $props;
+       }
+
        public function getDescription() {
                return 'Get basic page information such as namespace, title, last touched date, ...';
        }
@@ -705,13 +787,17 @@ class ApiQueryInfo extends ApiQueryBase {
                ) );
        }
 
-       protected function getExamples() {
+       public function getExamples() {
                return array(
                        'api.php?action=query&prop=info&titles=Main%20Page',
                        'api.php?action=query&prop=info&inprop=protection&titles=Main%20Page'
                );
        }
 
+       public function getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/API:Properties#info_.2F_in';
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }