3 * Implements Special:ExpandTemplates
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
25 * A special page that expands submitted templates, parser functions,
26 * and variables, allowing easier debugging of these.
28 * @ingroup SpecialPage
30 class SpecialExpandTemplates
extends SpecialPage
{
32 /** @var bool Whether or not to show the XML parse tree */
33 protected $generateXML;
35 /** @var bool Whether or not to show the raw HTML code */
36 protected $generateRawHtml;
38 /** @var bool Whether or not to remove comments in the expanded wikitext */
39 protected $removeComments;
41 /** @var bool Whether or not to remove <nowiki> tags in the expanded wikitext */
42 protected $removeNowiki;
44 /** @var int Maximum size in bytes to include. 50MB allows fixing those huge pages */
45 const MAX_INCLUDE_SIZE
= 50000000;
47 function __construct() {
48 parent
::__construct( 'ExpandTemplates' );
52 * Show the special page
53 * @param string|null $subpage
55 function execute( $subpage ) {
59 $this->addHelpLink( 'Help:ExpandTemplates' );
61 $request = $this->getRequest();
62 $titleStr = $request->getText( 'wpContextTitle' );
63 $title = Title
::newFromText( $titleStr );
66 $title = $this->getPageTitle();
68 $input = $request->getText( 'wpInput' );
69 $this->generateXML
= $request->getBool( 'wpGenerateXml' );
70 $this->generateRawHtml
= $request->getBool( 'wpGenerateRawHtml' );
72 if ( strlen( $input ) ) {
73 $this->removeComments
= $request->getBool( 'wpRemoveComments', false );
74 $this->removeNowiki
= $request->getBool( 'wpRemoveNowiki', false );
75 $options = ParserOptions
::newFromContext( $this->getContext() );
76 $options->setRemoveComments( $this->removeComments
);
77 $options->setTidy( true );
78 $options->setMaxIncludeSize( self
::MAX_INCLUDE_SIZE
);
80 if ( $this->generateXML
) {
81 $wgParser->startExternalParse( $title, $options, Parser
::OT_PREPROCESS
);
82 $dom = $wgParser->preprocessToDom( $input );
84 if ( method_exists( $dom, 'saveXML' ) ) {
85 $xml = $dom->saveXML();
87 $xml = $dom->__toString();
91 $output = $wgParser->preprocess( $input, $title, $options );
93 $this->removeComments
= $request->getBool( 'wpRemoveComments', true );
94 $this->removeNowiki
= $request->getBool( 'wpRemoveNowiki', false );
98 $out = $this->getOutput();
100 $this->makeForm( $titleStr, $input );
102 if ( $output !== false ) {
103 if ( $this->generateXML
&& strlen( $output ) > 0 ) {
104 $out->addHTML( $this->makeOutput( $xml, 'expand_templates_xml_output' ) );
107 $tmp = $this->makeOutput( $output );
109 if ( $this->removeNowiki
) {
111 [ '_<nowiki>_', '_</nowiki>_', '_<nowiki */>_' ],
117 $config = $this->getConfig();
118 if ( MWTidy
::isEnabled() && $options->getTidy() ) {
119 $tmp = MWTidy
::tidy( $tmp );
121 wfDeprecated( 'disabling tidy', '1.33' );
124 $out->addHTML( $tmp );
126 $pout = $this->generateHtml( $title, $output );
127 $rawhtml = $pout->getText();
128 if ( $this->generateRawHtml
&& strlen( $rawhtml ) > 0 ) {
129 $out->addHTML( $this->makeOutput( $rawhtml, 'expand_templates_html_output' ) );
132 $this->showHtmlPreview( $title, $pout, $out );
137 * Callback for the HTMLForm used in self::makeForm.
138 * Checks, if the input was given, and if not, returns a fatal Status
139 * object with an error message.
141 * @param array $values The values submitted to the HTMLForm
144 public function onSubmitInput( array $values ) {
145 $status = Status
::newGood();
146 if ( !strlen( $values['input'] ) ) {
147 $status = Status
::newFatal( 'expand_templates_input_missing' );
153 * Generate a form allowing users to enter information
155 * @param string $title Value for context title field
156 * @param string $input Value for input textbox
159 private function makeForm( $title, $input ) {
163 'label' => $this->msg( 'expand_templates_title' )->plain(),
164 'name' => 'wpContextTitle',
165 'id' => 'contexttitle',
171 'type' => 'textarea',
173 'label' => $this->msg( 'expand_templates_input' )->text(),
177 'useeditfont' => true,
179 'removecomments' => [
181 'label' => $this->msg( 'expand_templates_remove_comments' )->text(),
182 'name' => 'wpRemoveComments',
183 'id' => 'removecomments',
184 'default' => $this->removeComments
,
188 'label' => $this->msg( 'expand_templates_remove_nowiki' )->text(),
189 'name' => 'wpRemoveNowiki',
190 'id' => 'removenowiki',
191 'default' => $this->removeNowiki
,
195 'label' => $this->msg( 'expand_templates_generate_xml' )->text(),
196 'name' => 'wpGenerateXml',
197 'id' => 'generate_xml',
198 'default' => $this->generateXML
,
200 'generate_rawhtml' => [
202 'label' => $this->msg( 'expand_templates_generate_rawhtml' )->text(),
203 'name' => 'wpGenerateRawHtml',
204 'id' => 'generate_rawhtml',
205 'default' => $this->generateRawHtml
,
209 $form = HTMLForm
::factory( 'ooui', $fields, $this->getContext() );
211 ->setSubmitTextMsg( 'expand_templates_ok' )
212 ->setWrapperLegendMsg( 'expandtemplates' )
213 ->setHeaderText( $this->msg( 'expand_templates_intro' )->parse() )
214 ->setSubmitCallback( [ $this, 'onSubmitInput' ] )
219 * Generate a nice little box with a heading for output
221 * @param string $output Wiki text output
222 * @param string $heading
225 private function makeOutput( $output, $heading = 'expand_templates_output' ) {
226 $out = "<h2>" . $this->msg( $heading )->escaped() . "</h2>\n";
227 $out .= Xml
::textarea(
234 'readonly' => 'readonly',
235 'class' => 'mw-editfont-' . $this->getUser()->getOption( 'editfont' )
243 * Renders the supplied wikitext as html
245 * @param Title $title
246 * @param string $text
247 * @return ParserOutput
249 private function generateHtml( Title
$title, $text ) {
252 $popts = ParserOptions
::newFromContext( $this->getContext() );
253 $popts->setTargetLanguage( $title->getPageLanguage() );
254 return $wgParser->parse( $text, $title, $popts );
258 * Wraps the provided html code in a div and outputs it to the page
260 * @param Title $title
261 * @param ParserOutput $pout
262 * @param OutputPage $out
264 private function showHtmlPreview( Title
$title, ParserOutput
$pout, OutputPage
$out ) {
265 $lang = $title->getPageViewLanguage();
266 $out->addHTML( "<h2>" . $this->msg( 'expand_templates_preview' )->escaped() . "</h2>\n" );
268 if ( $this->getConfig()->get( 'RawHtml' ) ) {
269 $request = $this->getRequest();
270 $user = $this->getUser();
272 // To prevent cross-site scripting attacks, don't show the preview if raw HTML is
273 // allowed and a valid edit token is not provided (T73111). However, MediaWiki
274 // does not currently provide logged-out users with CSRF protection; in that case,
275 // do not show the preview unless anonymous editing is allowed.
276 if ( $user->isAnon() && !$user->isAllowed( 'edit' ) ) {
277 $error = [ 'expand_templates_preview_fail_html_anon' ];
278 } elseif ( !$user->matchEditToken( $request->getVal( 'wpEditToken' ), '', $request ) ) {
279 $error = [ 'expand_templates_preview_fail_html' ];
285 $out->wrapWikiMsg( "<div class='previewnote'>\n$1\n</div>", $error );
290 $out->addHTML( Html
::openElement( 'div', [
291 'class' => 'mw-content-' . $lang->getDir(),
292 'dir' => $lang->getDir(),
293 'lang' => $lang->getHtmlCode(),
295 $out->addParserOutputContent( $pout );
296 $out->addHTML( Html
::closeElement( 'div' ) );
297 $out->setCategoryLinks( $pout->getCategories() );
300 protected function getGroupName() {