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