includes/api/ApiParse.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Dec 01, 2007
   6  *
   7  * Copyright © 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 if ( !defined( 'MEDIAWIKI' ) ) {
  28         // Eclipse helper - will be ignored in production
  29         require_once( "ApiBase.php" );
  30 }
  31
  32 /**
  33  * @ingroup API
  34  */
  35 class ApiParse extends ApiBase {
  36
  37         private $section;
  38
  39         public function __construct( $main, $action ) {
  40                 parent::__construct( $main, $action );
  41         }
  42
  43         public function execute() {
  44                 // The data is hot but user-dependent, like page views, so we set vary cookies
  45                 $this->getMain()->setCacheMode( 'anon-public-user-private' );
  46
  47                 // Get parameters
  48                 $params = $this->extractRequestParams();
  49                 $text = $params['text'];
  50                 $title = $params['title'];
  51                 $page = $params['page'];
  52                 $pageid = $params['pageid'];
  53                 $oldid = $params['oldid'];
  54
  55                 if ( !is_null( $page ) && ( !is_null( $text ) || $title != 'API' ) ) {
  56                         $this->dieUsage( 'The page parameter cannot be used together with the text and title parameters', 'params' );
  57                 }
  58                 $prop = array_flip( $params['prop'] );
  59
  60                 if ( isset( $params['section'] ) ) {
  61                         $this->section = $params['section'];
  62                 } else {
  63                         $this->section = false;
  64                 }
  65
  66                 // The parser needs $wgTitle to be set, apparently the
  67                 // $title parameter in Parser::parse isn't enough *sigh*
  68                 global $wgParser, $wgUser, $wgTitle, $wgEnableParserCache, $wgLang;
  69
  70                 // Currently unnecessary, code to act as a safeguard against any change in current behaviour of uselang breaks
  71                 $oldLang = null;
  72                 if ( isset( $params['uselang'] ) && $params['uselang'] != $wgLang->getCode() ) {
  73                         $oldLang = $wgLang; // Backup wgLang
  74                         $wgLang = Language::factory( $params['uselang'] );
  75                 }
  76
  77                 $popts = new ParserOptions();
  78                 $popts->setTidy( true );
  79                 $popts->enableLimitReport( !$params['disablepp'] );
  80                 $redirValues = null;
  81                 if ( !is_null( $oldid ) || !is_null( $pageid ) || !is_null( $page ) ) {
  82                         if ( !is_null( $oldid ) ) {
  83                                 // Don't use the parser cache
  84                                 $rev = Revision::newFromID( $oldid );
  85                                 if ( !$rev ) {
  86                                         $this->dieUsage( "There is no revision ID $oldid", 'missingrev' );
  87                                 }
  88                                 if ( !$rev->userCan( Revision::DELETED_TEXT ) ) {
  89                                         $this->dieUsage( "You don't have permission to view deleted revisions", 'permissiondenied' );
  90                                 }
  91
  92                                 $titleObj = $rev->getTitle();
  93
  94                                 $wgTitle = $titleObj;
  95
  96                                 // If for some reason the "oldid" is actually the current revision, it may be cached
  97                                 if ( $titleObj->getLatestRevID() === intval( $oldid ) )  {
  98                                         $articleObj = new Article( $titleObj );
  99
 100                                         $p_result = $this->getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageid ) ;
 101
 102                                 } else {
 103                                         $text = $rev->getText( Revision::FOR_THIS_USER );
 104
 105                                         $wgTitle = $titleObj;
 106
 107                                         if ( $this->section !== false ) {
 108                                                 $text = $this->getSectionText( $text, 'r' . $rev );
 109                                         }
 110
 111                                         $p_result = $wgParser->parse( $text, $titleObj, $popts );
 112                                 }
 113                         } else {
 114                                 if ( !is_null ( $pageid ) ) {
 115                                         $titleObj = Title::newFromID( $pageid );
 116
 117                                         if ( !$titleObj ) {
 118                                                 $this->dieUsageMsg( array( 'nosuchpageid', $pageid ) );
 119                                         }
 120                                 } else {
 121                                         if ( $params['redirects'] ) {
 122                                                 $req = new FauxRequest( array(
 123                                                         'action' => 'query',
 124                                                         'redirects' => '',
 125                                                         'titles' => $page
 126                                                 ) );
 127                                                 $main = new ApiMain( $req );
 128                                                 $main->execute();
 129                                                 $data = $main->getResultData();
 130                                                 $redirValues = @$data['query']['redirects'];
 131                                                 $to = $page;
 132                                                 foreach ( (array)$redirValues as $r ) {
 133                                                         $to = $r['to'];
 134                                                 }
 135                                         } else {
 136                                                 $to = $page;
 137                                         }
 138                                         $titleObj = Title::newFromText( $to );
 139                                         if ( !$titleObj ) {
 140                                                 $this->dieUsage( "The page you specified doesn't exist", 'missingtitle' );
 141                                         }
 142                                 }
 143                                 $wgTitle = $titleObj;
 144
 145                                 $articleObj = new Article( $titleObj );
 146                                 if ( isset( $prop['revid'] ) ) {
 147                                         $oldid = $articleObj->getRevIdFetched();
 148                                 }
 149
 150                                 $p_result = $this->getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageid ) ;
 151                         }
 152                 } else {
 153                         $titleObj = Title::newFromText( $title );
 154                         if ( !$titleObj ) {
 155                                 $titleObj = Title::newFromText( 'API' );
 156                         }
 157                         $wgTitle = $titleObj;
 158
 159                         if ( $this->section !== false ) {
 160                                 $text = $this->getSectionText( $text, $titleObj->getText() );
 161                         }
 162
 163                         if ( $params['pst'] || $params['onlypst'] ) {
 164                                 $text = $wgParser->preSaveTransform( $text, $titleObj, $wgUser, $popts );
 165                         }
 166                         if ( $params['onlypst'] ) {
 167                                 // Build a result and bail out
 168                                 $result_array['text'] = array();
 169                                 $this->getResult()->setContent( $result_array['text'], $text );
 170                                 $this->getResult()->addValue( null, $this->getModuleName(), $result_array );
 171                                 return;
 172                         }
 173                         $p_result = $wgParser->parse( $text, $titleObj, $popts );
 174                 }
 175
 176                 // Return result
 177                 $result = $this->getResult();
 178                 $result_array = array();
 179                 if ( $params['redirects'] && !is_null( $redirValues ) ) {
 180                         $result_array['redirects'] = $redirValues;
 181                 }
 182
 183                 if ( isset( $prop['text'] ) ) {
 184                         $result_array['text'] = array();
 185                         $result->setContent( $result_array['text'], $p_result->getText() );
 186                 }
 187
 188                 if ( !is_null( $params['summary'] ) ) {
 189                         $result_array['parsedsummary'] = array();
 190                         $result->setContent( $result_array['parsedsummary'], $wgUser->getSkin()->formatComment( $params['summary'], $titleObj ) );
 191                 }
 192
 193                 if ( isset( $prop['langlinks'] ) ) {
 194                         $result_array['langlinks'] = $this->formatLangLinks( $p_result->getLanguageLinks() );
 195                 }
 196                 if ( isset( $prop['languageshtml'] ) ) {
 197                         $languagesHtml = $this->languagesHtml( $p_result->getLanguageLinks() );
 198                         $result_array['languageshtml'] = array();
 199                         $result->setContent( $result_array['languageshtml'], $languagesHtml );
 200                 }
 201                 if ( isset( $prop['categories'] ) ) {
 202                         $result_array['categories'] = $this->formatCategoryLinks( $p_result->getCategories() );
 203                 }
 204                 if ( isset( $prop['categorieshtml'] ) ) {
 205                         $categoriesHtml = $this->categoriesHtml( $p_result->getCategories() );
 206                         $result_array['categorieshtml'] = array();
 207                         $result->setContent( $result_array['categorieshtml'], $categoriesHtml );
 208                 }
 209                 if ( isset( $prop['links'] ) ) {
 210                         $result_array['links'] = $this->formatLinks( $p_result->getLinks() );
 211                 }
 212                 if ( isset( $prop['templates'] ) ) {
 213                         $result_array['templates'] = $this->formatLinks( $p_result->getTemplates() );
 214                 }
 215                 if ( isset( $prop['images'] ) ) {
 216                         $result_array['images'] = array_keys( $p_result->getImages() );
 217                 }
 218                 if ( isset( $prop['externallinks'] ) ) {
 219                         $result_array['externallinks'] = array_keys( $p_result->getExternalLinks() );
 220                 }
 221                 if ( isset( $prop['sections'] ) ) {
 222                         $result_array['sections'] = $p_result->getSections();
 223                 }
 224
 225                 if ( isset( $prop['displaytitle'] ) ) {
 226                         $result_array['displaytitle'] = $p_result->getDisplayTitle() ?
 227                                                         $p_result->getDisplayTitle() :
 228                                                         $titleObj->getPrefixedText();
 229                 }
 230
 231                 if ( isset( $prop['headitems'] ) || isset( $prop['headhtml'] ) ) {
 232                         $out = new OutputPage;
 233                         $out->addParserOutputNoText( $p_result );
 234                         $userSkin = $wgUser->getSkin();
 235                 }
 236
 237                 if ( isset( $prop['headitems'] ) ) {
 238                         $headItems = $this->formatHeadItems( $p_result->getHeadItems() );
 239
 240                         $userSkin->setupUserCss( $out );
 241                         $css = $this->formatCss( $out->buildCssLinksArray() );
 242
 243                         $scripts = array( $out->getHeadScripts( $userSkin ) );
 244
 245                         $result_array['headitems'] = array_merge( $headItems, $css, $scripts );
 246                 }
 247
 248                 if ( isset( $prop['headhtml'] ) ) {
 249                         $result_array['headhtml'] = array();
 250                         $result->setContent( $result_array['headhtml'], $out->headElement( $userSkin ) );
 251                 }
 252
 253                 if ( isset( $prop['iwlinks'] ) ) {
 254                         $result_array['iwlinks'] = $this->formatIWLinks( $p_result->getInterwikiLinks() );
 255                 }
 256
 257                 if ( !is_null( $oldid ) ) {
 258                         $result_array['revid'] = intval( $oldid );
 259                 }
 260
 261                 $result_mapping = array(
 262                         'redirects' => 'r',
 263                         'langlinks' => 'll',
 264                         'categories' => 'cl',
 265                         'links' => 'pl',
 266                         'templates' => 'tl',
 267                         'images' => 'img',
 268                         'externallinks' => 'el',
 269                         'iwlinks' => 'iw',
 270                         'sections' => 's',
 271                         'headitems' => 'hi',
 272                 );
 273                 $this->setIndexedTagNames( $result_array, $result_mapping );
 274                 $result->addValue( null, $this->getModuleName(), $result_array );
 275
 276                 if ( !is_null( $oldLang ) ) {
 277                         $wgLang = $oldLang; // Reset $wgLang to $oldLang
 278                 }
 279         }
 280
 281         /**
 282          * @param  $articleObj Article
 283          * @param  $titleObj Title
 284          * @param  $pageId Int
 285          * @param  $popts ParserOptions
 286          * @return ParserOutput
 287          */
 288         private function getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageId = null ) {
 289                 global $wgParser;
 290
 291                 if ( $this->section !== false ) {
 292                         $text = $this->getSectionText( $text, !is_null ( $pageId )
 293                                         ? 'page id ' . $pageId : $titleObj->getText() );
 294
 295                         return $wgParser->parse( $text, $titleObj, $popts );
 296                 } else {
 297                         // Try the parser cache first
 298                         return $articleObj->getParserOutput();
 299                 }
 300         }
 301
 302         private function getSectionText( $text, $what ) {
 303                 global $wgParser;
 304                 $text = $wgParser->getSection( $text, $this->section, false );
 305                 if ( $text === false ) {
 306                         $this->dieUsage( "There is no section {$this->section} in " . $what, 'nosuchsection' );
 307                 }
 308                 return $text;
 309         }
 310
 311         private function formatLangLinks( $links ) {
 312                 $result = array();
 313                 foreach ( $links as $link ) {
 314                         $entry = array();
 315                         $bits = explode( ':', $link, 2 );
 316                         $entry['lang'] = $bits[0];
 317                         $this->getResult()->setContent( $entry, $bits[1] );
 318                         $result[] = $entry;
 319                 }
 320                 return $result;
 321         }
 322
 323         private function formatCategoryLinks( $links ) {
 324                 $result = array();
 325                 foreach ( $links as $link => $sortkey ) {
 326                         $entry = array();
 327                         $entry['sortkey'] = $sortkey;
 328                         $this->getResult()->setContent( $entry, $link );
 329                         $result[] = $entry;
 330                 }
 331                 return $result;
 332         }
 333
 334         private function categoriesHtml( $categories ) {
 335                 global $wgOut, $wgUser;
 336                 $wgOut->addCategoryLinks( $categories );
 337                 $sk = $wgUser->getSkin();
 338                 return $sk->getCategories();
 339         }
 340
 341         private function languagesHtml( $languages ) {
 342                 global $wgOut, $wgUser;
 343                 $wgOut->setLanguageLinks( $languages );
 344                 $sk = $wgUser->getSkin();
 345                 return $sk->otherLanguages();
 346         }
 347
 348         private function formatLinks( $links ) {
 349                 $result = array();
 350                 foreach ( $links as $ns => $nslinks ) {
 351                         foreach ( $nslinks as $title => $id ) {
 352                                 $entry = array();
 353                                 $entry['ns'] = $ns;
 354                                 $this->getResult()->setContent( $entry, Title::makeTitle( $ns, $title )->getFullText() );
 355                                 if ( $id != 0 ) {
 356                                         $entry['exists'] = '';
 357                                 }
 358                                 $result[] = $entry;
 359                         }
 360                 }
 361                 return $result;
 362         }
 363
 364         private function formatIWLinks( $iw ) {
 365                 $result = array();
 366                 foreach ( $iw as $prefix => $titles ) {
 367                         foreach ( array_keys( $titles ) as $title ) {
 368                                 $entry = array();
 369                                 $entry['prefix'] = $prefix;
 370
 371                                 $title = Title::newFromText( "{$prefix}:{$title}" );
 372                                 if ( $title ) {
 373                                         $entry['url'] = $title->getFullURL();
 374                                 }
 375
 376                                 $this->getResult()->setContent( $entry, $title->getFullText() );
 377                                 $result[] = $entry;
 378                         }
 379                 }
 380                 return $result;
 381         }
 382
 383         private function formatHeadItems( $headItems ) {
 384                 $result = array();
 385                 foreach ( $headItems as $tag => $content ) {
 386                         $entry = array();
 387                         $entry['tag'] = $tag;
 388                         $this->getResult()->setContent( $entry, $content );
 389                         $result[] = $entry;
 390                 }
 391                 return $result;
 392         }
 393
 394         private function formatCss( $css ) {
 395                 $result = array();
 396                 foreach ( $css as $file => $link ) {
 397                         $entry = array();
 398                         $entry['file'] = $file;
 399                         $this->getResult()->setContent( $entry, $link );
 400                         $result[] = $entry;
 401                 }
 402                 return $result;
 403         }
 404
 405         private function setIndexedTagNames( &$array, $mapping ) {
 406                 foreach ( $mapping as $key => $name ) {
 407                         if ( isset( $array[$key] ) ) {
 408                                 $this->getResult()->setIndexedTagName( $array[$key], $name );
 409                         }
 410                 }
 411         }
 412
 413         public function getAllowedParams() {
 414                 return array(
 415                         'title' => array(
 416                                 ApiBase::PARAM_DFLT => 'API',
 417                         ),
 418                         'text' => null,
 419                         'summary' => null,
 420                         'page' => null,
 421                         'pageid' => null,
 422                         'redirects' => false,
 423                         'oldid' => null,
 424                         'prop' => array(
 425                                 ApiBase::PARAM_DFLT => 'text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle',
 426                                 ApiBase::PARAM_ISMULTI => true,
 427                                 ApiBase::PARAM_TYPE => array(
 428                                         'text',
 429                                         'langlinks',
 430                                         'languageshtml',
 431                                         'categories',
 432                                         'categorieshtml',
 433                                         'links',
 434                                         'templates',
 435                                         'images',
 436                                         'externallinks',
 437                                         'sections',
 438                                         'revid',
 439                                         'displaytitle',
 440                                         'headitems',
 441                                         'headhtml',
 442                                         'iwlinks',
 443                                 )
 444                         ),
 445                         'pst' => false,
 446                         'onlypst' => false,
 447                         'uselang' => null,
 448                         'section' => null,
 449                         'disablepp' => false,
 450                 );
 451         }
 452
 453         public function getParamDescription() {
 454                 $p = $this->getModulePrefix();
 455                 return array(
 456                         'text' => 'Wikitext to parse',
 457                         'summary' => 'Summary to parse',
 458                         'redirects' => "If the {$p}page parameter is set to a redirect, resolve it",
 459                         'title' => 'Title of page the text belongs to',
 460                         'page' => "Parse the content of this page. Cannot be used together with {$p}text and {$p}title",
 461                         'pageid' => "Parse the content of this page. Overrides {$p}page",
 462                         'oldid' => "Parse the content of this revision. Overrides {$p}page and {$p}pageid",
 463                         'prop' => array(
 464                                 'Which pieces of information to get',
 465                                 ' text           - Gives the parsed text of the wikitext',
 466                                 ' langlinks      - Gives the language links in the parsed wikitext',
 467                                 ' categories     - Gives the categories in the parsed wikitext',
 468                                 ' categorieshtml - Gives the HTML version of the categories',
 469                                 ' languageshtml  - Gives the HTML version of the language links',
 470                                 ' links          - Gives the internal links in the parsed wikitext',
 471                                 ' templates      - Gives the templates in the parsed wikitext',
 472                                 ' images         - Gives the images in the parsed wikitext',
 473                                 ' externallinks  - Gives the external links in the parsed wikitext',
 474                                 ' sections       - Gives the sections in the parsed wikitext',
 475                                 ' revid          - Adds the revision ID of the parsed page',
 476                                 ' displaytitle   - Adds the title of the parsed wikitext',
 477                                 ' headitems      - Gives items to put in the <head> of the page',
 478                                 ' headhtml       - Gives parsed <head> of the page',
 479                                 ' iwlinks        - Gives interwiki links in the parsed wikitext',
 480                                 'NOTE: Section tree is only generated if there are more than 4 sections, or if the __TOC__ keyword is present'
 481                         ),
 482                         'pst' => array(
 483                                 'Do a pre-save transform on the input before parsing it',
 484                                 'Ignored if page, pageid or oldid is used'
 485                         ),
 486                         'onlypst' => array(
 487                                 'Do a pre-save transform (PST) on the input, but don\'t parse it',
 488                                 'Returns the same wikitext, after a PST has been applied. Ignored if page, pageid or oldid is used'
 489                         ),
 490                         'uselang' => 'Which language to parse the request in',
 491                         'section' => 'Only retrieve the content of this section number',
 492                         'disablepp' => 'Disable the PP Report from the parser output',
 493                 );
 494         }
 495
 496         public function getDescription() {
 497                 return 'This module parses wikitext and returns parser output';
 498         }
 499
 500         public function getPossibleErrors() {
 501                 return array_merge( parent::getPossibleErrors(), array(
 502                         array( 'code' => 'params', 'info' => 'The page parameter cannot be used together with the text and title parameters' ),
 503                         array( 'code' => 'missingrev', 'info' => 'There is no revision ID oldid' ),
 504                         array( 'code' => 'permissiondenied', 'info' => 'You don\'t have permission to view deleted revisions' ),
 505                         array( 'code' => 'missingtitle', 'info' => 'The page you specified doesn\'t exist' ),
 506                         array( 'code' => 'nosuchsection', 'info' => 'There is no section sectionnumber in page' ),
 507                         array( 'nosuchpageid' ),
 508                 ) );
 509         }
 510
 511         protected function getExamples() {
 512                 return array(
 513                         'api.php?action=parse&text={{Project:Sandbox}}'
 514                 );
 515         }
 516
 517         public function getVersion() {
 518                 return __CLASS__ . ': $Id$';
 519         }
 520 }