3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
19 * @author Trevor Parscal
20 * @author Roan Kattouw
23 use MediaWiki\MediaWikiServices
;
24 use Psr\Log\LoggerAwareInterface
;
25 use Psr\Log\LoggerInterface
;
26 use Psr\Log\NullLogger
;
27 use Wikimedia\AtEase\AtEase
;
28 use Wikimedia\RelPath
;
29 use Wikimedia\ScopedCallback
;
32 * Abstraction for ResourceLoader modules, with name registration and maxage functionality.
34 * @ingroup ResourceLoader
37 abstract class ResourceLoaderModule
implements LoggerAwareInterface
{
40 /** @var LoggerInterface */
44 * Script and style modules form a hierarchy of trustworthiness, with core modules
45 * like skins and jQuery as most trustworthy, and user scripts as least trustworthy. We can
46 * limit the types of scripts and styles we allow to load on, say, sensitive special
47 * pages like Special:UserLogin and Special:Preferences
50 protected $origin = self
::ORIGIN_CORE_SITEWIDE
;
52 /** @var string|null Module name */
53 protected $name = null;
54 /** @var string[] What client platforms the module targets (e.g. desktop, mobile) */
55 protected $targets = [ 'desktop' ];
57 /** @var array Map of (variant => indirect file dependencies) */
58 protected $fileDeps = [];
59 /** @var array Map of (language => in-object cache for message blob) */
60 protected $msgBlobs = [];
61 /** @var array Map of (context hash => cached module version hash) */
62 protected $versionHash = [];
63 /** @var array Map of (context hash => cached module content) */
64 protected $contents = [];
66 /** @var string|bool Deprecation string or true if deprecated; false otherwise */
67 protected $deprecated = false;
69 /** @var string Scripts only */
70 const TYPE_SCRIPTS
= 'scripts';
71 /** @var string Styles only */
72 const TYPE_STYLES
= 'styles';
73 /** @var string Scripts and styles */
74 const TYPE_COMBINED
= 'combined';
76 /** @var string Module only has styles (loaded via <style> or <link rel=stylesheet>) */
77 const LOAD_STYLES
= 'styles';
78 /** @var string Module may have other resources (loaded via mw.loader from a script) */
79 const LOAD_GENERAL
= 'general';
81 /** @var int Sitewide core module like a skin file or jQuery component */
82 const ORIGIN_CORE_SITEWIDE
= 1;
83 /** @var int Per-user module generated by the software */
84 const ORIGIN_CORE_INDIVIDUAL
= 2;
86 * Sitewide module generated from user-editable files, like MediaWiki:Common.js,
87 * or modules accessible to multiple users, such as those generated by the Gadgets extension.
90 const ORIGIN_USER_SITEWIDE
= 3;
91 /** @var int Per-user module generated from user-editable files, like User:Me/vector.js */
92 const ORIGIN_USER_INDIVIDUAL
= 4;
93 /** @var int An access constant; make sure this is kept as the largest number in this group */
94 const ORIGIN_ALL
= 10;
97 * Get this module's name. This is set when the module is registered
98 * with ResourceLoader::register()
100 * @return string|null Name (string) or null if no name was set
102 public function getName() {
107 * Set this module's name. This is called by ResourceLoader::register()
108 * when registering the module. Other code should not call this.
110 * @param string $name
112 public function setName( $name ) {
117 * Get this module's origin. This is set when the module is registered
118 * with ResourceLoader::register()
120 * @return int ResourceLoaderModule class constant, the subclass default
121 * if not set manually
123 public function getOrigin() {
124 return $this->origin
;
128 * @param ResourceLoaderContext $context
131 public function getFlip( ResourceLoaderContext
$context ) {
132 return MediaWikiServices
::getInstance()->getContentLanguage()->getDir() !==
133 $context->getDirection();
137 * Get JS representing deprecation information for the current module if available
139 * @param ResourceLoaderContext|null $context Missing $context is deprecated in 1.34
140 * @return string JavaScript code
142 public function getDeprecationInformation( ResourceLoaderContext
$context = null ) {
143 if ( $context === null ) {
144 wfDeprecated( __METHOD__
. ' without a ResourceLoader context', '1.34' );
146 $deprecationInfo = $this->deprecated
;
147 if ( $deprecationInfo ) {
148 $name = $this->getName();
149 $warning = 'This page is using the deprecated ResourceLoader module "' . $name . '".';
150 if ( is_string( $deprecationInfo ) ) {
151 $warning .= "\n" . $deprecationInfo;
153 if ( $context === null ) {
154 return 'mw.log.warn(' . ResourceLoader
::encodeJsonForScript( $warning ) . ');';
156 return 'mw.log.warn(' . $context->encodeJson( $warning ) . ');';
163 * Get all JS for this module for a given language and skin.
164 * Includes all relevant JS except loader scripts.
166 * For "plain" script modules, this should return a string with JS code. For multi-file modules
167 * where require() is used to load one file from another file, this should return an array
168 * structured as follows:
171 * 'file1.js' => [ 'type' => 'script', 'content' => 'JS code' ],
172 * 'file2.js' => [ 'type' => 'script', 'content' => 'JS code' ],
173 * 'data.json' => [ 'type' => 'data', 'content' => array ]
175 * 'main' => 'file1.js'
178 * @param ResourceLoaderContext $context
179 * @return string|array JavaScript code (string), or multi-file structure described above (array)
181 public function getScript( ResourceLoaderContext
$context ) {
182 // Stub, override expected
187 * Takes named templates by the module and returns an array mapping.
189 * @return string[] Array of templates mapping template alias to content
191 public function getTemplates() {
192 // Stub, override expected.
200 public function getConfig() {
201 if ( $this->config
=== null ) {
202 // Ugh, fall back to default
203 $this->config
= MediaWikiServices
::getInstance()->getMainConfig();
206 return $this->config
;
210 * @param Config $config
213 public function setConfig( Config
$config ) {
214 $this->config
= $config;
219 * @param LoggerInterface $logger
221 public function setLogger( LoggerInterface
$logger ) {
222 $this->logger
= $logger;
227 * @return LoggerInterface
229 protected function getLogger() {
230 if ( !$this->logger
) {
231 $this->logger
= new NullLogger();
233 return $this->logger
;
237 * Get the URL or URLs to load for this module's JS in debug mode.
238 * The default behavior is to return a load.php?only=scripts URL for
239 * the module, but file-based modules will want to override this to
240 * load the files directly.
242 * This function is called only when 1) we're in debug mode, 2) there
243 * is no only= parameter and 3) supportsURLLoading() returns true.
244 * #2 is important to prevent an infinite loop, therefore this function
245 * MUST return either an only= URL or a non-load.php URL.
247 * @param ResourceLoaderContext $context
248 * @return array Array of URLs
250 public function getScriptURLsForDebug( ResourceLoaderContext
$context ) {
251 $resourceLoader = $context->getResourceLoader();
252 $derivative = new DerivativeResourceLoaderContext( $context );
253 $derivative->setModules( [ $this->getName() ] );
254 $derivative->setOnly( 'scripts' );
255 $derivative->setDebug( true );
257 $url = $resourceLoader->createLoaderURL(
266 * Whether this module supports URL loading. If this function returns false,
267 * getScript() will be used even in cases (debug mode, no only param) where
268 * getScriptURLsForDebug() would normally be used instead.
271 public function supportsURLLoading() {
276 * Get all CSS for this module for a given skin.
278 * @param ResourceLoaderContext $context
279 * @return array List of CSS strings or array of CSS strings keyed by media type.
280 * like [ 'screen' => '.foo { width: 0 }' ];
281 * or [ 'screen' => [ '.foo { width: 0 }' ] ];
283 public function getStyles( ResourceLoaderContext
$context ) {
284 // Stub, override expected
289 * Get the URL or URLs to load for this module's CSS in debug mode.
290 * The default behavior is to return a load.php?only=styles URL for
291 * the module, but file-based modules will want to override this to
292 * load the files directly. See also getScriptURLsForDebug()
294 * @param ResourceLoaderContext $context
295 * @return array [ mediaType => [ URL1, URL2, ... ], ... ]
297 public function getStyleURLsForDebug( ResourceLoaderContext
$context ) {
298 $resourceLoader = $context->getResourceLoader();
299 $derivative = new DerivativeResourceLoaderContext( $context );
300 $derivative->setModules( [ $this->getName() ] );
301 $derivative->setOnly( 'styles' );
302 $derivative->setDebug( true );
304 $url = $resourceLoader->createLoaderURL(
309 return [ 'all' => [ $url ] ];
313 * Get the messages needed for this module.
315 * To get a JSON blob with messages, use MessageBlobStore::get()
317 * @return array List of message keys. Keys may occur more than once
319 public function getMessages() {
320 // Stub, override expected
325 * Get the group this module is in.
327 * @return string Group name
329 public function getGroup() {
330 // Stub, override expected
335 * Get the source of this module. Should only be overridden for foreign modules.
337 * @return string Source name, 'local' for local modules
339 public function getSource() {
340 // Stub, override expected
345 * Get a list of modules this module depends on.
347 * Dependency information is taken into account when loading a module
348 * on the client side.
350 * Note: It is expected that $context will be made non-optional in the near
353 * @param ResourceLoaderContext|null $context
354 * @return array List of module names as strings
356 public function getDependencies( ResourceLoaderContext
$context = null ) {
357 // Stub, override expected
362 * Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile']
364 * @return array Array of strings
366 public function getTargets() {
367 return $this->targets
;
371 * Get the module's load type.
374 * @return string ResourceLoaderModule LOAD_* constant
376 public function getType() {
377 return self
::LOAD_GENERAL
;
381 * Get the skip function.
383 * Modules that provide fallback functionality can provide a "skip function". This
384 * function, if provided, will be passed along to the module registry on the client.
385 * When this module is loaded (either directly or as a dependency of another module),
386 * then this function is executed first. If the function returns true, the module will
387 * instantly be considered "ready" without requesting the associated module resources.
389 * The value returned here must be valid javascript for execution in a private function.
390 * It must not contain the "function () {" and "}" wrapper though.
392 * @return string|null A JavaScript function body returning a boolean value, or null
394 public function getSkipFunction() {
399 * Get the files this module depends on indirectly for a given skin.
401 * These are only image files referenced by the module's stylesheet.
403 * @param ResourceLoaderContext $context
404 * @return array List of files
406 protected function getFileDependencies( ResourceLoaderContext
$context ) {
407 $vary = self
::getVary( $context );
409 // Try in-object cache first
410 if ( !isset( $this->fileDeps
[$vary] ) ) {
411 $dbr = wfGetDB( DB_REPLICA
);
412 $deps = $dbr->selectField( 'module_deps',
415 'md_module' => $this->getName(),
421 if ( !is_null( $deps ) ) {
422 $this->fileDeps
[$vary] = self
::expandRelativePaths(
423 (array)json_decode( $deps, true )
426 $this->fileDeps
[$vary] = [];
429 return $this->fileDeps
[$vary];
433 * Set in-object cache for file dependencies.
435 * This is used to retrieve data in batches. See ResourceLoader::preloadModuleInfo().
436 * To save the data, use saveFileDependencies().
438 * @param ResourceLoaderContext $context
439 * @param string[] $files Array of file names
441 public function setFileDependencies( ResourceLoaderContext
$context, $files ) {
442 $vary = self
::getVary( $context );
443 $this->fileDeps
[$vary] = $files;
447 * Set the files this module depends on indirectly for a given skin.
450 * @param ResourceLoaderContext $context
451 * @param array $localFileRefs List of files
453 protected function saveFileDependencies( ResourceLoaderContext
$context, $localFileRefs ) {
455 // Related bugs and performance considerations:
456 // 1. Don't needlessly change the database value with the same list in a
457 // different order or with duplicates.
458 // 2. Use relative paths to avoid ghost entries when $IP changes. (T111481)
459 // 3. Don't needlessly replace the database with the same value
460 // just because $IP changed (e.g. when upgrading a wiki).
461 // 4. Don't create an endless replace loop on every request for this
462 // module when '../' is used anywhere. Even though both are expanded
463 // (one expanded by getFileDependencies from the DB, the other is
464 // still raw as originally read by RL), the latter has not
465 // been normalized yet.
468 $localFileRefs = array_values( array_unique( $localFileRefs ) );
469 sort( $localFileRefs );
470 $localPaths = self
::getRelativePaths( $localFileRefs );
471 $storedPaths = self
::getRelativePaths( $this->getFileDependencies( $context ) );
473 if ( $localPaths === $storedPaths ) {
474 // Unchanged. Avoid needless database query (especially master conn!).
478 // The file deps list has changed, we want to update it.
479 $vary = self
::getVary( $context );
480 $cache = ObjectCache
::getLocalClusterInstance();
481 $key = $cache->makeKey( __METHOD__
, $this->getName(), $vary );
482 $scopeLock = $cache->getScopedLock( $key, 0 );
484 // Another request appears to be doing this update already.
485 // Avoid write slams (T124649).
489 // No needless escaping as this isn't HTML output.
490 // Only stored in the database and parsed in PHP.
491 $deps = json_encode( $localPaths, JSON_UNESCAPED_SLASHES
);
492 $dbw = wfGetDB( DB_MASTER
);
493 $dbw->upsert( 'module_deps',
495 'md_module' => $this->getName(),
499 [ [ 'md_module', 'md_skin' ] ],
506 if ( $dbw->trxLevel() ) {
507 $dbw->onTransactionResolution(
508 function () use ( &$scopeLock ) {
509 ScopedCallback
::consume( $scopeLock ); // release after commit
514 } catch ( Exception
$e ) {
515 // Probably a DB failure. Either the read query from getFileDependencies(),
516 // or the write query above.
517 wfDebugLog( 'resourceloader', __METHOD__
. ": failed to update DB: $e" );
522 * Make file paths relative to MediaWiki directory.
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).
528 * @param array $filePaths
531 public static function getRelativePaths( array $filePaths ) {
533 return array_map( function ( $path ) use ( $IP ) {
534 return RelPath
::getRelativePath( $path, $IP );
539 * Expand directories relative to $IP.
542 * @param array $filePaths
545 public static function expandRelativePaths( array $filePaths ) {
547 return array_map( function ( $path ) use ( $IP ) {
548 return RelPath
::joinPath( $IP, $path );
553 * Get the hash of the message blob.
556 * @param ResourceLoaderContext $context
557 * @return string|null JSON blob or null if module has no messages
559 protected function getMessageBlob( ResourceLoaderContext
$context ) {
560 if ( !$this->getMessages() ) {
561 // Don't bother consulting MessageBlobStore
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(),
570 $store = $context->getResourceLoader()->getMessageBlobStore();
571 $this->msgBlobs
[$lang] = $store->getBlob( $this, $lang );
573 return $this->msgBlobs
[$lang];
577 * Set in-object cache for message blobs.
579 * Used to allow fetching of message blobs in batches. See ResourceLoader::preloadModuleInfo().
582 * @param string|null $blob JSON blob or null
583 * @param string $lang Language code
585 public function setMessageBlob( $blob, $lang ) {
586 $this->msgBlobs
[$lang] = $blob;
590 * Get headers to send as part of a module web response.
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).
597 * For exclusive or aggregated headers, see ResourceLoader::sendResponseHeaders().
600 * @param ResourceLoaderContext $context
601 * @return string[] Array of HTTP response headers
603 final public function getHeaders( ResourceLoaderContext
$context ) {
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}";
612 $formattedLinks[] = $link;
614 if ( $formattedLinks ) {
615 $headers[] = 'Link: ' . implode( ',', $formattedLinks );
622 * Get a list of resources that web browsers may preload.
624 * Behaviour of rel=preload link is specified at <https://www.w3.org/TR/preload/>.
626 * Use case for ResourceLoader originally part of T164299.
630 * protected function getPreloadLinks() {
632 * 'https://example.org/script.js' => [ 'as' => 'script' ],
633 * 'https://example.org/image.png' => [ 'as' => 'image' ],
638 * @par Example using HiDPI image variants
640 * protected function getPreloadLinks() {
642 * 'https://example.org/logo.png' => [
644 * 'media' => 'not all and (min-resolution: 2dppx)',
646 * 'https://example.org/logo@2x.png' => [
648 * 'media' => '(min-resolution: 2dppx)',
654 * @see ResourceLoaderModule::getHeaders
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.
660 protected function getPreloadLinks( ResourceLoaderContext
$context ) {
665 * Get module-specific LESS variables, if any.
668 * @param ResourceLoaderContext $context
669 * @return array Module-specific LESS variables.
671 protected function getLessVars( ResourceLoaderContext
$context ) {
676 * Get an array of this module's resources. Ready for serving to the web.
679 * @param ResourceLoaderContext $context
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 );
689 return $this->contents
[$contextHash];
693 * Bundle all resources attached to this module into an array.
696 * @param ResourceLoaderContext $context
699 final protected function buildContent( ResourceLoaderContext
$context ) {
700 $rl = $context->getResourceLoader();
701 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
702 $statStart = microtime( true );
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.
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 );
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"
735 $content['scripts'] = $scripts;
738 // Don't create empty stylesheets like [ '' => '' ] for modules
739 // that don't *have* any stylesheets (T40024).
740 $stylePairs = $this->getStyles( $context );
741 if ( count( $stylePairs ) ) {
742 // If we are in debug mode without &only= set, we'll want to return an array of URLs
743 // See comment near shouldIncludeScripts() for more details
744 if ( $context->getDebug() && !$context->getOnly() && $this->supportsURLLoading() ) {
746 'url' => $this->getStyleURLsForDebug( $context )
749 // Minify CSS before embedding in mw.loader.implement call
750 // (unless in debug mode)
751 if ( !$context->getDebug() ) {
752 foreach ( $stylePairs as $media => $style ) {
753 // Can be either a string or an array of strings.
754 if ( is_array( $style ) ) {
755 $stylePairs[$media] = [];
756 foreach ( $style as $cssText ) {
757 if ( is_string( $cssText ) ) {
758 $stylePairs[$media][] =
759 ResourceLoader
::filter( 'minify-css', $cssText );
762 } elseif ( is_string( $style ) ) {
763 $stylePairs[$media] = ResourceLoader
::filter( 'minify-css', $style );
767 // Wrap styles into @media groups as needed and flatten into a numerical array
769 'css' => $rl->makeCombinedStyles( $stylePairs )
773 $content['styles'] = $styles;
776 $blob = $this->getMessageBlob( $context );
778 $content['messagesBlob'] = $blob;
781 $templates = $this->getTemplates();
783 $content['templates'] = $templates;
786 $headers = $this->getHeaders( $context );
788 $content['headers'] = $headers;
791 $statTiming = microtime( true ) - $statStart;
792 $statName = strtr( $this->getName(), '.', '_' );
793 $stats->timing( "resourceloader_build.all", 1000 * $statTiming );
794 $stats->timing( "resourceloader_build.$statName", 1000 * $statTiming );
800 * Get a string identifying the current version of this module in a given context.
802 * Whenever anything happens that changes the module's response (e.g. scripts, styles, and
803 * messages) this value must change. This value is used to store module responses in cache.
804 * (Both client-side and server-side.)
806 * It is not recommended to override this directly. Use getDefinitionSummary() instead.
807 * If overridden, one must call the parent getVersionHash(), append data and re-hash.
809 * This method should be quick because it is frequently run by ResourceLoaderStartUpModule to
810 * propagate changes to the client and effectively invalidate cache.
813 * @param ResourceLoaderContext $context
814 * @return string Hash (should use ResourceLoader::makeHash)
816 public function getVersionHash( ResourceLoaderContext
$context ) {
817 // Cache this somewhat expensive operation. Especially because some classes
818 // (e.g. startup module) iterate more than once over all modules to get versions.
819 $contextHash = $context->getHash();
820 if ( !array_key_exists( $contextHash, $this->versionHash
) ) {
821 if ( $this->enableModuleContentVersion() ) {
822 // Detect changes directly by hashing the module contents.
823 $str = json_encode( $this->getModuleContent( $context ) );
825 // Infer changes based on definition and other metrics
826 $summary = $this->getDefinitionSummary( $context );
827 if ( !isset( $summary['_class'] ) ) {
828 throw new LogicException( 'getDefinitionSummary must call parent method' );
830 $str = json_encode( $summary );
833 $this->versionHash
[$contextHash] = ResourceLoader
::makeHash( $str );
835 return $this->versionHash
[$contextHash];
839 * Whether to generate version hash based on module content.
841 * If a module requires database or file system access to build the module
842 * content, consider disabling this in favour of manually tracking relevant
843 * aspects in getDefinitionSummary(). See getVersionHash() for how this is used.
847 public function enableModuleContentVersion() {
852 * Get the definition summary for this module.
854 * This is the method subclasses are recommended to use to track values in their
855 * version hash. Call this in getVersionHash() and pass it to e.g. json_encode.
857 * Subclasses must call the parent getDefinitionSummary() and build on that.
858 * It is recommended that each subclass appends its own new array. This prevents
859 * clashes or accidental overwrites of existing keys and gives each subclass
860 * its own scope for simple array keys.
863 * $summary = parent::getDefinitionSummary( $context );
871 * Return an array containing values from all significant properties of this
872 * module's definition.
874 * Be careful not to normalise too much. Especially preserve the order of things
875 * that carry significance in getScript and getStyles (T39812).
877 * Avoid including things that are insiginificant (e.g. order of message keys is
878 * insignificant and should be sorted to avoid unnecessary cache invalidation).
880 * This data structure must exclusively contain arrays and scalars as values (avoid
881 * object instances) to allow simple serialisation using json_encode.
883 * If modules have a hash or timestamp from another source, that may be incuded as-is.
885 * A number of utility methods are available to help you gather data. These are not
886 * called by default and must be included by the subclass' getDefinitionSummary().
891 * @param ResourceLoaderContext $context
894 public function getDefinitionSummary( ResourceLoaderContext
$context ) {
896 '_class' => static::class,
897 // Make sure that when filter cache for minification is invalidated,
898 // we also change the HTTP urls and mw.loader.store keys (T176884).
899 '_cacheVersion' => ResourceLoader
::CACHE_VERSION
,
904 * Check whether this module is known to be empty. If a child class
905 * has an easy and cheap way to determine that this module is
906 * definitely going to be empty, it should override this method to
907 * return true in that case. Callers may optimize the request for this
908 * module away if this function returns true.
909 * @param ResourceLoaderContext $context
912 public function isKnownEmpty( ResourceLoaderContext
$context ) {
917 * Check whether this module should be embeded rather than linked
919 * Modules returning true here will be embedded rather than loaded by
920 * ResourceLoaderClientHtml.
923 * @param ResourceLoaderContext $context
926 public function shouldEmbedModule( ResourceLoaderContext
$context ) {
927 return $this->getGroup() === 'private';
930 /** @var JSParser Lazy-initialized; use self::javaScriptParser() */
931 private static $jsParser;
932 private static $parseCacheVersion = 1;
935 * Validate a given script file; if valid returns the original source.
936 * If invalid, returns replacement JS source that throws an exception.
938 * @param string $fileName
939 * @param string $contents
940 * @return string JS with the original, or a replacement error
942 protected function validateScriptFile( $fileName, $contents ) {
943 if ( !$this->getConfig()->get( 'ResourceLoaderValidateJS' ) ) {
946 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
947 return $cache->getWithSetCallback(
948 $cache->makeGlobalKey(
949 'resourceloader-jsparse',
950 self
::$parseCacheVersion,
955 function () use ( $contents, $fileName ) {
956 $parser = self
::javaScriptParser();
959 AtEase
::suppressWarnings();
960 $parser->parse( $contents, $fileName, 1 );
961 } catch ( Exception
$e ) {
964 AtEase
::restoreWarnings();
967 // Send the error to the browser console client-side.
968 // By returning this as replacement for the actual script,
969 // we ensure modules are safe to load in a batch request,
970 // without causing other unrelated modules to break.
971 return 'mw.log.error(' .
972 Xml
::encodeJsVar( 'JavaScript parse error: ' . $err->getMessage() ) .
983 protected static function javaScriptParser() {
984 if ( !self
::$jsParser ) {
985 self
::$jsParser = new JSParser();
987 return self
::$jsParser;
991 * Safe version of filemtime(), which doesn't throw a PHP warning if the file doesn't exist.
994 * @param string $filePath File path
995 * @return int UNIX timestamp
997 protected static function safeFilemtime( $filePath ) {
998 AtEase
::suppressWarnings();
999 $mtime = filemtime( $filePath ) ?
: 1;
1000 AtEase
::restoreWarnings();
1005 * Compute a non-cryptographic string hash of a file's contents.
1006 * If the file does not exist or cannot be read, returns an empty string.
1008 * @since 1.26 Uses MD4 instead of SHA1.
1009 * @param string $filePath File path
1010 * @return string Hash
1012 protected static function safeFileHash( $filePath ) {
1013 return FileContentsHasher
::getFileContentsHash( $filePath );
1019 * @internal For internal use only.
1020 * @param ResourceLoaderContext $context
1021 * @return string Vary string
1023 public static function getVary( ResourceLoaderContext
$context ) {
1024 return implode( '|', [
1025 $context->getSkin(),
1026 $context->getLanguage(),