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