includes/api/ApiParse.php

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