Remove term from search results info
[mediawiki.git] / includes / specials / SpecialExpandTemplates.php
blob269dff68915c179e0132b5e5ddc1808dec1e1b1d
1 <?php
2 /**
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
20 * @file
21 * @ingroup SpecialPage
24 /**
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' );
51 /**
52 * Show the special page
53 * @param string|null $subpage
55 function execute( $subpage ) {
56 global $wgParser;
58 $this->setHeaders();
60 $request = $this->getRequest();
61 $titleStr = $request->getText( 'wpContextTitle' );
62 $title = Title::newFromText( $titleStr );
64 if ( !$title ) {
65 $title = $this->getPageTitle();
67 $input = $request->getText( 'wpInput' );
68 $this->generateXML = $request->getBool( 'wpGenerateXml' );
69 $this->generateRawHtml = $request->getBool( 'wpGenerateRawHtml' );
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 );
79 if ( $this->generateXML ) {
80 $wgParser->startExternalParse( $title, $options, OT_PREPROCESS );
81 $dom = $wgParser->preprocessToDom( $input );
83 if ( method_exists( $dom, 'saveXML' ) ) {
84 $xml = $dom->saveXML();
85 } else {
86 $xml = $dom->__toString();
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;
97 $out = $this->getOutput();
98 $out->addWikiMsg( 'expand_templates_intro' );
99 $out->addHTML( $this->makeForm( $titleStr, $input ) );
101 if ( $output !== false ) {
102 if ( $this->generateXML && strlen( $output ) > 0 ) {
103 $out->addHTML( $this->makeOutput( $xml, 'expand_templates_xml_output' ) );
106 $tmp = $this->makeOutput( $output );
108 if ( $this->removeNowiki ) {
109 $tmp = preg_replace(
110 array( '_&lt;nowiki&gt;_', '_&lt;/nowiki&gt;_', '_&lt;nowiki */&gt;_' ),
112 $tmp
116 $config = $this->getConfig();
117 if ( ( $config->get( 'UseTidy' ) && $options->getTidy() ) || $config->get( 'AlwaysUseTidy' ) ) {
118 $tmp = MWTidy::tidy( $tmp );
121 $out->addHTML( $tmp );
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' ) );
129 $this->showHtmlPreview( $title, $pout, $out );
134 * Generate a form allowing users to enter information
136 * @param string $title Value for context title field
137 * @param string $input Value for input textbox
138 * @return string
140 private function makeForm( $title, $input ) {
141 $self = $this->getPageTitle();
142 $form = Xml::openElement(
143 'form',
144 array( 'method' => 'post', 'action' => $self->getLocalUrl() )
146 $form .= "<fieldset><legend>" . $this->msg( 'expandtemplates' )->escaped() . "</legend>\n";
148 $form .= '<p>' . Xml::inputLabel(
149 $this->msg( 'expand_templates_title' )->plain(),
150 'wpContextTitle',
151 'contexttitle',
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,
165 array( 'id' => 'input' )
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' );
199 return $form;
203 * Generate a nice little box with a heading for output
205 * @param string $output Wiki text output
206 * @param string $heading
207 * @return string
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,
216 array( 'id' => 'output', 'readonly' => 'readonly' )
219 return $out;
223 * Renders the supplied wikitext as html
225 * @param Title $title
226 * @param string $text
227 * @return ParserOutput
229 private function generateHtml( Title $title, $text ) {
230 global $wgParser;
232 $popts = ParserOptions::newFromContext( $this->getContext() );
233 $popts->setTargetLanguage( $title->getPageLanguage() );
234 return $wgParser->parse( $text, $title, $popts );
238 * Wraps the provided html code in a div and outputs it to the page
240 * @param Title $title
241 * @param ParserOutput $pout
242 * @param OutputPage $out
244 private function showHtmlPreview( Title $title, ParserOutput $pout, OutputPage $out ) {
245 $lang = $title->getPageViewLanguage();
246 $out->addHTML( "<h2>" . $this->msg( 'expand_templates_preview' )->escaped() . "</h2>\n" );
247 $out->addHTML( Html::openElement( 'div', array(
248 'class' => 'mw-content-' . $lang->getDir(),
249 'dir' => $lang->getDir(),
250 'lang' => $lang->getHtmlCode(),
251 ) ) );
252 $out->addParserOutputContent( $pout );
253 $out->addHTML( Html::closeElement( 'div' ) );
256 protected function getGroupName() {
257 return 'wiki';