SpecialExpandTemplates.php

Go to the documentation of this file.

<?php
class SpecialExpandTemplates extends SpecialPage {
 
    protected $generateXML;
 
    protected $generateRawHtml;
 
    protected $removeComments;
 
    protected $removeNowiki;
 
    const MAX_INCLUDE_SIZE = 50000000;
 
    function __construct() {
        parent::__construct( 'ExpandTemplates' );
    }
 
    function execute( $subpage ) {
        global $wgParser, $wgUseTidy, $wgAlwaysUseTidy;
 
        $this->setHeaders();
 
        $request = $this->getRequest();
        $titleStr = $request->getText( 'wpContextTitle' );
        $title = Title::newFromText( $titleStr );
 
        if ( !$title ) {
            $title = $this->getPageTitle();
        }
        $input = $request->getText( 'wpInput' );
        $this->generateXML = $request->getBool( 'wpGenerateXml' );
        $this->generateRawHtml = $request->getBool( 'wpGenerateRawHtml' );
 
        if ( strlen( $input ) ) {
            $this->removeComments = $request->getBool( 'wpRemoveComments', false );
            $this->removeNowiki = $request->getBool( 'wpRemoveNowiki', false );
            $options = ParserOptions::newFromContext( $this->getContext() );
            $options->setRemoveComments( $this->removeComments );
            $options->setTidy( true );
            $options->setMaxIncludeSize( self::MAX_INCLUDE_SIZE );
 
            if ( $this->generateXML ) {
                $wgParser->startExternalParse( $title, $options, OT_PREPROCESS );
                $dom = $wgParser->preprocessToDom( $input );
 
                if ( method_exists( $dom, 'saveXML' ) ) {
                    $xml = $dom->saveXML();
                } else {
                    $xml = $dom->__toString();
                }
            }
 
            $output = $wgParser->preprocess( $input, $title, $options );
        } else {
            $this->removeComments = $request->getBool( 'wpRemoveComments', true );
            $this->removeNowiki = $request->getBool( 'wpRemoveNowiki', false );
            $output = false;
        }
 
        $out = $this->getOutput();
        $out->addWikiMsg( 'expand_templates_intro' );
        $out->addHTML( $this->makeForm( $titleStr, $input ) );
 
        if ( $output !== false ) {
            if ( $this->generateXML && strlen( $output ) > 0 ) {
                $out->addHTML( $this->makeOutput( $xml, 'expand_templates_xml_output' ) );
            }
 
            $tmp = $this->makeOutput( $output );
 
            if ( $this->removeNowiki ) {
                $tmp = preg_replace(
                    array( '_&lt;nowiki&gt;_', '_&lt;/nowiki&gt;_', '_&lt;nowiki */&gt;_' ),
                    '',
                    $tmp
                );
            }
 
            if ( ( $wgUseTidy && $options->getTidy() ) || $wgAlwaysUseTidy ) {
                $tmp = MWTidy::tidy( $tmp );
            }
 
            $out->addHTML( $tmp );
 
            $rawhtml = $this->generateHtml( $title, $output );
 
            if ( $this->generateRawHtml && strlen( $rawhtml ) > 0 ) {
                $out->addHTML( $this->makeOutput( $rawhtml, 'expand_templates_html_output' ) );
            }
 
            $this->showHtmlPreview( $title, $rawhtml, $out );
        }
    }
 
    private function makeForm( $title, $input ) {
        $self = $this->getPageTitle();
        $request = $this->getRequest();
        $user = $this->getUser();
 
        $form = Xml::openElement(
            'form',
            array( 'method' => 'post', 'action' => $self->getLocalUrl() )
        );
        $form .= "<fieldset><legend>" . $this->msg( 'expandtemplates' )->escaped() . "</legend>\n";
 
        $form .= '<p>' . Xml::inputLabel(
            $this->msg( 'expand_templates_title' )->plain(),
            'wpContextTitle',
            'contexttitle',
            60,
            $title,
            array( 'autofocus' => true )
        ) . '</p>';
        $form .= '<p>' . Xml::label(
            $this->msg( 'expand_templates_input' )->text(),
            'input'
        ) . '</p>';
        $form .= Xml::textarea(
            'wpInput',
            $input,
            10,
            10,
            array( 'id' => 'input' )
        );
 
        $form .= '<p>' . Xml::checkLabel(
            $this->msg( 'expand_templates_remove_comments' )->text(),
            'wpRemoveComments',
            'removecomments',
            $this->removeComments
        ) . '</p>';
        $form .= '<p>' . Xml::checkLabel(
            $this->msg( 'expand_templates_remove_nowiki' )->text(),
            'wpRemoveNowiki',
            'removenowiki',
            $this->removeNowiki
        ) . '</p>';
        $form .= '<p>' . Xml::checkLabel(
            $this->msg( 'expand_templates_generate_xml' )->text(),
            'wpGenerateXml',
            'generate_xml',
            $this->generateXML
        ) . '</p>';
        $form .= '<p>' . Xml::checkLabel(
            $this->msg( 'expand_templates_generate_rawhtml' )->text(),
            'wpGenerateRawHtml',
            'generate_rawhtml',
            $this->generateRawHtml
        ) . '</p>';
        $form .= '<p>' . Xml::submitButton(
            $this->msg( 'expand_templates_ok' )->text(),
            array( 'accesskey' => 's' )
        ) . '</p>';
        $form .= "</fieldset>\n";
        $form .= Html::hidden( 'wpEditToken', $user->getEditToken( '', $request ) );
        $form .= Xml::closeElement( 'form' );
 
        return $form;
    }
 
    private function makeOutput( $output, $heading = 'expand_templates_output' ) {
        $out = "<h2>" . $this->msg( $heading )->escaped() . "</h2>\n";
        $out .= Xml::textarea(
            'output',
            $output,
            10,
            10,
            array( 'id' => 'output', 'readonly' => 'readonly' )
        );
 
        return $out;
    }
 
    private function generateHtml( Title $title, $text ) {
        global $wgParser;
 
        $popts = ParserOptions::newFromContext( $this->getContext() );
        $popts->setTargetLanguage( $title->getPageLanguage() );
        $pout = $wgParser->parse( $text, $title, $popts );
 
        return $pout->getText();
    }
 
    private function showHtmlPreview( Title $title, $html, OutputPage $out ) {
        $lang = $title->getPageViewLanguage();
        $out->addHTML( "<h2>" . $this->msg( 'expand_templates_preview' )->escaped() . "</h2>\n" );
 
        global $wgRawHtml;
        if ( $wgRawHtml ) {
            $request = $this->getRequest();
            $user = $this->getUser();
 
            // To prevent cross-site scripting attacks, don't show the preview if raw HTML is
            // allowed and a valid edit token is not provided (bug 71111). However, MediaWiki
            // does not currently provide logged-out users with CSRF protection; in that case,
            // do not show the preview unless anonymous editing is allowed.
            if ( $user->isAnon() && !$user->isAllowed( 'edit' ) ) {
                $error = array( 'expand_templates_preview_fail_html_anon' );
            } elseif ( !$user->matchEditToken( $request->getVal( 'wpEditToken' ), '', $request ) ) {
                $error = array( 'expand_templates_preview_fail_html' );
            } else {
                $error = false;
            }
 
            if ( $error ) {
                $out->wrapWikiMsg( "<div class='previewnote'>\n$1\n</div>", $error );
                return;
            }
        }
 
        $out->addHTML( Html::openElement( 'div', array(
            'class' => 'mw-content-' . $lang->getDir(),
            'dir' => $lang->getDir(),
            'lang' => $lang->getHtmlCode(),
        ) ) );
        $out->addHTML( $html );
        $out->addHTML( Html::closeElement( 'div' ) );
    }
 
    protected function getGroupName() {
        return 'wiki';
    }
}