MediaWiki  1.28.1
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 
60  $request = $this->getRequest();
61  $titleStr = $request->getText( 'wpContextTitle' );
62  $title = Title::newFromText( $titleStr );
63 
64  if ( !$title ) {
65  $title = $this->getPageTitle();
66  }
67  $input = $request->getText( 'wpInput' );
68  $this->generateXML = $request->getBool( 'wpGenerateXml' );
69  $this->generateRawHtml = $request->getBool( 'wpGenerateRawHtml' );
70 
71  if ( strlen( $input ) ) {
72  $this->removeComments = $request->getBool( 'wpRemoveComments', false );
73  $this->removeNowiki = $request->getBool( 'wpRemoveNowiki', false );
75  $options->setRemoveComments( $this->removeComments );
76  $options->setTidy( true );
77  $options->setMaxIncludeSize( self::MAX_INCLUDE_SIZE );
78 
79  if ( $this->generateXML ) {
80  $wgParser->startExternalParse( $title, $options, Parser::OT_PREPROCESS );
81  $dom = $wgParser->preprocessToDom( $input );
82 
83  if ( method_exists( $dom, 'saveXML' ) ) {
84  $xml = $dom->saveXML();
85  } else {
86  $xml = $dom->__toString();
87  }
88  }
89 
90  $output = $wgParser->preprocess( $input, $title, $options );
91  } else {
92  $this->removeComments = $request->getBool( 'wpRemoveComments', true );
93  $this->removeNowiki = $request->getBool( 'wpRemoveNowiki', false );
94  $output = false;
95  }
96 
97  $out = $this->getOutput();
98 
99  $this->makeForm( $titleStr, $input );
100 
101  if ( $output !== false ) {
102  if ( $this->generateXML && strlen( $output ) > 0 ) {
103  $out->addHTML( $this->makeOutput( $xml, 'expand_templates_xml_output' ) );
104  }
105 
106  $tmp = $this->makeOutput( $output );
107 
108  if ( $this->removeNowiki ) {
109  $tmp = preg_replace(
110  [ '_&lt;nowiki&gt;_', '_&lt;/nowiki&gt;_', '_&lt;nowiki */&gt;_' ],
111  '',
112  $tmp
113  );
114  }
115 
116  $config = $this->getConfig();
117  if ( $config->get( 'UseTidy' ) && $options->getTidy() ) {
118  $tmp = MWTidy::tidy( $tmp );
119  }
120 
121  $out->addHTML( $tmp );
122 
123  $pout = $this->generateHtml( $title, $output );
124  $rawhtml = $pout->getText();
125  if ( $this->generateRawHtml && strlen( $rawhtml ) > 0 ) {
126  $out->addHTML( $this->makeOutput( $rawhtml, 'expand_templates_html_output' ) );
127  }
128 
129  $this->showHtmlPreview( $title, $pout, $out );
130  }
131  }
132 
141  public function onSubmitInput( array $values ) {
143  if ( !strlen( $values['input'] ) ) {
144  $status = Status::newFatal( 'expand_templates_input_missing' );
145  }
146  return $status;
147  }
148 
156  private function makeForm( $title, $input ) {
157  $fields = [
158  'contexttitle' => [
159  'type' => 'text',
160  'label' => $this->msg( 'expand_templates_title' )->plain(),
161  'name' => 'wpContextTitle',
162  'id' => 'contexttitle',
163  'size' => 60,
164  'default' => $title,
165  'autofocus' => true,
166  'cssclass' => 'mw-ui-input-inline',
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  ],
176  'removecomments' => [
177  'type' => 'check',
178  'label' => $this->msg( 'expand_templates_remove_comments' )->text(),
179  'name' => 'wpRemoveComments',
180  'id' => 'removecomments',
181  'default' => $this->removeComments,
182  ],
183  'removenowiki' => [
184  'type' => 'check',
185  'label' => $this->msg( 'expand_templates_remove_nowiki' )->text(),
186  'name' => 'wpRemoveNowiki',
187  'id' => 'removenowiki',
188  'default' => $this->removeNowiki,
189  ],
190  'generate_xml' => [
191  'type' => 'check',
192  'label' => $this->msg( 'expand_templates_generate_xml' )->text(),
193  'name' => 'wpGenerateXml',
194  'id' => 'generate_xml',
195  'default' => $this->generateXML,
196  ],
197  'generate_rawhtml' => [
198  'type' => 'check',
199  'label' => $this->msg( 'expand_templates_generate_rawhtml' )->text(),
200  'name' => 'wpGenerateRawHtml',
201  'id' => 'generate_rawhtml',
202  'default' => $this->generateRawHtml,
203  ],
204  ];
205 
206  $form = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
207  $form
208  ->setSubmitTextMsg( 'expand_templates_ok' )
209  ->setWrapperLegendMsg( 'expandtemplates' )
210  ->setHeaderText( $this->msg( 'expand_templates_intro' )->parse() )
211  ->setSubmitCallback( [ $this, 'onSubmitInput' ] )
212  ->showAlways();
213  }
214 
222  private function makeOutput( $output, $heading = 'expand_templates_output' ) {
223  $out = "<h2>" . $this->msg( $heading )->escaped() . "</h2>\n";
224  $out .= Xml::textarea(
225  'output',
226  $output,
227  10,
228  10,
229  [ 'id' => 'output', 'readonly' => 'readonly' ]
230  );
231 
232  return $out;
233  }
234 
242  private function generateHtml( Title $title, $text ) {
244 
245  $popts = ParserOptions::newFromContext( $this->getContext() );
246  $popts->setTargetLanguage( $title->getPageLanguage() );
247  return $wgParser->parse( $text, $title, $popts );
248  }
249 
257  private function showHtmlPreview( Title $title, ParserOutput $pout, OutputPage $out ) {
258  $lang = $title->getPageViewLanguage();
259  $out->addHTML( "<h2>" . $this->msg( 'expand_templates_preview' )->escaped() . "</h2>\n" );
260 
261  if ( $this->getConfig()->get( 'RawHtml' ) ) {
262  $request = $this->getRequest();
263  $user = $this->getUser();
264 
265  // To prevent cross-site scripting attacks, don't show the preview if raw HTML is
266  // allowed and a valid edit token is not provided (bug 71111). However, MediaWiki
267  // does not currently provide logged-out users with CSRF protection; in that case,
268  // do not show the preview unless anonymous editing is allowed.
269  if ( $user->isAnon() && !$user->isAllowed( 'edit' ) ) {
270  $error = [ 'expand_templates_preview_fail_html_anon' ];
271  } elseif ( !$user->matchEditToken( $request->getVal( 'wpEditToken' ), '', $request ) ) {
272  $error = [ 'expand_templates_preview_fail_html' ];
273  } else {
274  $error = false;
275  }
276 
277  if ( $error ) {
278  $out->wrapWikiMsg( "<div class='previewnote'>\n$1\n</div>", $error );
279  return;
280  }
281  }
282 
283  $out->addHTML( Html::openElement( 'div', [
284  'class' => 'mw-content-' . $lang->getDir(),
285  'dir' => $lang->getDir(),
286  'lang' => $lang->getHtmlCode(),
287  ] ) );
288  $out->addParserOutputContent( $pout );
289  $out->addHTML( Html::closeElement( 'div' ) );
290  $out->setCategoryLinks( $pout->getCategories() );
291  }
292 
293  protected function getGroupName() {
294  return 'wiki';
295  }
296 }
static closeElement($element)
Returns "".
Definition: Html.php:305
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:802
the array() calling protocol came about after MediaWiki 1.4rc1.
getContext()
Gets the context this SpecialPage is executed in.
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:63
static tidy($text)
Interface with html tidy.
Definition: MWTidy.php:46
$wgParser
Definition: Setup.php:821
bool $generateXML
Whether or not to show the XML parse tree.
execute($subpage)
Show the special page.
if(!isset($args[0])) $lang
static factory($displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:275
msg()
Wrapper around wfMessage that sets the current context.
addParserOutputContent($parserOutput)
Add the HTML and enhancements for it (like ResourceLoader modules) associated with a ParserOutput obj...
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:262
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.
const OT_PREPROCESS
Definition: Parser.php:112
Parent class for all special pages.
Definition: SpecialPage.php:36
static openElement($element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:247
A special page that expands submitted templates, parser functions, and variables, allowing easier deb...
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1046
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.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
static newGood($value=null)
Factory function for good results.
Definition: StatusValue.php:76
This class should be covered by a general architecture document which does not exist as of January 20...
Definition: OutputPage.php:43
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:242
generateHtml(Title $title, $text)
Renders the supplied wikitext as html.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object & $output
Definition: hooks.txt:1046
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:4740
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2573
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:604
getPageLanguage()
Get the language in which the content of this page is written in wikitext.
Definition: Title.php:4702
getConfig()
Shortcut to get main config object.
bool $removeComments
Whether or not to remove comments in the expanded wikitext.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
wrapWikiMsg($wrap)
This function takes a number of message/argument specifications, wraps them in some overall structure...
getRequest()
Get the WebRequest being used for this instance.
makeForm($title, $input)
Generate a form allowing users to enter information.
getPageTitle($subpage=false)
Get a self-referential title object.