MediaWiki  master
SpecialExpandTemplates.php
Go to the documentation of this file.
1 <?php
31 
33  protected $generateXML;
34 
36  protected $generateRawHtml;
37 
39  protected $removeComments;
40 
42  protected $removeNowiki;
43 
45  const MAX_INCLUDE_SIZE = 50000000;
46 
47  function __construct() {
48  parent::__construct( 'ExpandTemplates' );
49  }
50 
55  function execute( $subpage ) {
57 
58  $this->setHeaders();
59  $this->addHelpLink( 'Help:ExpandTemplates' );
60 
61  $request = $this->getRequest();
62  $titleStr = $request->getText( 'wpContextTitle' );
63  $title = Title::newFromText( $titleStr );
64 
65  if ( !$title ) {
66  $title = $this->getPageTitle();
67  }
68  $input = $request->getText( 'wpInput' );
69  $this->generateXML = $request->getBool( 'wpGenerateXml' );
70  $this->generateRawHtml = $request->getBool( 'wpGenerateRawHtml' );
71 
72  if ( strlen( $input ) ) {
73  $this->removeComments = $request->getBool( 'wpRemoveComments', false );
74  $this->removeNowiki = $request->getBool( 'wpRemoveNowiki', false );
76  $options->setRemoveComments( $this->removeComments );
77  $options->setTidy( true );
78  $options->setMaxIncludeSize( self::MAX_INCLUDE_SIZE );
79 
80  if ( $this->generateXML ) {
81  $wgParser->startExternalParse( $title, $options, Parser::OT_PREPROCESS );
82  $dom = $wgParser->preprocessToDom( $input );
83 
84  if ( method_exists( $dom, 'saveXML' ) ) {
85  $xml = $dom->saveXML();
86  } else {
87  $xml = $dom->__toString();
88  }
89  }
90 
91  $output = $wgParser->preprocess( $input, $title, $options );
92  } else {
93  $this->removeComments = $request->getBool( 'wpRemoveComments', true );
94  $this->removeNowiki = $request->getBool( 'wpRemoveNowiki', false );
95  $output = false;
96  }
97 
98  $out = $this->getOutput();
99 
100  $this->makeForm( $titleStr, $input );
101 
102  if ( $output !== false ) {
103  if ( $this->generateXML && strlen( $output ) > 0 ) {
104  $out->addHTML( $this->makeOutput( $xml, 'expand_templates_xml_output' ) );
105  }
106 
107  $tmp = $this->makeOutput( $output );
108 
109  if ( $this->removeNowiki ) {
110  $tmp = preg_replace(
111  [ '_&lt;nowiki&gt;_', '_&lt;/nowiki&gt;_', '_&lt;nowiki */&gt;_' ],
112  '',
113  $tmp
114  );
115  }
116 
117  $config = $this->getConfig();
118  if ( $config->get( 'UseTidy' ) && $options->getTidy() ) {
119  $tmp = MWTidy::tidy( $tmp );
120  }
121 
122  $out->addHTML( $tmp );
123 
124  $pout = $this->generateHtml( $title, $output );
125  $rawhtml = $pout->getText();
126  if ( $this->generateRawHtml && strlen( $rawhtml ) > 0 ) {
127  $out->addHTML( $this->makeOutput( $rawhtml, 'expand_templates_html_output' ) );
128  }
129 
130  $this->showHtmlPreview( $title, $pout, $out );
131  }
132  }
133 
142  public function onSubmitInput( array $values ) {
144  if ( !strlen( $values['input'] ) ) {
145  $status = Status::newFatal( 'expand_templates_input_missing' );
146  }
147  return $status;
148  }
149 
157  private function makeForm( $title, $input ) {
158  $fields = [
159  'contexttitle' => [
160  'type' => 'text',
161  'label' => $this->msg( 'expand_templates_title' )->plain(),
162  'name' => 'wpContextTitle',
163  'id' => 'contexttitle',
164  'size' => 60,
165  'default' => $title,
166  'autofocus' => true,
167  ],
168  'input' => [
169  'type' => 'textarea',
170  'name' => 'wpInput',
171  'label' => $this->msg( 'expand_templates_input' )->text(),
172  'rows' => 10,
173  'default' => $input,
174  'id' => 'input',
175  'useeditfont' => true,
176  ],
177  'removecomments' => [
178  'type' => 'check',
179  'label' => $this->msg( 'expand_templates_remove_comments' )->text(),
180  'name' => 'wpRemoveComments',
181  'id' => 'removecomments',
182  'default' => $this->removeComments,
183  ],
184  'removenowiki' => [
185  'type' => 'check',
186  'label' => $this->msg( 'expand_templates_remove_nowiki' )->text(),
187  'name' => 'wpRemoveNowiki',
188  'id' => 'removenowiki',
189  'default' => $this->removeNowiki,
190  ],
191  'generate_xml' => [
192  'type' => 'check',
193  'label' => $this->msg( 'expand_templates_generate_xml' )->text(),
194  'name' => 'wpGenerateXml',
195  'id' => 'generate_xml',
196  'default' => $this->generateXML,
197  ],
198  'generate_rawhtml' => [
199  'type' => 'check',
200  'label' => $this->msg( 'expand_templates_generate_rawhtml' )->text(),
201  'name' => 'wpGenerateRawHtml',
202  'id' => 'generate_rawhtml',
203  'default' => $this->generateRawHtml,
204  ],
205  ];
206 
207  $form = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
208  $form
209  ->setSubmitTextMsg( 'expand_templates_ok' )
210  ->setWrapperLegendMsg( 'expandtemplates' )
211  ->setHeaderText( $this->msg( 'expand_templates_intro' )->parse() )
212  ->setSubmitCallback( [ $this, 'onSubmitInput' ] )
213  ->showAlways();
214  }
215 
223  private function makeOutput( $output, $heading = 'expand_templates_output' ) {
224  $out = "<h2>" . $this->msg( $heading )->escaped() . "</h2>\n";
225  $out .= Xml::textarea(
226  'output',
227  $output,
228  10,
229  10,
230  [
231  'id' => 'output',
232  'readonly' => 'readonly',
233  'class' => 'mw-editfont-' . $this->getUser()->getOption( 'editfont' )
234  ]
235  );
236 
237  return $out;
238  }
239 
247  private function generateHtml( Title $title, $text ) {
249 
250  $popts = ParserOptions::newFromContext( $this->getContext() );
251  $popts->setTargetLanguage( $title->getPageLanguage() );
252  return $wgParser->parse( $text, $title, $popts );
253  }
254 
262  private function showHtmlPreview( Title $title, ParserOutput $pout, OutputPage $out ) {
263  $lang = $title->getPageViewLanguage();
264  $out->addHTML( "<h2>" . $this->msg( 'expand_templates_preview' )->escaped() . "</h2>\n" );
265 
266  if ( $this->getConfig()->get( 'RawHtml' ) ) {
267  $request = $this->getRequest();
268  $user = $this->getUser();
269 
270  // To prevent cross-site scripting attacks, don't show the preview if raw HTML is
271  // allowed and a valid edit token is not provided (T73111). However, MediaWiki
272  // does not currently provide logged-out users with CSRF protection; in that case,
273  // do not show the preview unless anonymous editing is allowed.
274  if ( $user->isAnon() && !$user->isAllowed( 'edit' ) ) {
275  $error = [ 'expand_templates_preview_fail_html_anon' ];
276  } elseif ( !$user->matchEditToken( $request->getVal( 'wpEditToken' ), '', $request ) ) {
277  $error = [ 'expand_templates_preview_fail_html' ];
278  } else {
279  $error = false;
280  }
281 
282  if ( $error ) {
283  $out->wrapWikiMsg( "<div class='previewnote'>\n$1\n</div>", $error );
284  return;
285  }
286  }
287 
288  $out->addHTML( Html::openElement( 'div', [
289  'class' => 'mw-content-' . $lang->getDir(),
290  'dir' => $lang->getDir(),
291  'lang' => $lang->getHtmlCode(),
292  ] ) );
293  $out->addParserOutputContent( $pout );
294  $out->addHTML( Html::closeElement( 'div' ) );
295  $out->setCategoryLinks( $pout->getCategories() );
296  }
297 
298  protected function getGroupName() {
299  return 'wiki';
300  }
301 }
static closeElement($element)
Returns "".
Definition: Html.php:309
static newFromContext(IContextSource $context)
Get a ParserOptions object from a IContextSource object.
addHTML($text)
Append $text to the body HTML.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:790
the array() calling protocol came about after MediaWiki 1.4rc1.
getContext()
Gets the context this SpecialPage is executed in.
if(is_array($mode)) switch($mode) $input
showHtmlPreview(Title $title, ParserOutput $pout, OutputPage $out)
Wraps the provided html code in a div and outputs it to the page.
static newFatal($message)
Factory function for fatal errors.
Definition: StatusValue.php:68
static tidy($text)
Interface with html tidy.
Definition: MWTidy.php:46
$wgParser
Definition: Setup.php:905
bool $generateXML
Whether or not to show the XML parse tree.
execute($subpage)
Show the special page.
if(!isset($args[0])) $lang
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2252
static factory($displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:283
getOutput()
Get the OutputPage being used for this instance.
onSubmitInput(array $values)
Callback for the HTMLForm used in self::makeForm.
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
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
bool $generateRawHtml
Whether or not to show the raw HTML code.
setCategoryLinks(array $categories)
Reset the category links (but not the category list) and add $categories.
addHelpLink($to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
const OT_PREPROCESS
Definition: Parser.php:113
static openElement($element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:251
A special page that expands submitted templates, parser functions, and variables, allowing easier deb...
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:2019
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
bool $removeNowiki
Whether or not to remove tags in the expanded wikitext.
addParserOutputContent($parserOutput, $poOptions=[])
Add the HTML and enhancements for it (like ResourceLoader modules) associated with a ParserOutput obj...
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:941
static newGood($value=null)
Factory function for good results.
Definition: StatusValue.php:81
msg($key)
Wrapper around wfMessage that sets the current context.
generateHtml(Title $title, $text)
Renders the supplied wikitext as html.
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:35
getPageViewLanguage()
Get the language in which the content of this page is written when viewed by user.
Definition: Title.php:5002
makeOutput($output, $heading= 'expand_templates_output')
Generate a nice little box with a heading for output.
getUser()
Shortcut to get the User executing this instance.
static textarea($name, $content, $cols=40, $rows=5, $attribs=[])
Shortcut for creating textareas.
Definition: Xml.php:636
getPageLanguage()
Get the language in which the content of this page is written in wikitext.
Definition: Title.php:4964
getConfig()
Shortcut to get main config object.
bool $removeComments
Whether or not to remove comments in the expanded wikitext.
wrapWikiMsg($wrap)
This function takes a number of message/argument specifications, wraps them in some overall structure...
Status::newGood()`to allow deletion, and then`return false`from the hook function.Ensure you consume the 'ChangeTagAfterDelete'hook to carry out custom deletion actions.$tag:name of the tag $user:user initiating the action &$status:Status object.See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use.&$tags:list of all active tags.Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function.Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change.&$allowedTags:List of all the tags the user is allowed to add.Any tags the user wants to add($addTags) that are not in this array will cause it to fail.You may add or remove tags to this array as required.$addTags:List of tags user intends to add.$user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed.$performer:The User who will perform the change $user:The User whose groups will be changed &$add:The groups that will be added &$remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation.$collationName:Name of the collation in question &$collationObject:Null.Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user's email has been confirmed successfully.$user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object.Called by Content::getParserOutput after parsing has finished.Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML).$content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput.May be used to override the normal model-specific rendering of page content.$content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering.To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state.$generateHtml:boolean, indicating whether full HTML should be generated.If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object.&$output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title.May be used to assign a different model for that title.$title:the Title in question &$model:the model name.Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers.Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core.$modeName:the requested content model name &$handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page.This is especially useful to prevent some content models to be used in some special location.$contentModel:ID of the content model in question $title:the Title in question.&$ok:Output parameter, whether it is OK to use $contentModel on $title.Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run &$pager:Pager object for contributions &$queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions &$data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions &$ret:the HTML line $row:the DB row for this line &$classes:the classes to add to the surrounding< li > &$attribs:associative array of other HTML attributes for the< li > element.Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title &$tools:Array of tool links $specialPage:SpecialPage instance for context and services.Can be either SpecialContributions or DeletedContributionsPage.Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested.Handler functions that modify $result should generally return false to disable further attempts at conversion.$content:The Content object to be converted.$toModel:The ID of the content model to convert to.$lossy:boolean indicating whether lossy conversion is allowed.&$result:Output parameter, in case the handler function wants to provide a converted Content object.Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources.This affects all directives except for the script directive.If you want to add a script source, see ContentSecurityPolicyScriptSource hook.&$defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives.Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs.&$directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources.Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add.&$scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g.for a special namespace, etc.$article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery &$data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished.Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions &$ret:the HTML line $row:the DB row for this line &$classes:the classes to add to the surrounding< li > &$attribs:associative array of other HTML attributes for the< li > element.Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about.This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process.For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion.&where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table.$db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function.$differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable's value is null.This hook can be used to inject content into said class member variable.$differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the"mark as patrolled"link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink".$differenceEngine:DifferenceEngine object &$markAsPatrolledLink:The"mark as patrolled"link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter.For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions.&$rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision's author, whether the revision was marked as a minor edit or not, etc.$differenceEngine:DifferenceEngine object &$newHeader:The string containing the various#mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1287
getRequest()
Get the WebRequest being used for this instance.
makeForm($title, $input)
Generate a form allowing users to enter information.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g.with the RejectParserCacheValue hook) because MediaWiki won't do it for you.&$defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2636
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 $user
Definition: hooks.txt:244
getPageTitle($subpage=false)
Get a self-referential title object.