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 boolean whether or not to show the XML parse tree */
  33         protected $generateXML;
  34
  35         /** @var boolean whether or not to show the raw HTML code */
  36         protected $generateRawHtml;
  37
  38         /** @var boolean whether or not to remove comments in the expanded wikitext */
  39         protected $removeComments;
  40
  41         /** @var boolean whether or not to remove <nowiki> tags in the expanded wikitext */
  42         protected $removeNowiki;
  43
  44         /** @var 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          */
  54         function execute( $subpage ) {
  55                 global $wgParser, $wgUseTidy, $wgAlwaysUseTidy;
  56
  57                 $this->setHeaders();
  58
  59                 $request = $this->getRequest();
  60                 $titleStr = $request->getText( 'wpContextTitle' );
  61                 $title = Title::newFromText( $titleStr );
  62
  63                 if ( !$title ) {
  64                         $title = $this->getTitle();
  65                 }
  66                 $input = $request->getText( 'wpInput' );
  67                 $this->generateXML = $request->getBool( 'wpGenerateXml' );
  68                 $this->generateRawHtml = $request->getBool( 'wpGenerateRawHtml' );
  69
  70                 if ( strlen( $input ) ) {
  71                         $this->removeComments = $request->getBool( 'wpRemoveComments', false );
  72                         $this->removeNowiki = $request->getBool( 'wpRemoveNowiki', false );
  73                         $options = ParserOptions::newFromContext( $this->getContext() );
  74                         $options->setRemoveComments( $this->removeComments );
  75                         $options->setTidy( true );
  76                         $options->setMaxIncludeSize( self::MAX_INCLUDE_SIZE );
  77
  78                         if ( $this->generateXML ) {
  79                                 $wgParser->startExternalParse( $title, $options, OT_PREPROCESS );
  80                                 $dom = $wgParser->preprocessToDom( $input );
  81
  82                                 if ( method_exists( $dom, 'saveXML' ) ) {
  83                                         $xml = $dom->saveXML();
  84                                 } else {
  85                                         $xml = $dom->__toString();
  86                                 }
  87                         }
  88
  89                         $output = $wgParser->preprocess( $input, $title, $options );
  90                 } else {
  91                         $this->removeComments = $request->getBool( 'wpRemoveComments', true );
  92                         $this->removeNowiki = $request->getBool( 'wpRemoveNowiki', false );
  93                         $output = false;
  94                 }
  95
  96                 $out = $this->getOutput();
  97                 $out->addWikiMsg( 'expand_templates_intro' );
  98                 $out->addHTML( $this->makeForm( $titleStr, $input ) );
  99
 100                 if ( $output !== false ) {
 101                         if ( $this->generateXML && strlen( $output ) > 0 ) {
 102                                 $out->addHTML( $this->makeOutput( $xml, 'expand_templates_xml_output' ) );
 103                         }
 104
 105                         $tmp = $this->makeOutput( $output );
 106
 107                         if ( $this->removeNowiki ) {
 108                                 $tmp = preg_replace(
 109                                         array( '_&lt;nowiki&gt;_', '_&lt;/nowiki&gt;_', '_&lt;nowiki */&gt;_' ),
 110                                         '',
 111                                         $tmp
 112                                 );
 113                         }
 114
 115                         if ( ( $wgUseTidy && $options->getTidy() ) || $wgAlwaysUseTidy ) {
 116                                 $tmp = MWTidy::tidy( $tmp );
 117                         }
 118
 119                         $out->addHTML( $tmp );
 120
 121                         $rawhtml = $this->generateHtml( $title, $output );
 122
 123                         if ( $this->generateRawHtml && strlen( $rawhtml ) > 0 ) {
 124                                 $out->addHTML( $this->makeOutput( $rawhtml, 'expand_templates_html_output' ) );
 125                         }
 126
 127                         $this->showHtmlPreview( $title, $rawhtml, $out );
 128
 129                 }
 130
 131         }
 132
 133         /**
 134          * Generate a form allowing users to enter information
 135          *
 136          * @param string $title Value for context title field
 137          * @param string $input Value for input textbox
 138          * @return string
 139          */
 140         private function makeForm( $title, $input ) {
 141                 $self = $this->getTitle();
 142                 $form = Xml::openElement(
 143                         'form',
 144                         array( 'method' => 'post', 'action' => $self->getLocalUrl() )
 145                 );
 146                 $form .= "<fieldset><legend>" . $this->msg( 'expandtemplates' )->escaped() . "</legend>\n";
 147
 148                 $form .= '<p>' . Xml::inputLabel(
 149                         $this->msg( 'expand_templates_title' )->plain(),
 150                         'wpContextTitle',
 151                         'contexttitle',
 152                         60,
 153                         $title,
 154                         array( 'autofocus' => true )
 155                 ) . '</p>';
 156                 $form .= '<p>' . Xml::label(
 157                         $this->msg( 'expand_templates_input' )->text(),
 158                         'input'
 159                 ) . '</p>';
 160                 $form .= Xml::textarea(
 161                         'wpInput',
 162                         $input,
 163                         10,
 164                         10,
 165                         array( 'id' => 'input' )
 166                 );
 167
 168                 $form .= '<p>' . Xml::checkLabel(
 169                         $this->msg( 'expand_templates_remove_comments' )->text(),
 170                         'wpRemoveComments',
 171                         'removecomments',
 172                         $this->removeComments
 173                 ) . '</p>';
 174                 $form .= '<p>' . Xml::checkLabel(
 175                         $this->msg( 'expand_templates_remove_nowiki' )->text(),
 176                         'wpRemoveNowiki',
 177                         'removenowiki',
 178                         $this->removeNowiki
 179                 ) . '</p>';
 180                 $form .= '<p>' . Xml::checkLabel(
 181                         $this->msg( 'expand_templates_generate_xml' )->text(),
 182                         'wpGenerateXml',
 183                         'generate_xml',
 184                         $this->generateXML
 185                 ) . '</p>';
 186                 $form .= '<p>' . Xml::checkLabel(
 187                         $this->msg( 'expand_templates_generate_rawhtml' )->text(),
 188                         'wpGenerateRawHtml',
 189                         'generate_rawhtml',
 190                         $this->generateRawHtml
 191                 ) . '</p>';
 192                 $form .= '<p>' . Xml::submitButton(
 193                         $this->msg( 'expand_templates_ok' )->text(),
 194                         array( 'accesskey' => 's' )
 195                 ) . '</p>';
 196                 $form .= "</fieldset>\n";
 197                 $form .= Xml::closeElement( 'form' );
 198
 199                 return $form;
 200         }
 201
 202         /**
 203          * Generate a nice little box with a heading for output
 204          *
 205          * @param string $output Wiki text output
 206          * @param string $heading
 207          * @return string
 208          */
 209         private function makeOutput( $output, $heading = 'expand_templates_output' ) {
 210                 $out = "<h2>" . $this->msg( $heading )->escaped() . "</h2>\n";
 211                 $out .= Xml::textarea(
 212                         'output',
 213                         $output,
 214                         10,
 215                         10,
 216                         array( 'id' => 'output', 'readonly' => 'readonly' )
 217                 );
 218
 219                 return $out;
 220         }
 221
 222         /**
 223          * Renders the supplied wikitext as html
 224          *
 225          * @param Title $title
 226          * @param string $text
 227          * @return string
 228          */
 229         private function generateHtml( Title $title, $text ) {
 230                 global $wgParser;
 231
 232                 $popts = ParserOptions::newFromContext( $this->getContext() );
 233                 $popts->setTargetLanguage( $title->getPageLanguage() );
 234                 $pout = $wgParser->parse( $text, $title, $popts );
 235
 236                 return $pout->getText();
 237         }
 238
 239         /**
 240          * Wraps the provided html code in a div and outputs it to the page
 241          *
 242          * @param Title $title
 243          * @param string $html
 244          * @param OutputPage $out
 245          */
 246         private function showHtmlPreview( Title $title, $html, OutputPage $out ) {
 247                 $lang = $title->getPageViewLanguage();
 248                 $out->addHTML( "<h2>" . $this->msg( 'expand_templates_preview' )->escaped() . "</h2>\n" );
 249                 $out->addHTML( Html::openElement( 'div', array(
 250                         'class' => 'mw-content-' . $lang->getDir(),
 251                         'dir' => $lang->getDir(),
 252                         'lang' => $lang->getHtmlCode(),
 253                 ) ) );
 254                 $out->addHTML( $html );
 255                 $out->addHTML( Html::closeElement( 'div' ) );
 256         }
 257 }