includes/specials/SpecialExpandTemplates.php

   1 <?php
   2 /**
   3  * Implements Special:ExpandTemplates
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 /**
  25  * A special page that expands submitted templates, parser functions,
  26  * and variables, allowing easier debugging of these.
  27  *
  28  * @ingroup SpecialPage
  29  */
  30 class SpecialExpandTemplates extends SpecialPage {
  31
  32         /** @var bool Whether or not to show the XML parse tree */
  33         protected $generateXML;
  34
  35         /** @var bool Whether or not to show the raw HTML code */
  36         protected $generateRawHtml;
  37
  38         /** @var bool Whether or not to remove comments in the expanded wikitext */
  39         protected $removeComments;
  40
  41         /** @var bool Whether or not to remove <nowiki> tags in the expanded wikitext */
  42         protected $removeNowiki;
  43
  44         /** @var int Maximum size in bytes to include. 50MB allows fixing those huge pages */
  45         const MAX_INCLUDE_SIZE = 50000000;
  46
  47         function __construct() {
  48                 parent::__construct( 'ExpandTemplates' );
  49         }
  50
  51         /**
  52          * Show the special page
  53          * @param string|null $subpage
  54          */
  55         function execute( $subpage ) {
  56                 global $wgParser;
  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 );
  74                         $options = ParserOptions::newFromContext( $this->getContext() );
  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
 133         /**
 134          * Callback for the HTMLForm used in self::makeForm.
 135          * Checks, if the input was given, and if not, returns a fatal Status
 136          * object with an error message.
 137          *
 138          * @param array $values The values submitted to the HTMLForm
 139          * @return Status
 140          */
 141         public function onSubmitInput( array $values ) {
 142                 $status = Status::newGood();
 143                 if ( !strlen( $values['input'] ) ) {
 144                         $status = Status::newFatal( 'expand_templates_input_missing' );
 145                 }
 146                 return $status;
 147         }
 148
 149         /**
 150          * Generate a form allowing users to enter information
 151          *
 152          * @param string $title Value for context title field
 153          * @param string $input Value for input textbox
 154          * @return string
 155          */
 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                                 // The following classes can be used here:
 176                                 // * mw-editfont-monospace
 177                                 // * mw-editfont-sans-serif
 178                                 // * mw-editfont-serif
 179                                 'cssclass' => 'mw-editfont-' . $this->getUser()->getOption( 'editfont' ),
 180                         ],
 181                         'removecomments' => [
 182                                 'type' => 'check',
 183                                 'label' => $this->msg( 'expand_templates_remove_comments' )->text(),
 184                                 'name' => 'wpRemoveComments',
 185                                 'id' => 'removecomments',
 186                                 'default' => $this->removeComments,
 187                         ],
 188                         'removenowiki' => [
 189                                 'type' => 'check',
 190                                 'label' => $this->msg( 'expand_templates_remove_nowiki' )->text(),
 191                                 'name' => 'wpRemoveNowiki',
 192                                 'id' => 'removenowiki',
 193                                 'default' => $this->removeNowiki,
 194                         ],
 195                         'generate_xml' => [
 196                                 'type' => 'check',
 197                                 'label' => $this->msg( 'expand_templates_generate_xml' )->text(),
 198                                 'name' => 'wpGenerateXml',
 199                                 'id' => 'generate_xml',
 200                                 'default' => $this->generateXML,
 201                         ],
 202                         'generate_rawhtml' => [
 203                                 'type' => 'check',
 204                                 'label' => $this->msg( 'expand_templates_generate_rawhtml' )->text(),
 205                                 'name' => 'wpGenerateRawHtml',
 206                                 'id' => 'generate_rawhtml',
 207                                 'default' => $this->generateRawHtml,
 208                         ],
 209                 ];
 210
 211                 $this->getOutput()->addModuleStyles( 'mediawiki.editfont.styles' );
 212
 213                 $form = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
 214                 $form
 215                         ->setSubmitTextMsg( 'expand_templates_ok' )
 216                         ->setWrapperLegendMsg( 'expandtemplates' )
 217                         ->setHeaderText( $this->msg( 'expand_templates_intro' )->parse() )
 218                         ->setSubmitCallback( [ $this, 'onSubmitInput' ] )
 219                         ->showAlways();
 220         }
 221
 222         /**
 223          * Generate a nice little box with a heading for output
 224          *
 225          * @param string $output Wiki text output
 226          * @param string $heading
 227          * @return string
 228          */
 229         private function makeOutput( $output, $heading = 'expand_templates_output' ) {
 230                 $out = "<h2>" . $this->msg( $heading )->escaped() . "</h2>\n";
 231                 $out .= Xml::textarea(
 232                         'output',
 233                         $output,
 234                         10,
 235                         10,
 236                         [
 237                                 'id' => 'output',
 238                                 'readonly' => 'readonly',
 239                                 'class' => 'mw-editfont-' . $this->getUser()->getOption( 'editfont' )
 240                         ]
 241                 );
 242
 243                 return $out;
 244         }
 245
 246         /**
 247          * Renders the supplied wikitext as html
 248          *
 249          * @param Title $title
 250          * @param string $text
 251          * @return ParserOutput
 252          */
 253         private function generateHtml( Title $title, $text ) {
 254                 global $wgParser;
 255
 256                 $popts = ParserOptions::newFromContext( $this->getContext() );
 257                 $popts->setTargetLanguage( $title->getPageLanguage() );
 258                 return $wgParser->parse( $text, $title, $popts );
 259         }
 260
 261         /**
 262          * Wraps the provided html code in a div and outputs it to the page
 263          *
 264          * @param Title $title
 265          * @param ParserOutput $pout
 266          * @param OutputPage $out
 267          */
 268         private function showHtmlPreview( Title $title, ParserOutput $pout, OutputPage $out ) {
 269                 $lang = $title->getPageViewLanguage();
 270                 $out->addHTML( "<h2>" . $this->msg( 'expand_templates_preview' )->escaped() . "</h2>\n" );
 271
 272                 if ( $this->getConfig()->get( 'RawHtml' ) ) {
 273                         $request = $this->getRequest();
 274                         $user = $this->getUser();
 275
 276                         // To prevent cross-site scripting attacks, don't show the preview if raw HTML is
 277                         // allowed and a valid edit token is not provided (T73111). However, MediaWiki
 278                         // does not currently provide logged-out users with CSRF protection; in that case,
 279                         // do not show the preview unless anonymous editing is allowed.
 280                         if ( $user->isAnon() && !$user->isAllowed( 'edit' ) ) {
 281                                 $error = [ 'expand_templates_preview_fail_html_anon' ];
 282                         } elseif ( !$user->matchEditToken( $request->getVal( 'wpEditToken' ), '', $request ) ) {
 283                                 $error = [ 'expand_templates_preview_fail_html' ];
 284                         } else {
 285                                 $error = false;
 286                         }
 287
 288                         if ( $error ) {
 289                                 $out->wrapWikiMsg( "<div class='previewnote'>\n$1\n</div>", $error );
 290                                 return;
 291                         }
 292                 }
 293
 294                 $out->addHTML( Html::openElement( 'div', [
 295                         'class' => 'mw-content-' . $lang->getDir(),
 296                         'dir' => $lang->getDir(),
 297                         'lang' => $lang->getHtmlCode(),
 298                 ] ) );
 299                 $out->addParserOutputContent( $pout );
 300                 $out->addHTML( Html::closeElement( 'div' ) );
 301                 $out->setCategoryLinks( $pout->getCategories() );
 302         }
 303
 304         protected function getGroupName() {
 305                 return 'wiki';
 306         }
 307 }