MediaWiki REL1_32
ApiExpandTemplates.php
Go to the documentation of this file.
1<?php
24
33
34 public function execute() {
35 // Cache may vary on the user because ParserOptions gets data from it
36 $this->getMain()->setCacheMode( 'anon-public-user-private' );
37
38 // Get parameters
40 $this->requireMaxOneParameter( $params, 'prop', 'generatexml' );
41
42 $title = $params['title'];
43 if ( $title === null ) {
44 $titleProvided = false;
45 // A title is needed for parsing, so arbitrarily choose one
46 $title = 'API';
47 } else {
48 $titleProvided = true;
49 }
50
51 if ( $params['prop'] === null ) {
52 $this->addDeprecation(
53 [ 'apiwarn-deprecation-missingparam', 'prop' ], 'action=expandtemplates&!prop'
54 );
55 $prop = [];
56 } else {
57 $prop = array_flip( $params['prop'] );
58 }
59
60 $titleObj = Title::newFromText( $title );
61 if ( !$titleObj || $titleObj->isExternal() ) {
62 $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $params['title'] ) ] );
63 }
64
65 // Get title and revision ID for parser
66 $revid = $params['revid'];
67 if ( $revid !== null ) {
68 $rev = MediaWikiServices::getInstance()->getRevisionStore()->getRevisionById( $revid );
69 if ( !$rev ) {
70 $this->dieWithError( [ 'apierror-nosuchrevid', $revid ] );
71 }
72 $pTitleObj = $titleObj;
73 $titleObj = Title::newFromLinkTarget( $rev->getPageAsLinkTarget() );
74 if ( $titleProvided ) {
75 if ( !$titleObj->equals( $pTitleObj ) ) {
76 $this->addWarning( [ 'apierror-revwrongpage', $rev->getId(),
77 wfEscapeWikiText( $pTitleObj->getPrefixedText() ) ] );
78 }
79 } else {
80 // Consider the title derived from the revid as having
81 // been provided.
82 $titleProvided = true;
83 }
84 }
85
86 $result = $this->getResult();
87
88 // Parse text
89 global $wgParser;
90 $options = ParserOptions::newFromContext( $this->getContext() );
91
92 if ( $params['includecomments'] ) {
93 $options->setRemoveComments( false );
94 }
95
96 $reset = null;
97 $suppressCache = false;
98 Hooks::run( 'ApiMakeParserOptions',
99 [ $options, $titleObj, $params, $this, &$reset, &$suppressCache ] );
100
101 $retval = [];
102
103 if ( isset( $prop['parsetree'] ) || $params['generatexml'] ) {
104 $wgParser->startExternalParse( $titleObj, $options, Parser::OT_PREPROCESS );
105 $dom = $wgParser->preprocessToDom( $params['text'] );
106 if ( is_callable( [ $dom, 'saveXML' ] ) ) {
107 $xml = $dom->saveXML();
108 } else {
109 $xml = $dom->__toString();
110 }
111 if ( isset( $prop['parsetree'] ) ) {
112 unset( $prop['parsetree'] );
113 $retval['parsetree'] = $xml;
114 } else {
115 // the old way
116 $result->addValue( null, 'parsetree', $xml );
117 $result->addValue( null, ApiResult::META_BC_SUBELEMENTS, [ 'parsetree' ] );
118 }
119 }
120
121 // if they didn't want any output except (probably) the parse tree,
122 // then don't bother actually fully expanding it
123 if ( $prop || $params['prop'] === null ) {
124 $wgParser->startExternalParse( $titleObj, $options, Parser::OT_PREPROCESS );
125 $frame = $wgParser->getPreprocessor()->newFrame();
126 $wikitext = $wgParser->preprocess( $params['text'], $titleObj, $options, $revid, $frame );
127 if ( $params['prop'] === null ) {
128 // the old way
129 ApiResult::setContentValue( $retval, 'wikitext', $wikitext );
130 } else {
131 $p_output = $wgParser->getOutput();
132 if ( isset( $prop['categories'] ) ) {
133 $categories = $p_output->getCategories();
134 if ( $categories ) {
135 $categories_result = [];
136 foreach ( $categories as $category => $sortkey ) {
137 $entry = [];
138 $entry['sortkey'] = $sortkey;
139 ApiResult::setContentValue( $entry, 'category', (string)$category );
140 $categories_result[] = $entry;
141 }
142 ApiResult::setIndexedTagName( $categories_result, 'category' );
143 $retval['categories'] = $categories_result;
144 }
145 }
146 if ( isset( $prop['properties'] ) ) {
147 $properties = $p_output->getProperties();
148 if ( $properties ) {
149 ApiResult::setArrayType( $properties, 'BCkvp', 'name' );
150 ApiResult::setIndexedTagName( $properties, 'property' );
151 $retval['properties'] = $properties;
152 }
153 }
154 if ( isset( $prop['volatile'] ) ) {
155 $retval['volatile'] = $frame->isVolatile();
156 }
157 if ( isset( $prop['ttl'] ) && $frame->getTTL() !== null ) {
158 $retval['ttl'] = $frame->getTTL();
159 }
160 if ( isset( $prop['wikitext'] ) ) {
161 $retval['wikitext'] = $wikitext;
162 }
163 if ( isset( $prop['modules'] ) ) {
164 $retval['modules'] = array_values( array_unique( $p_output->getModules() ) );
165 $retval['modulescripts'] = array_values( array_unique( $p_output->getModuleScripts() ) );
166 $retval['modulestyles'] = array_values( array_unique( $p_output->getModuleStyles() ) );
167 }
168 if ( isset( $prop['jsconfigvars'] ) ) {
169 $retval['jsconfigvars'] =
170 ApiResult::addMetadataToResultVars( $p_output->getJsConfigVars() );
171 }
172 if ( isset( $prop['encodedjsconfigvars'] ) ) {
173 $retval['encodedjsconfigvars'] = FormatJson::encode(
174 $p_output->getJsConfigVars(), false, FormatJson::ALL_OK
175 );
176 $retval[ApiResult::META_SUBELEMENTS][] = 'encodedjsconfigvars';
177 }
178 if ( isset( $prop['modules'] ) &&
179 !isset( $prop['jsconfigvars'] ) && !isset( $prop['encodedjsconfigvars'] ) ) {
180 $this->addWarning( 'apiwarn-moduleswithoutvars' );
181 }
182 }
183 }
184 ApiResult::setSubelementsList( $retval, [ 'wikitext', 'parsetree' ] );
185 $result->addValue( null, $this->getModuleName(), $retval );
186 }
187
188 public function getAllowedParams() {
189 return [
190 'title' => null,
191 'text' => [
192 ApiBase::PARAM_TYPE => 'text',
194 ],
195 'revid' => [
196 ApiBase::PARAM_TYPE => 'integer',
197 ],
198 'prop' => [
200 'wikitext',
201 'categories',
202 'properties',
203 'volatile',
204 'ttl',
205 'modules',
206 'jsconfigvars',
207 'encodedjsconfigvars',
208 'parsetree',
209 ],
212 ],
213 'includecomments' => false,
214 'generatexml' => [
215 ApiBase::PARAM_TYPE => 'boolean',
217 ],
218 ];
219 }
220
221 protected function getExamplesMessages() {
222 return [
223 'action=expandtemplates&text={{Project:Sandbox}}'
224 => 'apihelp-expandtemplates-example-simple',
225 ];
226 }
227
228 public function getHelpUrls() {
229 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Parsing_wikitext#expandtemplates';
230 }
231}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
$wgParser
Definition Setup.php:921
This abstract class implements many basic API functions, and is the base of all API classes.
Definition ApiBase.php:37
const PARAM_REQUIRED
(boolean) Is the parameter required?
Definition ApiBase.php:111
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition ApiBase.php:105
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:1987
getMain()
Get the main module.
Definition ApiBase.php:555
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:87
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition ApiBase.php:157
addDeprecation( $msg, $feature, $data=[])
Add a deprecation warning for this module.
Definition ApiBase.php:1920
getResult()
Get the result object.
Definition ApiBase.php:659
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:770
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition ApiBase.php:939
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition ApiBase.php:1906
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:539
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:51
API module that functions as a shortcut to the wikitext preprocessor.
getExamplesMessages()
Returns usage examples for this module.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
getHelpUrls()
Return links to more detailed help pages about the module.
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
static addMetadataToResultVars( $vars, $forceHash=true)
Add the correct metadata to an array of vars we want to export through the API.
const META_SUBELEMENTS
Key for the 'subelements' metadata item.
Definition ApiResult.php:78
static setSubelementsList(array &$arr, $names)
Causes the elements with the specified names to be output as subelements rather than attributes.
const META_BC_SUBELEMENTS
Key for the 'BC subelements' metadata item.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
getContext()
Get the base IContextSource object.
MediaWikiServices is the service locator for the application scope of MediaWiki.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED since 1.16! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:2042
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account incomplete not yet checked for validity & $retval
Definition hooks.txt:266
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition hooks.txt:2050
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:994
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition hooks.txt:1818
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
$params