* (bug 23460) Parse action should have a section option

Also add uselang parameter, not originally added in r63428

Clarify section description in both. Move global into if statement

diff --git a/RELEASE-NOTES b/RELEASE-NOTES
index f3b92d6..1e224e0 100644 (file)
--- a/RELEASE-NOTES
+++ b/RELEASE-NOTES
@@ -171,6 +171,7 @@ in a negative namespace (which is invalid).
   is empty, for consistency with list=recentchanges
 * (bug 19721) API action=help should have a way to just list for a specific module
 * (bug 23458) Add support for pageid parameter to action=parse requests
+* (bug 23460) Parse action should have a section option
 
 === Languages updated in 1.17 ===
 

diff --git a/includes/api/ApiParse.php b/includes/api/ApiParse.php
index 92b1512..20b667d 100644 (file)
--- a/includes/api/ApiParse.php
+++ b/includes/api/ApiParse.php
@@ -45,11 +45,18 @@ class ApiParse extends ApiBase {
                $page = $params['page'];
                $pageid = $params['pageid'];
                $oldid = $params['oldid'];
+
                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'] );
                $revid = false;
+               
+               if ( isset( $params['section'] ) ) {
+                       $this->section = $params['section'];
+               } else {
+                       $this->section = false;
+               }
 
                // The parser needs $wgTitle to be set, apparently the
                // $title parameter in Parser::parse isn't enough *sigh*
@@ -80,6 +87,11 @@ class ApiParse extends ApiBase {
                                $text = $rev->getText( Revision::FOR_THIS_USER );
                                $titleObj = $rev->getTitle();
                                $wgTitle = $titleObj;
+
+                               if ( $this->section !== false ) {
+                                       $text = $this->getSectionText( $text, 'r' . $rev );
+                               }
+
                                $p_result = $wgParser->parse( $text, $titleObj, $popts );
                        } else {
                                if ( !is_null ( $pageid ) ) {
@@ -117,17 +129,23 @@ class ApiParse extends ApiBase {
                                if ( isset( $prop['revid'] ) ) {
                                        $oldid = $articleObj->getRevIdFetched();
                                }
-                               // Try the parser cache first
-                               $p_result = false;
-                               $pcache = ParserCache::singleton();
-                               if ( $wgEnableParserCache ) {
-                                       $p_result = $pcache->get( $articleObj, $wgUser );
-                               }
-                               if ( !$p_result ) {
-                                       $p_result = $wgParser->parse( $articleObj->getContent(), $titleObj, $popts );
 
+                               if ( $this->section !== false ) {
+                                       $text = $this->getSectionText( $text, !is_null ( $pageid ) ? 'page id ' . $pageid : $titleObj->getText() );
+                                       $p_result = $wgParser->parse( $text, $titleObj, $popts );
+                               } else {
+                                       // Try the parser cache first
+                                       $p_result = false;
+                                       $pcache = ParserCache::singleton();
                                        if ( $wgEnableParserCache ) {
-                                               $pcache->save( $p_result, $articleObj, $popts );
+                                               $p_result = $pcache->get( $articleObj, $wgUser );
+                                       }
+                                       if ( !$p_result ) {
+                                               $p_result = $wgParser->parse( $articleObj->getContent(), $titleObj, $popts );
+
+                                               if ( $wgEnableParserCache ) {
+                                                       $pcache->save( $p_result, $articleObj, $popts );
+                                               }
                                        }
                                }
                        }
@@ -137,6 +155,11 @@ class ApiParse extends ApiBase {
                                $titleObj = Title::newFromText( 'API' );
                        }
                        $wgTitle = $titleObj;
+
+                       if ( $this->section !== false ) {
+                               $text = $this->getSectionText( $text, $titleObj->getText() );
+                       }
+
                        if ( $params['pst'] || $params['onlypst'] ) {
                                $text = $wgParser->preSaveTransform( $text, $titleObj, $wgUser, $popts );
                        }
@@ -228,6 +251,15 @@ class ApiParse extends ApiBase {
                }
        }
 
+       private function getSectionText( $text, $what ) {
+               global $wgParser;
+               $text = $wgParser->getSection( $text, $this->section, false );
+               if ( $text === false ) {
+                       $this->dieUsage( "There is no section {$this->section} in " . $what, 'nosuchsection' );
+               }
+               return $text;
+       }
+
        private function formatLangLinks( $links ) {
                $result = array();
                foreach ( $links as $link ) {
@@ -317,6 +349,8 @@ class ApiParse extends ApiBase {
                        ),
                        'pst' => false,
                        'onlypst' => false,
+                       'uselang' => null,
+                       'section' => null,
                );
        }
 
@@ -338,7 +372,8 @@ class ApiParse extends ApiBase {
                        'onlypst' => array( 'Do a pre-save transform (PST) on the input, but don\'t parse it.',
                                        'Returns the same wikitext, after a PST has been applied. Ignored if page, pageid or oldid is used.'
                        ),
-                       'uselang' => 'Which language to parse the request in.'
+                       'uselang' => 'Which language to parse the request in.',
+                       'section' => 'Only retrieve the content of this section number',
                );
        }
 
@@ -352,6 +387,7 @@ class ApiParse extends ApiBase {
                        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' ),
+                       array( 'code' => 'nosuchsection', 'info' => 'There is no section  in '),
                        array( 'nosuchpageid' ),
                ) );
        }

diff --git a/includes/api/ApiQueryRevisions.php b/includes/api/ApiQueryRevisions.php
index 54f124b..0c4d870 100644 (file)
--- a/includes/api/ApiQueryRevisions.php
+++ b/includes/api/ApiQueryRevisions.php
@@ -425,12 +425,13 @@ class ApiQueryRevisions extends ApiQueryBase {
 
                $text = null;
                if ( $this->fld_content || !is_null( $this->difftotext ) ) {
-                       global $wgParser;
                        $text = $revision->getText();
                        // Expand templates after getting section content because
                        // template-added sections don't count and Parser::preprocess()
                        // will have less input
                        if ( $this->section !== false ) {
+                               global $wgParser;
+
                                $text = $wgParser->getSection( $text, $this->section, false );
                                if ( $text === false ) {
                                        $this->dieUsage( "There is no section {$this->section} in r" . $revision->getId(), 'nosuchsection' );
@@ -557,7 +558,7 @@ class ApiQueryRevisions extends ApiQueryBase {
                        'excludeuser' => 'Exclude revisions made by user',
                        'expandtemplates' => 'Expand templates in revision content',
                        'generatexml' => 'Generate XML parse tree for revision content',
-                       'section' => 'Only retrieve the content of this section',
+                       'section' => 'Only retrieve the content of this section number',
                        'token' => 'Which tokens to obtain for each revision',
                        'continue' => 'When more results are available, use this to continue',
                        'diffto' => array( 'Revision ID to diff each revision to.',