includes/api/ApiParse.php

   1 <?php
   2 /**
   3  * Created on Dec 01, 2007
   4  *
   5  * Copyright © 2007 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  * http://www.gnu.org/copyleft/gpl.html
  21  *
  22  * @file
  23  */
  24
  25 /**
  26  * @ingroup API
  27  */
  28 class ApiParse extends ApiBase {
  29         private $section, $text, $pstText = null;
  30
  31         public function __construct( $main, $action ) {
  32                 parent::__construct( $main, $action );
  33         }
  34
  35         public function execute() {
  36                 // The data is hot but user-dependent, like page views, so we set vary cookies
  37                 $this->getMain()->setCacheMode( 'anon-public-user-private' );
  38
  39                 // Get parameters
  40                 $params = $this->extractRequestParams();
  41                 $text = $params['text'];
  42                 $title = $params['title'];
  43                 $page = $params['page'];
  44                 $pageid = $params['pageid'];
  45                 $oldid = $params['oldid'];
  46
  47                 if ( !is_null( $page ) && ( !is_null( $text ) || $title != 'API' ) ) {
  48                         $this->dieUsage( 'The page parameter cannot be used together with the text and title parameters', 'params' );
  49                 }
  50
  51                 $prop = array_flip( $params['prop'] );
  52
  53                 if ( isset( $params['section'] ) ) {
  54                         $this->section = $params['section'];
  55                 } else {
  56                         $this->section = false;
  57                 }
  58
  59                 // The parser needs $wgTitle to be set, apparently the
  60                 // $title parameter in Parser::parse isn't enough *sigh*
  61                 // TODO: Does this still need $wgTitle?
  62                 global $wgParser, $wgTitle;
  63
  64                 // Currently unnecessary, code to act as a safeguard against any change in current behaviour of uselang breaks
  65                 $oldLang = null;
  66                 if ( isset( $params['uselang'] ) && $params['uselang'] != $this->getContext()->getLanguage()->getCode() ) {
  67                         $oldLang = $this->getContext()->getLanguage(); // Backup language
  68                         $this->getContext()->setLanguage( Language::factory( $params['uselang'] ) );
  69                 }
  70
  71                 $popts = ParserOptions::newFromContext( $this->getContext() );
  72                 $popts->setTidy( true );
  73                 $popts->enableLimitReport( !$params['disablepp'] );
  74
  75                 $redirValues = null;
  76
  77                 // Return result
  78                 $result = $this->getResult();
  79
  80                 if ( !is_null( $oldid ) || !is_null( $pageid ) || !is_null( $page ) ) {
  81                         if ( !is_null( $oldid ) ) {
  82                                 // Don't use the parser cache
  83                                 $rev = Revision::newFromID( $oldid );
  84                                 if ( !$rev ) {
  85                                         $this->dieUsage( "There is no revision ID $oldid", 'missingrev' );
  86                                 }
  87                                 if ( !$rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
  88                                         $this->dieUsage( "You don't have permission to view deleted revisions", 'permissiondenied' );
  89                                 }
  90
  91                                 $titleObj = $rev->getTitle();
  92
  93                                 $wgTitle = $titleObj;
  94
  95                                 // If for some reason the "oldid" is actually the current revision, it may be cached
  96                                 if ( $titleObj->getLatestRevID() === intval( $oldid ) )  {
  97                                         // May get from/save to parser cache
  98                                         $p_result = $this->getParsedSectionOrText( $titleObj, $popts, $pageid,
  99                                                  isset( $prop['wikitext'] ) ) ;
 100                                 } else { // This is an old revision, so get the text differently
 101                                         $this->text = $rev->getText( Revision::FOR_THIS_USER, $this->getUser() );
 102
 103                                         if ( $this->section !== false ) {
 104                                                 $this->text = $this->getSectionText( $this->text, 'r' . $rev->getId() );
 105                                         }
 106
 107                                         // Should we save old revision parses to the parser cache?
 108                                         $p_result = $wgParser->parse( $this->text, $titleObj, $popts );
 109                                 }
 110                         } else { // Not $oldid, but $pageid or $page
 111                                 if ( $params['redirects'] ) {
 112                                         $reqParams = array(
 113                                                 'action' => 'query',
 114                                                 'redirects' => '',
 115                                         );
 116                                         if ( !is_null ( $pageid ) ) {
 117                                                 $reqParams['pageids'] = $pageid;
 118                                         } else { // $page
 119                                                 $reqParams['titles'] = $page;
 120                                         }
 121                                         $req = new FauxRequest( $reqParams );
 122                                         $main = new ApiMain( $req );
 123                                         $main->execute();
 124                                         $data = $main->getResultData();
 125                                         $redirValues = isset( $data['query']['redirects'] )
 126                                                 ? $data['query']['redirects']
 127                                                 : array();
 128                                         $to = $page;
 129                                         foreach ( (array)$redirValues as $r ) {
 130                                                 $to = $r['to'];
 131                                         }
 132                                         $titleObj = Title::newFromText( $to );
 133                                 } else {
 134                                         if ( !is_null ( $pageid ) ) {
 135                                                 $reqParams['pageids'] = $pageid;
 136                                                 $titleObj = Title::newFromID( $pageid );
 137                                         } else { // $page
 138                                                 $to = $page;
 139                                                 $titleObj = Title::newFromText( $to );
 140                                         }
 141                                 }
 142                                 if ( !is_null ( $pageid ) ) {
 143                                         if ( !$titleObj ) {
 144                                                 // Still throw nosuchpageid error if pageid was provided
 145                                                 $this->dieUsageMsg( array( 'nosuchpageid', $pageid ) );
 146                                         }
 147                                 } elseif ( !$titleObj || !$titleObj->exists() ) {
 148                                         $this->dieUsage( "The page you specified doesn't exist", 'missingtitle' );
 149                                 }
 150                                 $wgTitle = $titleObj;
 151
 152                                 if ( isset( $prop['revid'] ) ) {
 153                                         $oldid = $titleObj->getLatestRevID();
 154                                 }
 155
 156                                 // Potentially cached
 157                                 $p_result = $this->getParsedSectionOrText( $titleObj, $popts, $pageid,
 158                                          isset( $prop['wikitext'] ) ) ;
 159                         }
 160                 } else { // Not $oldid, $pageid, $page. Hence based on $text
 161
 162                         if ( is_null( $text ) ) {
 163                                 $this->dieUsage( 'The text parameter should be passed with the title parameter. Should you be using the "page" parameter instead?', 'params' );
 164                         }
 165                         $this->text = $text;
 166                         $titleObj = Title::newFromText( $title );
 167                         if ( !$titleObj ) {
 168                                 $this->dieUsageMsg( array( 'invalidtitle', $title ) );
 169                         }
 170                         $wgTitle = $titleObj;
 171
 172                         if ( $this->section !== false ) {
 173                                 $this->text = $this->getSectionText( $this->text, $titleObj->getText() );
 174                         }
 175
 176                         if ( $params['pst'] || $params['onlypst'] ) {
 177                                 $this->pstText = $wgParser->preSaveTransform( $this->text, $titleObj, $this->getUser(), $popts );
 178                         }
 179                         if ( $params['onlypst'] ) {
 180                                 // Build a result and bail out
 181                                 $result_array = array();
 182                                 $result_array['text'] = array();
 183                                 $result->setContent( $result_array['text'], $this->pstText );
 184                                 if ( isset( $prop['wikitext'] ) ) {
 185                                         $result_array['wikitext'] = array();
 186                                         $result->setContent( $result_array['wikitext'], $this->text );
 187                                 }
 188                                 $result->addValue( null, $this->getModuleName(), $result_array );
 189                                 return;
 190                         }
 191                         // Not cached (save or load)
 192                         $p_result = $wgParser->parse( $params['pst'] ? $this->pstText : $this->text, $titleObj, $popts );
 193                 }
 194
 195                 $result_array = array();
 196
 197                 $result_array['title'] = $titleObj->getPrefixedText();
 198
 199                 if ( !is_null( $oldid ) ) {
 200                         $result_array['revid'] = intval( $oldid );
 201                 }
 202
 203                 if ( $params['redirects'] && !is_null( $redirValues ) ) {
 204                         $result_array['redirects'] = $redirValues;
 205                 }
 206
 207                 if ( isset( $prop['text'] ) ) {
 208                         $result_array['text'] = array();
 209                         $result->setContent( $result_array['text'], $p_result->getText() );
 210                 }
 211
 212                 if ( !is_null( $params['summary'] ) ) {
 213                         $result_array['parsedsummary'] = array();
 214                         $result->setContent( $result_array['parsedsummary'], Linker::formatComment( $params['summary'], $titleObj ) );
 215                 }
 216
 217                 if ( isset( $prop['langlinks'] ) ) {
 218                         $result_array['langlinks'] = $this->formatLangLinks( $p_result->getLanguageLinks() );
 219                 }
 220                 if ( isset( $prop['languageshtml'] ) ) {
 221                         $languagesHtml = $this->languagesHtml( $p_result->getLanguageLinks() );
 222                         $result_array['languageshtml'] = array();
 223                         $result->setContent( $result_array['languageshtml'], $languagesHtml );
 224                 }
 225                 if ( isset( $prop['categories'] ) ) {
 226                         $result_array['categories'] = $this->formatCategoryLinks( $p_result->getCategories() );
 227                 }
 228                 if ( isset( $prop['categorieshtml'] ) ) {
 229                         $categoriesHtml = $this->categoriesHtml( $p_result->getCategories() );
 230                         $result_array['categorieshtml'] = array();
 231                         $result->setContent( $result_array['categorieshtml'], $categoriesHtml );
 232                 }
 233                 if ( isset( $prop['links'] ) ) {
 234                         $result_array['links'] = $this->formatLinks( $p_result->getLinks() );
 235                 }
 236                 if ( isset( $prop['templates'] ) ) {
 237                         $result_array['templates'] = $this->formatLinks( $p_result->getTemplates() );
 238                 }
 239                 if ( isset( $prop['images'] ) ) {
 240                         $result_array['images'] = array_keys( $p_result->getImages() );
 241                 }
 242                 if ( isset( $prop['externallinks'] ) ) {
 243                         $result_array['externallinks'] = array_keys( $p_result->getExternalLinks() );
 244                 }
 245                 if ( isset( $prop['sections'] ) ) {
 246                         $result_array['sections'] = $p_result->getSections();
 247                 }
 248
 249                 if ( isset( $prop['displaytitle'] ) ) {
 250                         $result_array['displaytitle'] = $p_result->getDisplayTitle() ?
 251                                                         $p_result->getDisplayTitle() :
 252                                                         $titleObj->getPrefixedText();
 253                 }
 254
 255                 if ( isset( $prop['headitems'] ) || isset( $prop['headhtml'] ) ) {
 256                         $context = $this->getContext();
 257                         $context->setTitle( $titleObj );
 258                         $context->getOutput()->addParserOutputNoText( $p_result );
 259
 260                         if ( isset( $prop['headitems'] ) ) {
 261                                 $headItems = $this->formatHeadItems( $p_result->getHeadItems() );
 262
 263                                 $css = $this->formatCss( $context->getOutput()->buildCssLinksArray() );
 264
 265                                 $scripts = array( $context->getOutput()->getHeadScripts() );
 266
 267                                 $result_array['headitems'] = array_merge( $headItems, $css, $scripts );
 268                         }
 269
 270                         if ( isset( $prop['headhtml'] ) ) {
 271                                 $result_array['headhtml'] = array();
 272                                 $result->setContent( $result_array['headhtml'], $context->getOutput()->headElement( $context->getSkin() ) );
 273                         }
 274                 }
 275
 276                 if ( isset( $prop['iwlinks'] ) ) {
 277                         $result_array['iwlinks'] = $this->formatIWLinks( $p_result->getInterwikiLinks() );
 278                 }
 279
 280                 if ( isset( $prop['wikitext'] ) ) {
 281                         $result_array['wikitext'] = array();
 282                         $result->setContent( $result_array['wikitext'], $this->text );
 283                         if ( !is_null( $this->pstText ) ) {
 284                                 $result_array['psttext'] = array();
 285                                 $result->setContent( $result_array['psttext'], $this->pstText );
 286                         }
 287                 }
 288                 if ( isset( $prop['properties'] ) ) {
 289                         $result_array['properties'] = $this->formatProperties( $p_result->getProperties() );
 290                 }
 291
 292                 if ( $params['generatexml'] ) {
 293                         $wgParser->startExternalParse( $titleObj, $popts, OT_PREPROCESS );
 294                         $dom = $wgParser->preprocessToDom( $this->text );
 295                         if ( is_callable( array( $dom, 'saveXML' ) ) ) {
 296                                 $xml = $dom->saveXML();
 297                         } else {
 298                                 $xml = $dom->__toString();
 299                         }
 300                         $result_array['parsetree'] = array();
 301                         $result->setContent( $result_array['parsetree'], $xml );
 302                 }
 303
 304                 $result_mapping = array(
 305                         'redirects' => 'r',
 306                         'langlinks' => 'll',
 307                         'categories' => 'cl',
 308                         'links' => 'pl',
 309                         'templates' => 'tl',
 310                         'images' => 'img',
 311                         'externallinks' => 'el',
 312                         'iwlinks' => 'iw',
 313                         'sections' => 's',
 314                         'headitems' => 'hi',
 315                         'properties' => 'pp',
 316                 );
 317                 $this->setIndexedTagNames( $result_array, $result_mapping );
 318                 $result->addValue( null, $this->getModuleName(), $result_array );
 319
 320                 if ( !is_null( $oldLang ) ) {
 321                         $this->getContext()->setLanguage( $oldLang ); // Reset language to $oldLang
 322                 }
 323         }
 324
 325         /**
 326          * @param $titleObj Title
 327          * @param $popts ParserOptions
 328          * @param $pageId Int
 329          * @param $getWikitext Bool
 330          * @return ParserOutput
 331          */
 332         private function getParsedSectionOrText( $titleObj, $popts, $pageId = null, $getWikitext = false ) {
 333                 global $wgParser;
 334
 335                 $page = WikiPage::factory( $titleObj );
 336
 337                 if ( $this->section !== false ) {
 338                         $this->text = $this->getSectionText( $page->getRawText(), !is_null( $pageId )
 339                                         ? 'page id ' . $pageId : $titleObj->getText() );
 340
 341                         // Not cached (save or load)
 342                         return $wgParser->parse( $this->text, $titleObj, $popts );
 343                 } else {
 344                         // Try the parser cache first
 345                         // getParserOutput will save to Parser cache if able
 346                         $pout = $page->getParserOutput( $popts );
 347                         if ( !$pout ) {
 348                                 $this->dieUsage( "There is no revision ID {$page->getLatest()}", 'missingrev' );
 349                         }
 350                         if ( $getWikitext ) {
 351                                 $this->text = $page->getRawText();
 352                         }
 353                         return $pout;
 354                 }
 355         }
 356
 357         private function getSectionText( $text, $what ) {
 358                 global $wgParser;
 359                 // Not cached (save or load)
 360                 $text = $wgParser->getSection( $text, $this->section, false );
 361                 if ( $text === false ) {
 362                         $this->dieUsage( "There is no section {$this->section} in " . $what, 'nosuchsection' );
 363                 }
 364                 return $text;
 365         }
 366
 367         private function formatLangLinks( $links ) {
 368                 $result = array();
 369                 foreach ( $links as $link ) {
 370                         $entry = array();
 371                         $bits = explode( ':', $link, 2 );
 372                         $title = Title::newFromText( $link );
 373
 374                         $entry['lang'] = $bits[0];
 375                         if ( $title ) {
 376                                 $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
 377                         }
 378                         $this->getResult()->setContent( $entry, $bits[1] );
 379                         $result[] = $entry;
 380                 }
 381                 return $result;
 382         }
 383
 384         private function formatCategoryLinks( $links ) {
 385                 $result = array();
 386                 foreach ( $links as $link => $sortkey ) {
 387                         $entry = array();
 388                         $entry['sortkey'] = $sortkey;
 389                         $this->getResult()->setContent( $entry, $link );
 390                         $result[] = $entry;
 391                 }
 392                 return $result;
 393         }
 394
 395         private function categoriesHtml( $categories ) {
 396                 $context = $this->getContext();
 397                 $context->getOutput()->addCategoryLinks( $categories );
 398                 return $context->getSkin()->getCategories();
 399         }
 400
 401         /**
 402          * @deprecated since 1.18 No modern skin generates language links this way, please use language links
 403          *                        data to generate your own HTML.
 404          * @param $languages array
 405          * @return string
 406          */
 407         private function languagesHtml( $languages ) {
 408                 wfDeprecated( __METHOD__, '1.18' );
 409
 410                 global $wgContLang, $wgHideInterlanguageLinks;
 411
 412                 if ( $wgHideInterlanguageLinks || count( $languages ) == 0 ) {
 413                         return '';
 414                 }
 415
 416                 $s = htmlspecialchars( wfMsg( 'otherlanguages' ) . wfMsg( 'colon-separator' ) );
 417
 418                 $langs = array();
 419                 foreach ( $languages as $l ) {
 420                         $nt = Title::newFromText( $l );
 421                         $text = Language::fetchLanguageName( $nt->getInterwiki() );
 422
 423                         $langs[] = Html::element( 'a',
 424                                 array( 'href' => $nt->getFullURL(), 'title' => $nt->getText(), 'class' => "external" ),
 425                                 $text == '' ? $l : $text );
 426                 }
 427
 428                 $s .= implode( htmlspecialchars( wfMsgExt( 'pipe-separator', 'escapenoentities' ) ), $langs );
 429
 430                 if ( $wgContLang->isRTL() ) {
 431                         $s = Html::rawElement( 'span', array( 'dir' => "LTR" ), $s );
 432                 }
 433
 434                 return $s;
 435         }
 436
 437         private function formatLinks( $links ) {
 438                 $result = array();
 439                 foreach ( $links as $ns => $nslinks ) {
 440                         foreach ( $nslinks as $title => $id ) {
 441                                 $entry = array();
 442                                 $entry['ns'] = $ns;
 443                                 $this->getResult()->setContent( $entry, Title::makeTitle( $ns, $title )->getFullText() );
 444                                 if ( $id != 0 ) {
 445                                         $entry['exists'] = '';
 446                                 }
 447                                 $result[] = $entry;
 448                         }
 449                 }
 450                 return $result;
 451         }
 452
 453         private function formatIWLinks( $iw ) {
 454                 $result = array();
 455                 foreach ( $iw as $prefix => $titles ) {
 456                         foreach ( array_keys( $titles ) as $title ) {
 457                                 $entry = array();
 458                                 $entry['prefix'] = $prefix;
 459
 460                                 $title = Title::newFromText( "{$prefix}:{$title}" );
 461                                 if ( $title ) {
 462                                         $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
 463                                 }
 464
 465                                 $this->getResult()->setContent( $entry, $title->getFullText() );
 466                                 $result[] = $entry;
 467                         }
 468                 }
 469                 return $result;
 470         }
 471
 472         private function formatHeadItems( $headItems ) {
 473                 $result = array();
 474                 foreach ( $headItems as $tag => $content ) {
 475                         $entry = array();
 476                         $entry['tag'] = $tag;
 477                         $this->getResult()->setContent( $entry, $content );
 478                         $result[] = $entry;
 479                 }
 480                 return $result;
 481         }
 482
 483         private function formatProperties( $properties ) {
 484                 $result = array();
 485                 foreach ( $properties as $name => $value ) {
 486                         $entry = array();
 487                         $entry['name'] = $name;
 488                         $this->getResult()->setContent( $entry, $value );
 489                         $result[] = $entry;
 490                 }
 491                 return $result;
 492         }
 493
 494         private function formatCss( $css ) {
 495                 $result = array();
 496                 foreach ( $css as $file => $link ) {
 497                         $entry = array();
 498                         $entry['file'] = $file;
 499                         $this->getResult()->setContent( $entry, $link );
 500                         $result[] = $entry;
 501                 }
 502                 return $result;
 503         }
 504
 505         private function setIndexedTagNames( &$array, $mapping ) {
 506                 foreach ( $mapping as $key => $name ) {
 507                         if ( isset( $array[$key] ) ) {
 508                                 $this->getResult()->setIndexedTagName( $array[$key], $name );
 509                         }
 510                 }
 511         }
 512
 513         public function getAllowedParams() {
 514                 return array(
 515                         'title' => array(
 516                                 ApiBase::PARAM_DFLT => 'API',
 517                         ),
 518                         'text' => null,
 519                         'summary' => null,
 520                         'page' => null,
 521                         'pageid' => array(
 522                                 ApiBase::PARAM_TYPE => 'integer',
 523                         ),
 524                         'redirects' => false,
 525                         'oldid' => array(
 526                                 ApiBase::PARAM_TYPE => 'integer',
 527                         ),
 528                         'prop' => array(
 529                                 ApiBase::PARAM_DFLT => 'text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties',
 530                                 ApiBase::PARAM_ISMULTI => true,
 531                                 ApiBase::PARAM_TYPE => array(
 532                                         'text',
 533                                         'langlinks',
 534                                         'languageshtml',
 535                                         'categories',
 536                                         'categorieshtml',
 537                                         'links',
 538                                         'templates',
 539                                         'images',
 540                                         'externallinks',
 541                                         'sections',
 542                                         'revid',
 543                                         'displaytitle',
 544                                         'headitems',
 545                                         'headhtml',
 546                                         'iwlinks',
 547                                         'wikitext',
 548                                         'properties',
 549                                 )
 550                         ),
 551                         'pst' => false,
 552                         'onlypst' => false,
 553                         'uselang' => null,
 554                         'section' => null,
 555                         'disablepp' => false,
 556                         'generatexml' => false,
 557                 );
 558         }
 559
 560         public function getParamDescription() {
 561                 $p = $this->getModulePrefix();
 562                 return array(
 563                         'text' => 'Wikitext to parse',
 564                         'summary' => 'Summary to parse',
 565                         'redirects' => "If the {$p}page or the {$p}pageid parameter is set to a redirect, resolve it",
 566                         'title' => 'Title of page the text belongs to',
 567                         'page' => "Parse the content of this page. Cannot be used together with {$p}text and {$p}title",
 568                         'pageid' => "Parse the content of this page. Overrides {$p}page",
 569                         'oldid' => "Parse the content of this revision. Overrides {$p}page and {$p}pageid",
 570                         'prop' => array(
 571                                 'Which pieces of information to get',
 572                                 ' text           - Gives the parsed text of the wikitext',
 573                                 ' langlinks      - Gives the language links in the parsed wikitext',
 574                                 ' categories     - Gives the categories in the parsed wikitext',
 575                                 ' categorieshtml - Gives the HTML version of the categories',
 576                                 ' languageshtml  - Gives the HTML version of the language links',
 577                                 ' links          - Gives the internal links in the parsed wikitext',
 578                                 ' templates      - Gives the templates in the parsed wikitext',
 579                                 ' images         - Gives the images in the parsed wikitext',
 580                                 ' externallinks  - Gives the external links in the parsed wikitext',
 581                                 ' sections       - Gives the sections in the parsed wikitext',
 582                                 ' revid          - Adds the revision ID of the parsed page',
 583                                 ' displaytitle   - Adds the title of the parsed wikitext',
 584                                 ' headitems      - Gives items to put in the <head> of the page',
 585                                 ' headhtml       - Gives parsed <head> of the page',
 586                                 ' iwlinks        - Gives interwiki links in the parsed wikitext',
 587                                 ' wikitext       - Gives the original wikitext that was parsed',
 588                                 ' properties     - Gives various properties defined in the parsed wikitext',
 589                         ),
 590                         'pst' => array(
 591                                 'Do a pre-save transform on the input before parsing it',
 592                                 'Ignored if page, pageid or oldid is used'
 593                         ),
 594                         'onlypst' => array(
 595                                 'Do a pre-save transform (PST) on the input, but don\'t parse it',
 596                                 'Returns the same wikitext, after a PST has been applied. Ignored if page, pageid or oldid is used'
 597                         ),
 598                         'uselang' => 'Which language to parse the request in',
 599                         'section' => 'Only retrieve the content of this section number',
 600                         'disablepp' => 'Disable the PP Report from the parser output',
 601                         'generatexml' => 'Generate XML parse tree',
 602                 );
 603         }
 604
 605         public function getDescription() {
 606                 return array(
 607                         'Parses wikitext and returns parser output',
 608                         'See the various prop-Modules of action=query to get information from the current version of a page',
 609                 );
 610         }
 611
 612         public function getPossibleErrors() {
 613                 return array_merge( parent::getPossibleErrors(), array(
 614                         array( 'code' => 'params', 'info' => 'The page parameter cannot be used together with the text and title parameters' ),
 615                         array( 'code' => 'params', 'info' => 'The text parameter should be passed with the title parameter. Should you be using the "page" parameter instead?' ),
 616                         array( 'code' => 'missingrev', 'info' => 'There is no revision ID oldid' ),
 617                         array( 'code' => 'permissiondenied', 'info' => 'You don\'t have permission to view deleted revisions' ),
 618                         array( 'code' => 'missingtitle', 'info' => 'The page you specified doesn\'t exist' ),
 619                         array( 'code' => 'nosuchsection', 'info' => 'There is no section sectionnumber in page' ),
 620                         array( 'nosuchpageid' ),
 621                         array( 'invalidtitle', 'title' ),
 622                 ) );
 623         }
 624
 625         public function getExamples() {
 626                 return array(
 627                         'api.php?action=parse&text={{Project:Sandbox}}'
 628                 );
 629         }
 630
 631         public function getHelpUrls() {
 632                 return 'https://www.mediawiki.org/wiki/API:Parsing_wikitext#parse';
 633         }
 634
 635         public function getVersion() {
 636                 return __CLASS__ . ': $Id$';
 637         }
 638 }