5 * Created on Oct 05, 2007
7 * Copyright © 2007 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
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.
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.
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
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
34 class ApiExpandTemplates
extends ApiBase
{
36 public function execute() {
37 // Cache may vary on the user because ParserOptions gets data from it
38 $this->getMain()->setCacheMode( 'anon-public-user-private' );
41 $params = $this->extractRequestParams();
42 $this->requireMaxOneParameter( $params, 'prop', 'generatexml' );
44 $title = $params['title'];
45 if ( $title === null ) {
46 $titleProvided = false;
47 // A title is needed for parsing, so arbitrarily choose one
50 $titleProvided = true;
53 if ( $params['prop'] === null ) {
54 $this->addDeprecation(
55 'apiwarn-deprecation-expandtemplates-prop', 'action=expandtemplates&!prop'
59 $prop = array_flip( $params['prop'] );
62 $titleObj = Title
::newFromText( $title );
63 if ( !$titleObj ||
$titleObj->isExternal() ) {
64 $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $params['title'] ) ] );
67 // Get title and revision ID for parser
68 $revid = $params['revid'];
69 if ( $revid !== null ) {
70 $rev = Revision
::newFromId( $revid );
72 $this->dieWithError( [ 'apierror-nosuchrevid', $revid ] );
74 $pTitleObj = $titleObj;
75 $titleObj = $rev->getTitle();
76 if ( $titleProvided ) {
77 if ( !$titleObj->equals( $pTitleObj ) ) {
78 $this->addWarning( [ 'apierror-revwrongpage', $rev->getId(),
79 wfEscapeWikiText( $pTitleObj->getPrefixedText() ) ] );
82 // Consider the title derived from the revid as having
84 $titleProvided = true;
88 $result = $this->getResult();
92 $options = ParserOptions
::newFromContext( $this->getContext() );
94 if ( $params['includecomments'] ) {
95 $options->setRemoveComments( false );
99 $suppressCache = false;
100 Hooks
::run( 'ApiMakeParserOptions',
101 [ $options, $titleObj, $params, $this, &$reset, &$suppressCache ] );
105 if ( isset( $prop['parsetree'] ) ||
$params['generatexml'] ) {
106 $wgParser->startExternalParse( $titleObj, $options, Parser
::OT_PREPROCESS
);
107 $dom = $wgParser->preprocessToDom( $params['text'] );
108 if ( is_callable( [ $dom, 'saveXML' ] ) ) {
109 $xml = $dom->saveXML();
111 $xml = $dom->__toString();
113 if ( isset( $prop['parsetree'] ) ) {
114 unset( $prop['parsetree'] );
115 $retval['parsetree'] = $xml;
118 $result->addValue( null, 'parsetree', $xml );
119 $result->addValue( null, ApiResult
::META_BC_SUBELEMENTS
, [ 'parsetree' ] );
123 // if they didn't want any output except (probably) the parse tree,
124 // then don't bother actually fully expanding it
125 if ( $prop ||
$params['prop'] === null ) {
126 $wgParser->startExternalParse( $titleObj, $options, Parser
::OT_PREPROCESS
);
127 $frame = $wgParser->getPreprocessor()->newFrame();
128 $wikitext = $wgParser->preprocess( $params['text'], $titleObj, $options, $revid, $frame );
129 if ( $params['prop'] === null ) {
131 ApiResult
::setContentValue( $retval, 'wikitext', $wikitext );
133 $p_output = $wgParser->getOutput();
134 if ( isset( $prop['categories'] ) ) {
135 $categories = $p_output->getCategories();
137 $categories_result = [];
138 foreach ( $categories as $category => $sortkey ) {
140 $entry['sortkey'] = $sortkey;
141 ApiResult
::setContentValue( $entry, 'category', (string)$category );
142 $categories_result[] = $entry;
144 ApiResult
::setIndexedTagName( $categories_result, 'category' );
145 $retval['categories'] = $categories_result;
148 if ( isset( $prop['properties'] ) ) {
149 $properties = $p_output->getProperties();
151 ApiResult
::setArrayType( $properties, 'BCkvp', 'name' );
152 ApiResult
::setIndexedTagName( $properties, 'property' );
153 $retval['properties'] = $properties;
156 if ( isset( $prop['volatile'] ) ) {
157 $retval['volatile'] = $frame->isVolatile();
159 if ( isset( $prop['ttl'] ) && $frame->getTTL() !== null ) {
160 $retval['ttl'] = $frame->getTTL();
162 if ( isset( $prop['wikitext'] ) ) {
163 $retval['wikitext'] = $wikitext;
165 if ( isset( $prop['modules'] ) ) {
166 $retval['modules'] = array_values( array_unique( $p_output->getModules() ) );
167 $retval['modulescripts'] = array_values( array_unique( $p_output->getModuleScripts() ) );
168 $retval['modulestyles'] = array_values( array_unique( $p_output->getModuleStyles() ) );
170 if ( isset( $prop['jsconfigvars'] ) ) {
171 $retval['jsconfigvars'] =
172 ApiResult
::addMetadataToResultVars( $p_output->getJsConfigVars() );
174 if ( isset( $prop['encodedjsconfigvars'] ) ) {
175 $retval['encodedjsconfigvars'] = FormatJson
::encode(
176 $p_output->getJsConfigVars(), false, FormatJson
::ALL_OK
178 $retval[ApiResult
::META_SUBELEMENTS
][] = 'encodedjsconfigvars';
180 if ( isset( $prop['modules'] ) &&
181 !isset( $prop['jsconfigvars'] ) && !isset( $prop['encodedjsconfigvars'] ) ) {
182 $this->addWarning( 'apiwarn-moduleswithoutvars' );
186 ApiResult
::setSubelementsList( $retval, [ 'wikitext', 'parsetree' ] );
187 $result->addValue( null, $this->getModuleName(), $retval );
190 public function getAllowedParams() {
194 ApiBase
::PARAM_TYPE
=> 'text',
195 ApiBase
::PARAM_REQUIRED
=> true,
198 ApiBase
::PARAM_TYPE
=> 'integer',
201 ApiBase
::PARAM_TYPE
=> [
209 'encodedjsconfigvars',
212 ApiBase
::PARAM_ISMULTI
=> true,
213 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [],
215 'includecomments' => false,
217 ApiBase
::PARAM_TYPE
=> 'boolean',
218 ApiBase
::PARAM_DEPRECATED
=> true,
223 protected function getExamplesMessages() {
225 'action=expandtemplates&text={{Project:Sandbox}}'
226 => 'apihelp-expandtemplates-example-simple',
230 public function getHelpUrls() {
231 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Parsing_wikitext#expandtemplates';