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