includes/api/ApiExpandTemplates.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Oct 05, 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 /**
  28  * API module that functions as a shortcut to the wikitext preprocessor. Expands
  29  * any templates in a provided string, and returns the result of this expansion
  30  * to the caller.
  31  *
  32  * @ingroup API
  33  */
  34 class ApiExpandTemplates extends ApiBase {
  35
  36         public function execute() {
  37                 // Cache may vary on $wgUser because ParserOptions gets data from it
  38                 $this->getMain()->setCacheMode( 'anon-public-user-private' );
  39
  40                 // Get parameters
  41                 $params = $this->extractRequestParams();
  42                 $this->requireMaxOneParameter( $params, 'prop', 'generatexml' );
  43
  44                 if ( $params['prop'] === null ) {
  45                         $this->logFeatureUsage( 'action=expandtemplates&!prop' );
  46                         $this->setWarning( 'Because no values have been specified for the prop parameter, a ' .
  47                                 'legacy format has been used for the output. This format is deprecated, and in ' .
  48                                 'the future, a default value will be set for the prop parameter, causing the new' .
  49                                 'format to always be used.' );
  50                         $prop = array();
  51                 } else {
  52                         $prop = array_flip( $params['prop'] );
  53                 }
  54
  55                 // Get title and revision ID for parser
  56                 $revid = $params['revid'];
  57                 if ( $revid !== null ) {
  58                         $rev = Revision::newFromId( $revid );
  59                         if ( !$rev ) {
  60                                 $this->dieUsage( "There is no revision ID $revid", 'missingrev' );
  61                         }
  62                         $title_obj = $rev->getTitle();
  63                 } else {
  64                         $title_obj = Title::newFromText( $params['title'] );
  65                         if ( !$title_obj || $title_obj->isExternal() ) {
  66                                 $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
  67                         }
  68                 }
  69
  70                 $result = $this->getResult();
  71
  72                 // Parse text
  73                 global $wgParser;
  74                 $options = ParserOptions::newFromContext( $this->getContext() );
  75
  76                 if ( $params['includecomments'] ) {
  77                         $options->setRemoveComments( false );
  78                 }
  79
  80                 $retval = array();
  81
  82                 if ( isset( $prop['parsetree'] ) || $params['generatexml'] ) {
  83                         if ( !isset( $prop['parsetree'] ) ) {
  84                                 $this->logFeatureUsage( 'action=expandtemplates&generatexml' );
  85                         }
  86
  87                         $wgParser->startExternalParse( $title_obj, $options, Parser::OT_PREPROCESS );
  88                         $dom = $wgParser->preprocessToDom( $params['text'] );
  89                         if ( is_callable( array( $dom, 'saveXML' ) ) ) {
  90                                 $xml = $dom->saveXML();
  91                         } else {
  92                                 $xml = $dom->__toString();
  93                         }
  94                         if ( isset( $prop['parsetree'] ) ) {
  95                                 unset( $prop['parsetree'] );
  96                                 $retval['parsetree'] = $xml;
  97                         } else {
  98                                 // the old way
  99                                 $result->addValue( null, 'parsetree', $xml );
 100                                 $result->addValue( null, ApiResult::META_BC_SUBELEMENTS, array( 'parsetree' ) );
 101                         }
 102                 }
 103
 104                 // if they didn't want any output except (probably) the parse tree,
 105                 // then don't bother actually fully expanding it
 106                 if ( $prop || $params['prop'] === null ) {
 107                         $wgParser->startExternalParse( $title_obj, $options, Parser::OT_PREPROCESS );
 108                         $frame = $wgParser->getPreprocessor()->newFrame();
 109                         $wikitext = $wgParser->preprocess( $params['text'], $title_obj, $options, $revid, $frame );
 110                         if ( $params['prop'] === null ) {
 111                                 // the old way
 112                                 ApiResult::setContentValue( $retval, 'wikitext', $wikitext );
 113                         } else {
 114                                 $p_output = $wgParser->getOutput();
 115                                 if ( isset( $prop['categories'] ) ) {
 116                                         $categories = $p_output->getCategories();
 117                                         if ( $categories ) {
 118                                                 $categories_result = array();
 119                                                 foreach ( $categories as $category => $sortkey ) {
 120                                                         $entry = array();
 121                                                         $entry['sortkey'] = $sortkey;
 122                                                         ApiResult::setContentValue( $entry, 'category', $category );
 123                                                         $categories_result[] = $entry;
 124                                                 }
 125                                                 ApiResult::setIndexedTagName( $categories_result, 'category' );
 126                                                 $retval['categories'] = $categories_result;
 127                                         }
 128                                 }
 129                                 if ( isset( $prop['properties'] ) ) {
 130                                         $properties = $p_output->getProperties();
 131                                         if ( $properties ) {
 132                                                 ApiResult::setArrayType( $properties, 'BCkvp', 'name' );
 133                                                 ApiResult::setIndexedTagName( $properties, 'property' );
 134                                                 $retval['properties'] = $properties;
 135                                         }
 136                                 }
 137                                 if ( isset( $prop['volatile'] ) ) {
 138                                         $retval['volatile'] = $frame->isVolatile();
 139                                 }
 140                                 if ( isset( $prop['ttl'] ) && $frame->getTTL() !== null ) {
 141                                         $retval['ttl'] = $frame->getTTL();
 142                                 }
 143                                 if ( isset( $prop['wikitext'] ) ) {
 144                                         $retval['wikitext'] = $wikitext;
 145                                 }
 146                                 if ( isset( $prop['modules'] ) ) {
 147                                         $retval['modules'] = array_values( array_unique( $p_output->getModules() ) );
 148                                         $retval['modulescripts'] = array_values( array_unique( $p_output->getModuleScripts() ) );
 149                                         $retval['modulestyles'] = array_values( array_unique( $p_output->getModuleStyles() ) );
 150                                 }
 151                                 if ( isset( $prop['jsconfigvars'] ) ) {
 152                                         $retval['jsconfigvars'] =
 153                                                 ApiResult::addMetadataToResultVars( $p_output->getJsConfigVars() );
 154                                 }
 155                                 if ( isset( $prop['encodedjsconfigvars'] ) ) {
 156                                         $retval['encodedjsconfigvars'] = FormatJson::encode(
 157                                                 $p_output->getJsConfigVars(), false, FormatJson::ALL_OK
 158                                         );
 159                                         $retval[ApiResult::META_SUBELEMENTS][] = 'encodedjsconfigvars';
 160                                 }
 161                                 if ( isset( $prop['modules'] ) &&
 162                                         !isset( $prop['jsconfigvars'] ) && !isset( $prop['encodedjsconfigvars'] ) ) {
 163                                         $this->setWarning( "Property 'modules' was set but not 'jsconfigvars' " .
 164                                                 "or 'encodedjsconfigvars'. Configuration variables are necessary " .
 165                                                 "for proper module usage." );
 166                                 }
 167                         }
 168                 }
 169                 ApiResult::setSubelementsList( $retval, array( 'wikitext', 'parsetree' ) );
 170                 $result->addValue( null, $this->getModuleName(), $retval );
 171         }
 172
 173         public function getAllowedParams() {
 174                 return array(
 175                         'title' => array(
 176                                 ApiBase::PARAM_DFLT => 'API',
 177                         ),
 178                         'text' => array(
 179                                 ApiBase::PARAM_TYPE => 'text',
 180                                 ApiBase::PARAM_REQUIRED => true,
 181                         ),
 182                         'revid' => array(
 183                                 ApiBase::PARAM_TYPE => 'integer',
 184                         ),
 185                         'prop' => array(
 186                                 ApiBase::PARAM_TYPE => array(
 187                                         'wikitext',
 188                                         'categories',
 189                                         'properties',
 190                                         'volatile',
 191                                         'ttl',
 192                                         'modules',
 193                                         'jsconfigvars',
 194                                         'encodedjsconfigvars',
 195                                         'parsetree',
 196                                 ),
 197                                 ApiBase::PARAM_ISMULTI => true,
 198                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => array(),
 199                         ),
 200                         'includecomments' => false,
 201                         'generatexml' => array(
 202                                 ApiBase::PARAM_TYPE => 'boolean',
 203                                 ApiBase::PARAM_DEPRECATED => true,
 204                         ),
 205                 );
 206         }
 207
 208         protected function getExamplesMessages() {
 209                 return array(
 210                         'action=expandtemplates&text={{Project:Sandbox}}'
 211                                 => 'apihelp-expandtemplates-example-simple',
 212                 );
 213         }
 214
 215         public function getHelpUrls() {
 216                 return 'https://www.mediawiki.org/wiki/API:Parsing_wikitext#expandtemplates';
 217         }
 218 }