Patch from MaxSem re bug 15162 - handle throttling in the login API
[lhc/web/wiklou.git] / includes / api / ApiParse.php
index 5f2a0c6..71cf0f9 100644 (file)
@@ -29,7 +29,7 @@ if (!defined('MEDIAWIKI')) {
 }
 
 /**
- * @addtogroup API
+ * @ingroup API
  */
 class ApiParse extends ApiBase {
 
@@ -42,28 +42,83 @@ class ApiParse extends ApiBase {
                $params = $this->extractRequestParams();
                $text = $params['text'];
                $title = $params['title'];
-               $retval = '';
+               $page = $params['page'];
+               $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;
 
-               //Create title for parser
-               $title_obj = Title :: newFromText($params['title']);
-               if(!$title_obj)
-                       $title_obj = Title :: newFromText("API");       //  Default title is "API". For example, ExpandTemplates uses "ExpendTemplates" for it
+               global $wgParser, $wgUser;
+               $popts = new ParserOptions();
+               $popts->setTidy(true);
+               $popts->enableLimitReport();
+               if(!is_null($oldid) || !is_null($page))
+               {
+                       if(!is_null($oldid))
+                       {
+                               # Don't use the parser cache
+                               $rev = Revision::newFromID($oldid);
+                               if(!$rev)
+                                       $this->dieUsage("There is no revision ID $oldid", 'missingrev');
+                               if(!$rev->userCan(Revision::DELETED_TEXT))
+                                       $this->dieUsage("You don't have permission to view deleted revisions", 'permissiondenied');
+                               $text = $rev->getRawText();
+                               $titleObj = $rev->getTitle();
+                               $p_result = $wgParser->parse($text, $titleObj, $popts);
+                       }
+                       else
+                       {
+                               $titleObj = Title::newFromText($page);
+                               if(!$titleObj)
+                                       $this->dieUsage("The page you specified doesn't exist", 'missingtitle');
 
-               // Parse text
-               global $wgParser;
-               $p_result = $wgParser->parse( $text, $title_obj, new ParserOptions() );
+                               // Try the parser cache first
+                               $articleObj = new Article($titleObj);
+                               if(isset($prop['revid']))
+                                       $oldid = $articleObj->getRevIdFetched();
+                               $pcache = ParserCache::singleton();
+                               $p_result = $pcache->get($articleObj, $wgUser);
+                               if(!$p_result) {
+                                       $p_result = $wgParser->parse($articleObj->getContent(), $titleObj, $popts);
+                                       global $wgUseParserCache;
+                                       if($wgUseParserCache)
+                                               $pcache->save($p_result, $articleObj, $wgUser);
+                               }
+                       }
+               }
+               else
+               {
+                       $titleObj = Title::newFromText($title);
+                       if(!$titleObj)
+                               $titleObj = Title::newFromText("API");
+                       $p_result = $wgParser->parse($text, $titleObj, $popts);
+               }
 
                // Return result
                $result = $this->getResult();
-               $result_array = array(
-                       'text' => array(),
-                       'langlinks' => $this->formatLangLinks( $p_result->getLanguageLinks() ),
-                       'categories' => $this->formatCategoryLinks( $p_result->getCategories() ),
-                       'links' => $this->formatLinks( $p_result->getLinks() ),
-                       'templates' => $this->formatLinks( $p_result->getTemplates() ),
-                       'images' => array_keys( $p_result->getImages() ),
-                       'externallinks' => array_keys( $p_result->getExternalLinks() ),
-               );
+               $result_array = array();
+               if(isset($prop['text'])) {
+                       $result_array['text'] = array();
+                       $result->setContent($result_array['text'], $p_result->getText());
+               }
+               if(isset($prop['langlinks']))
+                       $result_array['langlinks'] = $this->formatLangLinks($p_result->getLanguageLinks());
+               if(isset($prop['categories']))
+                       $result_array['categories'] = $this->formatCategoryLinks($p_result->getCategories());
+               if(isset($prop['links']))
+                       $result_array['links'] = $this->formatLinks($p_result->getLinks());
+               if(isset($prop['templates']))
+                       $result_array['templates'] = $this->formatLinks($p_result->getTemplates());
+               if(isset($prop['images']))
+                       $result_array['images'] = array_keys($p_result->getImages());
+               if(isset($prop['externallinks']))
+                       $result_array['externallinks'] = array_keys($p_result->getExternalLinks());
+               if(isset($prop['sections']))
+                       $result_array['sections'] = $p_result->getSections();
+               if(!is_null($oldid))
+                       $result_array['revid'] = $oldid;
+
                $result_mapping = array(
                        'langlinks' => 'll',
                        'categories' => 'cl',
@@ -71,13 +126,14 @@ class ApiParse extends ApiBase {
                        'templates' => 'tl',
                        'images' => 'img',
                        'externallinks' => 'el',
+                       'sections' => 's',
                );
                $this->setIndexedTagNames( $result_array, $result_mapping );
-               $result->setContent( $result_array['text'], $p_result->getText() );
                $result->addValue( null, $this->getModuleName(), $result_array );
        }
-       
+
        private function formatLangLinks( $links ) {
+               $result = array();
                foreach( $links as $link ) {
                        $entry = array();
                        $bits = split( ':', $link, 2 );
@@ -87,8 +143,9 @@ class ApiParse extends ApiBase {
                }
                return $result;
        }
-       
+
        private function formatCategoryLinks( $links ) {
+               $result = array();
                foreach( $links as $link => $sortkey ) {
                        $entry = array();
                        $entry['sortkey'] = $sortkey;
@@ -97,9 +154,9 @@ class ApiParse extends ApiBase {
                }
                return $result;
        }
-       
+
        private function formatLinks( $links ) {
-               global $wgContLang;
+               $result = array();
                foreach( $links as $ns => $nslinks ) {
                        foreach( $nslinks as $title => $id ) {
                                $entry = array();
@@ -112,30 +169,53 @@ class ApiParse extends ApiBase {
                }
                return $result;
        }
-       
+
        private function setIndexedTagNames( &$array, $mapping ) {
                foreach( $mapping as $key => $name ) {
-                       $this->getResult()->setIndexedTagName( $array[$key], $name );
+                       if( isset( $array[$key] ) )
+                               $this->getResult()->setIndexedTagName( $array[$key], $name );
                }
        }
 
-       protected function getAllowedParams() {
+       public function getAllowedParams() {
                return array (
-                       'title' => array( 
+                       'title' => array(
                                ApiBase :: PARAM_DFLT => 'API',
                        ),
-                       'text' => null
+                       'text' => null,
+                       'page' => null,
+                       'oldid' => null,
+                       'prop' => array(
+                               ApiBase :: PARAM_DFLT => 'text|langlinks|categories|links|templates|images|externallinks|sections|revid',
+                               ApiBase :: PARAM_ISMULTI => true,
+                               ApiBase :: PARAM_TYPE => array(
+                                       'text',
+                                       'langlinks',
+                                       'categories',
+                                       'links',
+                                       'templates',
+                                       'images',
+                                       'externallinks',
+                                       'sections',
+                                       'revid'
+                               )
+                       )
                );
        }
 
-       protected function getParamDescription() {
+       public function getParamDescription() {
                return array (
                        'text' => 'Wikitext to parse',
-                       'title' => 'Title of page',
+                       'title' => 'Title of page the text belongs to',
+                       'page' => 'Parse the content of this page. Cannot be used together with text and title',
+                       'oldid' => 'Parse the content of this revision. Overrides page',
+                       'prop' => array('Which pieces of information to get.',
+                                       'NOTE: Section tree is only generated if there are more than 4 sections, or if the __TOC__ keyword is present'
+                       ),
                );
        }
 
-       protected function getDescription() {
+       public function getDescription() {
                return 'This module parses wikitext and returns parser output';
        }
 
@@ -149,4 +229,3 @@ class ApiParse extends ApiBase {
                return __CLASS__ . ': $Id$';
        }
 }
-