includes/resourceloader/ResourceLoaderFileModule.php

   1 <?php
   2 /**
   3  * Resource loader 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         /* Protected Members */
  30
  31         /** @var string Local base path, see __construct() */
  32         protected $localBasePath = '';
  33
  34         /** @var string Remote base path, see __construct() */
  35         protected $remoteBasePath = '';
  36
  37         /** @var array Saves a list of the templates named by the modules. */
  38         protected $templates = array();
  39
  40         /**
  41          * @var array List of paths to JavaScript files to always include
  42          * @par Usage:
  43          * @code
  44          * array( [file-path], [file-path], ... )
  45          * @endcode
  46          */
  47         protected $scripts = array();
  48
  49         /**
  50          * @var array List of JavaScript files to include when using a specific language
  51          * @par Usage:
  52          * @code
  53          * array( [language-code] => array( [file-path], [file-path], ... ), ... )
  54          * @endcode
  55          */
  56         protected $languageScripts = array();
  57
  58         /**
  59          * @var array List of JavaScript files to include when using a specific skin
  60          * @par Usage:
  61          * @code
  62          * array( [skin-name] => array( [file-path], [file-path], ... ), ... )
  63          * @endcode
  64          */
  65         protected $skinScripts = array();
  66
  67         /**
  68          * @var array List of paths to JavaScript files to include in debug mode
  69          * @par Usage:
  70          * @code
  71          * array( [skin-name] => array( [file-path], [file-path], ... ), ... )
  72          * @endcode
  73          */
  74         protected $debugScripts = array();
  75
  76         /**
  77          * @var array List of paths to JavaScript files to include in the startup module
  78          * @par Usage:
  79          * @code
  80          * array( [file-path], [file-path], ... )
  81          * @endcode
  82          */
  83         protected $loaderScripts = array();
  84
  85         /**
  86          * @var array List of paths to CSS files to always include
  87          * @par Usage:
  88          * @code
  89          * array( [file-path], [file-path], ... )
  90          * @endcode
  91          */
  92         protected $styles = array();
  93
  94         /**
  95          * @var array List of paths to CSS files to include when using specific skins
  96          * @par Usage:
  97          * @code
  98          * array( [file-path], [file-path], ... )
  99          * @endcode
 100          */
 101         protected $skinStyles = array();
 102
 103         /**
 104          * @var array List of modules this module depends on
 105          * @par Usage:
 106          * @code
 107          * array( [file-path], [file-path], ... )
 108          * @endcode
 109          */
 110         protected $dependencies = array();
 111
 112         /**
 113          * @var string File name containing the body of the skip function
 114          */
 115         protected $skipFunction = null;
 116
 117         /**
 118          * @var array List of message keys used by this module
 119          * @par Usage:
 120          * @code
 121          * array( [message-key], [message-key], ... )
 122          * @endcode
 123          */
 124         protected $messages = array();
 125
 126         /** @var string Name of group to load this module in */
 127         protected $group;
 128
 129         /** @var string Position on the page to load this module at */
 130         protected $position = 'bottom';
 131
 132         /** @var bool Link to raw files in debug mode */
 133         protected $debugRaw = true;
 134
 135         /** @var bool Whether mw.loader.state() call should be omitted */
 136         protected $raw = false;
 137
 138         protected $targets = array( 'desktop' );
 139
 140         /**
 141          * @var bool Whether getStyleURLsForDebug should return raw file paths,
 142          * or return load.php urls
 143          */
 144         protected $hasGeneratedStyles = false;
 145
 146         /**
 147          * @var array Place where readStyleFile() tracks file dependencies
 148          * @par Usage:
 149          * @code
 150          * array( [file-path], [file-path], ... )
 151          * @endcode
 152          */
 153         protected $localFileRefs = array();
 154
 155         /**
 156          * @var array Place where readStyleFile() tracks file dependencies for non-existent files.
 157          * Used in tests to detect missing dependencies.
 158          */
 159         protected $missingLocalFileRefs = array();
 160
 161         /* Methods */
 162
 163         /**
 164          * Constructs a new module from an options array.
 165          *
 166          * @param array $options List of options; if not given or empty, an empty module will be
 167          *     constructed
 168          * @param string $localBasePath Base path to prepend to all local paths in $options. Defaults
 169          *     to $IP
 170          * @param string $remoteBasePath Base path to prepend to all remote paths in $options. Defaults
 171          *     to $wgResourceBasePath
 172          *
 173          * Below is a description for the $options array:
 174          * @throws InvalidArgumentException
 175          * @par Construction options:
 176          * @code
 177          *     array(
 178          *         // Base path to prepend to all local paths in $options. Defaults to $IP
 179          *         'localBasePath' => [base path],
 180          *         // Base path to prepend to all remote paths in $options. Defaults to $wgResourceBasePath
 181          *         'remoteBasePath' => [base path],
 182          *         // Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath
 183          *         'remoteExtPath' => [base path],
 184          *         // Equivalent of remoteBasePath, but relative to $wgStylePath
 185          *         'remoteSkinPath' => [base path],
 186          *         // Scripts to always include
 187          *         'scripts' => [file path string or array of file path strings],
 188          *         // Scripts to include in specific language contexts
 189          *         'languageScripts' => array(
 190          *             [language code] => [file path string or array of file path strings],
 191          *         ),
 192          *         // Scripts to include in specific skin contexts
 193          *         'skinScripts' => array(
 194          *             [skin name] => [file path string or array of file path strings],
 195          *         ),
 196          *         // Scripts to include in debug contexts
 197          *         'debugScripts' => [file path string or array of file path strings],
 198          *         // Scripts to include in the startup module
 199          *         'loaderScripts' => [file path string or array of file path strings],
 200          *         // Modules which must be loaded before this module
 201          *         'dependencies' => [module name string or array of module name strings],
 202          *         'templates' => array(
 203          *             [template alias with file.ext] => [file path to a template file],
 204          *         ),
 205          *         // Styles to always load
 206          *         'styles' => [file path string or array of file path strings],
 207          *         // Styles to include in specific skin contexts
 208          *         'skinStyles' => array(
 209          *             [skin name] => [file path string or array of file path strings],
 210          *         ),
 211          *         // Messages to always load
 212          *         'messages' => [array of message key strings],
 213          *         // Group which this module should be loaded together with
 214          *         'group' => [group name string],
 215          *         // Position on the page to load this module at
 216          *         'position' => ['bottom' (default) or 'top']
 217          *         // Function that, if it returns true, makes the loader skip this module.
 218          *         // The file must contain valid JavaScript for execution in a private function.
 219          *         // The file must not contain the "function () {" and "}" wrapper though.
 220          *         'skipFunction' => [file path]
 221          *     )
 222          * @endcode
 223          */
 224         public function __construct(
 225                 $options = array(),
 226                 $localBasePath = null,
 227                 $remoteBasePath = null
 228         ) {
 229                 // Flag to decide whether to automagically add the mediawiki.template module
 230                 $hasTemplates = false;
 231                 // localBasePath and remoteBasePath both have unbelievably long fallback chains
 232                 // and need to be handled separately.
 233                 list( $this->localBasePath, $this->remoteBasePath ) =
 234                         self::extractBasePaths( $options, $localBasePath, $remoteBasePath );
 235
 236                 // Extract, validate and normalise remaining options
 237                 foreach ( $options as $member => $option ) {
 238                         switch ( $member ) {
 239                                 // Lists of file paths
 240                                 case 'scripts':
 241                                 case 'debugScripts':
 242                                 case 'loaderScripts':
 243                                 case 'styles':
 244                                         $this->{$member} = (array)$option;
 245                                         break;
 246                                 case 'templates':
 247                                         $hasTemplates = true;
 248                                         $this->{$member} = (array)$option;
 249                                         break;
 250                                 // Collated lists of file paths
 251                                 case 'languageScripts':
 252                                 case 'skinScripts':
 253                                 case 'skinStyles':
 254                                         if ( !is_array( $option ) ) {
 255                                                 throw new InvalidArgumentException(
 256                                                         "Invalid collated file path list error. " .
 257                                                         "'$option' given, array expected."
 258                                                 );
 259                                         }
 260                                         foreach ( $option as $key => $value ) {
 261                                                 if ( !is_string( $key ) ) {
 262                                                         throw new InvalidArgumentException(
 263                                                                 "Invalid collated file path list key error. " .
 264                                                                 "'$key' given, string expected."
 265                                                         );
 266                                                 }
 267                                                 $this->{$member}[$key] = (array)$value;
 268                                         }
 269                                         break;
 270                                 // Lists of strings
 271                                 case 'dependencies':
 272                                 case 'messages':
 273                                 case 'targets':
 274                                         // Normalise
 275                                         $option = array_values( array_unique( (array)$option ) );
 276                                         sort( $option );
 277
 278                                         $this->{$member} = $option;
 279                                         break;
 280                                 // Single strings
 281                                 case 'position':
 282                                         $this->isPositionDefined = true;
 283                                 case 'group':
 284                                 case 'skipFunction':
 285                                         $this->{$member} = (string)$option;
 286                                         break;
 287                                 // Single booleans
 288                                 case 'debugRaw':
 289                                 case 'raw':
 290                                         $this->{$member} = (bool)$option;
 291                                         break;
 292                         }
 293                 }
 294                 if ( $hasTemplates ) {
 295                         $this->dependencies[] = 'mediawiki.template';
 296                         // Ensure relevant template compiler module gets loaded
 297                         foreach ( $this->templates as $alias => $templatePath ) {
 298                                 if ( is_int( $alias ) ) {
 299                                         $alias = $templatePath;
 300                                 }
 301                                 $suffix = explode( '.', $alias );
 302                                 $suffix = end( $suffix );
 303                                 $compilerModule = 'mediawiki.template.' . $suffix;
 304                                 if ( $suffix !== 'html' && !in_array( $compilerModule, $this->dependencies ) ) {
 305                                         $this->dependencies[] = $compilerModule;
 306                                 }
 307                         }
 308                 }
 309         }
 310
 311         /**
 312          * Extract a pair of local and remote base paths from module definition information.
 313          * Implementation note: the amount of global state used in this function is staggering.
 314          *
 315          * @param array $options Module definition
 316          * @param string $localBasePath Path to use if not provided in module definition. Defaults
 317          *     to $IP
 318          * @param string $remoteBasePath Path to use if not provided in module definition. Defaults
 319          *     to $wgResourceBasePath
 320          * @return array Array( localBasePath, remoteBasePath )
 321          */
 322         public static function extractBasePaths(
 323                 $options = array(),
 324                 $localBasePath = null,
 325                 $remoteBasePath = null
 326         ) {
 327                 global $IP, $wgResourceBasePath;
 328
 329                 // The different ways these checks are done, and their ordering, look very silly,
 330                 // but were preserved for backwards-compatibility just in case. Tread lightly.
 331
 332                 if ( $localBasePath === null ) {
 333                         $localBasePath = $IP;
 334                 }
 335                 if ( $remoteBasePath === null ) {
 336                         $remoteBasePath = $wgResourceBasePath;
 337                 }
 338
 339                 if ( isset( $options['remoteExtPath'] ) ) {
 340                         global $wgExtensionAssetsPath;
 341                         $remoteBasePath = $wgExtensionAssetsPath . '/' . $options['remoteExtPath'];
 342                 }
 343
 344                 if ( isset( $options['remoteSkinPath'] ) ) {
 345                         global $wgStylePath;
 346                         $remoteBasePath = $wgStylePath . '/' . $options['remoteSkinPath'];
 347                 }
 348
 349                 if ( array_key_exists( 'localBasePath', $options ) ) {
 350                         $localBasePath = (string)$options['localBasePath'];
 351                 }
 352
 353                 if ( array_key_exists( 'remoteBasePath', $options ) ) {
 354                         $remoteBasePath = (string)$options['remoteBasePath'];
 355                 }
 356
 357                 // Make sure the remote base path is a complete valid URL,
 358                 // but possibly protocol-relative to avoid cache pollution
 359                 $remoteBasePath = wfExpandUrl( $remoteBasePath, PROTO_RELATIVE );
 360
 361                 return array( $localBasePath, $remoteBasePath );
 362         }
 363
 364         /**
 365          * Gets all scripts for a given context concatenated together.
 366          *
 367          * @param ResourceLoaderContext $context Context in which to generate script
 368          * @return string JavaScript code for $context
 369          */
 370         public function getScript( ResourceLoaderContext $context ) {
 371                 $files = $this->getScriptFiles( $context );
 372                 return $this->readScriptFiles( $files );
 373         }
 374
 375         /**
 376          * @param ResourceLoaderContext $context
 377          * @return array
 378          */
 379         public function getScriptURLsForDebug( ResourceLoaderContext $context ) {
 380                 $urls = array();
 381                 foreach ( $this->getScriptFiles( $context ) as $file ) {
 382                         $urls[] = $this->getRemotePath( $file );
 383                 }
 384                 return $urls;
 385         }
 386
 387         /**
 388          * @return bool
 389          */
 390         public function supportsURLLoading() {
 391                 return $this->debugRaw;
 392         }
 393
 394         /**
 395          * Get loader script.
 396          *
 397          * @return string|bool JavaScript code to be added to startup module
 398          */
 399         public function getLoaderScript() {
 400                 if ( count( $this->loaderScripts ) === 0 ) {
 401                         return false;
 402                 }
 403                 return $this->readScriptFiles( $this->loaderScripts );
 404         }
 405
 406         /**
 407          * Get all styles for a given context.
 408          *
 409          * @param ResourceLoaderContext $context
 410          * @return array CSS code for $context as an associative array mapping media type to CSS text.
 411          */
 412         public function getStyles( ResourceLoaderContext $context ) {
 413                 $styles = $this->readStyleFiles(
 414                         $this->getStyleFiles( $context ),
 415                         $this->getFlip( $context ),
 416                         $context
 417                 );
 418                 // Collect referenced files
 419                 $this->localFileRefs = array_unique( $this->localFileRefs );
 420                 $this->saveFileDependencies( $context->getSkin(), $this->localFileRefs );
 421
 422                 return $styles;
 423         }
 424
 425         /**
 426          * @param ResourceLoaderContext $context
 427          * @return array
 428          */
 429         public function getStyleURLsForDebug( ResourceLoaderContext $context ) {
 430                 if ( $this->hasGeneratedStyles ) {
 431                         // Do the default behaviour of returning a url back to load.php
 432                         // but with only=styles.
 433                         return parent::getStyleURLsForDebug( $context );
 434                 }
 435                 // Our module consists entirely of real css files,
 436                 // in debug mode we can load those directly.
 437                 $urls = array();
 438                 foreach ( $this->getStyleFiles( $context ) as $mediaType => $list ) {
 439                         $urls[$mediaType] = array();
 440                         foreach ( $list as $file ) {
 441                                 $urls[$mediaType][] = $this->getRemotePath( $file );
 442                         }
 443                 }
 444                 return $urls;
 445         }
 446
 447         /**
 448          * Gets list of message keys used by this module.
 449          *
 450          * @return array List of message keys
 451          */
 452         public function getMessages() {
 453                 return $this->messages;
 454         }
 455
 456         /**
 457          * Gets the name of the group this module should be loaded in.
 458          *
 459          * @return string Group name
 460          */
 461         public function getGroup() {
 462                 return $this->group;
 463         }
 464
 465         /**
 466          * @return string
 467          */
 468         public function getPosition() {
 469                 return $this->position;
 470         }
 471
 472         /**
 473          * Gets list of names of modules this module depends on.
 474          * @param ResourceLoaderContext context
 475          * @return array List of module names
 476          */
 477         public function getDependencies( ResourceLoaderContext $context = null ) {
 478                 return $this->dependencies;
 479         }
 480
 481         /**
 482          * Get the skip function.
 483          * @return null|string
 484          * @throws MWException
 485          */
 486         public function getSkipFunction() {
 487                 if ( !$this->skipFunction ) {
 488                         return null;
 489                 }
 490
 491                 $localPath = $this->getLocalPath( $this->skipFunction );
 492                 if ( !file_exists( $localPath ) ) {
 493                         throw new MWException( __METHOD__ . ": skip function file not found: \"$localPath\"" );
 494                 }
 495                 $contents = file_get_contents( $localPath );
 496                 if ( $this->getConfig()->get( 'ResourceLoaderValidateStaticJS' ) ) {
 497                         $contents = $this->validateScriptFile( $localPath, $contents );
 498                 }
 499                 return $contents;
 500         }
 501
 502         /**
 503          * @return bool
 504          */
 505         public function isRaw() {
 506                 return $this->raw;
 507         }
 508
 509         /**
 510          * Disable module content versioning.
 511          *
 512          * This class uses getDefinitionSummary() instead, to avoid filesystem overhead
 513          * involved with building the full module content inside a startup request.
 514          *
 515          * @return bool
 516          */
 517         public function enableModuleContentVersion() {
 518                 return false;
 519         }
 520
 521         /**
 522          * Helper method to gather file hashes for getDefinitionSummary.
 523          *
 524          * This function is context-sensitive, only computing hashes of files relevant to the
 525          * given language, skin, etc.
 526          *
 527          * @see ResourceLoaderModule::getFileDependencies
 528          * @param ResourceLoaderContext $context
 529          * @return array
 530          */
 531         protected function getFileHashes( ResourceLoaderContext $context ) {
 532                 $files = array();
 533
 534                 // Flatten style files into $files
 535                 $styles = self::collateFilePathListByOption( $this->styles, 'media', 'all' );
 536                 foreach ( $styles as $styleFiles ) {
 537                         $files = array_merge( $files, $styleFiles );
 538                 }
 539
 540                 $skinFiles = self::collateFilePathListByOption(
 541                         self::tryForKey( $this->skinStyles, $context->getSkin(), 'default' ),
 542                         'media',
 543                         'all'
 544                 );
 545                 foreach ( $skinFiles as $styleFiles ) {
 546                         $files = array_merge( $files, $styleFiles );
 547                 }
 548
 549                 // Final merge, this should result in a master list of dependent files
 550                 $files = array_merge(
 551                         $files,
 552                         $this->scripts,
 553                         $this->templates,
 554                         $context->getDebug() ? $this->debugScripts : array(),
 555                         $this->getLanguageScripts( $context->getLanguage() ),
 556                         self::tryForKey( $this->skinScripts, $context->getSkin(), 'default' ),
 557                         $this->loaderScripts
 558                 );
 559                 if ( $this->skipFunction ) {
 560                         $files[] = $this->skipFunction;
 561                 }
 562                 $files = array_map( array( $this, 'getLocalPath' ), $files );
 563                 // File deps need to be treated separately because they're already prefixed
 564                 $files = array_merge( $files, $this->getFileDependencies( $context->getSkin() ) );
 565                 // Filter out any duplicates from getFileDependencies() and others.
 566                 // Most commonly introduced by compileLessFile(), which always includes the
 567                 // entry point Less file we already know about.
 568                 $files = array_values( array_unique( $files ) );
 569
 570                 // Don't include keys or file paths here, only the hashes. Including that would needlessly
 571                 // cause global cache invalidation when files move or if e.g. the MediaWiki path changes.
 572                 // Any significant ordering is already detected by the definition summary.
 573                 return array_map( array( __CLASS__, 'safeFileHash' ), $files );
 574         }
 575
 576         /**
 577          * Get the definition summary for this module.
 578          *
 579          * @param ResourceLoaderContext $context
 580          * @return array
 581          */
 582         public function getDefinitionSummary( ResourceLoaderContext $context ) {
 583                 $summary = parent::getDefinitionSummary( $context );
 584
 585                 $options = array();
 586                 foreach ( array(
 587                         // The following properties are omitted because they don't affect the module reponse:
 588                         // - localBasePath (Per T104950; Changes when absolute directory name changes. If
 589                         //    this affects 'scripts' and other file paths, getFileHashes accounts for that.)
 590                         // - remoteBasePath (Per T104950)
 591                         // - dependencies (provided via startup module)
 592                         // - targets
 593                         // - group (provided via startup module)
 594                         // - position (only used by OutputPage)
 595                         'scripts',
 596                         'debugScripts',
 597                         'loaderScripts',
 598                         'styles',
 599                         'languageScripts',
 600                         'skinScripts',
 601                         'skinStyles',
 602                         'messages',
 603                         'templates',
 604                         'skipFunction',
 605                         'debugRaw',
 606                         'raw',
 607                 ) as $member ) {
 608                         $options[$member] = $this->{$member};
 609                 };
 610
 611                 $summary[] = array(
 612                         'options' => $options,
 613                         'fileHashes' => $this->getFileHashes( $context ),
 614                         'msgBlobMtime' => $this->getMsgBlobMtime( $context->getLanguage() ),
 615                 );
 616                 return $summary;
 617         }
 618
 619         /**
 620          * @param string|ResourceLoaderFilePath $path
 621          * @return string
 622          */
 623         protected function getLocalPath( $path ) {
 624                 if ( $path instanceof ResourceLoaderFilePath ) {
 625                         return $path->getLocalPath();
 626                 }
 627
 628                 return "{$this->localBasePath}/$path";
 629         }
 630
 631         /**
 632          * @param string|ResourceLoaderFilePath $path
 633          * @return string
 634          */
 635         protected function getRemotePath( $path ) {
 636                 if ( $path instanceof ResourceLoaderFilePath ) {
 637                         return $path->getRemotePath();
 638                 }
 639
 640                 return "{$this->remoteBasePath}/$path";
 641         }
 642
 643         /**
 644          * Infer the stylesheet language from a stylesheet file path.
 645          *
 646          * @since 1.22
 647          * @param string $path
 648          * @return string The stylesheet language name
 649          */
 650         public function getStyleSheetLang( $path ) {
 651                 return preg_match( '/\.less$/i', $path ) ? 'less' : 'css';
 652         }
 653
 654         /**
 655          * Collates file paths by option (where provided).
 656          *
 657          * @param array $list List of file paths in any combination of index/path
 658          *     or path/options pairs
 659          * @param string $option Option name
 660          * @param mixed $default Default value if the option isn't set
 661          * @return array List of file paths, collated by $option
 662          */
 663         protected static function collateFilePathListByOption( array $list, $option, $default ) {
 664                 $collatedFiles = array();
 665                 foreach ( (array)$list as $key => $value ) {
 666                         if ( is_int( $key ) ) {
 667                                 // File name as the value
 668                                 if ( !isset( $collatedFiles[$default] ) ) {
 669                                         $collatedFiles[$default] = array();
 670                                 }
 671                                 $collatedFiles[$default][] = $value;
 672                         } elseif ( is_array( $value ) ) {
 673                                 // File name as the key, options array as the value
 674                                 $optionValue = isset( $value[$option] ) ? $value[$option] : $default;
 675                                 if ( !isset( $collatedFiles[$optionValue] ) ) {
 676                                         $collatedFiles[$optionValue] = array();
 677                                 }
 678                                 $collatedFiles[$optionValue][] = $key;
 679                         }
 680                 }
 681                 return $collatedFiles;
 682         }
 683
 684         /**
 685          * Get a list of element that match a key, optionally using a fallback key.
 686          *
 687          * @param array $list List of lists to select from
 688          * @param string $key Key to look for in $map
 689          * @param string $fallback Key to look for in $list if $key doesn't exist
 690          * @return array List of elements from $map which matched $key or $fallback,
 691          *  or an empty list in case of no match
 692          */
 693         protected static function tryForKey( array $list, $key, $fallback = null ) {
 694                 if ( isset( $list[$key] ) && is_array( $list[$key] ) ) {
 695                         return $list[$key];
 696                 } elseif ( is_string( $fallback )
 697                         && isset( $list[$fallback] )
 698                         && is_array( $list[$fallback] )
 699                 ) {
 700                         return $list[$fallback];
 701                 }
 702                 return array();
 703         }
 704
 705         /**
 706          * Get a list of file paths for all scripts in this module, in order of proper execution.
 707          *
 708          * @param ResourceLoaderContext $context
 709          * @return array List of file paths
 710          */
 711         protected function getScriptFiles( ResourceLoaderContext $context ) {
 712                 $files = array_merge(
 713                         $this->scripts,
 714                         $this->getLanguageScripts( $context->getLanguage() ),
 715                         self::tryForKey( $this->skinScripts, $context->getSkin(), 'default' )
 716                 );
 717                 if ( $context->getDebug() ) {
 718                         $files = array_merge( $files, $this->debugScripts );
 719                 }
 720
 721                 return array_unique( $files, SORT_REGULAR );
 722         }
 723
 724         /**
 725          * Get the set of language scripts for the given language,
 726          * possibly using a fallback language.
 727          *
 728          * @param string $lang
 729          * @return array
 730          */
 731         private function getLanguageScripts( $lang ) {
 732                 $scripts = self::tryForKey( $this->languageScripts, $lang );
 733                 if ( $scripts ) {
 734                         return $scripts;
 735                 }
 736                 $fallbacks = Language::getFallbacksFor( $lang );
 737                 foreach ( $fallbacks as $lang ) {
 738                         $scripts = self::tryForKey( $this->languageScripts, $lang );
 739                         if ( $scripts ) {
 740                                 return $scripts;
 741                         }
 742                 }
 743
 744                 return array();
 745         }
 746
 747         /**
 748          * Get a list of file paths for all styles in this module, in order of proper inclusion.
 749          *
 750          * @param ResourceLoaderContext $context
 751          * @return array List of file paths
 752          */
 753         public function getStyleFiles( ResourceLoaderContext $context ) {
 754                 return array_merge_recursive(
 755                         self::collateFilePathListByOption( $this->styles, 'media', 'all' ),
 756                         self::collateFilePathListByOption(
 757                                 self::tryForKey( $this->skinStyles, $context->getSkin(), 'default' ),
 758                                 'media',
 759                                 'all'
 760                         )
 761                 );
 762         }
 763
 764         /**
 765          * Gets a list of file paths for all skin styles in the module used by
 766          * the skin.
 767          *
 768          * @param string $skinName The name of the skin
 769          * @return array A list of file paths collated by media type
 770          */
 771         protected function getSkinStyleFiles( $skinName ) {
 772                 return self::collateFilePathListByOption(
 773                         self::tryForKey( $this->skinStyles, $skinName ),
 774                         'media',
 775                         'all'
 776                 );
 777         }
 778
 779         /**
 780          * Gets a list of file paths for all skin style files in the module,
 781          * for all available skins.
 782          *
 783          * @return array A list of file paths collated by media type
 784          */
 785         protected function getAllSkinStyleFiles() {
 786                 $styleFiles = array();
 787                 $internalSkinNames = array_keys( Skin::getSkinNames() );
 788                 $internalSkinNames[] = 'default';
 789
 790                 foreach ( $internalSkinNames as $internalSkinName ) {
 791                         $styleFiles = array_merge_recursive(
 792                                 $styleFiles,
 793                                 $this->getSkinStyleFiles( $internalSkinName )
 794                         );
 795                 }
 796
 797                 return $styleFiles;
 798         }
 799
 800         /**
 801          * Returns all style files and all skin style files used by this module.
 802          *
 803          * @return array
 804          */
 805         public function getAllStyleFiles() {
 806                 $collatedStyleFiles = array_merge_recursive(
 807                         self::collateFilePathListByOption( $this->styles, 'media', 'all' ),
 808                         $this->getAllSkinStyleFiles()
 809                 );
 810
 811                 $result = array();
 812
 813                 foreach ( $collatedStyleFiles as $media => $styleFiles ) {
 814                         foreach ( $styleFiles as $styleFile ) {
 815                                 $result[] = $this->getLocalPath( $styleFile );
 816                         }
 817                 }
 818
 819                 return $result;
 820         }
 821
 822         /**
 823          * Gets the contents of a list of JavaScript files.
 824          *
 825          * @param array $scripts List of file paths to scripts to read, remap and concetenate
 826          * @throws MWException
 827          * @return string Concatenated and remapped JavaScript data from $scripts
 828          */
 829         protected function readScriptFiles( array $scripts ) {
 830                 if ( empty( $scripts ) ) {
 831                         return '';
 832                 }
 833                 $js = '';
 834                 foreach ( array_unique( $scripts, SORT_REGULAR ) as $fileName ) {
 835                         $localPath = $this->getLocalPath( $fileName );
 836                         if ( !file_exists( $localPath ) ) {
 837                                 throw new MWException( __METHOD__ . ": script file not found: \"$localPath\"" );
 838                         }
 839                         $contents = file_get_contents( $localPath );
 840                         if ( $this->getConfig()->get( 'ResourceLoaderValidateStaticJS' ) ) {
 841                                 // Static files don't really need to be checked as often; unlike
 842                                 // on-wiki module they shouldn't change unexpectedly without
 843                                 // admin interference.
 844                                 $contents = $this->validateScriptFile( $fileName, $contents );
 845                         }
 846                         $js .= $contents . "\n";
 847                 }
 848                 return $js;
 849         }
 850
 851         /**
 852          * Gets the contents of a list of CSS files.
 853          *
 854          * @param array $styles List of media type/list of file paths pairs, to read, remap and
 855          * concetenate
 856          * @param bool $flip
 857          * @param ResourceLoaderContext $context
 858          *
 859          * @throws MWException
 860          * @return array List of concatenated and remapped CSS data from $styles,
 861          *     keyed by media type
 862          *
 863          * @since 1.26 Calling this method without a ResourceLoaderContext instance
 864          *   is deprecated.
 865          */
 866         public function readStyleFiles( array $styles, $flip, $context = null ) {
 867                 if ( $context === null ) {
 868                         wfDeprecated( __METHOD__ . ' without a ResourceLoader context', '1.26' );
 869                         $context = ResourceLoaderContext::newDummyContext();
 870                 }
 871
 872                 if ( empty( $styles ) ) {
 873                         return array();
 874                 }
 875                 foreach ( $styles as $media => $files ) {
 876                         $uniqueFiles = array_unique( $files, SORT_REGULAR );
 877                         $styleFiles = array();
 878                         foreach ( $uniqueFiles as $file ) {
 879                                 $styleFiles[] = $this->readStyleFile( $file, $flip, $context );
 880                         }
 881                         $styles[$media] = implode( "\n", $styleFiles );
 882                 }
 883                 return $styles;
 884         }
 885
 886         /**
 887          * Reads a style file.
 888          *
 889          * This method can be used as a callback for array_map()
 890          *
 891          * @param string $path File path of style file to read
 892          * @param bool $flip
 893          * @param ResourceLoaderContext $context
 894          *
 895          * @return string CSS data in script file
 896          * @throws MWException If the file doesn't exist
 897          */
 898         protected function readStyleFile( $path, $flip, $context ) {
 899                 $localPath = $this->getLocalPath( $path );
 900                 $remotePath = $this->getRemotePath( $path );
 901                 if ( !file_exists( $localPath ) ) {
 902                         $msg = __METHOD__ . ": style file not found: \"$localPath\"";
 903                         wfDebugLog( 'resourceloader', $msg );
 904                         throw new MWException( $msg );
 905                 }
 906
 907                 if ( $this->getStyleSheetLang( $localPath ) === 'less' ) {
 908                         $style = $this->compileLessFile( $localPath, $context );
 909                         $this->hasGeneratedStyles = true;
 910                 } else {
 911                         $style = file_get_contents( $localPath );
 912                 }
 913
 914                 if ( $flip ) {
 915                         $style = CSSJanus::transform( $style, true, false );
 916                 }
 917                 $localDir = dirname( $localPath );
 918                 $remoteDir = dirname( $remotePath );
 919                 // Get and register local file references
 920                 $localFileRefs = CSSMin::getAllLocalFileReferences( $style, $localDir );
 921                 foreach ( $localFileRefs as $file ) {
 922                         if ( file_exists( $file ) ) {
 923                                 $this->localFileRefs[] = $file;
 924                         } else {
 925                                 $this->missingLocalFileRefs[] = $file;
 926                         }
 927                 }
 928                 return CSSMin::remap(
 929                         $style, $localDir, $remoteDir, true
 930                 );
 931         }
 932
 933         /**
 934          * Get whether CSS for this module should be flipped
 935          * @param ResourceLoaderContext $context
 936          * @return bool
 937          */
 938         public function getFlip( $context ) {
 939                 return $context->getDirection() === 'rtl';
 940         }
 941
 942         /**
 943          * Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile']
 944          *
 945          * @return array Array of strings
 946          */
 947         public function getTargets() {
 948                 return $this->targets;
 949         }
 950
 951         /**
 952          * Compile a LESS file into CSS.
 953          *
 954          * Keeps track of all used files and adds them to localFileRefs.
 955          *
 956          * @since 1.22
 957          * @since 1.26 Added $context paramter.
 958          * @throws Exception If less.php encounters a parse error
 959          * @param string $fileName File path of LESS source
 960          * @param ResourceLoaderContext $context Context in which to generate script
 961          * @return string CSS source
 962          */
 963         protected function compileLessFile( $fileName, ResourceLoaderContext $context ) {
 964                 static $cache;
 965
 966                 if ( !$cache ) {
 967                         $cache = ObjectCache::newAccelerator( CACHE_ANYTHING );
 968                 }
 969
 970                 // Construct a cache key from the LESS file name and a hash digest
 971                 // of the LESS variables used for compilation.
 972                 $vars = $this->getLessVars( $context );
 973                 ksort( $vars );
 974                 $varsHash = hash( 'md4', serialize( $vars ) );
 975                 $cacheKey = wfGlobalCacheKey( 'LESS', $fileName, $varsHash );
 976                 $cachedCompile = $cache->get( $cacheKey );
 977
 978                 // If we got a cached value, we have to validate it by getting a
 979                 // checksum of all the files that were loaded by the parser and
 980                 // ensuring it matches the cached entry's.
 981                 if ( isset( $cachedCompile['hash'] ) ) {
 982                         $contentHash = FileContentsHasher::getFileContentsHash( $cachedCompile['files'] );
 983                         if ( $contentHash === $cachedCompile['hash'] ) {
 984                                 $this->localFileRefs += $cachedCompile['files'];
 985                                 return $cachedCompile['css'];
 986                         }
 987                 }
 988
 989                 $compiler = ResourceLoader::getLessCompiler( $this->getConfig(), $vars );
 990                 $css = $compiler->parseFile( $fileName )->getCss();
 991                 $files = $compiler->AllParsedFiles();
 992                 $this->localFileRefs = array_merge( $this->localFileRefs, $files );
 993
 994                 $cache->set( $cacheKey, array(
 995                         'css'   => $css,
 996                         'files' => $files,
 997                         'hash'  => FileContentsHasher::getFileContentsHash( $files ),
 998                 ), 60 * 60 * 24 );  // 86400 seconds, or 24 hours.
 999
1000                 return $css;
1001         }
1002
1003         /**
1004          * Takes named templates by the module and returns an array mapping.
1005          * @return array of templates mapping template alias to content
1006          * @throws MWException
1007          */
1008         public function getTemplates() {
1009                 $templates = array();
1010
1011                 foreach ( $this->templates as $alias => $templatePath ) {
1012                         // Alias is optional
1013                         if ( is_int( $alias ) ) {
1014                                 $alias = $templatePath;
1015                         }
1016                         $localPath = $this->getLocalPath( $templatePath );
1017                         if ( file_exists( $localPath ) ) {
1018                                 $content = file_get_contents( $localPath );
1019                                 $templates[$alias] = $content;
1020                         } else {
1021                                 $msg = __METHOD__ . ": template file not found: \"$localPath\"";
1022                                 wfDebugLog( 'resourceloader', $msg );
1023                                 throw new MWException( $msg );
1024                         }
1025                 }
1026                 return $templates;
1027         }
1028 }