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 ( $params['generatexml'] ) {
 366                         if ( $this->content->getModel() != CONTENT_MODEL_WIKITEXT ) {
 367                                 $this->dieUsage( "generatexml is only supported for wikitext content", "notwikitext" );
 368                         }
 369
 370                         $wgParser->startExternalParse( $titleObj, $popts, OT_PREPROCESS );
 371                         $dom = $wgParser->preprocessToDom( $this->content->getNativeData() );
 372                         if ( is_callable( array( $dom, 'saveXML' ) ) ) {
 373                                 $xml = $dom->saveXML();
 374                         } else {
 375                                 $xml = $dom->__toString();
 376                         }
 377                         $result_array['parsetree'] = array();
 378                         ApiResult::setContent( $result_array['parsetree'], $xml );
 379                 }
 380
 381                 $result_mapping = array(
 382                         'redirects' => 'r',
 383                         'langlinks' => 'll',
 384                         'categories' => 'cl',
 385                         'links' => 'pl',
 386                         'templates' => 'tl',
 387                         'images' => 'img',
 388                         'externallinks' => 'el',
 389                         'iwlinks' => 'iw',
 390                         'sections' => 's',
 391                         'headitems' => 'hi',
 392                         'properties' => 'pp',
 393                 );
 394                 $this->setIndexedTagNames( $result_array, $result_mapping );
 395                 $result->addValue( null, $this->getModuleName(), $result_array );
 396
 397                 if ( !is_null( $oldLang ) ) {
 398                         $this->getContext()->setLanguage( $oldLang ); // Reset language to $oldLang
 399                 }
 400         }
 401
 402         /**
 403          * Constructs a ParserOptions object
 404          *
 405          * @param WikiPage $pageObj
 406          * @param array $params
 407          *
 408          * @return ParserOptions
 409          */
 410         protected function makeParserOptions( WikiPage $pageObj, array $params ) {
 411                 wfProfileIn( __METHOD__ );
 412
 413                 $popts = $pageObj->makeParserOptions( $this->getContext() );
 414                 $popts->enableLimitReport( !$params['disablepp'] );
 415                 $popts->setIsPreview( $params['preview'] || $params['sectionpreview'] );
 416                 $popts->setIsSectionPreview( $params['sectionpreview'] );
 417
 418                 wfProfileOut( __METHOD__ );
 419
 420                 return $popts;
 421         }
 422
 423         /**
 424          * @param $page WikiPage
 425          * @param $popts ParserOptions
 426          * @param $pageId Int
 427          * @param $getWikitext Bool
 428          * @return ParserOutput
 429          */
 430         private function getParsedContent( WikiPage $page, $popts, $pageId = null, $getWikitext = false ) {
 431                 $this->content = $page->getContent( Revision::RAW ); //XXX: really raw?
 432
 433                 if ( $this->section !== false && $this->content !== null ) {
 434                         $this->content = $this->getSectionContent(
 435                                 $this->content,
 436                                 !is_null( $pageId ) ? 'page id ' . $pageId : $page->getTitle()->getText()
 437                         );
 438
 439                         // Not cached (save or load)
 440                         return $this->content->getParserOutput( $page->getTitle(), null, $popts );
 441                 }
 442
 443                 // Try the parser cache first
 444                 // getParserOutput will save to Parser cache if able
 445                 $pout = $page->getParserOutput( $popts );
 446                 if ( !$pout ) {
 447                         $this->dieUsage( "There is no revision ID {$page->getLatest()}", 'missingrev' );
 448                 }
 449                 if ( $getWikitext ) {
 450                         $this->content = $page->getContent( Revision::RAW );
 451                 }
 452
 453                 return $pout;
 454         }
 455
 456         private function getSectionContent( Content $content, $what ) {
 457                 // Not cached (save or load)
 458                 $section = $content->getSection( $this->section );
 459                 if ( $section === false ) {
 460                         $this->dieUsage( "There is no section {$this->section} in " . $what, 'nosuchsection' );
 461                 }
 462                 if ( $section === null ) {
 463                         $this->dieUsage( "Sections are not supported by " . $what, 'nosuchsection' );
 464                         $section = false;
 465                 }
 466
 467                 return $section;
 468         }
 469
 470         private function formatLangLinks( $links ) {
 471                 $result = array();
 472                 foreach ( $links as $link ) {
 473                         $entry = array();
 474                         $bits = explode( ':', $link, 2 );
 475                         $title = Title::newFromText( $link );
 476
 477                         $entry['lang'] = $bits[0];
 478                         if ( $title ) {
 479                                 $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
 480                         }
 481                         ApiResult::setContent( $entry, $bits[1] );
 482                         $result[] = $entry;
 483                 }
 484
 485                 return $result;
 486         }
 487
 488         private function formatCategoryLinks( $links ) {
 489                 $result = array();
 490
 491                 if ( !$links ) {
 492                         return $result;
 493                 }
 494
 495                 // Fetch hiddencat property
 496                 $lb = new LinkBatch;
 497                 $lb->setArray( array( NS_CATEGORY => $links ) );
 498                 $db = $this->getDB();
 499                 $res = $db->select( array( 'page', 'page_props' ),
 500                         array( 'page_title', 'pp_propname' ),
 501                         $lb->constructSet( 'page', $db ),
 502                         __METHOD__,
 503                         array(),
 504                         array( 'page_props' => array(
 505                                 'LEFT JOIN', array( 'pp_propname' => 'hiddencat', 'pp_page = page_id' )
 506                         ) )
 507                 );
 508                 $hiddencats = array();
 509                 foreach ( $res as $row ) {
 510                         $hiddencats[$row->page_title] = isset( $row->pp_propname );
 511                 }
 512
 513                 foreach ( $links as $link => $sortkey ) {
 514                         $entry = array();
 515                         $entry['sortkey'] = $sortkey;
 516                         ApiResult::setContent( $entry, $link );
 517                         if ( !isset( $hiddencats[$link] ) ) {
 518                                 $entry['missing'] = '';
 519                         } elseif ( $hiddencats[$link] ) {
 520                                 $entry['hidden'] = '';
 521                         }
 522                         $result[] = $entry;
 523                 }
 524
 525                 return $result;
 526         }
 527
 528         private function categoriesHtml( $categories ) {
 529                 $context = $this->getContext();
 530                 $context->getOutput()->addCategoryLinks( $categories );
 531
 532                 return $context->getSkin()->getCategories();
 533         }
 534
 535         /**
 536          * @deprecated since 1.18 No modern skin generates language links this way,
 537          * please use language links data to generate your own HTML.
 538          * @param $languages array
 539          * @return string
 540          */
 541         private function languagesHtml( $languages ) {
 542                 wfDeprecated( __METHOD__, '1.18' );
 543                 $this->setWarning( '"action=parse&prop=languageshtml" is deprecated ' .
 544                         'and will be removed in MediaWiki 1.24. Use "prop=langlinks" ' .
 545                         'to generate your own HTML.' );
 546
 547                 global $wgContLang, $wgHideInterlanguageLinks;
 548
 549                 if ( $wgHideInterlanguageLinks || count( $languages ) == 0 ) {
 550                         return '';
 551                 }
 552
 553                 $s = htmlspecialchars( wfMessage( 'otherlanguages' )->text() .
 554                         wfMessage( 'colon-separator' )->text() );
 555
 556                 $langs = array();
 557                 foreach ( $languages as $l ) {
 558                         $nt = Title::newFromText( $l );
 559                         $text = Language::fetchLanguageName( $nt->getInterwiki() );
 560
 561                         $langs[] = Html::element( 'a',
 562                                 array( 'href' => $nt->getFullURL(), 'title' => $nt->getText(), 'class' => 'external' ),
 563                                 $text == '' ? $l : $text );
 564                 }
 565
 566                 $s .= implode( wfMessage( 'pipe-separator' )->escaped(), $langs );
 567
 568                 if ( $wgContLang->isRTL() ) {
 569                         $s = Html::rawElement( 'span', array( 'dir' => 'LTR' ), $s );
 570                 }
 571
 572                 return $s;
 573         }
 574
 575         private function formatLinks( $links ) {
 576                 $result = array();
 577                 foreach ( $links as $ns => $nslinks ) {
 578                         foreach ( $nslinks as $title => $id ) {
 579                                 $entry = array();
 580                                 $entry['ns'] = $ns;
 581                                 ApiResult::setContent( $entry, Title::makeTitle( $ns, $title )->getFullText() );
 582                                 if ( $id != 0 ) {
 583                                         $entry['exists'] = '';
 584                                 }
 585                                 $result[] = $entry;
 586                         }
 587                 }
 588
 589                 return $result;
 590         }
 591
 592         private function formatIWLinks( $iw ) {
 593                 $result = array();
 594                 foreach ( $iw as $prefix => $titles ) {
 595                         foreach ( array_keys( $titles ) as $title ) {
 596                                 $entry = array();
 597                                 $entry['prefix'] = $prefix;
 598
 599                                 $title = Title::newFromText( "{$prefix}:{$title}" );
 600                                 if ( $title ) {
 601                                         $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
 602                                 }
 603
 604                                 ApiResult::setContent( $entry, $title->getFullText() );
 605                                 $result[] = $entry;
 606                         }
 607                 }
 608
 609                 return $result;
 610         }
 611
 612         private function formatHeadItems( $headItems ) {
 613                 $result = array();
 614                 foreach ( $headItems as $tag => $content ) {
 615                         $entry = array();
 616                         $entry['tag'] = $tag;
 617                         ApiResult::setContent( $entry, $content );
 618                         $result[] = $entry;
 619                 }
 620
 621                 return $result;
 622         }
 623
 624         private function formatProperties( $properties ) {
 625                 $result = array();
 626                 foreach ( $properties as $name => $value ) {
 627                         $entry = array();
 628                         $entry['name'] = $name;
 629                         ApiResult::setContent( $entry, $value );
 630                         $result[] = $entry;
 631                 }
 632
 633                 return $result;
 634         }
 635
 636         private function formatCss( $css ) {
 637                 $result = array();
 638                 foreach ( $css as $file => $link ) {
 639                         $entry = array();
 640                         $entry['file'] = $file;
 641                         ApiResult::setContent( $entry, $link );
 642                         $result[] = $entry;
 643                 }
 644
 645                 return $result;
 646         }
 647
 648         private function setIndexedTagNames( &$array, $mapping ) {
 649                 foreach ( $mapping as $key => $name ) {
 650                         if ( isset( $array[$key] ) ) {
 651                                 $this->getResult()->setIndexedTagName( $array[$key], $name );
 652                         }
 653                 }
 654         }
 655
 656         public function getAllowedParams() {
 657                 return array(
 658                         'title' => null,
 659                         'text' => null,
 660                         'summary' => null,
 661                         'page' => null,
 662                         'pageid' => array(
 663                                 ApiBase::PARAM_TYPE => 'integer',
 664                         ),
 665                         'redirects' => false,
 666                         'oldid' => array(
 667                                 ApiBase::PARAM_TYPE => 'integer',
 668                         ),
 669                         'prop' => array(
 670                                 ApiBase::PARAM_DFLT => 'text|langlinks|categories|links|templates|' .
 671                                         'images|externallinks|sections|revid|displaytitle|iwlinks|properties',
 672                                 ApiBase::PARAM_ISMULTI => true,
 673                                 ApiBase::PARAM_TYPE => array(
 674                                         'text',
 675                                         'langlinks',
 676                                         'languageshtml',
 677                                         'categories',
 678                                         'categorieshtml',
 679                                         'links',
 680                                         'templates',
 681                                         'images',
 682                                         'externallinks',
 683                                         'sections',
 684                                         'revid',
 685                                         'displaytitle',
 686                                         'headitems',
 687                                         'headhtml',
 688                                         'iwlinks',
 689                                         'wikitext',
 690                                         'properties',
 691                                 )
 692                         ),
 693                         'pst' => false,
 694                         'onlypst' => false,
 695                         'effectivelanglinks' => false,
 696                         'uselang' => null,
 697                         'section' => null,
 698                         'disablepp' => false,
 699                         'generatexml' => false,
 700                         'preview' => false,
 701                         'sectionpreview' => false,
 702                         'disabletoc' => false,
 703                         'contentformat' => array(
 704                                 ApiBase::PARAM_TYPE => ContentHandler::getAllContentFormats(),
 705                         ),
 706                         'contentmodel' => array(
 707                                 ApiBase::PARAM_TYPE => ContentHandler::getContentModels(),
 708                         )
 709                 );
 710         }
 711
 712         public function getParamDescription() {
 713                 $p = $this->getModulePrefix();
 714
 715                 return array(
 716                         'text' => "Text to parse. Use {$p}title or {$p}contentmodel to control the content model",
 717                         'summary' => 'Summary to parse',
 718                         'redirects' => "If the {$p}page or the {$p}pageid parameter is set to a redirect, resolve it",
 719                         'title' => "Title of page the text belongs to. " .
 720                                 "If omitted, {$p}contentmodel must be specified, and \"API\" will be used as the title",
 721                         'page' => "Parse the content of this page. Cannot be used together with {$p}text and {$p}title",
 722                         'pageid' => "Parse the content of this page. Overrides {$p}page",
 723                         'oldid' => "Parse the content of this revision. Overrides {$p}page and {$p}pageid",
 724                         'prop' => array(
 725                                 'Which pieces of information to get',
 726                                 ' text           - Gives the parsed text of the wikitext',
 727                                 ' langlinks      - Gives the language links in the parsed wikitext',
 728                                 ' categories     - Gives the categories in the parsed wikitext',
 729                                 ' categorieshtml - Gives the HTML version of the categories',
 730                                 ' languageshtml  - DEPRECATED. Will be removed in MediaWiki 1.24.',
 731                                 '                  Gives the HTML version of the language links',
 732                                 ' links          - Gives the internal links in the parsed wikitext',
 733                                 ' templates      - Gives the templates in the parsed wikitext',
 734                                 ' images         - Gives the images in the parsed wikitext',
 735                                 ' externallinks  - Gives the external links in the parsed wikitext',
 736                                 ' sections       - Gives the sections in the parsed wikitext',
 737                                 ' revid          - Adds the revision ID of the parsed page',
 738                                 ' displaytitle   - Adds the title of the parsed wikitext',
 739                                 ' headitems      - Gives items to put in the <head> of the page',
 740                                 ' headhtml       - Gives parsed <head> of the page',
 741                                 ' iwlinks        - Gives interwiki links in the parsed wikitext',
 742                                 ' wikitext       - Gives the original wikitext that was parsed',
 743                                 ' properties     - Gives various properties defined in the parsed wikitext',
 744                         ),
 745                         'effectivelanglinks' => array(
 746                                 'Includes language links supplied by extensions',
 747                                 '(for use with prop=langlinks|languageshtml)',
 748                         ),
 749                         'pst' => array(
 750                                 'Do a pre-save transform on the input before parsing it',
 751                                 "Only valid when used with {$p}text",
 752                         ),
 753                         'onlypst' => array(
 754                                 'Do a pre-save transform (PST) on the input, but don\'t parse it',
 755                                 'Returns the same wikitext, after a PST has been applied.',
 756                                 "Only valid when used with {$p}text",
 757                         ),
 758                         'uselang' => 'Which language to parse the request in',
 759                         'section' => 'Only retrieve the content of this section number',
 760                         'disablepp' => 'Disable the PP Report from the parser output',
 761                         'generatexml' => "Generate XML parse tree (requires contentmodel=$wikitext)",
 762                         'preview' => 'Parse in preview mode',
 763                         'sectionpreview' => 'Parse in section preview mode (enables preview mode too)',
 764                         'disabletoc' => 'Disable table of contents in output',
 765                         'contentformat' => array(
 766                                 'Content serialization format used for the input text',
 767                                 "Only valid when used with {$p}text",
 768                         ),
 769                         'contentmodel' => array(
 770                                 "Content model of the input text. If omitted, ${p}title must be specified, " .
 771                                         "and default will be the model of the specified ${p}title",
 772                                 "Only valid when used with {$p}text",
 773                         ),
 774                 );
 775         }
 776
 777         public function getDescription() {
 778                 $p = $this->getModulePrefix();
 779
 780                 return array(
 781                         'Parses content and returns parser output',
 782                         'See the various prop-Modules of action=query to get information from the current' .
 783                                 'version of a page',
 784                         'There are several ways to specify the text to parse:',
 785                         "1) Specify a page or revision, using {$p}page, {$p}pageid, or {$p}oldid.",
 786                         "2) Specify content explicitly, using {$p}text, {$p}title, and {$p}contentmodel.",
 787                         "3) Specify only a summary to parse. {$p}prop should be given an empty value.",
 788                 );
 789         }
 790
 791         public function getPossibleErrors() {
 792                 return array_merge( parent::getPossibleErrors(), array(
 793                         array(
 794                                 'code' => 'params',
 795                                 'info' => 'The page parameter cannot be used together with the text and title parameters'
 796                         ),
 797                         array( 'code' => 'missingrev', 'info' => 'There is no revision ID oldid' ),
 798                         array(
 799                                 'code' => 'permissiondenied',
 800                                 'info' => 'You don\'t have permission to view deleted revisions'
 801                         ),
 802                         array( 'code' => 'missingtitle', 'info' => 'The page you specified doesn\'t exist' ),
 803                         array( 'code' => 'nosuchsection', 'info' => 'There is no section sectionnumber in page' ),
 804                         array( 'nosuchpageid' ),
 805                         array( 'invalidtitle', 'title' ),
 806                         array( 'code' => 'parseerror', 'info' => 'Failed to parse the given text.' ),
 807                         array(
 808                                 'code' => 'notwikitext',
 809                                 'info' => 'The requested operation is only supported on wikitext content.'
 810                         ),
 811                 ) );
 812         }
 813
 814         public function getExamples() {
 815                 return array(
 816                         'api.php?action=parse&page=Project:Sandbox' => 'Parse a page',
 817                         'api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext' => 'Parse wikitext',
 818                         'api.php?action=parse&text={{PAGENAME}}&title=Test'
 819                                 => 'Parse wikitext, specifying the page title',
 820                         'api.php?action=parse&summary=Some+[[link]]&prop=' => 'Parse a summary',
 821                 );
 822         }
 823
 824         public function getHelpUrls() {
 825                 return 'https://www.mediawiki.org/wiki/API:Parsing_wikitext#parse';
 826         }
 827 }