Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
15.69% covered (danger)
15.69%
8 / 51
50.00% covered (danger)
50.00%
3 / 6
CRAP
0.00% covered (danger)
0.00%
0 / 1
JavaScriptContentHandler
16.00% covered (danger)
16.00%
8 / 50
50.00% covered (danger)
50.00%
3 / 6
57.01
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getContentClass
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 supportsRedirects
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 makeRedirectContent
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
1
 preSaveTransform
0.00% covered (danger)
0.00%
0 / 14
0.00% covered (danger)
0.00%
0 / 1
6
 fillParserOutput
0.00% covered (danger)
0.00%
0 / 27
0.00% covered (danger)
0.00%
0 / 1
12
1<?php
2/**
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
17 *
18 * @file
19 */
20
21namespace MediaWiki\Content;
22
23use CodeContentHandler;
24use Content;
25use MediaWiki\Content\Renderer\ContentParseParams;
26use MediaWiki\Content\Transform\PreSaveTransformParams;
27use MediaWiki\Html\Html;
28use MediaWiki\MainConfigNames;
29use MediaWiki\MediaWikiServices;
30use MediaWiki\Parser\ParserOutput;
31use MediaWiki\Parser\ParserOutputFlags;
32use MediaWiki\Title\Title;
33use WikiPage;
34
35/**
36 * Content handler for JavaScript pages.
37 *
38 * @todo Create a ScriptContentHandler base class, do highlighting stuff there?
39 *
40 * @since 1.21
41 * @ingroup Content
42 */
43class JavaScriptContentHandler extends CodeContentHandler {
44
45    /**
46     * @param string $modelId
47     */
48    public function __construct( $modelId = CONTENT_MODEL_JAVASCRIPT ) {
49        parent::__construct( $modelId, [ CONTENT_FORMAT_JAVASCRIPT ] );
50    }
51
52    /**
53     * @return class-string<JavaScriptContent>
54     */
55    protected function getContentClass() {
56        return JavaScriptContent::class;
57    }
58
59    public function supportsRedirects() {
60        return true;
61    }
62
63    /**
64     * Create a redirect that is also valid JavaScript
65     *
66     * @param Title $destination
67     * @param string $text ignored
68     * @return JavaScriptContent
69     */
70    public function makeRedirectContent( Title $destination, $text = '' ) {
71        // The parameters are passed as a string so the / is not url-encoded by wfArrayToCgi
72        $url = $destination->getFullURL( 'action=raw&ctype=text/javascript', false, PROTO_RELATIVE );
73        $class = $this->getContentClass();
74        // Don't needlessly encode ampersands in URLs (T107289).
75        // Avoid FormatJson or Html::encodeJsCall to ensure long-term byte-identical stability,
76        // as required for JavaScriptContent::getRedirectTarget validation.
77        $redirectContent = '/* #REDIRECT */mw.loader.load('
78            . json_encode( $url, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE )
79            . ');';
80        return new $class( $redirectContent );
81    }
82
83    public function preSaveTransform(
84        Content $content,
85        PreSaveTransformParams $pstParams
86    ): Content {
87        '@phan-var JavascriptContent $content';
88
89        $parserOptions = $pstParams->getParserOptions();
90        // @todo Make pre-save transformation optional for script pages (T34858)
91        $services = MediaWikiServices::getInstance();
92        if ( !$services->getUserOptionsLookup()->getBoolOption( $pstParams->getUser(), 'pst-cssjs' ) ) {
93            // Allow bot users to disable the pre-save transform for CSS/JS (T236828).
94            $parserOptions = clone $parserOptions;
95            $parserOptions->setPreSaveTransform( false );
96        }
97
98        $text = $content->getText();
99        $pst = $services->getParserFactory()->getInstance()->preSaveTransform(
100            $text,
101            $pstParams->getPage(),
102            $pstParams->getUser(),
103            $parserOptions
104        );
105
106        $contentClass = $this->getContentClass();
107        return new $contentClass( $pst );
108    }
109
110    /**
111     * Fills the provided ParserOutput object with information derived from the content.
112     * Unless $cpo->getGenerateHtml was false, this includes an HTML representation of the content.
113     *
114     * For content models listed in $wgTextModelsToParse, this method will call the MediaWiki
115     * wikitext parser on the text to extract any (wikitext) links, magic words, etc.
116     *
117     * Subclasses may override this to provide custom content processing..
118     *
119     * @stable to override
120     *
121     * @since 1.38
122     * @param Content $content
123     * @param ContentParseParams $cpoParams
124     * @param ParserOutput &$output The output object to fill (reference).
125     */
126    protected function fillParserOutput(
127        Content $content,
128        ContentParseParams $cpoParams,
129        ParserOutput &$output
130    ) {
131        $textModelsToParse = MediaWikiServices::getInstance()->getMainConfig()->get(
132            MainConfigNames::TextModelsToParse );
133        '@phan-var JavaScriptContent $content';
134        if ( in_array( $content->getModel(), $textModelsToParse ) ) {
135            // parse just to get links etc into the database, HTML is replaced below.
136            $output = MediaWikiServices::getInstance()->getParserFactory()->getInstance()
137                ->parse(
138                    $content->getText(),
139                    $cpoParams->getPage(),
140                    WikiPage::makeParserOptionsFromTitleAndModel(
141                        $cpoParams->getPage(),
142                        $content->getModel(),
143                        'canonical'
144                    ),
145                    true,
146                    true,
147                    $cpoParams->getRevId()
148                );
149        }
150
151        if ( $cpoParams->getGenerateHtml() ) {
152            // Return JavaScript wrapped in a <pre> tag.
153            $html = Html::element(
154                'pre',
155                [ 'class' => 'mw-code mw-js', 'dir' => 'ltr' ],
156                "\n" . $content->getText() . "\n"
157            ) . "\n";
158        } else {
159            $html = null;
160        }
161
162        $output->clearWrapperDivClass();
163        $output->setRawText( $html );
164        // Suppress the TOC (T307691)
165        $output->setOutputFlag( ParserOutputFlags::NO_TOC );
166        $output->setSections( [] );
167    }
168}
169/** @deprecated class alias since 1.43 */
170class_alias( JavaScriptContentHandler::class, 'JavaScriptContentHandler' );