includes/api/ApiExpandTemplates.php

   1 <?php
   2
   3 /**
   4  * Created on Oct 05, 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  * API module that functions as a shortcut to the wikitext preprocessor. Expands
  33  * any templates in a provided string, and returns the result of this expansion
  34  * to the caller.
  35  *
  36  * @ingroup API
  37  */
  38 class ApiExpandTemplates extends ApiBase {
  39
  40         public function __construct( $main, $action ) {
  41                 parent::__construct( $main, $action );
  42         }
  43
  44         public function execute() {
  45                 // Cache may vary on $wgUser because ParserOptions gets data from it
  46                 $this->getMain()->setCacheMode( 'anon-public-user-private' );
  47
  48                 // Get parameters
  49                 $params = $this->extractRequestParams();
  50
  51                 // Create title for parser
  52                 $title_obj = Title::newFromText( $params['title'] );
  53                 if ( !$title_obj ) {
  54                         $title_obj = Title::newFromText( 'API' ); // default
  55                 }
  56
  57                 $result = $this->getResult();
  58
  59                 // Parse text
  60                 global $wgParser;
  61                 $options = new ParserOptions();
  62
  63                 if ( $params['generatexml'] ) {
  64                         $wgParser->startExternalParse( $title_obj, $options, OT_PREPROCESS );
  65                         $dom = $wgParser->preprocessToDom( $params['text'] );
  66                         if ( is_callable( array( $dom, 'saveXML' ) ) ) {
  67                                 $xml = $dom->saveXML();
  68                         } else {
  69                                 $xml = $dom->__toString();
  70                         }
  71                         $xml_result = array();
  72                         $result->setContent( $xml_result, $xml );
  73                         $result->addValue( null, 'parsetree', $xml_result );
  74                 }
  75                 $retval = $wgParser->preprocess( $params['text'], $title_obj, $options );
  76
  77                 // Return result
  78                 $retval_array = array();
  79                 $result->setContent( $retval_array, $retval );
  80                 $result->addValue( null, $this->getModuleName(), $retval_array );
  81         }
  82
  83         public function getAllowedParams() {
  84                 return array(
  85                         'title' => array(
  86                                 ApiBase::PARAM_DFLT => 'API',
  87                         ),
  88                         'text' => null,
  89                         'generatexml' => false,
  90                 );
  91         }
  92
  93         public function getParamDescription() {
  94                 return array(
  95                         'text' => 'Wikitext to convert',
  96                         'title' => 'Title of page',
  97                         'generatexml' => 'Generate XML parse tree',
  98                 );
  99         }
 100
 101         public function getDescription() {
 102                 return 'This module expand all templates in wikitext';
 103         }
 104
 105         protected function getExamples() {
 106                 return array(
 107                         'api.php?action=expandtemplates&text={{Project:Sandbox}}'
 108                 );
 109         }
 110
 111         public function getVersion() {
 112                 return __CLASS__ . ': $Id$';
 113         }
 114 }