includes/resourceloader/ResourceLoaderModule.php

   1 <?php
   2 /**
   3  * Abstraction for ResourceLoader modules.
   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 use MediaWiki\MediaWikiServices;
  26 use Psr\Log\LoggerAwareInterface;
  27 use Psr\Log\LoggerInterface;
  28 use Psr\Log\NullLogger;
  29 use Wikimedia\RelPath;
  30 use Wikimedia\ScopedCallback;
  31
  32 /**
  33  * Abstraction for ResourceLoader modules, with name registration and maxage functionality.
  34  */
  35 abstract class ResourceLoaderModule implements LoggerAwareInterface {
  36         # Type of resource
  37         const TYPE_SCRIPTS = 'scripts';
  38         const TYPE_STYLES = 'styles';
  39         const TYPE_COMBINED = 'combined';
  40
  41         # Desired load type
  42         // Module only has styles (loaded via <style> or <link rel=stylesheet>)
  43         const LOAD_STYLES = 'styles';
  44         // Module may have other resources (loaded via mw.loader from a script)
  45         const LOAD_GENERAL = 'general';
  46
  47         # sitewide core module like a skin file or jQuery component
  48         const ORIGIN_CORE_SITEWIDE = 1;
  49
  50         # per-user module generated by the software
  51         const ORIGIN_CORE_INDIVIDUAL = 2;
  52
  53         # sitewide module generated from user-editable files, like MediaWiki:Common.js, or
  54         # modules accessible to multiple users, such as those generated by the Gadgets extension.
  55         const ORIGIN_USER_SITEWIDE = 3;
  56
  57         # per-user module generated from user-editable files, like User:Me/vector.js
  58         const ORIGIN_USER_INDIVIDUAL = 4;
  59
  60         # an access constant; make sure this is kept as the largest number in this group
  61         const ORIGIN_ALL = 10;
  62
  63         # script and style modules form a hierarchy of trustworthiness, with core modules like
  64         # skins and jQuery as most trustworthy, and user scripts as least trustworthy.  We can
  65         # limit the types of scripts and styles we allow to load on, say, sensitive special
  66         # pages like Special:UserLogin and Special:Preferences
  67         protected $origin = self::ORIGIN_CORE_SITEWIDE;
  68
  69         protected $name = null;
  70         protected $targets = [ 'desktop' ];
  71
  72         // In-object cache for file dependencies
  73         protected $fileDeps = [];
  74         // In-object cache for message blob (keyed by language)
  75         protected $msgBlobs = [];
  76         // In-object cache for version hash
  77         protected $versionHash = [];
  78         // In-object cache for module content
  79         protected $contents = [];
  80
  81         /**
  82          * @var Config
  83          */
  84         protected $config;
  85
  86         /**
  87          * @var array|bool
  88          */
  89         protected $deprecated = false;
  90
  91         /**
  92          * @var LoggerInterface
  93          */
  94         protected $logger;
  95
  96         /**
  97          * Get this module's name. This is set when the module is registered
  98          * with ResourceLoader::register()
  99          *
 100          * @return string|null Name (string) or null if no name was set
 101          */
 102         public function getName() {
 103                 return $this->name;
 104         }
 105
 106         /**
 107          * Set this module's name. This is called by ResourceLoader::register()
 108          * when registering the module. Other code should not call this.
 109          *
 110          * @param string $name
 111          */
 112         public function setName( $name ) {
 113                 $this->name = $name;
 114         }
 115
 116         /**
 117          * Get this module's origin. This is set when the module is registered
 118          * with ResourceLoader::register()
 119          *
 120          * @return int ResourceLoaderModule class constant, the subclass default
 121          *     if not set manually
 122          */
 123         public function getOrigin() {
 124                 return $this->origin;
 125         }
 126
 127         /**
 128          * @param ResourceLoaderContext $context
 129          * @return bool
 130          */
 131         public function getFlip( $context ) {
 132                 return MediaWikiServices::getInstance()->getContentLanguage()->getDir() !==
 133                         $context->getDirection();
 134         }
 135
 136         /**
 137          * Get JS representing deprecation information for the current module if available
 138          *
 139          * @return string JavaScript code
 140          */
 141         public function getDeprecationInformation() {
 142                 $deprecationInfo = $this->deprecated;
 143                 if ( $deprecationInfo ) {
 144                         $name = $this->getName();
 145                         $warning = 'This page is using the deprecated ResourceLoader module "' . $name . '".';
 146                         if ( is_string( $deprecationInfo ) ) {
 147                                 $warning .= "\n" . $deprecationInfo;
 148                         }
 149                         return Xml::encodeJsCall(
 150                                 'mw.log.warn',
 151                                 [ $warning ]
 152                         );
 153                 } else {
 154                         return '';
 155                 }
 156         }
 157
 158         /**
 159          * Get all JS for this module for a given language and skin.
 160          * Includes all relevant JS except loader scripts.
 161          *
 162          * For "plain" script modules, this should return a string with JS code. For multi-file modules
 163          * where require() is used to load one file from another file, this should return an array
 164          * structured as follows:
 165          * [
 166          *     'files' => [
 167          *         'file1.js' => [ 'type' => 'script', 'content' => 'JS code' ],
 168          *         'file2.js' => [ 'type' => 'script', 'content' => 'JS code' ],
 169          *         'data.json' => [ 'type' => 'data', 'content' => array ]
 170          *     ],
 171          *     'main' => 'file1.js'
 172          * ]
 173          *
 174          * @param ResourceLoaderContext $context
 175          * @return string|array JavaScript code (string), or multi-file structure described above (array)
 176          */
 177         public function getScript( ResourceLoaderContext $context ) {
 178                 // Stub, override expected
 179                 return '';
 180         }
 181
 182         /**
 183          * Takes named templates by the module and returns an array mapping.
 184          *
 185          * @return array of templates mapping template alias to content
 186          */
 187         public function getTemplates() {
 188                 // Stub, override expected.
 189                 return [];
 190         }
 191
 192         /**
 193          * @return Config
 194          * @since 1.24
 195          */
 196         public function getConfig() {
 197                 if ( $this->config === null ) {
 198                         // Ugh, fall back to default
 199                         $this->config = MediaWikiServices::getInstance()->getMainConfig();
 200                 }
 201
 202                 return $this->config;
 203         }
 204
 205         /**
 206          * @param Config $config
 207          * @since 1.24
 208          */
 209         public function setConfig( Config $config ) {
 210                 $this->config = $config;
 211         }
 212
 213         /**
 214          * @since 1.27
 215          * @param LoggerInterface $logger
 216          * @return null
 217          */
 218         public function setLogger( LoggerInterface $logger ) {
 219                 $this->logger = $logger;
 220         }
 221
 222         /**
 223          * @since 1.27
 224          * @return LoggerInterface
 225          */
 226         protected function getLogger() {
 227                 if ( !$this->logger ) {
 228                         $this->logger = new NullLogger();
 229                 }
 230                 return $this->logger;
 231         }
 232
 233         /**
 234          * Get the URL or URLs to load for this module's JS in debug mode.
 235          * The default behavior is to return a load.php?only=scripts URL for
 236          * the module, but file-based modules will want to override this to
 237          * load the files directly.
 238          *
 239          * This function is called only when 1) we're in debug mode, 2) there
 240          * is no only= parameter and 3) supportsURLLoading() returns true.
 241          * #2 is important to prevent an infinite loop, therefore this function
 242          * MUST return either an only= URL or a non-load.php URL.
 243          *
 244          * @param ResourceLoaderContext $context
 245          * @return array Array of URLs
 246          */
 247         public function getScriptURLsForDebug( ResourceLoaderContext $context ) {
 248                 $resourceLoader = $context->getResourceLoader();
 249                 $derivative = new DerivativeResourceLoaderContext( $context );
 250                 $derivative->setModules( [ $this->getName() ] );
 251                 $derivative->setOnly( 'scripts' );
 252                 $derivative->setDebug( true );
 253
 254                 $url = $resourceLoader->createLoaderURL(
 255                         $this->getSource(),
 256                         $derivative
 257                 );
 258
 259                 return [ $url ];
 260         }
 261
 262         /**
 263          * Whether this module supports URL loading. If this function returns false,
 264          * getScript() will be used even in cases (debug mode, no only param) where
 265          * getScriptURLsForDebug() would normally be used instead.
 266          * @return bool
 267          */
 268         public function supportsURLLoading() {
 269                 return true;
 270         }
 271
 272         /**
 273          * Get all CSS for this module for a given skin.
 274          *
 275          * @param ResourceLoaderContext $context
 276          * @return array List of CSS strings or array of CSS strings keyed by media type.
 277          *  like [ 'screen' => '.foo { width: 0 }' ];
 278          *  or [ 'screen' => [ '.foo { width: 0 }' ] ];
 279          */
 280         public function getStyles( ResourceLoaderContext $context ) {
 281                 // Stub, override expected
 282                 return [];
 283         }
 284
 285         /**
 286          * Get the URL or URLs to load for this module's CSS in debug mode.
 287          * The default behavior is to return a load.php?only=styles URL for
 288          * the module, but file-based modules will want to override this to
 289          * load the files directly. See also getScriptURLsForDebug()
 290          *
 291          * @param ResourceLoaderContext $context
 292          * @return array [ mediaType => [ URL1, URL2, ... ], ... ]
 293          */
 294         public function getStyleURLsForDebug( ResourceLoaderContext $context ) {
 295                 $resourceLoader = $context->getResourceLoader();
 296                 $derivative = new DerivativeResourceLoaderContext( $context );
 297                 $derivative->setModules( [ $this->getName() ] );
 298                 $derivative->setOnly( 'styles' );
 299                 $derivative->setDebug( true );
 300
 301                 $url = $resourceLoader->createLoaderURL(
 302                         $this->getSource(),
 303                         $derivative
 304                 );
 305
 306                 return [ 'all' => [ $url ] ];
 307         }
 308
 309         /**
 310          * Get the messages needed for this module.
 311          *
 312          * To get a JSON blob with messages, use MessageBlobStore::get()
 313          *
 314          * @return array List of message keys. Keys may occur more than once
 315          */
 316         public function getMessages() {
 317                 // Stub, override expected
 318                 return [];
 319         }
 320
 321         /**
 322          * Get the group this module is in.
 323          *
 324          * @return string Group name
 325          */
 326         public function getGroup() {
 327                 // Stub, override expected
 328                 return null;
 329         }
 330
 331         /**
 332          * Get the source of this module. Should only be overridden for foreign modules.
 333          *
 334          * @return string Source name, 'local' for local modules
 335          */
 336         public function getSource() {
 337                 // Stub, override expected
 338                 return 'local';
 339         }
 340
 341         /**
 342          * Whether this module's JS expects to work without the client-side ResourceLoader module.
 343          * Returning true from this function will prevent mw.loader.state() call from being
 344          * appended to the bottom of the script.
 345          *
 346          * @return bool
 347          */
 348         public function isRaw() {
 349                 return false;
 350         }
 351
 352         /**
 353          * Get a list of modules this module depends on.
 354          *
 355          * Dependency information is taken into account when loading a module
 356          * on the client side.
 357          *
 358          * Note: It is expected that $context will be made non-optional in the near
 359          * future.
 360          *
 361          * @param ResourceLoaderContext|null $context
 362          * @return array List of module names as strings
 363          */
 364         public function getDependencies( ResourceLoaderContext $context = null ) {
 365                 // Stub, override expected
 366                 return [];
 367         }
 368
 369         /**
 370          * Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile']
 371          *
 372          * @return array Array of strings
 373          */
 374         public function getTargets() {
 375                 return $this->targets;
 376         }
 377
 378         /**
 379          * Get the module's load type.
 380          *
 381          * @since 1.28
 382          * @return string ResourceLoaderModule LOAD_* constant
 383          */
 384         public function getType() {
 385                 return self::LOAD_GENERAL;
 386         }
 387
 388         /**
 389          * Get the skip function.
 390          *
 391          * Modules that provide fallback functionality can provide a "skip function". This
 392          * function, if provided, will be passed along to the module registry on the client.
 393          * When this module is loaded (either directly or as a dependency of another module),
 394          * then this function is executed first. If the function returns true, the module will
 395          * instantly be considered "ready" without requesting the associated module resources.
 396          *
 397          * The value returned here must be valid javascript for execution in a private function.
 398          * It must not contain the "function () {" and "}" wrapper though.
 399          *
 400          * @return string|null A JavaScript function body returning a boolean value, or null
 401          */
 402         public function getSkipFunction() {
 403                 return null;
 404         }
 405
 406         /**
 407          * Get the files this module depends on indirectly for a given skin.
 408          *
 409          * These are only image files referenced by the module's stylesheet.
 410          *
 411          * @param ResourceLoaderContext $context
 412          * @return array List of files
 413          */
 414         protected function getFileDependencies( ResourceLoaderContext $context ) {
 415                 $vary = $context->getSkin() . '|' . $context->getLanguage();
 416
 417                 // Try in-object cache first
 418                 if ( !isset( $this->fileDeps[$vary] ) ) {
 419                         $dbr = wfGetDB( DB_REPLICA );
 420                         $deps = $dbr->selectField( 'module_deps',
 421                                 'md_deps',
 422                                 [
 423                                         'md_module' => $this->getName(),
 424                                         'md_skin' => $vary,
 425                                 ],
 426                                 __METHOD__
 427                         );
 428
 429                         if ( !is_null( $deps ) ) {
 430                                 $this->fileDeps[$vary] = self::expandRelativePaths(
 431                                         (array)json_decode( $deps, true )
 432                                 );
 433                         } else {
 434                                 $this->fileDeps[$vary] = [];
 435                         }
 436                 }
 437                 return $this->fileDeps[$vary];
 438         }
 439
 440         /**
 441          * Set in-object cache for file dependencies.
 442          *
 443          * This is used to retrieve data in batches. See ResourceLoader::preloadModuleInfo().
 444          * To save the data, use saveFileDependencies().
 445          *
 446          * @param ResourceLoaderContext $context
 447          * @param string[] $files Array of file names
 448          */
 449         public function setFileDependencies( ResourceLoaderContext $context, $files ) {
 450                 $vary = $context->getSkin() . '|' . $context->getLanguage();
 451                 $this->fileDeps[$vary] = $files;
 452         }
 453
 454         /**
 455          * Set the files this module depends on indirectly for a given skin.
 456          *
 457          * @since 1.27
 458          * @param ResourceLoaderContext $context
 459          * @param array $localFileRefs List of files
 460          */
 461         protected function saveFileDependencies( ResourceLoaderContext $context, $localFileRefs ) {
 462                 try {
 463                         // Related bugs and performance considerations:
 464                         // 1. Don't needlessly change the database value with the same list in a
 465                         //    different order or with duplicates.
 466                         // 2. Use relative paths to avoid ghost entries when $IP changes. (T111481)
 467                         // 3. Don't needlessly replace the database with the same value
 468                         //    just because $IP changed (e.g. when upgrading a wiki).
 469                         // 4. Don't create an endless replace loop on every request for this
 470                         //    module when '../' is used anywhere. Even though both are expanded
 471                         //    (one expanded by getFileDependencies from the DB, the other is
 472                         //    still raw as originally read by RL), the latter has not
 473                         //    been normalized yet.
 474
 475                         // Normalise
 476                         $localFileRefs = array_values( array_unique( $localFileRefs ) );
 477                         sort( $localFileRefs );
 478                         $localPaths = self::getRelativePaths( $localFileRefs );
 479
 480                         $storedPaths = self::getRelativePaths( $this->getFileDependencies( $context ) );
 481                         // If the list has been modified since last time we cached it, update the cache
 482                         if ( $localPaths !== $storedPaths ) {
 483                                 $vary = $context->getSkin() . '|' . $context->getLanguage();
 484                                 $cache = ObjectCache::getLocalClusterInstance();
 485                                 $key = $cache->makeKey( __METHOD__, $this->getName(), $vary );
 486                                 $scopeLock = $cache->getScopedLock( $key, 0 );
 487                                 if ( !$scopeLock ) {
 488                                         return; // T124649; avoid write slams
 489                                 }
 490
 491                                 // No needless escaping as this isn't HTML output.
 492                                 // Only stored in the database and parsed in PHP.
 493                                 $deps = json_encode( $localPaths, JSON_UNESCAPED_SLASHES );
 494                                 $dbw = wfGetDB( DB_MASTER );
 495                                 $dbw->upsert( 'module_deps',
 496                                         [
 497                                                 'md_module' => $this->getName(),
 498                                                 'md_skin' => $vary,
 499                                                 'md_deps' => $deps,
 500                                         ],
 501                                         [ 'md_module', 'md_skin' ],
 502                                         [
 503                                                 'md_deps' => $deps,
 504                                         ]
 505                                 );
 506
 507                                 if ( $dbw->trxLevel() ) {
 508                                         $dbw->onTransactionResolution(
 509                                                 function () use ( &$scopeLock ) {
 510                                                         ScopedCallback::consume( $scopeLock ); // release after commit
 511                                                 },
 512                                                 __METHOD__
 513                                         );
 514                                 }
 515                         }
 516                 } catch ( Exception $e ) {
 517                         wfDebugLog( 'resourceloader', __METHOD__ . ": failed to update DB: $e" );
 518                 }
 519         }
 520
 521         /**
 522          * Make file paths relative to MediaWiki directory.
 523          *
 524          * This is used to make file paths safe for storing in a database without the paths
 525          * becoming stale or incorrect when MediaWiki is moved or upgraded (T111481).
 526          *
 527          * @since 1.27
 528          * @param array $filePaths
 529          * @return array
 530          */
 531         public static function getRelativePaths( array $filePaths ) {
 532                 global $IP;
 533                 return array_map( function ( $path ) use ( $IP ) {
 534                         return RelPath::getRelativePath( $path, $IP );
 535                 }, $filePaths );
 536         }
 537
 538         /**
 539          * Expand directories relative to $IP.
 540          *
 541          * @since 1.27
 542          * @param array $filePaths
 543          * @return array
 544          */
 545         public static function expandRelativePaths( array $filePaths ) {
 546                 global $IP;
 547                 return array_map( function ( $path ) use ( $IP ) {
 548                         return RelPath::joinPath( $IP, $path );
 549                 }, $filePaths );
 550         }
 551
 552         /**
 553          * Get the hash of the message blob.
 554          *
 555          * @since 1.27
 556          * @param ResourceLoaderContext $context
 557          * @return string|null JSON blob or null if module has no messages
 558          */
 559         protected function getMessageBlob( ResourceLoaderContext $context ) {
 560                 if ( !$this->getMessages() ) {
 561                         // Don't bother consulting MessageBlobStore
 562                         return null;
 563                 }
 564                 // Message blobs may only vary language, not by context keys
 565                 $lang = $context->getLanguage();
 566                 if ( !isset( $this->msgBlobs[$lang] ) ) {
 567                         $this->getLogger()->warning( 'Message blob for {module} should have been preloaded', [
 568                                 'module' => $this->getName(),
 569                         ] );
 570                         $store = $context->getResourceLoader()->getMessageBlobStore();
 571                         $this->msgBlobs[$lang] = $store->getBlob( $this, $lang );
 572                 }
 573                 return $this->msgBlobs[$lang];
 574         }
 575
 576         /**
 577          * Set in-object cache for message blobs.
 578          *
 579          * Used to allow fetching of message blobs in batches. See ResourceLoader::preloadModuleInfo().
 580          *
 581          * @since 1.27
 582          * @param string|null $blob JSON blob or null
 583          * @param string $lang Language code
 584          */
 585         public function setMessageBlob( $blob, $lang ) {
 586                 $this->msgBlobs[$lang] = $blob;
 587         }
 588
 589         /**
 590          * Get headers to send as part of a module web response.
 591          *
 592          * It is not supported to send headers through this method that are
 593          * required to be unique or otherwise sent once in an HTTP response
 594          * because clients may make batch requests for multiple modules (as
 595          * is the default behaviour for ResourceLoader clients).
 596          *
 597          * For exclusive or aggregated headers, see ResourceLoader::sendResponseHeaders().
 598          *
 599          * @since 1.30
 600          * @param ResourceLoaderContext $context
 601          * @return string[] Array of HTTP response headers
 602          */
 603         final public function getHeaders( ResourceLoaderContext $context ) {
 604                 $headers = [];
 605
 606                 $formattedLinks = [];
 607                 foreach ( $this->getPreloadLinks( $context ) as $url => $attribs ) {
 608                         $link = "<{$url}>;rel=preload";
 609                         foreach ( $attribs as $key => $val ) {
 610                                 $link .= ";{$key}={$val}";
 611                         }
 612                         $formattedLinks[] = $link;
 613                 }
 614                 if ( $formattedLinks ) {
 615                         $headers[] = 'Link: ' . implode( ',', $formattedLinks );
 616                 }
 617
 618                 return $headers;
 619         }
 620
 621         /**
 622          * Get a list of resources that web browsers may preload.
 623          *
 624          * Behaviour of rel=preload link is specified at <https://www.w3.org/TR/preload/>.
 625          *
 626          * Use case for ResourceLoader originally part of T164299.
 627          *
 628          * @par Example
 629          * @code
 630          *     protected function getPreloadLinks() {
 631          *         return [
 632          *             'https://example.org/script.js' => [ 'as' => 'script' ],
 633          *             'https://example.org/image.png' => [ 'as' => 'image' ],
 634          *         ];
 635          *     }
 636          * @endcode
 637          *
 638          * @par Example using HiDPI image variants
 639          * @code
 640          *     protected function getPreloadLinks() {
 641          *         return [
 642          *             'https://example.org/logo.png' => [
 643          *                 'as' => 'image',
 644          *                 'media' => 'not all and (min-resolution: 2dppx)',
 645          *             ],
 646          *             'https://example.org/logo@2x.png' => [
 647          *                 'as' => 'image',
 648          *                 'media' => '(min-resolution: 2dppx)',
 649          *             ],
 650          *         ];
 651          *     }
 652          * @endcode
 653          *
 654          * @see ResourceLoaderModule::getHeaders
 655          * @since 1.30
 656          * @param ResourceLoaderContext $context
 657          * @return array Keyed by url, values must be an array containing
 658          *  at least an 'as' key. Optionally a 'media' key as well.
 659          */
 660         protected function getPreloadLinks( ResourceLoaderContext $context ) {
 661                 return [];
 662         }
 663
 664         /**
 665          * Get module-specific LESS variables, if any.
 666          *
 667          * @since 1.27
 668          * @param ResourceLoaderContext $context
 669          * @return array Module-specific LESS variables.
 670          */
 671         protected function getLessVars( ResourceLoaderContext $context ) {
 672                 return [];
 673         }
 674
 675         /**
 676          * Get an array of this module's resources. Ready for serving to the web.
 677          *
 678          * @since 1.26
 679          * @param ResourceLoaderContext $context
 680          * @return array
 681          */
 682         public function getModuleContent( ResourceLoaderContext $context ) {
 683                 $contextHash = $context->getHash();
 684                 // Cache this expensive operation. This calls builds the scripts, styles, and messages
 685                 // content which typically involves filesystem and/or database access.
 686                 if ( !array_key_exists( $contextHash, $this->contents ) ) {
 687                         $this->contents[$contextHash] = $this->buildContent( $context );
 688                 }
 689                 return $this->contents[$contextHash];
 690         }
 691
 692         /**
 693          * Bundle all resources attached to this module into an array.
 694          *
 695          * @since 1.26
 696          * @param ResourceLoaderContext $context
 697          * @return array
 698          */
 699         final protected function buildContent( ResourceLoaderContext $context ) {
 700                 $rl = $context->getResourceLoader();
 701                 $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
 702                 $statStart = microtime( true );
 703
 704                 // This MUST build both scripts and styles, regardless of whether $context->getOnly()
 705                 // is 'scripts' or 'styles' because the result is used by getVersionHash which
 706                 // must be consistent regardless of the 'only' filter on the current request.
 707                 // Also, when introducing new module content resources (e.g. templates, headers),
 708                 // these should only be included in the array when they are non-empty so that
 709                 // existing modules not using them do not get their cache invalidated.
 710                 $content = [];
 711
 712                 // Scripts
 713                 // If we are in debug mode, we'll want to return an array of URLs if possible
 714                 // However, we can't do this if the module doesn't support it.
 715                 // We also can't do this if there is an only= parameter, because we have to give
 716                 // the module a way to return a load.php URL without causing an infinite loop
 717                 if ( $context->getDebug() && !$context->getOnly() && $this->supportsURLLoading() ) {
 718                         $scripts = $this->getScriptURLsForDebug( $context );
 719                 } else {
 720                         $scripts = $this->getScript( $context );
 721                         // Make the script safe to concatenate by making sure there is at least one
 722                         // trailing new line at the end of the content. Previously, this looked for
 723                         // a semi-colon instead, but that breaks concatenation if the semicolon
 724                         // is inside a comment like "// foo();". Instead, simply use a
 725                         // line break as separator which matches JavaScript native logic for implicitly
 726                         // ending statements even if a semi-colon is missing.
 727                         // Bugs: T29054, T162719.
 728                         if ( is_string( $scripts )
 729                                 && strlen( $scripts )
 730                                 && substr( $scripts, -1 ) !== "\n"
 731                         ) {
 732                                 $scripts .= "\n";
 733                         }
 734                 }
 735                 $content['scripts'] = $scripts;
 736
 737                 // Styles
 738                 $styles = [];
 739                 // Don't create empty stylesheets like [ '' => '' ] for modules
 740                 // that don't *have* any stylesheets (T40024).
 741                 $stylePairs = $this->getStyles( $context );
 742                 if ( count( $stylePairs ) ) {
 743                         // If we are in debug mode without &only= set, we'll want to return an array of URLs
 744                         // See comment near shouldIncludeScripts() for more details
 745                         if ( $context->getDebug() && !$context->getOnly() && $this->supportsURLLoading() ) {
 746                                 $styles = [
 747                                         'url' => $this->getStyleURLsForDebug( $context )
 748                                 ];
 749                         } else {
 750                                 // Minify CSS before embedding in mw.loader.implement call
 751                                 // (unless in debug mode)
 752                                 if ( !$context->getDebug() ) {
 753                                         foreach ( $stylePairs as $media => $style ) {
 754                                                 // Can be either a string or an array of strings.
 755                                                 if ( is_array( $style ) ) {
 756                                                         $stylePairs[$media] = [];
 757                                                         foreach ( $style as $cssText ) {
 758                                                                 if ( is_string( $cssText ) ) {
 759                                                                         $stylePairs[$media][] =
 760                                                                                 ResourceLoader::filter( 'minify-css', $cssText );
 761                                                                 }
 762                                                         }
 763                                                 } elseif ( is_string( $style ) ) {
 764                                                         $stylePairs[$media] = ResourceLoader::filter( 'minify-css', $style );
 765                                                 }
 766                                         }
 767                                 }
 768                                 // Wrap styles into @media groups as needed and flatten into a numerical array
 769                                 $styles = [
 770                                         'css' => $rl->makeCombinedStyles( $stylePairs )
 771                                 ];
 772                         }
 773                 }
 774                 $content['styles'] = $styles;
 775
 776                 // Messages
 777                 $blob = $this->getMessageBlob( $context );
 778                 if ( $blob ) {
 779                         $content['messagesBlob'] = $blob;
 780                 }
 781
 782                 $templates = $this->getTemplates();
 783                 if ( $templates ) {
 784                         $content['templates'] = $templates;
 785                 }
 786
 787                 $headers = $this->getHeaders( $context );
 788                 if ( $headers ) {
 789                         $content['headers'] = $headers;
 790                 }
 791
 792                 $statTiming = microtime( true ) - $statStart;
 793                 $statName = strtr( $this->getName(), '.', '_' );
 794                 $stats->timing( "resourceloader_build.all", 1000 * $statTiming );
 795                 $stats->timing( "resourceloader_build.$statName", 1000 * $statTiming );
 796
 797                 return $content;
 798         }
 799
 800         /**
 801          * Get a string identifying the current version of this module in a given context.
 802          *
 803          * Whenever anything happens that changes the module's response (e.g. scripts, styles, and
 804          * messages) this value must change. This value is used to store module responses in cache.
 805          * (Both client-side and server-side.)
 806          *
 807          * It is not recommended to override this directly. Use getDefinitionSummary() instead.
 808          * If overridden, one must call the parent getVersionHash(), append data and re-hash.
 809          *
 810          * This method should be quick because it is frequently run by ResourceLoaderStartUpModule to
 811          * propagate changes to the client and effectively invalidate cache.
 812          *
 813          * @since 1.26
 814          * @param ResourceLoaderContext $context
 815          * @return string Hash (should use ResourceLoader::makeHash)
 816          */
 817         public function getVersionHash( ResourceLoaderContext $context ) {
 818                 // Cache this somewhat expensive operation. Especially because some classes
 819                 // (e.g. startup module) iterate more than once over all modules to get versions.
 820                 $contextHash = $context->getHash();
 821                 if ( !array_key_exists( $contextHash, $this->versionHash ) ) {
 822                         if ( $this->enableModuleContentVersion() ) {
 823                                 // Detect changes directly by hashing the module contents.
 824                                 $str = json_encode( $this->getModuleContent( $context ) );
 825                         } else {
 826                                 // Infer changes based on definition and other metrics
 827                                 $summary = $this->getDefinitionSummary( $context );
 828                                 if ( !isset( $summary['_class'] ) ) {
 829                                         throw new LogicException( 'getDefinitionSummary must call parent method' );
 830                                 }
 831                                 $str = json_encode( $summary );
 832                         }
 833
 834                         $this->versionHash[$contextHash] = ResourceLoader::makeHash( $str );
 835                 }
 836                 return $this->versionHash[$contextHash];
 837         }
 838
 839         /**
 840          * Whether to generate version hash based on module content.
 841          *
 842          * If a module requires database or file system access to build the module
 843          * content, consider disabling this in favour of manually tracking relevant
 844          * aspects in getDefinitionSummary(). See getVersionHash() for how this is used.
 845          *
 846          * @return bool
 847          */
 848         public function enableModuleContentVersion() {
 849                 return false;
 850         }
 851
 852         /**
 853          * Get the definition summary for this module.
 854          *
 855          * This is the method subclasses are recommended to use to track values in their
 856          * version hash. Call this in getVersionHash() and pass it to e.g. json_encode.
 857          *
 858          * Subclasses must call the parent getDefinitionSummary() and build on that.
 859          * It is recommended that each subclass appends its own new array. This prevents
 860          * clashes or accidental overwrites of existing keys and gives each subclass
 861          * its own scope for simple array keys.
 862          *
 863          * @code
 864          *     $summary = parent::getDefinitionSummary( $context );
 865          *     $summary[] = [
 866          *         'foo' => 123,
 867          *         'bar' => 'quux',
 868          *     ];
 869          *     return $summary;
 870          * @endcode
 871          *
 872          * Return an array containing values from all significant properties of this
 873          * module's definition.
 874          *
 875          * Be careful not to normalise too much. Especially preserve the order of things
 876          * that carry significance in getScript and getStyles (T39812).
 877          *
 878          * Avoid including things that are insiginificant (e.g. order of message keys is
 879          * insignificant and should be sorted to avoid unnecessary cache invalidation).
 880          *
 881          * This data structure must exclusively contain arrays and scalars as values (avoid
 882          * object instances) to allow simple serialisation using json_encode.
 883          *
 884          * If modules have a hash or timestamp from another source, that may be incuded as-is.
 885          *
 886          * A number of utility methods are available to help you gather data. These are not
 887          * called by default and must be included by the subclass' getDefinitionSummary().
 888          *
 889          * - getMessageBlob()
 890          *
 891          * @since 1.23
 892          * @param ResourceLoaderContext $context
 893          * @return array|null
 894          */
 895         public function getDefinitionSummary( ResourceLoaderContext $context ) {
 896                 return [
 897                         '_class' => static::class,
 898                         // Make sure that when filter cache for minification is invalidated,
 899                         // we also change the HTTP urls and mw.loader.store keys (T176884).
 900                         '_cacheVersion' => ResourceLoader::CACHE_VERSION,
 901                 ];
 902         }
 903
 904         /**
 905          * Check whether this module is known to be empty. If a child class
 906          * has an easy and cheap way to determine that this module is
 907          * definitely going to be empty, it should override this method to
 908          * return true in that case. Callers may optimize the request for this
 909          * module away if this function returns true.
 910          * @param ResourceLoaderContext $context
 911          * @return bool
 912          */
 913         public function isKnownEmpty( ResourceLoaderContext $context ) {
 914                 return false;
 915         }
 916
 917         /**
 918          * Check whether this module should be embeded rather than linked
 919          *
 920          * Modules returning true here will be embedded rather than loaded by
 921          * ResourceLoaderClientHtml.
 922          *
 923          * @since 1.30
 924          * @param ResourceLoaderContext $context
 925          * @return bool
 926          */
 927         public function shouldEmbedModule( ResourceLoaderContext $context ) {
 928                 return $this->getGroup() === 'private';
 929         }
 930
 931         /** @var JSParser Lazy-initialized; use self::javaScriptParser() */
 932         private static $jsParser;
 933         private static $parseCacheVersion = 1;
 934
 935         /**
 936          * Validate a given script file; if valid returns the original source.
 937          * If invalid, returns replacement JS source that throws an exception.
 938          *
 939          * @param string $fileName
 940          * @param string $contents
 941          * @return string JS with the original, or a replacement error
 942          */
 943         protected function validateScriptFile( $fileName, $contents ) {
 944                 if ( !$this->getConfig()->get( 'ResourceLoaderValidateJS' ) ) {
 945                         return $contents;
 946                 }
 947                 $cache = ObjectCache::getMainWANInstance();
 948                 return $cache->getWithSetCallback(
 949                         $cache->makeGlobalKey(
 950                                 'resourceloader',
 951                                 'jsparse',
 952                                 self::$parseCacheVersion,
 953                                 md5( $contents ),
 954                                 $fileName
 955                         ),
 956                         $cache::TTL_WEEK,
 957                         function () use ( $contents, $fileName ) {
 958                                 $parser = self::javaScriptParser();
 959                                 $err = null;
 960                                 try {
 961                                         Wikimedia\suppressWarnings();
 962                                         $parser->parse( $contents, $fileName, 1 );
 963                                 } catch ( Exception $e ) {
 964                                         $err = $e;
 965                                 } finally {
 966                                         Wikimedia\restoreWarnings();
 967                                 }
 968                                 if ( $err ) {
 969                                         // Send the error to the browser console client-side.
 970                                         // By returning this as replacement for the actual script,
 971                                         // we ensure modules are safe to load in a batch request,
 972                                         // without causing other unrelated modules to break.
 973                                         return 'mw.log.error(' .
 974                                                 Xml::encodeJsVar( 'JavaScript parse error: ' . $err->getMessage() ) .
 975                                                 ');';
 976                                 }
 977                                 return $contents;
 978                         }
 979                 );
 980         }
 981
 982         /**
 983          * @return JSParser
 984          */
 985         protected static function javaScriptParser() {
 986                 if ( !self::$jsParser ) {
 987                         self::$jsParser = new JSParser();
 988                 }
 989                 return self::$jsParser;
 990         }
 991
 992         /**
 993          * Safe version of filemtime(), which doesn't throw a PHP warning if the file doesn't exist.
 994          * Defaults to 1.
 995          *
 996          * @param string $filePath File path
 997          * @return int UNIX timestamp
 998          */
 999         protected static function safeFilemtime( $filePath ) {
1000                 Wikimedia\suppressWarnings();
1001                 $mtime = filemtime( $filePath ) ?: 1;
1002                 Wikimedia\restoreWarnings();
1003                 return $mtime;
1004         }
1005
1006         /**
1007          * Compute a non-cryptographic string hash of a file's contents.
1008          * If the file does not exist or cannot be read, returns an empty string.
1009          *
1010          * @since 1.26 Uses MD4 instead of SHA1.
1011          * @param string $filePath File path
1012          * @return string Hash
1013          */
1014         protected static function safeFileHash( $filePath ) {
1015                 return FileContentsHasher::getFileContentsHash( $filePath );
1016         }
1017 }