includes/resourceloader/ResourceLoaderJqueryMsgModule.php

   1 <?php
   2 /**
   3  * ResourceLoader module for mediawiki.jqueryMsg that provides generated data.
   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  */
  22
  23 /**
  24  * ResourceLoader module for mediawiki.jqueryMsg and its generated data
  25  */
  26 class ResourceLoaderJqueryMsgModule extends ResourceLoaderFileModule {
  27
  28         /**
  29          * @param ResourceLoaderContext $context
  30          * @return string JavaScript code
  31          */
  32         public function getScript( ResourceLoaderContext $context ) {
  33                 $fileScript = parent::getScript( $context );
  34
  35                 $tagData = Sanitizer::getRecognizedTagData();
  36                 $allowedHtmlElements = array_merge(
  37                         array_keys( $tagData['htmlpairs'] ),
  38                         array_diff(
  39                                 array_keys( $tagData['htmlsingle'] ),
  40                                 array_keys( $tagData['htmlsingleonly'] )
  41                         )
  42                 );
  43
  44                 $magicWords = [
  45                         'SITENAME' => $this->getConfig()->get( 'Sitename' ),
  46                 ];
  47                 Hooks::run( 'ResourceLoaderJqueryMsgModuleMagicWords', [ $context, &$magicWords ] );
  48
  49                 $parserDefaults = [
  50                         'allowedHtmlElements' => $allowedHtmlElements,
  51                         'magic' => $magicWords,
  52                 ];
  53
  54                 $setDataScript = Xml::encodeJsCall( 'mw.jqueryMsg.setParserDefaults', [
  55                         $parserDefaults,
  56                         // Pass deep=true because mediawiki.jqueryMsg.js contains
  57                         // page-specific magic words that must not be overwritten.
  58                         true,
  59                 ] );
  60
  61                 return $fileScript . $setDataScript;
  62         }
  63
  64         /**
  65          * @param ResourceLoaderContext $context
  66          * @return array
  67          */
  68         public function getScriptURLsForDebug( ResourceLoaderContext $context ) {
  69                 // Bypass file module urls
  70                 return ResourceLoaderModule::getScriptURLsForDebug( $context );
  71         }
  72
  73         /**
  74          * @return bool
  75          */
  76         public function enableModuleContentVersion() {
  77                 return true;
  78         }
  79 }