includes/resourceloader/ResourceLoaderFileModule.php

   1 <?php
   2 /**
   3  * ResourceLoader module based on local JavaScript/CSS files.
   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 Trevor Parscal
  22  * @author Roan Kattouw
  23  */
  24
  25 /**
  26  * ResourceLoader module based on local JavaScript/CSS files.
  27  */
  28 class ResourceLoaderFileModule extends ResourceLoaderModule {
  29
  30         /** @var string Local base path, see __construct() */
  31         protected $localBasePath = '';
  32
  33         /** @var string Remote base path, see __construct() */
  34         protected $remoteBasePath = '';
  35
  36         /** @var array Saves a list of the templates named by the modules. */
  37         protected $templates = [];
  38
  39         /**
  40          * @var array List of paths to JavaScript files to always include
  41          * @par Usage:
  42          * @code
  43          * [ [file-path], [file-path], ... ]
  44          * @endcode
  45          */
  46         protected $scripts = [];
  47
  48         /**
  49          * @var array List of JavaScript files to include when using a specific language
  50          * @par Usage:
  51          * @code
  52          * [ [language-code] => [ [file-path], [file-path], ... ], ... ]
  53          * @endcode
  54          */
  55         protected $languageScripts = [];
  56
  57         /**
  58          * @var array List of JavaScript files to include when using a specific skin
  59          * @par Usage:
  60          * @code
  61          * [ [skin-name] => [ [file-path], [file-path], ... ], ... ]
  62          * @endcode
  63          */
  64         protected $skinScripts = [];
  65
  66         /**
  67          * @var array List of paths to JavaScript files to include in debug mode
  68          * @par Usage:
  69          * @code
  70          * [ [skin-name] => [ [file-path], [file-path], ... ], ... ]
  71          * @endcode
  72          */
  73         protected $debugScripts = [];
  74
  75         /**
  76          * @var array List of paths to CSS files to always include
  77          * @par Usage:
  78          * @code
  79          * [ [file-path], [file-path], ... ]
  80          * @endcode
  81          */
  82         protected $styles = [];
  83
  84         /**
  85          * @var array List of paths to CSS files to include when using specific skins
  86          * @par Usage:
  87          * @code
  88          * [ [file-path], [file-path], ... ]
  89          * @endcode
  90          */
  91         protected $skinStyles = [];
  92
  93         /**
  94          * @var array List of packaged files to make available through require()
  95          * @par Usage:
  96          * @code
  97          * [ [file-path], [file-path], ... ]
  98          * @endcode
  99          */
 100         protected $packageFiles = null;
 101
 102         /**
 103          * @var array Expanded versions of $packageFiles, lazy-computed by expandPackageFiles();
 104          *  keyed by context hash
 105          */
 106         private $expandedPackageFiles = [];
 107
 108         /**
 109          * @var array List of modules this module depends on
 110          * @par Usage:
 111          * @code
 112          * [ [file-path], [file-path], ... ]
 113          * @endcode
 114          */
 115         protected $dependencies = [];
 116
 117         /**
 118          * @var string File name containing the body of the skip function
 119          */
 120         protected $skipFunction = null;
 121
 122         /**
 123          * @var array List of message keys used by this module
 124          * @par Usage:
 125          * @code
 126          * [ [message-key], [message-key], ... ]
 127          * @endcode
 128          */
 129         protected $messages = [];
 130
 131         /** @var string Name of group to load this module in */
 132         protected $group;
 133
 134         /** @var bool Link to raw files in debug mode */
 135         protected $debugRaw = true;
 136
 137         /** @var bool Whether mw.loader.state() call should be omitted */
 138         protected $raw = false;
 139
 140         protected $targets = [ 'desktop' ];
 141
 142         /** @var bool Whether CSSJanus flipping should be skipped for this module */
 143         protected $noflip = false;
 144
 145         /**
 146          * @var bool Whether getStyleURLsForDebug should return raw file paths,
 147          * or return load.php urls
 148          */
 149         protected $hasGeneratedStyles = false;
 150
 151         /**
 152          * @var array Place where readStyleFile() tracks file dependencies
 153          * @par Usage:
 154          * @code
 155          * [ [file-path], [file-path], ... ]
 156          * @endcode
 157          */
 158         protected $localFileRefs = [];
 159
 160         /**
 161          * @var array Place where readStyleFile() tracks file dependencies for non-existent files.
 162          * Used in tests to detect missing dependencies.
 163          */
 164         protected $missingLocalFileRefs = [];
 165
 166         /**
 167          * Constructs a new module from an options array.
 168          *
 169          * @param array $options List of options; if not given or empty, an empty module will be
 170          *     constructed
 171          * @param string|null $localBasePath Base path to prepend to all local paths in $options.
 172          *     Defaults to $IP
 173          * @param string|null $remoteBasePath Base path to prepend to all remote paths in $options.
 174          *     Defaults to $wgResourceBasePath
 175          *
 176          * Below is a description for the $options array:
 177          * @throws InvalidArgumentException
 178          * @par Construction options:
 179          * @code
 180          *     [
 181          *         // Base path to prepend to all local paths in $options. Defaults to $IP
 182          *         'localBasePath' => [base path],
 183          *         // Base path to prepend to all remote paths in $options. Defaults to $wgResourceBasePath
 184          *         'remoteBasePath' => [base path],
 185          *         // Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath
 186          *         'remoteExtPath' => [base path],
 187          *         // Equivalent of remoteBasePath, but relative to $wgStylePath
 188          *         'remoteSkinPath' => [base path],
 189          *         // Scripts to always include (cannot be set if 'packageFiles' is also set, see below)
 190          *         'scripts' => [file path string or array of file path strings],
 191          *         // Scripts to include in specific language contexts
 192          *         'languageScripts' => [
 193          *             [language code] => [file path string or array of file path strings],
 194          *         ],
 195          *         // Scripts to include in specific skin contexts
 196          *         'skinScripts' => [
 197          *             [skin name] => [file path string or array of file path strings],
 198          *         ],
 199          *         // Scripts to include in debug contexts
 200          *         'debugScripts' => [file path string or array of file path strings],
 201          *         // For package modules: files to be made available for internal require() do not
 202          *         // need to have 'type' defined; it will be inferred from the file name extension
 203          *         // if omitted. 'config' can only be used when 'type' is 'data'; the variables are
 204          *         // resolved with Config::get(). The first entry in 'packageFiles' is always the
 205          *         // module entry point. If 'packageFiles' is set, 'scripts' cannot also be set.
 206          *         'packageFiles' => [
 207          *             [file path string], // or:
 208          *             [ 'name' => [file name], 'file' => [file path], 'type' => 'script'|'data' ], // or:
 209          *             [ 'name' => [name], 'content' => [string], 'type' => 'script'|'data' ], // or:
 210          *             [ 'name' => [name], 'callback' => [callable], 'type' => 'script'|'data' ],
 211          *             [ 'name' => [name], 'config' => [ [config var name], ... ], 'type' => 'data' ],
 212          *             [ 'name' => [name], 'config' => [ [JS name] => [PHP name] ], 'type' => 'data' ],
 213          *         ],
 214          *         // Modules which must be loaded before this module
 215          *         'dependencies' => [module name string or array of module name strings],
 216          *         'templates' => [
 217          *             [template alias with file.ext] => [file path to a template file],
 218          *         ],
 219          *         // Styles to always load
 220          *         'styles' => [file path string or array of file path strings],
 221          *         // Styles to include in specific skin contexts
 222          *         'skinStyles' => [
 223          *             [skin name] => [file path string or array of file path strings],
 224          *         ],
 225          *         // Messages to always load
 226          *         'messages' => [array of message key strings],
 227          *         // Group which this module should be loaded together with
 228          *         'group' => [group name string],
 229          *         // Function that, if it returns true, makes the loader skip this module.
 230          *         // The file must contain valid JavaScript for execution in a private function.
 231          *         // The file must not contain the "function () {" and "}" wrapper though.
 232          *         'skipFunction' => [file path]
 233          *     ]
 234          * @endcode
 235          */
 236         public function __construct(
 237                 $options = [],
 238                 $localBasePath = null,
 239                 $remoteBasePath = null
 240         ) {
 241                 // Flag to decide whether to automagically add the mediawiki.template module
 242                 $hasTemplates = false;
 243                 // localBasePath and remoteBasePath both have unbelievably long fallback chains
 244                 // and need to be handled separately.
 245                 list( $this->localBasePath, $this->remoteBasePath ) =
 246                         self::extractBasePaths( $options, $localBasePath, $remoteBasePath );
 247
 248                 // Extract, validate and normalise remaining options
 249                 foreach ( $options as $member => $option ) {
 250                         switch ( $member ) {
 251                                 // Lists of file paths
 252                                 case 'scripts':
 253                                 case 'debugScripts':
 254                                 case 'styles':
 255                                 case 'packageFiles':
 256                                         $this->{$member} = (array)$option;
 257                                         break;
 258                                 case 'templates':
 259                                         $hasTemplates = true;
 260                                         $this->{$member} = (array)$option;
 261                                         break;
 262                                 // Collated lists of file paths
 263                                 case 'languageScripts':
 264                                 case 'skinScripts':
 265                                 case 'skinStyles':
 266                                         if ( !is_array( $option ) ) {
 267                                                 throw new InvalidArgumentException(
 268                                                         "Invalid collated file path list error. " .
 269                                                         "'$option' given, array expected."
 270                                                 );
 271                                         }
 272                                         foreach ( $option as $key => $value ) {
 273                                                 if ( !is_string( $key ) ) {
 274                                                         throw new InvalidArgumentException(
 275                                                                 "Invalid collated file path list key error. " .
 276                                                                 "'$key' given, string expected."
 277                                                         );
 278                                                 }
 279                                                 $this->{$member}[$key] = (array)$value;
 280                                         }
 281                                         break;
 282                                 case 'deprecated':
 283                                         $this->deprecated = $option;
 284                                         break;
 285                                 // Lists of strings
 286                                 case 'dependencies':
 287                                 case 'messages':
 288                                 case 'targets':
 289                                         // Normalise
 290                                         $option = array_values( array_unique( (array)$option ) );
 291                                         sort( $option );
 292
 293                                         $this->{$member} = $option;
 294                                         break;
 295                                 // Single strings
 296                                 case 'group':
 297                                 case 'skipFunction':
 298                                         $this->{$member} = (string)$option;
 299                                         break;
 300                                 // Single booleans
 301                                 case 'debugRaw':
 302                                 case 'raw':
 303                                 case 'noflip':
 304                                         $this->{$member} = (bool)$option;
 305                                         break;
 306                         }
 307                 }
 308                 if ( isset( $options['scripts'] ) && isset( $options['packageFiles'] ) ) {
 309                         throw new InvalidArgumentException( "A module may not set both 'scripts' and 'packageFiles'" );
 310                 }
 311                 if ( $hasTemplates ) {
 312                         $this->dependencies[] = 'mediawiki.template';
 313                         // Ensure relevant template compiler module gets loaded
 314                         foreach ( $this->templates as $alias => $templatePath ) {
 315                                 if ( is_int( $alias ) ) {
 316                                         $alias = $templatePath;
 317                                 }
 318                                 $suffix = explode( '.', $alias );
 319                                 $suffix = end( $suffix );
 320                                 $compilerModule = 'mediawiki.template.' . $suffix;
 321                                 if ( $suffix !== 'html' && !in_array( $compilerModule, $this->dependencies ) ) {
 322                                         $this->dependencies[] = $compilerModule;
 323                                 }
 324                         }
 325                 }
 326         }
 327
 328         /**
 329          * Extract a pair of local and remote base paths from module definition information.
 330          * Implementation note: the amount of global state used in this function is staggering.
 331          *
 332          * @param array $options Module definition
 333          * @param string|null $localBasePath Path to use if not provided in module definition. Defaults
 334          *     to $IP
 335          * @param string|null $remoteBasePath Path to use if not provided in module definition. Defaults
 336          *     to $wgResourceBasePath
 337          * @return array Array( localBasePath, remoteBasePath )
 338          */
 339         public static function extractBasePaths(
 340                 $options = [],
 341                 $localBasePath = null,
 342                 $remoteBasePath = null
 343         ) {
 344                 global $IP, $wgResourceBasePath;
 345
 346                 // The different ways these checks are done, and their ordering, look very silly,
 347                 // but were preserved for backwards-compatibility just in case. Tread lightly.
 348
 349                 if ( $localBasePath === null ) {
 350                         $localBasePath = $IP;
 351                 }
 352                 if ( $remoteBasePath === null ) {
 353                         $remoteBasePath = $wgResourceBasePath;
 354                 }
 355
 356                 if ( isset( $options['remoteExtPath'] ) ) {
 357                         global $wgExtensionAssetsPath;
 358                         $remoteBasePath = $wgExtensionAssetsPath . '/' . $options['remoteExtPath'];
 359                 }
 360
 361                 if ( isset( $options['remoteSkinPath'] ) ) {
 362                         global $wgStylePath;
 363                         $remoteBasePath = $wgStylePath . '/' . $options['remoteSkinPath'];
 364                 }
 365
 366                 if ( array_key_exists( 'localBasePath', $options ) ) {
 367                         $localBasePath = (string)$options['localBasePath'];
 368                 }
 369
 370                 if ( array_key_exists( 'remoteBasePath', $options ) ) {
 371                         $remoteBasePath = (string)$options['remoteBasePath'];
 372                 }
 373
 374                 return [ $localBasePath, $remoteBasePath ];
 375         }
 376
 377         /**
 378          * Gets all scripts for a given context concatenated together.
 379          *
 380          * @param ResourceLoaderContext $context Context in which to generate script
 381          * @return string|array JavaScript code for $context, or package files data structure
 382          */
 383         public function getScript( ResourceLoaderContext $context ) {
 384                 $deprecationScript = $this->getDeprecationInformation();
 385                 if ( $this->packageFiles !== null ) {
 386                         $packageFiles = $this->getPackageFiles( $context );
 387                         if ( $deprecationScript ) {
 388                                 $mainFile =& $packageFiles['files'][$packageFiles['main']];
 389                                 $mainFile['content'] = $deprecationScript . $mainFile['content'];
 390                         }
 391                         return $packageFiles;
 392                 }
 393
 394                 $files = $this->getScriptFiles( $context );
 395                 return $deprecationScript . $this->readScriptFiles( $files );
 396         }
 397
 398         /**
 399          * @param ResourceLoaderContext $context
 400          * @return array
 401          */
 402         public function getScriptURLsForDebug( ResourceLoaderContext $context ) {
 403                 $urls = [];
 404                 foreach ( $this->getScriptFiles( $context ) as $file ) {
 405                         $urls[] = OutputPage::transformResourcePath(
 406                                 $this->getConfig(),
 407                                 $this->getRemotePath( $file )
 408                         );
 409                 }
 410                 return $urls;
 411         }
 412
 413         /**
 414          * @return bool
 415          */
 416         public function supportsURLLoading() {
 417                 // If package files are involved, don't support URL loading, because that breaks
 418                 // scoped require() functions
 419                 return $this->debugRaw && !$this->packageFiles;
 420         }
 421
 422         /**
 423          * Get all styles for a given context.
 424          *
 425          * @param ResourceLoaderContext $context
 426          * @return array CSS code for $context as an associative array mapping media type to CSS text.
 427          */
 428         public function getStyles( ResourceLoaderContext $context ) {
 429                 $styles = $this->readStyleFiles(
 430                         $this->getStyleFiles( $context ),
 431                         $this->getFlip( $context ),
 432                         $context
 433                 );
 434                 // Collect referenced files
 435                 $this->saveFileDependencies( $context, $this->localFileRefs );
 436
 437                 return $styles;
 438         }
 439
 440         /**
 441          * @param ResourceLoaderContext $context
 442          * @return array
 443          */
 444         public function getStyleURLsForDebug( ResourceLoaderContext $context ) {
 445                 if ( $this->hasGeneratedStyles ) {
 446                         // Do the default behaviour of returning a url back to load.php
 447                         // but with only=styles.
 448                         return parent::getStyleURLsForDebug( $context );
 449                 }
 450                 // Our module consists entirely of real css files,
 451                 // in debug mode we can load those directly.
 452                 $urls = [];
 453                 foreach ( $this->getStyleFiles( $context ) as $mediaType => $list ) {
 454                         $urls[$mediaType] = [];
 455                         foreach ( $list as $file ) {
 456                                 $urls[$mediaType][] = OutputPage::transformResourcePath(
 457                                         $this->getConfig(),
 458                                         $this->getRemotePath( $file )
 459                                 );
 460                         }
 461                 }
 462                 return $urls;
 463         }
 464
 465         /**
 466          * Gets list of message keys used by this module.
 467          *
 468          * @return array List of message keys
 469          */
 470         public function getMessages() {
 471                 return $this->messages;
 472         }
 473
 474         /**
 475          * Gets the name of the group this module should be loaded in.
 476          *
 477          * @return string Group name
 478          */
 479         public function getGroup() {
 480                 return $this->group;
 481         }
 482
 483         /**
 484          * Gets list of names of modules this module depends on.
 485          * @param ResourceLoaderContext|null $context
 486          * @return array List of module names
 487          */
 488         public function getDependencies( ResourceLoaderContext $context = null ) {
 489                 return $this->dependencies;
 490         }
 491
 492         /**
 493          * Get the skip function.
 494          * @return null|string
 495          * @throws MWException
 496          */
 497         public function getSkipFunction() {
 498                 if ( !$this->skipFunction ) {
 499                         return null;
 500                 }
 501
 502                 $localPath = $this->getLocalPath( $this->skipFunction );
 503                 if ( !file_exists( $localPath ) ) {
 504                         throw new MWException( __METHOD__ . ": skip function file not found: \"$localPath\"" );
 505                 }
 506                 $contents = $this->stripBom( file_get_contents( $localPath ) );
 507                 return $contents;
 508         }
 509
 510         /**
 511          * @return bool
 512          */
 513         public function isRaw() {
 514                 return $this->raw;
 515         }
 516
 517         /**
 518          * Disable module content versioning.
 519          *
 520          * This class uses getDefinitionSummary() instead, to avoid filesystem overhead
 521          * involved with building the full module content inside a startup request.
 522          *
 523          * @return bool
 524          */
 525         public function enableModuleContentVersion() {
 526                 return false;
 527         }
 528
 529         /**
 530          * Helper method for getDefinitionSummary.
 531          *
 532          * @see ResourceLoaderModule::getFileDependencies
 533          * @param ResourceLoaderContext $context
 534          * @return array
 535          */
 536         private function getFileHashes( ResourceLoaderContext $context ) {
 537                 $files = [];
 538
 539                 // Flatten style files into $files
 540                 $styles = self::collateFilePathListByOption( $this->styles, 'media', 'all' );
 541                 foreach ( $styles as $styleFiles ) {
 542                         $files = array_merge( $files, $styleFiles );
 543                 }
 544
 545                 $skinFiles = self::collateFilePathListByOption(
 546                         self::tryForKey( $this->skinStyles, $context->getSkin(), 'default' ),
 547                         'media',
 548                         'all'
 549                 );
 550                 foreach ( $skinFiles as $styleFiles ) {
 551                         $files = array_merge( $files, $styleFiles );
 552                 }
 553
 554                 // Extract file names for package files
 555                 $expandedPackageFiles = $this->expandPackageFiles( $context );
 556                 $packageFiles = $expandedPackageFiles ?
 557                         array_filter( array_map( function ( $fileInfo ) {
 558                                 return $fileInfo['filePath'] ?? null;
 559                         }, $expandedPackageFiles['files'] ) ) :
 560                         [];
 561
 562                 // Final merge, this should result in a master list of dependent files
 563                 $files = array_merge(
 564                         $files,
 565                         $packageFiles,
 566                         $this->scripts,
 567                         $this->templates,
 568                         $context->getDebug() ? $this->debugScripts : [],
 569                         $this->getLanguageScripts( $context->getLanguage() ),
 570                         self::tryForKey( $this->skinScripts, $context->getSkin(), 'default' )
 571                 );
 572                 if ( $this->skipFunction ) {
 573                         $files[] = $this->skipFunction;
 574                 }
 575                 $files = array_map( [ $this, 'getLocalPath' ], $files );
 576                 // File deps need to be treated separately because they're already prefixed
 577                 $files = array_merge( $files, $this->getFileDependencies( $context ) );
 578                 // Filter out any duplicates from getFileDependencies() and others.
 579                 // Most commonly introduced by compileLessFile(), which always includes the
 580                 // entry point Less file we already know about.
 581                 $files = array_values( array_unique( $files ) );
 582
 583                 // Don't include keys or file paths here, only the hashes. Including that would needlessly
 584                 // cause global cache invalidation when files move or if e.g. the MediaWiki path changes.
 585                 // Any significant ordering is already detected by the definition summary.
 586                 return array_map( [ __CLASS__, 'safeFileHash' ], $files );
 587         }
 588
 589         /**
 590          * Get the definition summary for this module.
 591          *
 592          * @param ResourceLoaderContext $context
 593          * @return array
 594          */
 595         public function getDefinitionSummary( ResourceLoaderContext $context ) {
 596                 $summary = parent::getDefinitionSummary( $context );
 597
 598                 $options = [];
 599                 foreach ( [
 600                         // The following properties are omitted because they don't affect the module reponse:
 601                         // - localBasePath (Per T104950; Changes when absolute directory name changes. If
 602                         //    this affects 'scripts' and other file paths, getFileHashes accounts for that.)
 603                         // - remoteBasePath (Per T104950)
 604                         // - dependencies (provided via startup module)
 605                         // - targets
 606                         // - group (provided via startup module)
 607                         'scripts',
 608                         'debugScripts',
 609                         'styles',
 610                         'languageScripts',
 611                         'skinScripts',
 612                         'skinStyles',
 613                         'messages',
 614                         'templates',
 615                         'skipFunction',
 616                         'debugRaw',
 617                         'raw',
 618                 ] as $member ) {
 619                         $options[$member] = $this->{$member};
 620                 };
 621
 622                 $summary[] = [
 623                         'options' => $options,
 624                         'packageFiles' => $this->expandPackageFiles( $context ),
 625                         'fileHashes' => $this->getFileHashes( $context ),
 626                         'messageBlob' => $this->getMessageBlob( $context ),
 627                 ];
 628
 629                 $lessVars = $this->getLessVars( $context );
 630                 if ( $lessVars ) {
 631                         $summary[] = [ 'lessVars' => $lessVars ];
 632                 }
 633
 634                 return $summary;
 635         }
 636
 637         /**
 638          * @param string|ResourceLoaderFilePath $path
 639          * @return string
 640          */
 641         protected function getLocalPath( $path ) {
 642                 if ( $path instanceof ResourceLoaderFilePath ) {
 643                         return $path->getLocalPath();
 644                 }
 645
 646                 return "{$this->localBasePath}/$path";
 647         }
 648
 649         /**
 650          * @param string|ResourceLoaderFilePath $path
 651          * @return string
 652          */
 653         protected function getRemotePath( $path ) {
 654                 if ( $path instanceof ResourceLoaderFilePath ) {
 655                         return $path->getRemotePath();
 656                 }
 657
 658                 return "{$this->remoteBasePath}/$path";
 659         }
 660
 661         /**
 662          * Infer the stylesheet language from a stylesheet file path.
 663          *
 664          * @since 1.22
 665          * @param string $path
 666          * @return string The stylesheet language name
 667          */
 668         public function getStyleSheetLang( $path ) {
 669                 return preg_match( '/\.less$/i', $path ) ? 'less' : 'css';
 670         }
 671
 672         /**
 673          * Infer the file type from a package file path.
 674          * @param string $path
 675          * @return string 'script' or 'data'
 676          */
 677         public static function getPackageFileType( $path ) {
 678                 if ( preg_match( '/\.json$/i', $path ) ) {
 679                         return 'data';
 680                 }
 681                 return 'script';
 682         }
 683
 684         /**
 685          * Collates file paths by option (where provided).
 686          *
 687          * @param array $list List of file paths in any combination of index/path
 688          *     or path/options pairs
 689          * @param string $option Option name
 690          * @param mixed $default Default value if the option isn't set
 691          * @return array List of file paths, collated by $option
 692          */
 693         protected static function collateFilePathListByOption( array $list, $option, $default ) {
 694                 $collatedFiles = [];
 695                 foreach ( (array)$list as $key => $value ) {
 696                         if ( is_int( $key ) ) {
 697                                 // File name as the value
 698                                 if ( !isset( $collatedFiles[$default] ) ) {
 699                                         $collatedFiles[$default] = [];
 700                                 }
 701                                 $collatedFiles[$default][] = $value;
 702                         } elseif ( is_array( $value ) ) {
 703                                 // File name as the key, options array as the value
 704                                 $optionValue = $value[$option] ?? $default;
 705                                 if ( !isset( $collatedFiles[$optionValue] ) ) {
 706                                         $collatedFiles[$optionValue] = [];
 707                                 }
 708                                 $collatedFiles[$optionValue][] = $key;
 709                         }
 710                 }
 711                 return $collatedFiles;
 712         }
 713
 714         /**
 715          * Get a list of element that match a key, optionally using a fallback key.
 716          *
 717          * @param array $list List of lists to select from
 718          * @param string $key Key to look for in $map
 719          * @param string|null $fallback Key to look for in $list if $key doesn't exist
 720          * @return array List of elements from $map which matched $key or $fallback,
 721          *  or an empty list in case of no match
 722          */
 723         protected static function tryForKey( array $list, $key, $fallback = null ) {
 724                 if ( isset( $list[$key] ) && is_array( $list[$key] ) ) {
 725                         return $list[$key];
 726                 } elseif ( is_string( $fallback )
 727                         && isset( $list[$fallback] )
 728                         && is_array( $list[$fallback] )
 729                 ) {
 730                         return $list[$fallback];
 731                 }
 732                 return [];
 733         }
 734
 735         /**
 736          * Get a list of script file paths for this module, in order of proper execution.
 737          *
 738          * @param ResourceLoaderContext $context
 739          * @return array List of file paths
 740          */
 741         private function getScriptFiles( ResourceLoaderContext $context ) {
 742                 $files = array_merge(
 743                         $this->scripts,
 744                         $this->getLanguageScripts( $context->getLanguage() ),
 745                         self::tryForKey( $this->skinScripts, $context->getSkin(), 'default' )
 746                 );
 747                 if ( $context->getDebug() ) {
 748                         $files = array_merge( $files, $this->debugScripts );
 749                 }
 750
 751                 return array_unique( $files, SORT_REGULAR );
 752         }
 753
 754         /**
 755          * Get the set of language scripts for the given language,
 756          * possibly using a fallback language.
 757          *
 758          * @param string $lang
 759          * @return array
 760          */
 761         private function getLanguageScripts( $lang ) {
 762                 $scripts = self::tryForKey( $this->languageScripts, $lang );
 763                 if ( $scripts ) {
 764                         return $scripts;
 765                 }
 766                 $fallbacks = Language::getFallbacksFor( $lang );
 767                 foreach ( $fallbacks as $lang ) {
 768                         $scripts = self::tryForKey( $this->languageScripts, $lang );
 769                         if ( $scripts ) {
 770                                 return $scripts;
 771                         }
 772                 }
 773
 774                 return [];
 775         }
 776
 777         /**
 778          * Get a list of file paths for all styles in this module, in order of proper inclusion.
 779          *
 780          * This is considered a private method. Exposed for internal use by WebInstallerOutput.
 781          *
 782          * @private
 783          * @param ResourceLoaderContext $context
 784          * @return array List of file paths
 785          */
 786         public function getStyleFiles( ResourceLoaderContext $context ) {
 787                 return array_merge_recursive(
 788                         self::collateFilePathListByOption( $this->styles, 'media', 'all' ),
 789                         self::collateFilePathListByOption(
 790                                 self::tryForKey( $this->skinStyles, $context->getSkin(), 'default' ),
 791                                 'media',
 792                                 'all'
 793                         )
 794                 );
 795         }
 796
 797         /**
 798          * Gets a list of file paths for all skin styles in the module used by
 799          * the skin.
 800          *
 801          * @param string $skinName The name of the skin
 802          * @return array A list of file paths collated by media type
 803          */
 804         protected function getSkinStyleFiles( $skinName ) {
 805                 return self::collateFilePathListByOption(
 806                         self::tryForKey( $this->skinStyles, $skinName ),
 807                         'media',
 808                         'all'
 809                 );
 810         }
 811
 812         /**
 813          * Gets a list of file paths for all skin style files in the module,
 814          * for all available skins.
 815          *
 816          * @return array A list of file paths collated by media type
 817          */
 818         protected function getAllSkinStyleFiles() {
 819                 $styleFiles = [];
 820                 $internalSkinNames = array_keys( Skin::getSkinNames() );
 821                 $internalSkinNames[] = 'default';
 822
 823                 foreach ( $internalSkinNames as $internalSkinName ) {
 824                         $styleFiles = array_merge_recursive(
 825                                 $styleFiles,
 826                                 $this->getSkinStyleFiles( $internalSkinName )
 827                         );
 828                 }
 829
 830                 return $styleFiles;
 831         }
 832
 833         /**
 834          * Returns all style files and all skin style files used by this module.
 835          *
 836          * @return array
 837          */
 838         public function getAllStyleFiles() {
 839                 $collatedStyleFiles = array_merge_recursive(
 840                         self::collateFilePathListByOption( $this->styles, 'media', 'all' ),
 841                         $this->getAllSkinStyleFiles()
 842                 );
 843
 844                 $result = [];
 845
 846                 foreach ( $collatedStyleFiles as $media => $styleFiles ) {
 847                         foreach ( $styleFiles as $styleFile ) {
 848                                 $result[] = $this->getLocalPath( $styleFile );
 849                         }
 850                 }
 851
 852                 return $result;
 853         }
 854
 855         /**
 856          * Get the contents of a list of JavaScript files. Helper for getScript().
 857          *
 858          * @param array $scripts List of file paths to scripts to read, remap and concetenate
 859          * @return string Concatenated JavaScript data from $scripts
 860          * @throws MWException
 861          */
 862         private function readScriptFiles( array $scripts ) {
 863                 if ( empty( $scripts ) ) {
 864                         return '';
 865                 }
 866                 $js = '';
 867                 foreach ( array_unique( $scripts, SORT_REGULAR ) as $fileName ) {
 868                         $localPath = $this->getLocalPath( $fileName );
 869                         if ( !file_exists( $localPath ) ) {
 870                                 throw new MWException( __METHOD__ . ": script file not found: \"$localPath\"" );
 871                         }
 872                         $contents = $this->stripBom( file_get_contents( $localPath ) );
 873                         $js .= $contents . "\n";
 874                 }
 875                 return $js;
 876         }
 877
 878         /**
 879          * Get the contents of a list of CSS files.
 880          *
 881          * @internal This is considered a private method. Exposed for internal use by WebInstallerOutput.
 882          * @param array $styles Map of media type to file paths to read, remap, and concatenate
 883          * @param bool $flip
 884          * @param ResourceLoaderContext $context
 885          * @return array List of concatenated and remapped CSS data from $styles,
 886          *     keyed by media type
 887          * @throws MWException
 888          */
 889         public function readStyleFiles( array $styles, $flip, $context ) {
 890                 if ( !$styles ) {
 891                         return [];
 892                 }
 893                 foreach ( $styles as $media => $files ) {
 894                         $uniqueFiles = array_unique( $files, SORT_REGULAR );
 895                         $styleFiles = [];
 896                         foreach ( $uniqueFiles as $file ) {
 897                                 $styleFiles[] = $this->readStyleFile( $file, $flip, $context );
 898                         }
 899                         $styles[$media] = implode( "\n", $styleFiles );
 900                 }
 901                 return $styles;
 902         }
 903
 904         /**
 905          * Reads a style file.
 906          *
 907          * This method can be used as a callback for array_map()
 908          *
 909          * @param string $path File path of style file to read
 910          * @param bool $flip
 911          * @param ResourceLoaderContext $context
 912          *
 913          * @return string CSS data in script file
 914          * @throws MWException If the file doesn't exist
 915          */
 916         protected function readStyleFile( $path, $flip, $context ) {
 917                 $localPath = $this->getLocalPath( $path );
 918                 $remotePath = $this->getRemotePath( $path );
 919                 if ( !file_exists( $localPath ) ) {
 920                         $msg = __METHOD__ . ": style file not found: \"$localPath\"";
 921                         wfDebugLog( 'resourceloader', $msg );
 922                         throw new MWException( $msg );
 923                 }
 924
 925                 if ( $this->getStyleSheetLang( $localPath ) === 'less' ) {
 926                         $style = $this->compileLessFile( $localPath, $context );
 927                         $this->hasGeneratedStyles = true;
 928                 } else {
 929                         $style = $this->stripBom( file_get_contents( $localPath ) );
 930                 }
 931
 932                 if ( $flip ) {
 933                         $style = CSSJanus::transform( $style, true, false );
 934                 }
 935                 $localDir = dirname( $localPath );
 936                 $remoteDir = dirname( $remotePath );
 937                 // Get and register local file references
 938                 $localFileRefs = CSSMin::getLocalFileReferences( $style, $localDir );
 939                 foreach ( $localFileRefs as $file ) {
 940                         if ( file_exists( $file ) ) {
 941                                 $this->localFileRefs[] = $file;
 942                         } else {
 943                                 $this->missingLocalFileRefs[] = $file;
 944                         }
 945                 }
 946                 // Don't cache this call. remap() ensures data URIs embeds are up to date,
 947                 // and urls contain correct content hashes in their query string. (T128668)
 948                 return CSSMin::remap( $style, $localDir, $remoteDir, true );
 949         }
 950
 951         /**
 952          * Get whether CSS for this module should be flipped
 953          * @param ResourceLoaderContext $context
 954          * @return bool
 955          */
 956         public function getFlip( $context ) {
 957                 return $context->getDirection() === 'rtl' && !$this->noflip;
 958         }
 959
 960         /**
 961          * Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile']
 962          *
 963          * @return array Array of strings
 964          */
 965         public function getTargets() {
 966                 return $this->targets;
 967         }
 968
 969         /**
 970          * Get the module's load type.
 971          *
 972          * @since 1.28
 973          * @return string
 974          */
 975         public function getType() {
 976                 $canBeStylesOnly = !(
 977                         // All options except 'styles', 'skinStyles' and 'debugRaw'
 978                         $this->scripts
 979                         || $this->debugScripts
 980                         || $this->templates
 981                         || $this->languageScripts
 982                         || $this->skinScripts
 983                         || $this->dependencies
 984                         || $this->messages
 985                         || $this->skipFunction
 986                         || $this->raw
 987                 );
 988                 return $canBeStylesOnly ? self::LOAD_STYLES : self::LOAD_GENERAL;
 989         }
 990
 991         /**
 992          * Compile a LESS file into CSS.
 993          *
 994          * Keeps track of all used files and adds them to localFileRefs.
 995          *
 996          * @since 1.22
 997          * @since 1.27 Added $context paramter.
 998          * @throws Exception If less.php encounters a parse error
 999          * @param string $fileName File path of LESS source
1000          * @param ResourceLoaderContext $context Context in which to generate script
1001          * @return string CSS source
1002          */
1003         protected function compileLessFile( $fileName, ResourceLoaderContext $context ) {
1004                 static $cache;
1005
1006                 if ( !$cache ) {
1007                         $cache = ObjectCache::getLocalServerInstance( CACHE_ANYTHING );
1008                 }
1009
1010                 $vars = $this->getLessVars( $context );
1011                 // Construct a cache key from the LESS file name, and a hash digest
1012                 // of the LESS variables used for compilation.
1013                 ksort( $vars );
1014                 $varsHash = hash( 'md4', serialize( $vars ) );
1015                 $cacheKey = $cache->makeGlobalKey( 'LESS', $fileName, $varsHash );
1016                 $cachedCompile = $cache->get( $cacheKey );
1017
1018                 // If we got a cached value, we have to validate it by getting a
1019                 // checksum of all the files that were loaded by the parser and
1020                 // ensuring it matches the cached entry's.
1021                 if ( isset( $cachedCompile['hash'] ) ) {
1022                         $contentHash = FileContentsHasher::getFileContentsHash( $cachedCompile['files'] );
1023                         if ( $contentHash === $cachedCompile['hash'] ) {
1024                                 $this->localFileRefs = array_merge( $this->localFileRefs, $cachedCompile['files'] );
1025                                 return $cachedCompile['css'];
1026                         }
1027                 }
1028
1029                 $compiler = $context->getResourceLoader()->getLessCompiler( $vars );
1030                 $css = $compiler->parseFile( $fileName )->getCss();
1031                 $files = $compiler->AllParsedFiles();
1032                 $this->localFileRefs = array_merge( $this->localFileRefs, $files );
1033
1034                 // Cache for 24 hours (86400 seconds).
1035                 $cache->set( $cacheKey, [
1036                         'css'   => $css,
1037                         'files' => $files,
1038                         'hash'  => FileContentsHasher::getFileContentsHash( $files ),
1039                 ], 3600 * 24 );
1040
1041                 return $css;
1042         }
1043
1044         /**
1045          * Takes named templates by the module and returns an array mapping.
1046          * @return array Templates mapping template alias to content
1047          * @throws MWException
1048          */
1049         public function getTemplates() {
1050                 $templates = [];
1051
1052                 foreach ( $this->templates as $alias => $templatePath ) {
1053                         // Alias is optional
1054                         if ( is_int( $alias ) ) {
1055                                 $alias = $templatePath;
1056                         }
1057                         $localPath = $this->getLocalPath( $templatePath );
1058                         if ( file_exists( $localPath ) ) {
1059                                 $content = file_get_contents( $localPath );
1060                                 $templates[$alias] = $this->stripBom( $content );
1061                         } else {
1062                                 $msg = __METHOD__ . ": template file not found: \"$localPath\"";
1063                                 wfDebugLog( 'resourceloader', $msg );
1064                                 throw new MWException( $msg );
1065                         }
1066                 }
1067                 return $templates;
1068         }
1069
1070         /**
1071          * Expand the packageFiles definition into something that's (almost) the right format for
1072          * getPackageFiles() to return. This expands shorthands, resolves config vars and callbacks,
1073          * but does not expand file paths or read the actual contents of files. Those things are done
1074          * by getPackageFiles().
1075          *
1076          * This is split up in this way so that getFileHashes() can get a list of file names, and
1077          * getDefinitionSummary() can get config vars and callback results in their expanded form.
1078          *
1079          * @param ResourceLoaderContext $context
1080          * @return array|null
1081          */
1082         private function expandPackageFiles( ResourceLoaderContext $context ) {
1083                 $hash = $context->getHash();
1084                 if ( isset( $this->expandedPackageFiles[$hash] ) ) {
1085                         return $this->expandedPackageFiles[$hash];
1086                 }
1087                 if ( $this->packageFiles === null ) {
1088                         return null;
1089                 }
1090                 $expandedFiles = [];
1091                 $mainFile = null;
1092
1093                 foreach ( $this->packageFiles as $alias => $fileInfo ) {
1094                         if ( is_string( $fileInfo ) ) {
1095                                 $fileInfo = [ 'name' => $fileInfo, 'file' => $fileInfo ];
1096                         } elseif ( !isset( $fileInfo['name'] ) ) {
1097                                 $msg = __METHOD__ . ": invalid package file definition for module " .
1098                                         "\"{$this->getName()}\": 'name' key is required when value is not a string";
1099                                 wfDebugLog( 'resourceloader', $msg );
1100                                 throw new MWException( $msg );
1101                         }
1102
1103                         // Infer type from alias if needed
1104                         $type = $fileInfo['type'] ?? self::getPackageFileType( $fileInfo['name'] );
1105                         $expanded = [ 'type' => $type ];
1106                         if ( !empty( $fileInfo['main'] ) ) {
1107                                 $mainFile = $fileInfo['name'];
1108                                 if ( $type !== 'script' ) {
1109                                         $msg = __METHOD__ . ": invalid package file definition for module " .
1110                                                 "\"{$this->getName()}\": main file \"$mainFile\" must be of type \"script\", not \"$type\"";
1111                                         wfDebugLog( 'resourceloader', $msg );
1112                                         throw new MWException( $msg );
1113                                 }
1114                         }
1115
1116                         if ( isset( $fileInfo['content'] ) ) {
1117                                 $expanded['content'] = $fileInfo['content'];
1118                         } elseif ( isset( $fileInfo['file'] ) ) {
1119                                 $expanded['filePath'] = $fileInfo['file'];
1120                         } elseif ( isset( $fileInfo['callback'] ) ) {
1121                                 if ( is_callable( $fileInfo['callback'] ) ) {
1122                                         $expanded['content'] = $fileInfo['callback']( $context );
1123                                 } else {
1124                                         $msg = __METHOD__ . ": invalid callback for package file \"{$fileInfo['name']}\"" .
1125                                                 " in module \"{$this->getName()}\"";
1126                                         wfDebugLog( 'resourceloader', $msg );
1127                                         throw new MWException( $msg );
1128                                 }
1129                         } elseif ( isset( $fileInfo['config'] ) ) {
1130                                 if ( $type !== 'data' ) {
1131                                         $msg = __METHOD__ . ": invalid use of \"config\" for package file \"{$fileInfo['name']}\" " .
1132                                                 "in module \"{$this->getName()}\": type must be \"data\" but is \"$type\"";
1133                                         wfDebugLog( 'resourceloader', $msg );
1134                                         throw new MWException( $msg );
1135                                 }
1136                                 $expandedConfig = [];
1137                                 foreach ( $fileInfo['config'] as $key => $var ) {
1138                                         $expandedConfig[ is_numeric( $key ) ? $var : $key ] = $this->getConfig()->get( $var );
1139                                 }
1140                                 $expanded['content'] = $expandedConfig;
1141                         } elseif ( !empty( $fileInfo['main'] ) ) {
1142                                 // [ 'name' => 'foo.js', 'main' => true ] is shorthand
1143                                 $expanded['filePath'] = $fileInfo['name'];
1144                         } else {
1145                                 $msg = __METHOD__ . ": invalid package file definition for \"{$fileInfo['name']}\" " .
1146                                         "in module \"{$this->getName()}\": one of \"file\", \"content\", \"callback\" or \"config\" " .
1147                                         "must be set";
1148                                 wfDebugLog( 'resourceloader', $msg );
1149                                 throw new MWException( $msg );
1150                         }
1151
1152                         $expandedFiles[$fileInfo['name']] = $expanded;
1153                 }
1154
1155                 if ( $expandedFiles && $mainFile === null ) {
1156                         // The first package file that is a script is the main file
1157                         foreach ( $expandedFiles as $path => &$file ) {
1158                                 if ( $file['type'] === 'script' ) {
1159                                         $mainFile = $path;
1160                                         break;
1161                                 }
1162                         }
1163                 }
1164
1165                 $result = [
1166                         'main' => $mainFile,
1167                         'files' => $expandedFiles
1168                 ];
1169
1170                 $this->expandedPackageFiles[$hash] = $result;
1171                 return $result;
1172         }
1173
1174         /**
1175          * Resolves the package files defintion and generates the content of each package file.
1176          * @param ResourceLoaderContext $context
1177          * @return array Package files data structure, see ResourceLoaderModule::getScript()
1178          */
1179         public function getPackageFiles( ResourceLoaderContext $context ) {
1180                 if ( $this->packageFiles === null ) {
1181                         return null;
1182                 }
1183                 $expandedPackageFiles = $this->expandPackageFiles( $context );
1184
1185                 // Expand file contents
1186                 foreach ( $expandedPackageFiles['files'] as &$fileInfo ) {
1187                         if ( isset( $fileInfo['filePath'] ) ) {
1188                                 $localPath = $this->getLocalPath( $fileInfo['filePath'] );
1189                                 if ( !file_exists( $localPath ) ) {
1190                                         $msg = __METHOD__ . ": package file not found: \"$localPath\"" .
1191                                                 " in module \"{$this->getName()}\"";
1192                                         wfDebugLog( 'resourceloader', $msg );
1193                                         throw new MWException( $msg );
1194                                 }
1195                                 $content = $this->stripBom( file_get_contents( $localPath ) );
1196                                 if ( $fileInfo['type'] === 'data' ) {
1197                                         $content = json_decode( $content );
1198                                 }
1199                                 $fileInfo['content'] = $content;
1200                                 unset( $fileInfo['filePath'] );
1201                         }
1202                 }
1203
1204                 return $expandedPackageFiles;
1205         }
1206
1207         /**
1208          * Takes an input string and removes the UTF-8 BOM character if present
1209          *
1210          * We need to remove these after reading a file, because we concatenate our files and
1211          * the BOM character is not valid in the middle of a string.
1212          * We already assume UTF-8 everywhere, so this should be safe.
1213          *
1214          * @param string $input
1215          * @return string Input minus the intial BOM char
1216          */
1217         protected function stripBom( $input ) {
1218                 if ( substr_compare( "\xef\xbb\xbf", $input, 0, 3 ) === 0 ) {
1219                         return substr( $input, 3 );
1220                 }
1221                 return $input;
1222         }
1223 }