3 * Base class for resource loading system.
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.
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.
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
21 * @author Roan Kattouw
22 * @author Trevor Parscal
25 use MediaWiki\MediaWikiServices
;
26 use Psr\Log\LoggerAwareInterface
;
27 use Psr\Log\LoggerInterface
;
28 use Psr\Log\NullLogger
;
29 use Wikimedia\Rdbms\DBConnectionError
;
30 use Wikimedia\WrappedString
;
33 * Dynamic JavaScript and CSS resource loading system.
35 * Most of the documentation is on the MediaWiki documentation wiki starting at:
36 * https://www.mediawiki.org/wiki/ResourceLoader
38 class ResourceLoader
implements LoggerAwareInterface
{
39 /** @var Config $config */
41 /** @var MessageBlobStore */
44 /** @var LoggerInterface */
47 /** @var ResourceLoaderModule[] Map of (module name => ResourceLoaderModule) */
48 protected $modules = [];
49 /** @var array[] Map of (module name => associative info array) */
50 protected $moduleInfos = [];
52 * Associative array mapping framework ids to a list of names of test suite modules
53 * like [ 'qunit' => [ 'mediawiki.tests.qunit.suites', 'ext.foo.tests', ... ], ... ]
56 protected $testModuleNames = [];
57 /** @var string[] List of module names that contain QUnit test suites */
58 protected $testSuiteModuleNames = [];
60 /** @var array Map of (source => path); E.g. [ 'source-id' => 'http://.../load.php' ] */
61 protected $sources = [];
62 /** @var array Errors accumulated during current respond() call */
63 protected $errors = [];
64 /** @var string[] Extra HTTP response headers from modules loaded in makeModuleResponse() */
65 protected $extraHeaders = [];
68 protected static $debugMode = null;
71 const CACHE_VERSION
= 8;
73 /** @var string JavaScript / CSS pragma to disable minification. * */
74 const FILTER_NOMIN
= '/*@nomin*/';
77 * Load information stored in the database about modules.
79 * This method grabs modules dependencies from the database and updates modules
82 * This is not inside the module code because it is much faster to
83 * request all of the information at once than it is to have each module
84 * requests its own information. This sacrifice of modularity yields a substantial
85 * performance improvement.
87 * @param array $moduleNames List of module names to preload information for
88 * @param ResourceLoaderContext $context Context to load the information within
90 public function preloadModuleInfo( array $moduleNames, ResourceLoaderContext
$context ) {
91 if ( !$moduleNames ) {
92 // Or else Database*::select() will explode, plus it's cheaper!
95 $dbr = wfGetDB( DB_REPLICA
);
96 $lang = $context->getLanguage();
98 // Batched version of ResourceLoaderModule::getFileDependencies
99 $vary = ResourceLoaderModule
::getVary( $context );
100 $res = $dbr->select( 'module_deps', [ 'md_module', 'md_deps' ], [
101 'md_module' => $moduleNames,
106 // Prime in-object cache for file dependencies
107 $modulesWithDeps = [];
108 foreach ( $res as $row ) {
109 $module = $this->getModule( $row->md_module
);
111 $module->setFileDependencies( $context, ResourceLoaderModule
::expandRelativePaths(
112 json_decode( $row->md_deps
, true )
114 $modulesWithDeps[] = $row->md_module
;
117 // Register the absence of a dependency row too
118 foreach ( array_diff( $moduleNames, $modulesWithDeps ) as $name ) {
119 $module = $this->getModule( $name );
121 $this->getModule( $name )->setFileDependencies( $context, [] );
125 // Batched version of ResourceLoaderWikiModule::getTitleInfo
126 ResourceLoaderWikiModule
::preloadTitleInfo( $context, $dbr, $moduleNames );
128 // Prime in-object cache for message blobs for modules with messages
130 foreach ( $moduleNames as $name ) {
131 $module = $this->getModule( $name );
132 if ( $module && $module->getMessages() ) {
133 $modules[$name] = $module;
136 $store = $this->getMessageBlobStore();
137 $blobs = $store->getBlobs( $modules, $lang );
138 foreach ( $blobs as $name => $blob ) {
139 $modules[$name]->setMessageBlob( $blob, $lang );
144 * Run JavaScript or CSS data through a filter, caching the filtered result for future calls.
146 * Available filters are:
148 * - minify-js \see JavaScriptMinifier::minify
149 * - minify-css \see CSSMin::minify
151 * If $data is empty, only contains whitespace or the filter was unknown,
152 * $data is returned unmodified.
154 * @param string $filter Name of filter to run
155 * @param string $data Text to filter, such as JavaScript or CSS text
156 * @param array $options Keys:
157 * - (bool) cache: Whether to allow caching this data. Default: true.
158 * @return string Filtered data, or a comment containing an error message
160 public static function filter( $filter, $data, array $options = [] ) {
161 if ( strpos( $data, self
::FILTER_NOMIN
) !== false ) {
165 if ( isset( $options['cache'] ) && $options['cache'] === false ) {
166 return self
::applyFilter( $filter, $data );
169 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
170 $cache = ObjectCache
::getLocalServerInstance( CACHE_ANYTHING
);
172 $key = $cache->makeGlobalKey(
173 'resourceloader-filter',
179 $result = $cache->get( $key );
180 if ( $result === false ) {
181 $stats->increment( "resourceloader_cache.$filter.miss" );
182 $result = self
::applyFilter( $filter, $data );
183 $cache->set( $key, $result, 24 * 3600 );
185 $stats->increment( "resourceloader_cache.$filter.hit" );
187 if ( $result === null ) {
195 private static function applyFilter( $filter, $data ) {
196 $data = trim( $data );
199 $data = ( $filter === 'minify-css' )
200 ? CSSMin
::minify( $data )
201 : JavaScriptMinifier
::minify( $data );
202 } catch ( Exception
$e ) {
203 MWExceptionHandler
::logException( $e );
211 * Register core modules and runs registration hooks.
212 * @param Config|null $config
213 * @param LoggerInterface|null $logger [optional]
215 public function __construct( Config
$config = null, LoggerInterface
$logger = null ) {
216 $this->logger
= $logger ?
: new NullLogger();
219 wfDeprecated( __METHOD__
. ' without a Config instance', '1.34' );
220 $config = MediaWikiServices
::getInstance()->getMainConfig();
222 $this->config
= $config;
224 // Add 'local' source first
225 $this->addSource( 'local', $config->get( 'LoadScript' ) );
227 // Special module that always exists
228 $this->register( 'startup', [ 'class' => ResourceLoaderStartUpModule
::class ] );
230 $this->setMessageBlobStore( new MessageBlobStore( $this, $this->logger
) );
236 public function getConfig() {
237 return $this->config
;
242 * @param LoggerInterface $logger
244 public function setLogger( LoggerInterface
$logger ) {
245 $this->logger
= $logger;
250 * @return LoggerInterface
252 public function getLogger() {
253 return $this->logger
;
258 * @return MessageBlobStore
260 public function getMessageBlobStore() {
261 return $this->blobStore
;
266 * @param MessageBlobStore $blobStore
268 public function setMessageBlobStore( MessageBlobStore
$blobStore ) {
269 $this->blobStore
= $blobStore;
273 * Register a module with the ResourceLoader system.
275 * @param string|array[] $name Module name as a string or, array of module info arrays
277 * @param array|null $info Module info array. When using the first parameter to register
278 * multiple modules at once, this parameter is optional.
279 * @throws MWException If a duplicate module registration is attempted
280 * @throws MWException If a module name contains illegal characters (pipes or commas)
281 * @throws InvalidArgumentException If the module info is not an array
283 public function register( $name, $info = null ) {
284 $moduleSkinStyles = $this->config
->get( 'ResourceModuleSkinStyles' );
286 // Allow multiple modules to be registered in one call
287 $registrations = is_array( $name ) ?
$name : [ $name => $info ];
288 foreach ( $registrations as $name => $info ) {
289 // Warn on duplicate registrations
290 if ( isset( $this->moduleInfos
[$name] ) ) {
291 // A module has already been registered by this name
292 $this->logger
->warning(
293 'ResourceLoader duplicate registration warning. ' .
294 'Another module has already been registered as ' . $name
299 if ( !self
::isValidModuleName( $name ) ) {
300 throw new MWException( "ResourceLoader module name '$name' is invalid, "
301 . "see ResourceLoader::isValidModuleName()" );
303 if ( !is_array( $info ) ) {
304 throw new InvalidArgumentException(
305 'Invalid module info for "' . $name . '": expected array, got ' . gettype( $info )
310 $this->moduleInfos
[$name] = $info;
312 // Last-minute changes
313 // Apply custom skin-defined styles to existing modules.
314 if ( $this->isFileModule( $name ) ) {
315 foreach ( $moduleSkinStyles as $skinName => $skinStyles ) {
316 // If this module already defines skinStyles for this skin, ignore $wgResourceModuleSkinStyles.
317 if ( isset( $this->moduleInfos
[$name]['skinStyles'][$skinName] ) ) {
321 // If $name is preceded with a '+', the defined style files will be added to 'default'
322 // skinStyles, otherwise 'default' will be ignored as it normally would be.
323 if ( isset( $skinStyles[$name] ) ) {
324 $paths = (array)$skinStyles[$name];
326 } elseif ( isset( $skinStyles['+' . $name] ) ) {
327 $paths = (array)$skinStyles['+' . $name];
328 $styleFiles = isset( $this->moduleInfos
[$name]['skinStyles']['default'] ) ?
329 (array)$this->moduleInfos
[$name]['skinStyles']['default'] :
335 // Add new file paths, remapping them to refer to our directories and not use settings
336 // from the module we're modifying, which come from the base definition.
337 list( $localBasePath, $remoteBasePath ) =
338 ResourceLoaderFileModule
::extractBasePaths( $skinStyles );
340 foreach ( $paths as $path ) {
341 $styleFiles[] = new ResourceLoaderFilePath( $path, $localBasePath, $remoteBasePath );
344 $this->moduleInfos
[$name]['skinStyles'][$skinName] = $styleFiles;
351 * @internal For use by ServiceWiring only
352 * @codeCoverageIgnore
354 public function registerTestModules() {
357 if ( $this->config
->get( 'EnableJavaScriptTest' ) !== true ) {
358 throw new MWException( 'Attempt to register JavaScript test modules '
359 . 'but <code>$wgEnableJavaScriptTest</code> is false. '
360 . 'Edit your <code>LocalSettings.php</code> to enable it.' );
363 // This has a 'qunit' key for compat with the below hook.
364 $testModulesMeta = [ 'qunit' => [] ];
366 // Get test suites from extensions
367 // Avoid PHP 7.1 warning from passing $this by reference
369 Hooks
::run( 'ResourceLoaderTestModules', [ &$testModulesMeta, &$rl ] );
370 $extRegistry = ExtensionRegistry
::getInstance();
371 // In case of conflict, the deprecated hook has precedence.
372 $testModules = $testModulesMeta['qunit'] +
$extRegistry->getAttribute( 'QUnitTestModules' );
374 $testSuiteModuleNames = [];
375 foreach ( $testModules as $name => &$module ) {
376 // Turn any single-module dependency into an array
377 if ( isset( $module['dependencies'] ) && is_string( $module['dependencies'] ) ) {
378 $module['dependencies'] = [ $module['dependencies'] ];
381 // Ensure the testrunner loads before any test suites
382 $module['dependencies'][] = 'test.mediawiki.qunit.testrunner';
384 // Keep track of the test suites to load on SpecialJavaScriptTest
385 $testSuiteModuleNames[] = $name;
388 // Core test suites (their names have further precedence).
389 $testModules = ( include "$IP/tests/qunit/QUnitTestResources.php" ) +
$testModules;
390 $testSuiteModuleNames[] = 'test.mediawiki.qunit.suites';
392 $this->register( $testModules );
393 $this->testSuiteModuleNames
= $testSuiteModuleNames;
397 * Add a foreign source of modules.
399 * Source IDs are typically the same as the Wiki ID or database name (e.g. lowercase a-z).
401 * @param array|string $id Source ID (string), or [ id1 => loadUrl, id2 => loadUrl, ... ]
402 * @param string|array|null $loadUrl load.php url (string), or array with loadUrl key for
403 * backwards-compatibility.
404 * @throws MWException
406 public function addSource( $id, $loadUrl = null ) {
407 // Allow multiple sources to be registered in one call
408 if ( is_array( $id ) ) {
409 foreach ( $id as $key => $value ) {
410 $this->addSource( $key, $value );
415 // Disallow duplicates
416 if ( isset( $this->sources
[$id] ) ) {
417 throw new MWException(
418 'ResourceLoader duplicate source addition error. ' .
419 'Another source has already been registered as ' . $id
423 // Pre 1.24 backwards-compatibility
424 if ( is_array( $loadUrl ) ) {
425 if ( !isset( $loadUrl['loadScript'] ) ) {
426 throw new MWException(
427 __METHOD__
. ' was passed an array with no "loadScript" key.'
431 $loadUrl = $loadUrl['loadScript'];
434 $this->sources
[$id] = $loadUrl;
438 * Get a list of module names.
440 * @return array List of module names
442 public function getModuleNames() {
443 return array_keys( $this->moduleInfos
);
447 * Get a list of module names with QUnit test suites.
449 * @internal For use by SpecialJavaScriptTest only
451 * @codeCoverageIgnore
453 public function getTestSuiteModuleNames() {
454 return $this->testSuiteModuleNames
;
458 * Check whether a ResourceLoader module is registered
461 * @param string $name
464 public function isModuleRegistered( $name ) {
465 return isset( $this->moduleInfos
[$name] );
469 * Get the ResourceLoaderModule object for a given module name.
471 * If an array of module parameters exists but a ResourceLoaderModule object has not
472 * yet been instantiated, this method will instantiate and cache that object such that
473 * subsequent calls simply return the same object.
475 * @param string $name Module name
476 * @return ResourceLoaderModule|null If module has been registered, return a
477 * ResourceLoaderModule instance. Otherwise, return null.
479 public function getModule( $name ) {
480 if ( !isset( $this->modules
[$name] ) ) {
481 if ( !isset( $this->moduleInfos
[$name] ) ) {
485 // Construct the requested module object
486 $info = $this->moduleInfos
[$name];
487 if ( isset( $info['factory'] ) ) {
488 /** @var ResourceLoaderModule $object */
489 $object = call_user_func( $info['factory'], $info );
491 $class = $info['class'] ?? ResourceLoaderFileModule
::class;
492 /** @var ResourceLoaderModule $object */
493 $object = new $class( $info );
495 $object->setConfig( $this->getConfig() );
496 $object->setLogger( $this->logger
);
497 $object->setName( $name );
498 $this->modules
[$name] = $object;
501 return $this->modules
[$name];
505 * Whether the module is a ResourceLoaderFileModule (including subclasses).
507 * @param string $name Module name
510 protected function isFileModule( $name ) {
511 if ( !isset( $this->moduleInfos
[$name] ) ) {
514 $info = $this->moduleInfos
[$name];
515 return !isset( $info['factory'] ) && (
516 // The implied default for 'class' is ResourceLoaderFileModule
517 !isset( $info['class'] ) ||
519 $info['class'] === ResourceLoaderFileModule
::class ||
520 is_subclass_of( $info['class'], ResourceLoaderFileModule
::class )
525 * Get the list of sources.
527 * @return array Like [ id => load.php url, ... ]
529 public function getSources() {
530 return $this->sources
;
534 * Get the URL to the load.php endpoint for the given
535 * ResourceLoader source
538 * @param string $source
539 * @throws MWException On an invalid $source name
542 public function getLoadScript( $source ) {
543 if ( !isset( $this->sources
[$source] ) ) {
544 throw new MWException( "The $source source was never registered in ResourceLoader." );
546 return $this->sources
[$source];
550 * @internal For use by ResourceLoaderStartUpModule only.
552 const HASH_LENGTH
= 5;
555 * Create a hash for module versioning purposes.
557 * This hash is used in three ways:
559 * - To differentiate between the current version and a past version
560 * of a module by the same name.
562 * In the cache key of localStorage in the browser (mw.loader.store).
563 * This store keeps only one version of any given module. As long as the
564 * next version the client encounters has a different hash from the last
565 * version it saw, it will correctly discard it in favour of a network fetch.
567 * A browser may evict a site's storage container for any reason (e.g. when
568 * the user hasn't visited a site for some time, and/or when the device is
569 * low on storage space). Anecdotally it seems devices rarely keep unused
570 * storage beyond 2 weeks on mobile devices and 4 weeks on desktop.
571 * But, there is no hard limit or expiration on localStorage.
572 * ResourceLoader's Client also clears localStorage when the user changes
573 * their language preference or when they (temporarily) use Debug Mode.
575 * The only hard factors that reduce the range of possible versions are
576 * 1) the name and existence of a given module, and
577 * 2) the TTL for mw.loader.store, and
578 * 3) the `$wgResourceLoaderStorageVersion` configuration variable.
580 * - To identify a batch response of modules from load.php in an HTTP cache.
582 * When fetching modules in a batch from load.php, a combined hash
583 * is created by the JS code, and appended as query parameter.
585 * In cache proxies (e.g. Varnish, Nginx) and in the browser's HTTP cache,
586 * these urls are used to identify other previously cached responses.
587 * The range of possible versions a given version has to be unique amongst
588 * is determined by the maximum duration each response is stored for, which
589 * is controlled by `$wgResourceLoaderMaxage['versioned']`.
591 * - To detect race conditions between multiple web servers in a MediaWiki
592 * deployment of which some have the newer version and some still the older
595 * An HTTP request from a browser for the Startup manifest may be responded
596 * to by a server with the newer version. The browser may then use that to
597 * request a given module, which may then be responded to by a server with
598 * the older version. To avoid caching this for too long (which would pollute
599 * all other users without repairing itself), the combined hash that the JS
600 * client adds to the url is verified by the server (in ::sendResponseHeaders).
601 * If they don't match, we instruct cache proxies and clients to not cache
602 * this response as long as they normally would. This is also the reason
603 * that the algorithm used here in PHP must match the one used in JS.
605 * The fnv132 digest creates a 32-bit integer, which goes upto 4 Giga and
606 * needs up to 7 chars in base 36.
607 * Within 7 characters, base 36 can count up to 78,364,164,096 (78 Giga),
608 * (but with fnv132 we'd use very little of this range, mostly padding).
609 * Within 6 characters, base 36 can count up to 2,176,782,336 (2 Giga).
610 * Within 5 characters, base 36 can count up to 60,466,176 (60 Mega).
613 * @param string $value
614 * @return string Hash
616 public static function makeHash( $value ) {
617 $hash = hash( 'fnv132', $value );
618 // The base_convert will pad it (if too short),
619 // then substr() will trim it (if too long).
621 Wikimedia\base_convert
( $hash, 16, 36, self
::HASH_LENGTH
),
628 * Add an error to the 'errors' array and log it.
630 * @private For internal use by ResourceLoader and ResourceLoaderStartUpModule.
632 * @param Exception $e
634 * @param array $context
636 public function outputErrorAndLog( Exception
$e, $msg, array $context = [] ) {
637 MWExceptionHandler
::logException( $e );
638 $this->logger
->warning(
640 $context +
[ 'exception' => $e ]
642 $this->errors
[] = self
::formatExceptionNoComment( $e );
646 * Helper method to get and combine versions of multiple modules.
649 * @param ResourceLoaderContext $context
650 * @param string[] $moduleNames List of known module names
651 * @return string Hash
653 public function getCombinedVersion( ResourceLoaderContext
$context, array $moduleNames ) {
654 if ( !$moduleNames ) {
657 $hashes = array_map( function ( $module ) use ( $context ) {
659 return $this->getModule( $module )->getVersionHash( $context );
660 } catch ( Exception
$e ) {
661 // If modules fail to compute a version, don't fail the request (T152266)
662 // and still compute versions of other modules.
663 $this->outputErrorAndLog( $e,
664 'Calculating version for "{module}" failed: {exception}',
672 return self
::makeHash( implode( '', $hashes ) );
676 * Get the expected value of the 'version' query parameter.
678 * This is used by respond() to set a short Cache-Control header for requests with
679 * information newer than the current server has. This avoids pollution of edge caches.
680 * Typically during deployment. (T117587)
682 * This MUST match return value of `mw.loader#getCombinedVersion()` client-side.
685 * @param ResourceLoaderContext $context
686 * @return string Hash
688 public function makeVersionQuery( ResourceLoaderContext
$context ) {
689 // As of MediaWiki 1.28, the server and client use the same algorithm for combining
690 // version hashes. There is no technical reason for this to be same, and for years the
691 // implementations differed. If getCombinedVersion in PHP (used for StartupModule and
692 // E-Tag headers) differs in the future from getCombinedVersion in JS (used for 'version'
693 // query parameter), then this method must continue to match the JS one.
695 foreach ( $context->getModules() as $name ) {
696 if ( !$this->getModule( $name ) ) {
697 // If a versioned request contains a missing module, the version is a mismatch
698 // as the client considered a module (and version) we don't have.
701 $moduleNames[] = $name;
703 return $this->getCombinedVersion( $context, $moduleNames );
707 * Output a response to a load request, including the content-type header.
709 * @param ResourceLoaderContext $context Context in which a response should be formed
711 public function respond( ResourceLoaderContext
$context ) {
712 // Buffer output to catch warnings. Normally we'd use ob_clean() on the
713 // top-level output buffer to clear warnings, but that breaks when ob_gzhandler
714 // is used: ob_clean() will clear the GZIP header in that case and it won't come
715 // back for subsequent output, resulting in invalid GZIP. So we have to wrap
716 // the whole thing in our own output buffer to be sure the active buffer
717 // doesn't use ob_gzhandler.
718 // See https://bugs.php.net/bug.php?id=36514
721 $this->measureResponseTime( RequestContext
::getMain()->getTiming() );
723 // Find out which modules are missing and instantiate the others
726 foreach ( $context->getModules() as $name ) {
727 $module = $this->getModule( $name );
729 // Do not allow private modules to be loaded from the web.
730 // This is a security issue, see T36907.
731 if ( $module->getGroup() === 'private' ) {
732 // Not a serious error, just means something is trying to access it (T101806)
733 $this->logger
->debug( "Request for private module '$name' denied" );
734 $this->errors
[] = "Cannot build private module \"$name\"";
737 $modules[$name] = $module;
744 // Preload for getCombinedVersion() and for batch makeModuleResponse()
745 $this->preloadModuleInfo( array_keys( $modules ), $context );
746 } catch ( Exception
$e ) {
747 $this->outputErrorAndLog( $e, 'Preloading module info failed: {exception}' );
750 // Combine versions to propagate cache invalidation
753 $versionHash = $this->getCombinedVersion( $context, array_keys( $modules ) );
754 } catch ( Exception
$e ) {
755 $this->outputErrorAndLog( $e, 'Calculating version hash failed: {exception}' );
758 // See RFC 2616 § 3.11 Entity Tags
759 // https://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11
760 $etag = 'W/"' . $versionHash . '"';
762 // Try the client-side cache first
763 if ( $this->tryRespondNotModified( $context, $etag ) ) {
764 return; // output handled (buffers cleared)
767 // Use file cache if enabled and available...
768 if ( $this->config
->get( 'UseFileCache' ) ) {
769 $fileCache = ResourceFileCache
::newFromContext( $context );
770 if ( $this->tryRespondFromFileCache( $fileCache, $context, $etag ) ) {
771 return; // output handled
777 // Generate a response
778 $response = $this->makeModuleResponse( $context, $modules, $missing );
780 // Capture any PHP warnings from the output buffer and append them to the
781 // error list if we're in debug mode.
782 if ( $context->getDebug() ) {
783 $warnings = ob_get_contents();
784 if ( strlen( $warnings ) ) {
785 $this->errors
[] = $warnings;
789 // Consider saving the response to file cache (unless there are errors).
793 ResourceFileCache
::useFileCache( $context )
795 if ( $fileCache->isCacheWorthy() ) {
796 // There were enough hits, save the response to the cache
797 $fileCache->saveText( $response );
799 $fileCache->incrMissesRecent( $context->getRequest() );
803 $this->sendResponseHeaders( $context, $etag, (bool)$this->errors
, $this->extraHeaders
);
805 // Remove the output buffer and output the response
808 if ( $context->getImageObj() && $this->errors
) {
809 // We can't show both the error messages and the response when it's an image.
810 $response = implode( "\n\n", $this->errors
);
811 } elseif ( $this->errors
) {
812 $errorText = implode( "\n\n", $this->errors
);
813 $errorResponse = self
::makeComment( $errorText );
814 if ( $context->shouldIncludeScripts() ) {
815 $errorResponse .= 'if (window.console && console.error) {'
816 . Xml
::encodeJsCall( 'console.error', [ $errorText ] )
820 // Prepend error info to the response
821 $response = $errorResponse . $response;
828 protected function measureResponseTime( Timing
$timing ) {
829 DeferredUpdates
::addCallableUpdate( function () use ( $timing ) {
830 $measure = $timing->measure( 'responseTime', 'requestStart', 'requestShutdown' );
831 if ( $measure !== false ) {
832 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
833 $stats->timing( 'resourceloader.responseTime', $measure['duration'] * 1000 );
839 * Send main response headers to the client.
841 * Deals with Content-Type, CORS (for stylesheets), and caching.
843 * @param ResourceLoaderContext $context
844 * @param string $etag ETag header value
845 * @param bool $errors Whether there are errors in the response
846 * @param string[] $extra Array of extra HTTP response headers
849 protected function sendResponseHeaders(
850 ResourceLoaderContext
$context, $etag, $errors, array $extra = []
852 \MediaWiki\HeaderCallback
::warnIfHeadersSent();
853 $rlMaxage = $this->config
->get( 'ResourceLoaderMaxage' );
854 // Use a short cache expiry so that updates propagate to clients quickly, if:
855 // - No version specified (shared resources, e.g. stylesheets)
856 // - There were errors (recover quickly)
857 // - Version mismatch (T117587, T47877)
858 if ( is_null( $context->getVersion() )
860 ||
$context->getVersion() !== $this->makeVersionQuery( $context )
862 $maxage = $rlMaxage['unversioned']['client'];
863 $smaxage = $rlMaxage['unversioned']['server'];
864 // If a version was specified we can use a longer expiry time since changing
865 // version numbers causes cache misses
867 $maxage = $rlMaxage['versioned']['client'];
868 $smaxage = $rlMaxage['versioned']['server'];
870 if ( $context->getImageObj() ) {
871 // Output different headers if we're outputting textual errors.
873 header( 'Content-Type: text/plain; charset=utf-8' );
875 $context->getImageObj()->sendResponseHeaders( $context );
877 } elseif ( $context->getOnly() === 'styles' ) {
878 header( 'Content-Type: text/css; charset=utf-8' );
879 header( 'Access-Control-Allow-Origin: *' );
881 header( 'Content-Type: text/javascript; charset=utf-8' );
883 // See RFC 2616 § 14.19 ETag
884 // https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.19
885 header( 'ETag: ' . $etag );
886 if ( $context->getDebug() ) {
887 // Do not cache debug responses
888 header( 'Cache-Control: private, no-cache, must-revalidate' );
889 header( 'Pragma: no-cache' );
891 header( "Cache-Control: public, max-age=$maxage, s-maxage=$smaxage" );
892 $exp = min( $maxage, $smaxage );
893 header( 'Expires: ' . wfTimestamp( TS_RFC2822
, $exp +
time() ) );
895 foreach ( $extra as $header ) {
901 * Respond with HTTP 304 Not Modified if appropiate.
903 * If there's an If-None-Match header, respond with a 304 appropriately
904 * and clear out the output buffer. If the client cache is too old then do nothing.
906 * @param ResourceLoaderContext $context
907 * @param string $etag ETag header value
908 * @return bool True if HTTP 304 was sent and output handled
910 protected function tryRespondNotModified( ResourceLoaderContext
$context, $etag ) {
911 // See RFC 2616 § 14.26 If-None-Match
912 // https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26
913 $clientKeys = $context->getRequest()->getHeader( 'If-None-Match', WebRequest
::GETHEADER_LIST
);
914 // Never send 304s in debug mode
915 if ( $clientKeys !== false && !$context->getDebug() && in_array( $etag, $clientKeys ) ) {
916 // There's another bug in ob_gzhandler (see also the comment at
917 // the top of this function) that causes it to gzip even empty
918 // responses, meaning it's impossible to produce a truly empty
919 // response (because the gzip header is always there). This is
920 // a problem because 304 responses have to be completely empty
921 // per the HTTP spec, and Firefox behaves buggily when they're not.
922 // See also https://bugs.php.net/bug.php?id=51579
923 // To work around this, we tear down all output buffering before
925 wfResetOutputBuffers( /* $resetGzipEncoding = */ true );
927 HttpStatus
::header( 304 );
929 $this->sendResponseHeaders( $context, $etag, false );
936 * Send out code for a response from file cache if possible.
938 * @param ResourceFileCache $fileCache Cache object for this request URL
939 * @param ResourceLoaderContext $context Context in which to generate a response
940 * @param string $etag ETag header value
941 * @return bool If this found a cache file and handled the response
943 protected function tryRespondFromFileCache(
944 ResourceFileCache
$fileCache,
945 ResourceLoaderContext
$context,
948 $rlMaxage = $this->config
->get( 'ResourceLoaderMaxage' );
949 // Buffer output to catch warnings.
951 // Get the maximum age the cache can be
952 $maxage = is_null( $context->getVersion() )
953 ?
$rlMaxage['unversioned']['server']
954 : $rlMaxage['versioned']['server'];
955 // Minimum timestamp the cache file must have
956 $good = $fileCache->isCacheGood( wfTimestamp( TS_MW
, time() - $maxage ) );
958 try { // RL always hits the DB on file cache miss...
959 wfGetDB( DB_REPLICA
);
960 } catch ( DBConnectionError
$e ) { // ...check if we need to fallback to cache
961 $good = $fileCache->isCacheGood(); // cache existence check
965 $ts = $fileCache->cacheTimestamp();
966 // Send content type and cache headers
967 $this->sendResponseHeaders( $context, $etag, false );
968 $response = $fileCache->fetchText();
969 // Capture any PHP warnings from the output buffer and append them to the
970 // response in a comment if we're in debug mode.
971 if ( $context->getDebug() ) {
972 $warnings = ob_get_contents();
973 if ( strlen( $warnings ) ) {
974 $response = self
::makeComment( $warnings ) . $response;
977 // Remove the output buffer and output the response
979 echo $response . "\n/* Cached {$ts} */";
980 return true; // cache hit
985 return false; // cache miss
989 * Generate a CSS or JS comment block.
991 * Only use this for public data, not error message details.
993 * @param string $text
996 public static function makeComment( $text ) {
997 $encText = str_replace( '*/', '* /', $text );
998 return "/*\n$encText\n*/\n";
1002 * Handle exception display.
1004 * @param Exception $e Exception to be shown to the user
1005 * @return string Sanitized text in a CSS/JS comment that can be returned to the user
1007 public static function formatException( $e ) {
1008 return self
::makeComment( self
::formatExceptionNoComment( $e ) );
1012 * Handle exception display.
1015 * @param Exception $e Exception to be shown to the user
1016 * @return string Sanitized text that can be returned to the user
1018 protected static function formatExceptionNoComment( $e ) {
1019 global $wgShowExceptionDetails;
1021 if ( !$wgShowExceptionDetails ) {
1022 return MWExceptionHandler
::getPublicLogMessage( $e );
1025 return MWExceptionHandler
::getLogMessage( $e ) .
1027 MWExceptionHandler
::getRedactedTraceAsString( $e );
1031 * Generate code for a response.
1033 * Calling this method also populates the `errors` and `headers` members,
1034 * later used by respond().
1036 * @param ResourceLoaderContext $context Context in which to generate a response
1037 * @param ResourceLoaderModule[] $modules List of module objects keyed by module name
1038 * @param string[] $missing List of requested module names that are unregistered (optional)
1039 * @return string Response data
1041 public function makeModuleResponse( ResourceLoaderContext
$context,
1042 array $modules, array $missing = []
1047 if ( $modules === [] && $missing === [] ) {
1049 /* This file is the Web entry point for MediaWiki's ResourceLoader:
1050 <https://www.mediawiki.org/wiki/ResourceLoader>. In this request,
1051 no modules were requested. Max made me put this here. */
1055 $image = $context->getImageObj();
1057 $data = $image->getImageData( $context );
1058 if ( $data === false ) {
1060 $this->errors
[] = 'Image generation failed';
1065 foreach ( $missing as $name ) {
1066 $states[$name] = 'missing';
1069 $filter = $context->getOnly() === 'styles' ?
'minify-css' : 'minify-js';
1071 foreach ( $modules as $name => $module ) {
1073 $content = $module->getModuleContent( $context );
1074 $implementKey = $name . '@' . $module->getVersionHash( $context );
1077 if ( isset( $content['headers'] ) ) {
1078 $this->extraHeaders
= array_merge( $this->extraHeaders
, $content['headers'] );
1082 switch ( $context->getOnly() ) {
1084 $scripts = $content['scripts'];
1085 if ( is_string( $scripts ) ) {
1086 // Load scripts raw...
1087 $strContent = $scripts;
1088 } elseif ( is_array( $scripts ) ) {
1089 // ...except when $scripts is an array of URLs or an associative array
1090 $strContent = self
::makeLoaderImplementScript( $implementKey, $scripts, [], [], [] );
1094 $styles = $content['styles'];
1095 // We no longer separate into media, they are all combined now with
1096 // custom media type groups into @media .. {} sections as part of the css string.
1097 // Module returns either an empty array or a numerical array with css strings.
1098 $strContent = isset( $styles['css'] ) ?
implode( '', $styles['css'] ) : '';
1101 $scripts = $content['scripts'] ??
'';
1102 if ( is_string( $scripts ) ) {
1103 if ( $name === 'site' ||
$name === 'user' ) {
1104 // Legacy scripts that run in the global scope without a closure.
1105 // mw.loader.implement will use globalEval if scripts is a string.
1106 // Minify manually here, because general response minification is
1107 // not effective due it being a string literal, not a function.
1108 if ( !$context->getDebug() ) {
1109 $scripts = self
::filter( 'minify-js', $scripts ); // T107377
1112 $scripts = new XmlJsCode( $scripts );
1115 $strContent = self
::makeLoaderImplementScript(
1118 $content['styles'] ??
[],
1119 isset( $content['messagesBlob'] ) ?
new XmlJsCode( $content['messagesBlob'] ) : [],
1120 $content['templates'] ??
[]
1125 if ( !$context->getDebug() ) {
1126 $strContent = self
::filter( $filter, $strContent );
1128 // In debug mode, separate each response by a new line.
1129 // For example, between 'mw.loader.implement();' statements.
1130 $strContent = $this->ensureNewline( $strContent );
1133 if ( $context->getOnly() === 'scripts' ) {
1134 // Use a linebreak between module scripts (T162719)
1135 $out .= $this->ensureNewline( $strContent );
1137 $out .= $strContent;
1140 } catch ( Exception
$e ) {
1141 $this->outputErrorAndLog( $e, 'Generating module package failed: {exception}' );
1143 // Respond to client with error-state instead of module implementation
1144 $states[$name] = 'error';
1145 unset( $modules[$name] );
1149 // Update module states
1150 if ( $context->shouldIncludeScripts() && !$context->getRaw() ) {
1151 if ( $modules && $context->getOnly() === 'scripts' ) {
1152 // Set the state of modules loaded as only scripts to ready as
1153 // they don't have an mw.loader.implement wrapper that sets the state
1154 foreach ( $modules as $name => $module ) {
1155 $states[$name] = 'ready';
1159 // Set the state of modules we didn't respond to with mw.loader.implement
1161 $stateScript = self
::makeLoaderStateScript( $states );
1162 if ( !$context->getDebug() ) {
1163 $stateScript = self
::filter( 'minify-js', $stateScript );
1165 // Use a linebreak between module script and state script (T162719)
1166 $out = $this->ensureNewline( $out ) . $stateScript;
1168 } elseif ( $states ) {
1169 $this->errors
[] = 'Problematic modules: '
1170 . self
::encodeJsonForScript( $states );
1177 * Ensure the string is either empty or ends in a line break
1178 * @param string $str
1181 private function ensureNewline( $str ) {
1182 $end = substr( $str, -1 );
1183 if ( $end === false ||
$end === '' ||
$end === "\n" ) {
1190 * Get names of modules that use a certain message.
1192 * @param string $messageKey
1193 * @return array List of module names
1195 public function getModulesByMessage( $messageKey ) {
1197 foreach ( $this->getModuleNames() as $moduleName ) {
1198 $module = $this->getModule( $moduleName );
1199 if ( in_array( $messageKey, $module->getMessages() ) ) {
1200 $moduleNames[] = $moduleName;
1203 return $moduleNames;
1207 * Return JS code that calls mw.loader.implement with given module properties.
1209 * @param string $name Module name or implement key (format "`[name]@[version]`")
1210 * @param XmlJsCode|array|string $scripts Code as XmlJsCode (to be wrapped in a closure),
1211 * list of URLs to JavaScript files, string of JavaScript for `$.globalEval`, or array with
1212 * 'files' and 'main' properties (see ResourceLoaderModule::getScript())
1213 * @param mixed $styles Array of CSS strings keyed by media type, or an array of lists of URLs
1214 * to CSS files keyed by media type
1215 * @param mixed $messages List of messages associated with this module. May either be an
1216 * associative array mapping message key to value, or a JSON-encoded message blob containing
1217 * the same data, wrapped in an XmlJsCode object.
1218 * @param array $templates Keys are name of templates and values are the source of
1220 * @throws MWException
1221 * @return string JavaScript code
1223 protected static function makeLoaderImplementScript(
1224 $name, $scripts, $styles, $messages, $templates
1226 if ( $scripts instanceof XmlJsCode
) {
1227 if ( $scripts->value
=== '' ) {
1229 } elseif ( self
::inDebugMode() ) {
1230 $scripts = new XmlJsCode( "function ( $, jQuery, require, module ) {\n{$scripts->value}\n}" );
1232 $scripts = new XmlJsCode( 'function($,jQuery,require,module){' . $scripts->value
. '}' );
1234 } elseif ( is_array( $scripts ) && isset( $scripts['files'] ) ) {
1235 $files = $scripts['files'];
1236 foreach ( $files as $path => &$file ) {
1237 // $file is changed (by reference) from a descriptor array to the content of the file
1238 // All of these essentially do $file = $file['content'];, some just have wrapping around it
1239 if ( $file['type'] === 'script' ) {
1240 // Multi-file modules only get two parameters ($ and jQuery are being phased out)
1241 if ( self
::inDebugMode() ) {
1242 $file = new XmlJsCode( "function ( require, module ) {\n{$file['content']}\n}" );
1244 $file = new XmlJsCode( 'function(require,module){' . $file['content'] . '}' );
1247 $file = $file['content'];
1250 $scripts = XmlJsCode
::encodeObject( [
1251 'main' => $scripts['main'],
1252 'files' => XmlJsCode
::encodeObject( $files, self
::inDebugMode() )
1253 ], self
::inDebugMode() );
1254 } elseif ( !is_string( $scripts ) && !is_array( $scripts ) ) {
1255 throw new MWException( 'Invalid scripts error. Array of URLs or string of code expected.' );
1258 // mw.loader.implement requires 'styles', 'messages' and 'templates' to be objects (not
1259 // arrays). json_encode considers empty arrays to be numerical and outputs "[]" instead
1260 // of "{}". Force them to objects.
1268 self
::trimArray( $module );
1270 return Xml
::encodeJsCall( 'mw.loader.implement', $module, self
::inDebugMode() );
1274 * Returns JS code which, when called, will register a given list of messages.
1276 * @param mixed $messages Either an associative array mapping message key to value, or a
1277 * JSON-encoded message blob containing the same data, wrapped in an XmlJsCode object.
1278 * @return string JavaScript code
1280 public static function makeMessageSetScript( $messages ) {
1281 return 'mw.messages.set('
1282 . self
::encodeJsonForScript( (object)$messages )
1287 * Combines an associative array mapping media type to CSS into a
1288 * single stylesheet with "@media" blocks.
1290 * @param array $stylePairs Array keyed by media type containing (arrays of) CSS strings
1293 public static function makeCombinedStyles( array $stylePairs ) {
1295 foreach ( $stylePairs as $media => $styles ) {
1296 // ResourceLoaderFileModule::getStyle can return the styles
1297 // as a string or an array of strings. This is to allow separation in
1299 $styles = (array)$styles;
1300 foreach ( $styles as $style ) {
1301 $style = trim( $style );
1302 // Don't output an empty "@media print { }" block (T42498)
1303 if ( $style !== '' ) {
1304 // Transform the media type based on request params and config
1305 // The way that this relies on $wgRequest to propagate request params is slightly evil
1306 $media = OutputPage
::transformCssMedia( $media );
1308 if ( $media === '' ||
$media == 'all' ) {
1310 } elseif ( is_string( $media ) ) {
1311 $out[] = "@media $media {\n" . str_replace( "\n", "\n\t", "\t" . $style ) . "}";
1321 * Wrapper around json_encode that avoids needless escapes,
1322 * and pretty-prints in debug mode.
1326 * @param mixed $data
1327 * @return string JSON
1329 public static function encodeJsonForScript( $data ) {
1330 // Keep output as small as possible by disabling needless escape modes
1331 // that PHP uses by default.
1332 // However, while most module scripts are only served on HTTP responses
1333 // for JavaScript, some modules can also be embedded in the HTML as inline
1334 // scripts. This, and the fact that we sometimes need to export strings
1335 // containing user-generated content and labels that may genuinely contain
1336 // a sequences like "</script>", we need to encode either '/' or '<'.
1337 // By default PHP escapes '/'. Let's escape '<' instead which is less common
1338 // and allows URLs to mostly remain readable.
1339 $jsonFlags = JSON_UNESCAPED_SLASHES |
1340 JSON_UNESCAPED_UNICODE |
1343 if ( self
::inDebugMode() ) {
1344 $jsonFlags |
= JSON_PRETTY_PRINT
;
1346 return json_encode( $data, $jsonFlags );
1350 * Returns a JS call to mw.loader.state, which sets the state of one
1351 * ore more modules to a given value. Has two calling conventions:
1353 * - ResourceLoader::makeLoaderStateScript( $name, $state ):
1354 * Set the state of a single module called $name to $state
1356 * - ResourceLoader::makeLoaderStateScript( [ $name => $state, ... ] ):
1357 * Set the state of modules with the given names to the given states
1359 * @param array|string $states
1360 * @param string|null $state
1361 * @return string JavaScript code
1363 public static function makeLoaderStateScript( $states, $state = null ) {
1364 if ( !is_array( $states ) ) {
1365 $states = [ $states => $state ];
1367 return 'mw.loader.state('
1368 . self
::encodeJsonForScript( $states )
1372 private static function isEmptyObject( stdClass
$obj ) {
1373 foreach ( $obj as $key => $value ) {
1380 * Remove empty values from the end of an array.
1382 * Values considered empty:
1386 * - new XmlJsCode( '{}' )
1387 * - new stdClass() // (object) []
1389 * @param array $array
1391 private static function trimArray( array &$array ) {
1392 $i = count( $array );
1394 if ( $array[$i] === null
1395 ||
$array[$i] === []
1396 ||
( $array[$i] instanceof XmlJsCode
&& $array[$i]->value
=== '{}' )
1397 ||
( $array[$i] instanceof stdClass
&& self
::isEmptyObject( $array[$i] ) )
1399 unset( $array[$i] );
1407 * Returns JS code which calls mw.loader.register with the given
1413 * ResourceLoader::makeLoaderRegisterScript( [
1414 * [ $name1, $version1, $dependencies1, $group1, $source1, $skip1 ],
1415 * [ $name2, $version2, $dependencies1, $group2, $source2, $skip2 ],
1422 * @param array $modules Array of module registration arrays, each containing
1423 * - string: module name
1424 * - string: module version
1425 * - array|null: List of dependencies (optional)
1426 * - string|null: Module group (optional)
1427 * - string|null: Name of foreign module source, or 'local' (optional)
1428 * - string|null: Script body of a skip function (optional)
1429 * @return string JavaScript code
1431 public static function makeLoaderRegisterScript( array $modules ) {
1432 // Optimisation: Transform dependency names into indexes when possible
1433 // to produce smaller output. They are expanded by mw.loader.register on
1434 // the other end using resolveIndexedDependencies().
1436 foreach ( $modules as $i => &$module ) {
1437 // Build module name index
1438 $index[$module[0]] = $i;
1440 foreach ( $modules as &$module ) {
1441 if ( isset( $module[2] ) ) {
1442 foreach ( $module[2] as &$dependency ) {
1443 if ( isset( $index[$dependency] ) ) {
1444 // Replace module name in dependency list with index
1445 $dependency = $index[$dependency];
1451 array_walk( $modules, [ self
::class, 'trimArray' ] );
1453 return 'mw.loader.register('
1454 . self
::encodeJsonForScript( $modules )
1459 * Returns JS code which calls mw.loader.addSource() with the given
1460 * parameters. Has two calling conventions:
1462 * - ResourceLoader::makeLoaderSourcesScript( $id, $properties ):
1463 * Register a single source
1465 * - ResourceLoader::makeLoaderSourcesScript( [ $id1 => $loadUrl, $id2 => $loadUrl, ... ] );
1466 * Register sources with the given IDs and properties.
1468 * @param string|array $sources Source ID
1469 * @param string|null $loadUrl load.php url
1470 * @return string JavaScript code
1472 public static function makeLoaderSourcesScript( $sources, $loadUrl = null ) {
1473 if ( !is_array( $sources ) ) {
1474 $sources = [ $sources => $loadUrl ];
1476 return 'mw.loader.addSource('
1477 . self
::encodeJsonForScript( $sources )
1482 * Wraps JavaScript code to run after the startup module.
1484 * @param string $script JavaScript code
1485 * @return string JavaScript code
1487 public static function makeLoaderConditionalScript( $script ) {
1488 // Adds a function to lazy-created RLQ
1489 return '(RLQ=window.RLQ||[]).push(function(){' .
1490 trim( $script ) . '});';
1494 * Wraps JavaScript code to run after a required module.
1497 * @param string|string[] $modules Module name(s)
1498 * @param string $script JavaScript code
1499 * @return string JavaScript code
1501 public static function makeInlineCodeWithModule( $modules, $script ) {
1502 // Adds an array to lazy-created RLQ
1503 return '(RLQ=window.RLQ||[]).push(['
1504 . self
::encodeJsonForScript( $modules ) . ','
1505 . 'function(){' . trim( $script ) . '}'
1510 * Returns an HTML script tag that runs given JS code after startup and base modules.
1512 * The code will be wrapped in a closure, and it will be executed by ResourceLoader's
1513 * startup module if the client has adequate support for MediaWiki JavaScript code.
1515 * @param string $script JavaScript code
1516 * @param string|null $nonce [optional] Content-Security-Policy nonce
1517 * (from OutputPage::getCSPNonce)
1518 * @return string|WrappedString HTML
1520 public static function makeInlineScript( $script, $nonce = null ) {
1521 $js = self
::makeLoaderConditionalScript( $script );
1523 if ( $nonce === null ) {
1524 wfWarn( __METHOD__
. " did not get nonce. Will break CSP" );
1525 } elseif ( $nonce !== false ) {
1526 // If it was false, CSP is disabled, so no nonce attribute.
1527 // Nonce should be only base64 characters, so should be safe,
1528 // but better to be safely escaped than sorry.
1529 $escNonce = ' nonce="' . htmlspecialchars( $nonce ) . '"';
1532 return new WrappedString(
1533 Html
::inlineScript( $js, $nonce ),
1534 "<script$escNonce>(RLQ=window.RLQ||[]).push(function(){",
1540 * Returns JS code which will set the MediaWiki configuration array to
1543 * @param array $configuration List of configuration values keyed by variable name
1544 * @return string JavaScript code
1547 public static function makeConfigSetScript( array $configuration ) {
1548 $js = Xml
::encodeJsCall(
1553 if ( $js === false ) {
1555 'JSON serialization of config data failed. ' .
1556 'This usually means the config data is not valid UTF-8.'
1558 MWExceptionHandler
::logException( $e );
1559 $js = Xml
::encodeJsCall( 'mw.log.error', [ $e->__toString() ] );
1565 * Convert an array of module names to a packed query string.
1567 * For example, `[ 'foo.bar', 'foo.baz', 'bar.baz', 'bar.quux' ]`
1568 * becomes `'foo.bar,baz|bar.baz,quux'`.
1570 * This process is reversed by ResourceLoader::expandModuleNames().
1571 * See also mw.loader#buildModulesString() which is a port of this, used
1572 * on the client-side.
1574 * @param array $modules List of module names (strings)
1575 * @return string Packed query string
1577 public static function makePackedModulesString( $modules ) {
1578 $moduleMap = []; // [ prefix => [ suffixes ] ]
1579 foreach ( $modules as $module ) {
1580 $pos = strrpos( $module, '.' );
1581 $prefix = $pos === false ?
'' : substr( $module, 0, $pos );
1582 $suffix = $pos === false ?
$module : substr( $module, $pos +
1 );
1583 $moduleMap[$prefix][] = $suffix;
1587 foreach ( $moduleMap as $prefix => $suffixes ) {
1588 $p = $prefix === '' ?
'' : $prefix . '.';
1589 $arr[] = $p . implode( ',', $suffixes );
1591 return implode( '|', $arr );
1595 * Expand a string of the form `jquery.foo,bar|jquery.ui.baz,quux` to
1596 * an array of module names like `[ 'jquery.foo', 'jquery.bar',
1597 * 'jquery.ui.baz', 'jquery.ui.quux' ]`.
1599 * This process is reversed by ResourceLoader::makePackedModulesString().
1602 * @param string $modules Packed module name list
1603 * @return array Array of module names
1605 public static function expandModuleNames( $modules ) {
1607 $exploded = explode( '|', $modules );
1608 foreach ( $exploded as $group ) {
1609 if ( strpos( $group, ',' ) === false ) {
1610 // This is not a set of modules in foo.bar,baz notation
1611 // but a single module
1614 // This is a set of modules in foo.bar,baz notation
1615 $pos = strrpos( $group, '.' );
1616 if ( $pos === false ) {
1617 // Prefixless modules, i.e. without dots
1618 $retval = array_merge( $retval, explode( ',', $group ) );
1620 // We have a prefix and a bunch of suffixes
1621 $prefix = substr( $group, 0, $pos ); // 'foo'
1622 $suffixes = explode( ',', substr( $group, $pos +
1 ) ); // [ 'bar', 'baz' ]
1623 foreach ( $suffixes as $suffix ) {
1624 $retval[] = "$prefix.$suffix";
1633 * Determine whether debug mode was requested
1634 * Order of priority is 1) request param, 2) cookie, 3) $wg setting
1637 public static function inDebugMode() {
1638 if ( self
::$debugMode === null ) {
1639 global $wgRequest, $wgResourceLoaderDebug;
1640 self
::$debugMode = $wgRequest->getFuzzyBool( 'debug',
1641 $wgRequest->getCookie( 'resourceLoaderDebug', '', $wgResourceLoaderDebug )
1644 return self
::$debugMode;
1648 * Reset static members used for caching.
1650 * Global state and $wgRequest are evil, but we're using it right
1651 * now and sometimes we need to be able to force ResourceLoader to
1652 * re-evaluate the context because it has changed (e.g. in the test suite).
1654 * @internal For use by unit tests
1655 * @codeCoverageIgnore
1657 public static function clearCache() {
1658 self
::$debugMode = null;
1662 * Build a load.php URL
1665 * @param string $source Name of the ResourceLoader source
1666 * @param ResourceLoaderContext $context
1667 * @param array $extraQuery
1668 * @return string URL to load.php. May be protocol-relative if $wgLoadScript is, too.
1670 public function createLoaderURL( $source, ResourceLoaderContext
$context,
1673 $query = self
::createLoaderQuery( $context, $extraQuery );
1674 $script = $this->getLoadScript( $source );
1676 return wfAppendQuery( $script, $query );
1680 * Helper for createLoaderURL()
1683 * @see makeLoaderQuery
1684 * @param ResourceLoaderContext $context
1685 * @param array $extraQuery
1688 protected static function createLoaderQuery( ResourceLoaderContext
$context, $extraQuery = [] ) {
1689 return self
::makeLoaderQuery(
1690 $context->getModules(),
1691 $context->getLanguage(),
1692 $context->getSkin(),
1693 $context->getUser(),
1694 $context->getVersion(),
1695 $context->getDebug(),
1696 $context->getOnly(),
1697 $context->getRequest()->getBool( 'printable' ),
1698 $context->getRequest()->getBool( 'handheld' ),
1704 * Build a query array (array representation of query string) for load.php. Helper
1705 * function for createLoaderURL().
1707 * @param array $modules
1708 * @param string $lang
1709 * @param string $skin
1710 * @param string|null $user
1711 * @param string|null $version
1712 * @param bool $debug
1713 * @param string|null $only
1714 * @param bool $printable
1715 * @param bool $handheld
1716 * @param array $extraQuery
1719 public static function makeLoaderQuery( $modules, $lang, $skin, $user = null,
1720 $version = null, $debug = false, $only = null, $printable = false,
1721 $handheld = false, $extraQuery = []
1724 'modules' => self
::makePackedModulesString( $modules ),
1726 // Keep urls short by omitting query parameters that
1727 // match the defaults assumed by ResourceLoaderContext.
1728 // Note: This relies on the defaults either being insignificant or forever constant,
1729 // as otherwise cached urls could change in meaning when the defaults change.
1730 if ( $lang !== ResourceLoaderContext
::DEFAULT_LANG
) {
1731 $query['lang'] = $lang;
1733 if ( $skin !== ResourceLoaderContext
::DEFAULT_SKIN
) {
1734 $query['skin'] = $skin;
1736 if ( $debug === true ) {
1737 $query['debug'] = 'true';
1739 if ( $user !== null ) {
1740 $query['user'] = $user;
1742 if ( $version !== null ) {
1743 $query['version'] = $version;
1745 if ( $only !== null ) {
1746 $query['only'] = $only;
1749 $query['printable'] = 1;
1752 $query['handheld'] = 1;
1754 $query +
= $extraQuery;
1756 // Make queries uniform in order
1762 * Check a module name for validity.
1764 * Module names may not contain pipes (|), commas (,) or exclamation marks (!) and can be
1765 * at most 255 bytes.
1767 * @param string $moduleName Module name to check
1768 * @return bool Whether $moduleName is a valid module name
1770 public static function isValidModuleName( $moduleName ) {
1771 return strcspn( $moduleName, '!,|', 0, 255 ) === strlen( $moduleName );
1775 * Returns LESS compiler set up for use with MediaWiki
1778 * @param array $vars Associative array of variables that should be used
1779 * for compilation. Since 1.32, this method no longer automatically includes
1780 * global LESS vars from ResourceLoader::getLessVars (T191937).
1781 * @throws MWException
1782 * @return Less_Parser
1784 public function getLessCompiler( $vars = [] ) {
1786 // When called from the installer, it is possible that a required PHP extension
1787 // is missing (at least for now; see T49564). If this is the case, throw an
1788 // exception (caught by the installer) to prevent a fatal error later on.
1789 if ( !class_exists( 'Less_Parser' ) ) {
1790 throw new MWException( 'MediaWiki requires the less.php parser' );
1793 $parser = new Less_Parser
;
1794 $parser->ModifyVars( $vars );
1795 $parser->SetImportDirs( [
1796 "$IP/resources/src/mediawiki.less/" => '',
1798 $parser->SetOption( 'relativeUrls', false );
1804 * Get global LESS variables.
1807 * @deprecated since 1.32 Use ResourceLoderModule::getLessVars() instead.
1808 * @return array Map of variable names to string CSS values.
1810 public function getLessVars() {