Merge "Api method documentation tweaks"
[lhc/web/wiklou.git] / includes / api / ApiParse.php
index 6450917..dbcd43c 100644 (file)
  * @file
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-       // Eclipse helper - will be ignored in production
-       require_once( "ApiBase.php" );
-}
-
 /**
  * @ingroup API
  */
@@ -52,6 +47,7 @@ class ApiParse extends ApiBase {
                if ( !is_null( $page ) && ( !is_null( $text ) || $title != 'API' ) ) {
                        $this->dieUsage( 'The page parameter cannot be used together with the text and title parameters', 'params' );
                }
+
                $prop = array_flip( $params['prop'] );
 
                if ( isset( $params['section'] ) ) {
@@ -62,16 +58,17 @@ class ApiParse extends ApiBase {
 
                // The parser needs $wgTitle to be set, apparently the
                // $title parameter in Parser::parse isn't enough *sigh*
-               global $wgParser, $wgUser, $wgTitle, $wgLang;
+               // TODO: Does this still need $wgTitle?
+               global $wgParser, $wgTitle;
 
                // Currently unnecessary, code to act as a safeguard against any change in current behaviour of uselang breaks
                $oldLang = null;
-               if ( isset( $params['uselang'] ) && $params['uselang'] != $wgLang->getCode() ) {
-                       $oldLang = $wgLang; // Backup wgLang
-                       $wgLang = Language::factory( $params['uselang'] );
+               if ( isset( $params['uselang'] ) && $params['uselang'] != $this->getContext()->getLanguage()->getCode() ) {
+                       $oldLang = $this->getContext()->getLanguage(); // Backup language
+                       $this->getContext()->setLanguage( Language::factory( $params['uselang'] ) );
                }
 
-               $popts = new ParserOptions();
+               $popts = ParserOptions::newFromContext( $this->getContext() );
                $popts->setTidy( true );
                $popts->enableLimitReport( !$params['disablepp'] );
 
@@ -87,7 +84,7 @@ class ApiParse extends ApiBase {
                                if ( !$rev ) {
                                        $this->dieUsage( "There is no revision ID $oldid", 'missingrev' );
                                }
-                               if ( !$rev->userCan( Revision::DELETED_TEXT ) ) {
+                               if ( !$rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
                                        $this->dieUsage( "You don't have permission to view deleted revisions", 'permissiondenied' );
                                }
 
@@ -97,22 +94,20 @@ class ApiParse extends ApiBase {
 
                                // If for some reason the "oldid" is actually the current revision, it may be cached
                                if ( $titleObj->getLatestRevID() === intval( $oldid ) )  {
-                                       $articleObj = new Article( $titleObj, 0 );
-
-                                       $p_result = $this->getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageid,
+                                       // May get from/save to parser cache
+                                       $p_result = $this->getParsedSectionOrText( $titleObj, $popts, $pageid,
                                                 isset( $prop['wikitext'] ) ) ;
                                } else { // This is an old revision, so get the text differently
-                                       $this->text = $rev->getText( Revision::FOR_THIS_USER );
-
-                                       $wgTitle = $titleObj;
+                                       $this->text = $rev->getText( Revision::FOR_THIS_USER, $this->getUser() );
 
                                        if ( $this->section !== false ) {
                                                $this->text = $this->getSectionText( $this->text, 'r' . $rev->getId() );
                                        }
 
+                                       // Should we save old revision parses to the parser cache?
                                        $p_result = $wgParser->parse( $this->text, $titleObj, $popts );
                                }
-                       } else { // Not $oldid
+                       } else { // Not $oldid, but $pageid or $page
                                if ( $params['redirects'] ) {
                                        $reqParams = array(
                                                'action' => 'query',
@@ -154,16 +149,19 @@ class ApiParse extends ApiBase {
                                }
                                $wgTitle = $titleObj;
 
-                               $articleObj = new Article( $titleObj, 0 );
                                if ( isset( $prop['revid'] ) ) {
-                                       $oldid = $articleObj->getRevIdFetched();
+                                       $oldid = $titleObj->getLatestRevID();
                                }
 
-                               $p_result = $this->getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageid,
+                               // Potentially cached
+                               $p_result = $this->getParsedSectionOrText( $titleObj, $popts, $pageid,
                                         isset( $prop['wikitext'] ) ) ;
                        }
                } else { // Not $oldid, $pageid, $page. Hence based on $text
 
+                       if ( is_null( $text ) ) {
+                               $this->dieUsage( 'The text parameter should be passed with the title parameter. Should you be using the "page" parameter instead?', 'params' );
+                       }
                        $this->text = $text;
                        $titleObj = Title::newFromText( $title );
                        if ( !$titleObj ) {
@@ -176,10 +174,11 @@ class ApiParse extends ApiBase {
                        }
 
                        if ( $params['pst'] || $params['onlypst'] ) {
-                               $this->pstText = $wgParser->preSaveTransform( $this->text, $titleObj, $wgUser, $popts );
+                               $this->pstText = $wgParser->preSaveTransform( $this->text, $titleObj, $this->getUser(), $popts );
                        }
                        if ( $params['onlypst'] ) {
                                // Build a result and bail out
+                               $result_array = array();
                                $result_array['text'] = array();
                                $result->setContent( $result_array['text'], $this->pstText );
                                if ( isset( $prop['wikitext'] ) ) {
@@ -189,6 +188,7 @@ class ApiParse extends ApiBase {
                                $result->addValue( null, $this->getModuleName(), $result_array );
                                return;
                        }
+                       // Not cached (save or load)
                        $p_result = $wgParser->parse( $params['pst'] ? $this->pstText : $this->text, $titleObj, $popts );
                }
 
@@ -211,7 +211,7 @@ class ApiParse extends ApiBase {
 
                if ( !is_null( $params['summary'] ) ) {
                        $result_array['parsedsummary'] = array();
-                       $result->setContent( $result_array['parsedsummary'], $wgUser->getSkin()->formatComment( $params['summary'], $titleObj ) );
+                       $result->setContent( $result_array['parsedsummary'], Linker::formatComment( $params['summary'], $titleObj ) );
                }
 
                if ( isset( $prop['langlinks'] ) ) {
@@ -253,7 +253,7 @@ class ApiParse extends ApiBase {
                }
 
                if ( isset( $prop['headitems'] ) || isset( $prop['headhtml'] ) ) {
-                       $context = $this->createContext();
+                       $context = $this->getContext();
                        $context->setTitle( $titleObj );
                        $context->getOutput()->addParserOutputNoText( $p_result );
 
@@ -285,6 +285,9 @@ class ApiParse extends ApiBase {
                                $result->setContent( $result_array['psttext'], $this->pstText );
                        }
                }
+               if ( isset( $prop['properties'] ) ) {
+                       $result_array['properties'] = $this->formatProperties( $p_result->getProperties() );
+               }
 
                $result_mapping = array(
                        'redirects' => 'r',
@@ -297,39 +300,43 @@ class ApiParse extends ApiBase {
                        'iwlinks' => 'iw',
                        'sections' => 's',
                        'headitems' => 'hi',
+                       'properties' => 'pp',
                );
                $this->setIndexedTagNames( $result_array, $result_mapping );
                $result->addValue( null, $this->getModuleName(), $result_array );
 
                if ( !is_null( $oldLang ) ) {
-                       $wgLang = $oldLang; // Reset $wgLang to $oldLang
+                       $this->getContext()->setLanguage( $oldLang ); // Reset language to $oldLang
                }
        }
 
        /**
-        * @param $articleObj Article
         * @param $titleObj Title
         * @param $popts ParserOptions
         * @param $pageId Int
         * @param $getWikitext Bool
         * @return ParserOutput
         */
-       private function getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageId = null, $getWikitext = false ) {
-               if ( $this->section !== false ) {
-                       global $wgParser;
+       private function getParsedSectionOrText( $titleObj, $popts, $pageId = null, $getWikitext = false ) {
+               global $wgParser;
 
-                       $this->text = $this->getSectionText( $articleObj->getRawText(), !is_null ( $pageId )
+               $page = WikiPage::factory( $titleObj );
+
+               if ( $this->section !== false ) {
+                       $this->text = $this->getSectionText( $page->getRawText(), !is_null( $pageId )
                                        ? 'page id ' . $pageId : $titleObj->getText() );
 
+                       // Not cached (save or load)
                        return $wgParser->parse( $this->text, $titleObj, $popts );
                } else {
                        // Try the parser cache first
-                       $pout = $articleObj->getParserOutput();
+                       // getParserOutput will save to Parser cache if able
+                       $pout = $page->getParserOutput( $popts );
+                       if ( !$pout ) {
+                               $this->dieUsage( "There is no revision ID {$page->getLatest()}", 'missingrev' );
+                       }
                        if ( $getWikitext ) {
-                               $rev = Revision::newFromTitle( $titleObj );
-                               if ( $rev ) {
-                                       $this->text = $rev->getText();
-                               }
+                               $this->text = $page->getRawText();
                        }
                        return $pout;
                }
@@ -337,6 +344,7 @@ class ApiParse extends ApiBase {
 
        private function getSectionText( $text, $what ) {
                global $wgParser;
+               // Not cached (save or load)
                $text = $wgParser->getSection( $text, $this->section, false );
                if ( $text === false ) {
                        $this->dieUsage( "There is no section {$this->section} in " . $what, 'nosuchsection' );
@@ -353,7 +361,7 @@ class ApiParse extends ApiBase {
 
                        $entry['lang'] = $bits[0];
                        if ( $title ) {
-                               $entry['url'] = wfExpandUrl( $title->getFullURL() );
+                               $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
                        }
                        $this->getResult()->setContent( $entry, $bits[1] );
                        $result[] = $entry;
@@ -373,7 +381,7 @@ class ApiParse extends ApiBase {
        }
 
        private function categoriesHtml( $categories ) {
-               $context = $this->createContext();
+               $context = $this->getContext();
                $context->getOutput()->addCategoryLinks( $categories );
                return $context->getSkin()->getCategories();
        }
@@ -381,8 +389,12 @@ class ApiParse extends ApiBase {
        /**
         * @deprecated since 1.18 No modern skin generates language links this way, please use language links
         *                        data to generate your own HTML.
+        * @param $languages array
+        * @return string
         */
        private function languagesHtml( $languages ) {
+               wfDeprecated( __METHOD__, '1.18' );
+
                global $wgContLang, $wgHideInterlanguageLinks;
 
                if ( $wgHideInterlanguageLinks || count( $languages ) == 0 ) {
@@ -394,7 +406,7 @@ class ApiParse extends ApiBase {
                $langs = array();
                foreach ( $languages as $l ) {
                        $nt = Title::newFromText( $l );
-                       $text = $wgContLang->getLanguageName( $nt->getInterwiki() );
+                       $text = Language::fetchLanguageName( $nt->getInterwiki() );
 
                        $langs[] = Html::element( 'a',
                                array( 'href' => $nt->getFullURL(), 'title' => $nt->getText(), 'class' => "external" ),
@@ -435,7 +447,7 @@ class ApiParse extends ApiBase {
 
                                $title = Title::newFromText( "{$prefix}:{$title}" );
                                if ( $title ) {
-                                       $entry['url'] = wfExpandUrl( $title->getFullURL() );
+                                       $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
                                }
 
                                $this->getResult()->setContent( $entry, $title->getFullText() );
@@ -456,6 +468,17 @@ class ApiParse extends ApiBase {
                return $result;
        }
 
+       private function formatProperties( $properties ) {
+               $result = array();
+               foreach ( $properties as $name => $value ) {
+                       $entry = array();
+                       $entry['name'] = $name;
+                       $this->getResult()->setContent( $entry, $value );
+                       $result[] = $entry;
+               }
+               return $result;
+       }
+
        private function formatCss( $css ) {
                $result = array();
                foreach ( $css as $file => $link ) {
@@ -491,7 +514,7 @@ class ApiParse extends ApiBase {
                                ApiBase::PARAM_TYPE => 'integer',
                        ),
                        'prop' => array(
-                               ApiBase::PARAM_DFLT => 'text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle',
+                               ApiBase::PARAM_DFLT => 'text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties',
                                ApiBase::PARAM_ISMULTI => true,
                                ApiBase::PARAM_TYPE => array(
                                        'text',
@@ -510,6 +533,7 @@ class ApiParse extends ApiBase {
                                        'headhtml',
                                        'iwlinks',
                                        'wikitext',
+                                       'properties',
                                )
                        ),
                        'pst' => false,
@@ -548,6 +572,7 @@ class ApiParse extends ApiBase {
                                ' headhtml       - Gives parsed <head> of the page',
                                ' iwlinks        - Gives interwiki links in the parsed wikitext',
                                ' wikitext       - Gives the original wikitext that was parsed',
+                               ' properties     - Gives various properties defined in the parsed wikitext',
                        ),
                        'pst' => array(
                                'Do a pre-save transform on the input before parsing it',
@@ -564,12 +589,16 @@ class ApiParse extends ApiBase {
        }
 
        public function getDescription() {
-               return 'Parses wikitext and returns parser output';
+               return array(
+                       'Parses wikitext and returns parser output',
+                       'See the various prop-Modules of action=query to get information from the current version of a page',
+               );
        }
 
        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
                        array( 'code' => 'params', 'info' => 'The page parameter cannot be used together with the text and title parameters' ),
+                       array( 'code' => 'params', 'info' => 'The text parameter should be passed with the title parameter. Should you be using the "page" parameter instead?' ),
                        array( 'code' => 'missingrev', 'info' => 'There is no revision ID oldid' ),
                        array( 'code' => 'permissiondenied', 'info' => 'You don\'t have permission to view deleted revisions' ),
                        array( 'code' => 'missingtitle', 'info' => 'The page you specified doesn\'t exist' ),
@@ -579,14 +608,14 @@ class ApiParse extends ApiBase {
                ) );
        }
 
-       protected function getExamples() {
+       public function getExamples() {
                return array(
                        'api.php?action=parse&text={{Project:Sandbox}}'
                );
        }
 
        public function getHelpUrls() {
-               return 'http://www.mediawiki.org/wiki/API:Parsing_wikitext#parse';
+               return 'https://www.mediawiki.org/wiki/API:Parsing_wikitext#parse';
        }
 
        public function getVersion() {