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