Allow gender based localisation for 'lastmodifiedatby'
[lhc/web/wiklou.git] / includes / api / ApiParse.php
index 04915e5..d998070 100644 (file)
@@ -29,7 +29,7 @@ if (!defined('MEDIAWIKI')) {
 }
 
 /**
- * @addtogroup API
+ * @ingroup API
  */
 class ApiParse extends ApiBase {
 
@@ -42,20 +42,97 @@ class ApiParse extends ApiBase {
                $params = $this->extractRequestParams();
                $text = $params['text'];
                $title = $params['title'];
+               $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
+               // The parser needs $wgTitle to be set, apparently the
+               // $title parameter in Parser::parse isn't enough *sigh*
+               global $wgParser, $wgUser, $wgTitle;
+               $popts = new ParserOptions();
+               $popts->setTidy(true);
+               $popts->enableLimitReport();
+               $redirValues = null;
+               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->getText( Revision::FOR_THIS_USER );
+                               $titleObj = $rev->getTitle();
+                               $wgTitle = $titleObj;
+                               $p_result = $wgParser->parse($text, $titleObj, $popts);
+                       }
+                       else
+                       {
+                               if($params['redirects'])
+                               {
+                                       $req = new FauxRequest(array(
+                                               'action' => 'query',
+                                               'redirects' => '',
+                                               'titles' => $page
+                                       ));
+                                       $main = new ApiMain($req);
+                                       $main->execute();
+                                       $data = $main->getResultData();
+                                       $redirValues = @$data['query']['redirects'];
+                                       $to = $page;
+                                       foreach((array)$redirValues as $r)
+                                               $to = $r['to'];
+                               }
+                               else
+                                       $to = $page; 
+                               $titleObj = Title::newFromText($to);
+                               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() );
+                               $articleObj = new Article($titleObj);
+                               if(isset($prop['revid']))
+                                       $oldid = $articleObj->getRevIdFetched();
+                               // Try the parser cache first
+                               $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, $popts);
+                               }
+                       }
+               }
+               else
+               {
+                       $titleObj = Title::newFromText($title);
+                       if(!$titleObj)
+                               $titleObj = Title::newFromText("API");
+                       $wgTitle = $titleObj;
+                       if($params['pst'] || $params['onlypst'])
+                               $text = $wgParser->preSaveTransform($text, $titleObj, $wgUser, $popts);
+                       if($params['onlypst'])
+                       {
+                               // Build a result and bail out
+                               $result_array['text'] = array();
+                               $this->getResult()->setContent($result_array['text'], $text);
+                               $this->getResult()->addValue(null, $this->getModuleName(), $result_array);
+                               return;
+                       }
+                       $p_result = $wgParser->parse($text, $titleObj, $popts);
+               }
 
                // Return result
                $result = $this->getResult();
                $result_array = array();
+               if($params['redirects'] && !is_null($redirValues))
+                       $result_array['redirects'] = $redirValues;
                if(isset($prop['text'])) {
                        $result_array['text'] = array();
                        $result->setContent($result_array['text'], $p_result->getText());
@@ -74,8 +151,15 @@ class ApiParse extends ApiBase {
                        $result_array['externallinks'] = array_keys($p_result->getExternalLinks());
                if(isset($prop['sections']))
                        $result_array['sections'] = $p_result->getSections();
-               
+               if(isset($prop['displaytitle']))
+                       $result_array['displaytitle'] = $p_result->getDisplayTitle() ?
+                                                       $p_result->getDisplayTitle() :
+                                                       $titleObj->getPrefixedText();
+               if(!is_null($oldid))
+                       $result_array['revid'] = intval($oldid);
+
                $result_mapping = array(
+                       'redirects' => 'r',
                        'langlinks' => 'll',
                        'categories' => 'cl',
                        'links' => 'pl',
@@ -87,7 +171,7 @@ class ApiParse extends ApiBase {
                $this->setIndexedTagNames( $result_array, $result_mapping );
                $result->addValue( null, $this->getModuleName(), $result_array );
        }
-       
+
        private function formatLangLinks( $links ) {
                $result = array();
                foreach( $links as $link ) {
@@ -99,7 +183,7 @@ class ApiParse extends ApiBase {
                }
                return $result;
        }
-       
+
        private function formatCategoryLinks( $links ) {
                $result = array();
                foreach( $links as $link => $sortkey ) {
@@ -110,7 +194,7 @@ class ApiParse extends ApiBase {
                }
                return $result;
        }
-       
+
        private function formatLinks( $links ) {
                $result = array();
                foreach( $links as $ns => $nslinks ) {
@@ -125,7 +209,7 @@ class ApiParse extends ApiBase {
                }
                return $result;
        }
-       
+
        private function setIndexedTagNames( &$array, $mapping ) {
                foreach( $mapping as $key => $name ) {
                        if( isset( $array[$key] ) )
@@ -133,14 +217,17 @@ class ApiParse extends ApiBase {
                }
        }
 
-       protected function getAllowedParams() {
+       public function getAllowedParams() {
                return array (
-                       'title' => array( 
+                       'title' => array(
                                ApiBase :: PARAM_DFLT => 'API',
                        ),
                        'text' => null,
+                       'page' => null,
+                       'redirects' => false,
+                       'oldid' => null,
                        'prop' => array(
-                               ApiBase :: PARAM_DFLT => 'text|langlinks|categories|links|templates|images|externallinks|sections',
+                               ApiBase :: PARAM_DFLT => 'text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle',
                                ApiBase :: PARAM_ISMULTI => true,
                                ApiBase :: PARAM_TYPE => array(
                                        'text',
@@ -150,21 +237,36 @@ class ApiParse extends ApiBase {
                                        'templates',
                                        'images',
                                        'externallinks',
-                                       'sections'
+                                       'sections',
+                                       'revid',
+                                       'displaytitle',
                                )
-                       )
+                       ),
+                       'pst' => false,
+                       'onlypst' => false,
                );
        }
 
-       protected function getParamDescription() {
+       public function getParamDescription() {
                return array (
                        'text' => 'Wikitext to parse',
-                       'title' => 'Title of page',
-                       'prop' => 'Which pieces of information to get'
+                       'redirects' => 'If the page parameter is set to a redirect, resolve it',
+                       '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'
+                       ),
+                       'pst' => array( 'Do a pre-save transform on the input before parsing it.',
+                                       'Ignored if page or oldid is used.'
+                       ),
+                       'onlypst' => array('Do a PST on the input, but don\'t parse it.',
+                                       'Returns PSTed wikitext. Ignored if page or oldid is used.'
+                       ),
                );
        }
 
-       protected function getDescription() {
+       public function getDescription() {
                return 'This module parses wikitext and returns parser output';
        }
 
@@ -178,4 +280,3 @@ class ApiParse extends ApiBase {
                return __CLASS__ . ': $Id$';
        }
 }
-