MediaWiki  REL1_31
ApiExpandTemplates.php
Go to the documentation of this file.
1 <?php
30 class ApiExpandTemplates extends ApiBase {
31 
32  public function execute() {
33  // Cache may vary on the user because ParserOptions gets data from it
34  $this->getMain()->setCacheMode( 'anon-public-user-private' );
35 
36  // Get parameters
37  $params = $this->extractRequestParams();
38  $this->requireMaxOneParameter( $params, 'prop', 'generatexml' );
39 
40  $title = $params['title'];
41  if ( $title === null ) {
42  $titleProvided = false;
43  // A title is needed for parsing, so arbitrarily choose one
44  $title = 'API';
45  } else {
46  $titleProvided = true;
47  }
48 
49  if ( $params['prop'] === null ) {
50  $this->addDeprecation(
51  'apiwarn-deprecation-expandtemplates-prop', 'action=expandtemplates&!prop'
52  );
53  $prop = [];
54  } else {
55  $prop = array_flip( $params['prop'] );
56  }
57 
58  $titleObj = Title::newFromText( $title );
59  if ( !$titleObj || $titleObj->isExternal() ) {
60  $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $params['title'] ) ] );
61  }
62 
63  // Get title and revision ID for parser
64  $revid = $params['revid'];
65  if ( $revid !== null ) {
66  $rev = Revision::newFromId( $revid );
67  if ( !$rev ) {
68  $this->dieWithError( [ 'apierror-nosuchrevid', $revid ] );
69  }
70  $pTitleObj = $titleObj;
71  $titleObj = $rev->getTitle();
72  if ( $titleProvided ) {
73  if ( !$titleObj->equals( $pTitleObj ) ) {
74  $this->addWarning( [ 'apierror-revwrongpage', $rev->getId(),
75  wfEscapeWikiText( $pTitleObj->getPrefixedText() ) ] );
76  }
77  } else {
78  // Consider the title derived from the revid as having
79  // been provided.
80  $titleProvided = true;
81  }
82  }
83 
84  $result = $this->getResult();
85 
86  // Parse text
89 
90  if ( $params['includecomments'] ) {
91  $options->setRemoveComments( false );
92  }
93 
94  $reset = null;
95  $suppressCache = false;
96  Hooks::run( 'ApiMakeParserOptions',
97  [ $options, $titleObj, $params, $this, &$reset, &$suppressCache ] );
98 
99  $retval = [];
100 
101  if ( isset( $prop['parsetree'] ) || $params['generatexml'] ) {
102  $wgParser->startExternalParse( $titleObj, $options, Parser::OT_PREPROCESS );
103  $dom = $wgParser->preprocessToDom( $params['text'] );
104  if ( is_callable( [ $dom, 'saveXML' ] ) ) {
105  $xml = $dom->saveXML();
106  } else {
107  $xml = $dom->__toString();
108  }
109  if ( isset( $prop['parsetree'] ) ) {
110  unset( $prop['parsetree'] );
111  $retval['parsetree'] = $xml;
112  } else {
113  // the old way
114  $result->addValue( null, 'parsetree', $xml );
115  $result->addValue( null, ApiResult::META_BC_SUBELEMENTS, [ 'parsetree' ] );
116  }
117  }
118 
119  // if they didn't want any output except (probably) the parse tree,
120  // then don't bother actually fully expanding it
121  if ( $prop || $params['prop'] === null ) {
122  $wgParser->startExternalParse( $titleObj, $options, Parser::OT_PREPROCESS );
123  $frame = $wgParser->getPreprocessor()->newFrame();
124  $wikitext = $wgParser->preprocess( $params['text'], $titleObj, $options, $revid, $frame );
125  if ( $params['prop'] === null ) {
126  // the old way
127  ApiResult::setContentValue( $retval, 'wikitext', $wikitext );
128  } else {
129  $p_output = $wgParser->getOutput();
130  if ( isset( $prop['categories'] ) ) {
131  $categories = $p_output->getCategories();
132  if ( $categories ) {
133  $categories_result = [];
134  foreach ( $categories as $category => $sortkey ) {
135  $entry = [];
136  $entry['sortkey'] = $sortkey;
137  ApiResult::setContentValue( $entry, 'category', (string)$category );
138  $categories_result[] = $entry;
139  }
140  ApiResult::setIndexedTagName( $categories_result, 'category' );
141  $retval['categories'] = $categories_result;
142  }
143  }
144  if ( isset( $prop['properties'] ) ) {
145  $properties = $p_output->getProperties();
146  if ( $properties ) {
147  ApiResult::setArrayType( $properties, 'BCkvp', 'name' );
148  ApiResult::setIndexedTagName( $properties, 'property' );
149  $retval['properties'] = $properties;
150  }
151  }
152  if ( isset( $prop['volatile'] ) ) {
153  $retval['volatile'] = $frame->isVolatile();
154  }
155  if ( isset( $prop['ttl'] ) && $frame->getTTL() !== null ) {
156  $retval['ttl'] = $frame->getTTL();
157  }
158  if ( isset( $prop['wikitext'] ) ) {
159  $retval['wikitext'] = $wikitext;
160  }
161  if ( isset( $prop['modules'] ) ) {
162  $retval['modules'] = array_values( array_unique( $p_output->getModules() ) );
163  $retval['modulescripts'] = array_values( array_unique( $p_output->getModuleScripts() ) );
164  $retval['modulestyles'] = array_values( array_unique( $p_output->getModuleStyles() ) );
165  }
166  if ( isset( $prop['jsconfigvars'] ) ) {
167  $retval['jsconfigvars'] =
168  ApiResult::addMetadataToResultVars( $p_output->getJsConfigVars() );
169  }
170  if ( isset( $prop['encodedjsconfigvars'] ) ) {
171  $retval['encodedjsconfigvars'] = FormatJson::encode(
172  $p_output->getJsConfigVars(), false, FormatJson::ALL_OK
173  );
174  $retval[ApiResult::META_SUBELEMENTS][] = 'encodedjsconfigvars';
175  }
176  if ( isset( $prop['modules'] ) &&
177  !isset( $prop['jsconfigvars'] ) && !isset( $prop['encodedjsconfigvars'] ) ) {
178  $this->addWarning( 'apiwarn-moduleswithoutvars' );
179  }
180  }
181  }
182  ApiResult::setSubelementsList( $retval, [ 'wikitext', 'parsetree' ] );
183  $result->addValue( null, $this->getModuleName(), $retval );
184  }
185 
186  public function getAllowedParams() {
187  return [
188  'title' => null,
189  'text' => [
190  ApiBase::PARAM_TYPE => 'text',
191  ApiBase::PARAM_REQUIRED => true,
192  ],
193  'revid' => [
194  ApiBase::PARAM_TYPE => 'integer',
195  ],
196  'prop' => [
198  'wikitext',
199  'categories',
200  'properties',
201  'volatile',
202  'ttl',
203  'modules',
204  'jsconfigvars',
205  'encodedjsconfigvars',
206  'parsetree',
207  ],
208  ApiBase::PARAM_ISMULTI => true,
210  ],
211  'includecomments' => false,
212  'generatexml' => [
213  ApiBase::PARAM_TYPE => 'boolean',
215  ],
216  ];
217  }
218 
219  protected function getExamplesMessages() {
220  return [
221  'action=expandtemplates&text={{Project:Sandbox}}'
222  => 'apihelp-expandtemplates-example-simple',
223  ];
224  }
225 
226  public function getHelpUrls() {
227  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Parsing_wikitext#expandtemplates';
228  }
229 }
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:273
ContextSource\getContext
getContext()
Get the base IContextSource object.
Definition: ContextSource.php:40
ApiBase\addWarning
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition: ApiBase.php:1819
Revision\newFromId
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:114
ApiBase\PARAM_REQUIRED
const PARAM_REQUIRED
(boolean) Is the parameter required?
Definition: ApiBase.php:111
$wgParser
$wgParser
Definition: Setup.php:917
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1895
ApiResult\META_BC_SUBELEMENTS
const META_BC_SUBELEMENTS
Key for the 'BC subelements' metadata item.
Definition: ApiResult.php:141
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:87
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:641
$params
$params
Definition: styleTest.css.php:40
$result
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! 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! 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:1993
FormatJson\ALL_OK
const ALL_OK
Skip escaping as many characters as reasonably possible.
Definition: FormatJson.php:55
php
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
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:37
ApiResult\setContentValue
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
Definition: ApiResult.php:478
ApiBase\PARAM_DEPRECATED
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition: ApiBase.php:105
FormatJson\encode
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:127
ApiResult\setArrayType
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
Definition: ApiResult.php:728
ApiExpandTemplates\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiExpandTemplates.php:186
ApiResult\addMetadataToResultVars
static addMetadataToResultVars( $vars, $forceHash=true)
Add the correct metadata to an array of vars we want to export through the API.
Definition: ApiResult.php:1152
ApiResult\META_SUBELEMENTS
const META_SUBELEMENTS
Key for the 'subelements' metadata item.
Definition: ApiResult.php:76
ApiExpandTemplates\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiExpandTemplates.php:226
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
$options
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:2001
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:749
ApiResult\setIndexedTagName
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
ParserOptions\newFromContext
static newFromContext(IContextSource $context)
Get a ParserOptions object from a IContextSource object.
Definition: ParserOptions.php:1005
ApiBase\addDeprecation
addDeprecation( $msg, $feature, $data=[])
Add a deprecation warning for this module.
Definition: ApiBase.php:1833
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1643
ApiBase\requireMaxOneParameter
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:823
Parser\OT_PREPROCESS
const OT_PREPROCESS
Definition: Parser.php:113
$rev
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:1777
ApiExpandTemplates
API module that functions as a shortcut to the wikitext preprocessor.
Definition: ApiExpandTemplates.php:30
ApiExpandTemplates\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiExpandTemplates.php:32
as
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
Definition: distributors.txt:22
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:521
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:51
ApiBase\getMain
getMain()
Get the main module.
Definition: ApiBase.php:537
ApiBase\PARAM_HELP_MSG_PER_VALUE
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
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
$retval
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 account incomplete not yet checked for validity & $retval
Definition: hooks.txt:266
ApiResult\setSubelementsList
static setSubelementsList(array &$arr, $names)
Causes the elements with the specified names to be output as subelements rather than attributes.
Definition: ApiResult.php:565
ApiExpandTemplates\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiExpandTemplates.php:219