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