MediaWiki REL1_30
ResourceLoaderStartUpModule.php
Go to the documentation of this file.
1<?php
26
27 // Cache for getConfigSettings() as it's called by multiple methods
28 protected $configVars = [];
29 protected $targets = [ 'desktop', 'mobile' ];
30
35 protected function getConfigSettings( $context ) {
36 $hash = $context->getHash();
37 if ( isset( $this->configVars[$hash] ) ) {
38 return $this->configVars[$hash];
39 }
40
41 global $wgContLang;
42 $conf = $this->getConfig();
43
44 // We can't use Title::newMainPage() if 'mainpage' is in
45 // $wgForceUIMsgAsContentMsg because that will try to use the session
46 // user's language and we have no session user. This does the
47 // equivalent but falling back to our ResourceLoaderContext language
48 // instead.
49 $mainPage = Title::newFromText( $context->msg( 'mainpage' )->inContentLanguage()->text() );
50 if ( !$mainPage ) {
51 $mainPage = Title::newFromText( 'Main Page' );
52 }
53
59 $namespaceIds = $wgContLang->getNamespaceIds();
60 $caseSensitiveNamespaces = [];
61 foreach ( MWNamespace::getCanonicalNamespaces() as $index => $name ) {
62 $namespaceIds[$wgContLang->lc( $name )] = $index;
63 if ( !MWNamespace::isCapitalized( $index ) ) {
64 $caseSensitiveNamespaces[] = $index;
65 }
66 }
67
68 $illegalFileChars = $conf->get( 'IllegalFileChars' );
69
70 // Build list of variables
71 $vars = [
72 'wgLoadScript' => wfScript( 'load' ),
73 'debug' => $context->getDebug(),
74 'skin' => $context->getSkin(),
75 'stylepath' => $conf->get( 'StylePath' ),
76 'wgUrlProtocols' => wfUrlProtocols(),
77 'wgArticlePath' => $conf->get( 'ArticlePath' ),
78 'wgScriptPath' => $conf->get( 'ScriptPath' ),
79 'wgScriptExtension' => '.php',
80 'wgScript' => wfScript(),
81 'wgSearchType' => $conf->get( 'SearchType' ),
82 'wgVariantArticlePath' => $conf->get( 'VariantArticlePath' ),
83 // Force object to avoid "empty" associative array from
84 // becoming [] instead of {} in JS (T36604)
85 'wgActionPaths' => (object)$conf->get( 'ActionPaths' ),
86 'wgServer' => $conf->get( 'Server' ),
87 'wgServerName' => $conf->get( 'ServerName' ),
88 'wgUserLanguage' => $context->getLanguage(),
89 'wgContentLanguage' => $wgContLang->getCode(),
90 'wgTranslateNumerals' => $conf->get( 'TranslateNumerals' ),
91 'wgVersion' => $conf->get( 'Version' ),
92 'wgEnableAPI' => $conf->get( 'EnableAPI' ),
93 'wgEnableWriteAPI' => $conf->get( 'EnableWriteAPI' ),
94 'wgMainPageTitle' => $mainPage->getPrefixedText(),
95 'wgFormattedNamespaces' => $wgContLang->getFormattedNamespaces(),
96 'wgNamespaceIds' => $namespaceIds,
97 'wgContentNamespaces' => MWNamespace::getContentNamespaces(),
98 'wgSiteName' => $conf->get( 'Sitename' ),
99 'wgDBname' => $conf->get( 'DBname' ),
100 'wgExtraSignatureNamespaces' => $conf->get( 'ExtraSignatureNamespaces' ),
101 'wgAvailableSkins' => Skin::getSkinNames(),
102 'wgExtensionAssetsPath' => $conf->get( 'ExtensionAssetsPath' ),
103 // MediaWiki sets cookies to have this prefix by default
104 'wgCookiePrefix' => $conf->get( 'CookiePrefix' ),
105 'wgCookieDomain' => $conf->get( 'CookieDomain' ),
106 'wgCookiePath' => $conf->get( 'CookiePath' ),
107 'wgCookieExpiration' => $conf->get( 'CookieExpiration' ),
108 'wgResourceLoaderMaxQueryLength' => $conf->get( 'ResourceLoaderMaxQueryLength' ),
109 'wgCaseSensitiveNamespaces' => $caseSensitiveNamespaces,
110 'wgLegalTitleChars' => Title::convertByteClassToUnicodeClass( Title::legalChars() ),
111 'wgIllegalFileChars' => Title::convertByteClassToUnicodeClass( $illegalFileChars ),
112 'wgResourceLoaderStorageVersion' => $conf->get( 'ResourceLoaderStorageVersion' ),
113 'wgResourceLoaderStorageEnabled' => $conf->get( 'ResourceLoaderStorageEnabled' ),
114 'wgForeignUploadTargets' => $conf->get( 'ForeignUploadTargets' ),
115 'wgEnableUploads' => $conf->get( 'EnableUploads' ),
116 ];
117
118 Hooks::run( 'ResourceLoaderGetConfigVars', [ &$vars ] );
119
120 $this->configVars[$hash] = $vars;
121 return $this->configVars[$hash];
122 }
123
131 protected static function getImplicitDependencies( array $registryData, $moduleName ) {
132 static $dependencyCache = [];
133
134 // The list of implicit dependencies won't be altered, so we can
135 // cache them without having to worry.
136 if ( !isset( $dependencyCache[$moduleName] ) ) {
137 if ( !isset( $registryData[$moduleName] ) ) {
138 // Dependencies may not exist
139 $dependencyCache[$moduleName] = [];
140 } else {
141 $data = $registryData[$moduleName];
142 $dependencyCache[$moduleName] = $data['dependencies'];
143
144 foreach ( $data['dependencies'] as $dependency ) {
145 // Recursively get the dependencies of the dependencies
146 $dependencyCache[$moduleName] = array_merge(
147 $dependencyCache[$moduleName],
148 self::getImplicitDependencies( $registryData, $dependency )
149 );
150 }
151 }
152 }
153
154 return $dependencyCache[$moduleName];
155 }
156
175 public static function compileUnresolvedDependencies( array &$registryData ) {
176 foreach ( $registryData as $name => &$data ) {
177 $dependencies = $data['dependencies'];
178 foreach ( $data['dependencies'] as $dependency ) {
179 $implicitDependencies = self::getImplicitDependencies( $registryData, $dependency );
180 $dependencies = array_diff( $dependencies, $implicitDependencies );
181 }
182 // Rebuild keys
183 $data['dependencies'] = array_values( $dependencies );
184 }
185 }
186
194 $resourceLoader = $context->getResourceLoader();
195 $target = $context->getRequest()->getVal( 'target', 'desktop' );
196 // Bypass target filter if this request is Special:JavaScriptTest.
197 // To prevent misuse in production, this is only allowed if testing is enabled server-side.
198 $byPassTargetFilter = $this->getConfig()->get( 'EnableJavaScriptTest' ) && $target === 'test';
199
200 $out = '';
201 $states = [];
202 $registryData = [];
203
204 // Get registry data
205 foreach ( $resourceLoader->getModuleNames() as $name ) {
206 $module = $resourceLoader->getModule( $name );
207 $moduleTargets = $module->getTargets();
208 if ( !$byPassTargetFilter && !in_array( $target, $moduleTargets ) ) {
209 continue;
210 }
211
212 if ( $module->isRaw() ) {
213 // Don't register "raw" modules (like 'jquery' and 'mediawiki') client-side because
214 // depending on them is illegal anyway and would only lead to them being reloaded
215 // causing any state to be lost (like jQuery plugins, mw.config etc.)
216 continue;
217 }
218
219 try {
220 $versionHash = $module->getVersionHash( $context );
221 } catch ( Exception $e ) {
222 // See also T152266 and ResourceLoader::getCombinedVersion()
223 MWExceptionHandler::logException( $e );
224 $context->getLogger()->warning(
225 'Calculating version for "{module}" failed: {exception}',
226 [
227 'module' => $name,
228 'exception' => $e,
229 ]
230 );
231 $versionHash = '';
232 $states[$name] = 'error';
233 }
234
235 if ( $versionHash !== '' && strlen( $versionHash ) !== 7 ) {
236 $context->getLogger()->warning(
237 "Module '{module}' produced an invalid version hash: '{version}'.",
238 [
239 'module' => $name,
240 'version' => $versionHash,
241 ]
242 );
243 // Module implementation either broken or deviated from ResourceLoader::makeHash
244 // Asserted by tests/phpunit/structure/ResourcesTest.
246 }
247
248 $skipFunction = $module->getSkipFunction();
249 if ( $skipFunction !== null && !ResourceLoader::inDebugMode() ) {
250 $skipFunction = ResourceLoader::filter( 'minify-js', $skipFunction );
251 }
252
253 $registryData[$name] = [
254 'version' => $versionHash,
255 'dependencies' => $module->getDependencies( $context ),
256 'group' => $module->getGroup(),
257 'source' => $module->getSource(),
258 'skip' => $skipFunction,
259 ];
260 }
261
263
264 // Register sources
266
267 // Figure out the different call signatures for mw.loader.register
268 $registrations = [];
269 foreach ( $registryData as $name => $data ) {
270 // Call mw.loader.register(name, version, dependencies, group, source, skip)
271 $registrations[] = [
272 $name,
273 $data['version'],
274 $data['dependencies'],
275 $data['group'],
276 // Swap default (local) for null
277 $data['source'] === 'local' ? null : $data['source'],
278 $data['skip']
279 ];
280 }
281
282 // Register modules
283 $out .= "\n" . ResourceLoader::makeLoaderRegisterScript( $registrations );
284
285 if ( $states ) {
286 $out .= "\n" . ResourceLoader::makeLoaderStateScript( $states );
287 }
288
289 return $out;
290 }
291
295 public function isRaw() {
296 return true;
297 }
298
305 return [
306 $url => [ 'as' => 'script' ]
307 ];
308 }
309
315 public static function getStartupModules() {
316 return [ 'jquery', 'mediawiki' ];
317 }
318
319 public static function getLegacyModules() {
321
322 $legacyModules = [];
324 $legacyModules[] = 'mediawiki.legacy.wikibits';
325 }
326
327 return $legacyModules;
328 }
329
340 $rl = $context->getResourceLoader();
341 $derivative = new DerivativeResourceLoaderContext( $context );
342 $derivative->setModules( array_merge(
343 self::getStartupModules(),
344 self::getLegacyModules()
345 ) );
346 $derivative->setOnly( 'scripts' );
347 // Must setModules() before makeVersionQuery()
348 $derivative->setVersion( $rl->makeVersionQuery( $derivative ) );
349
350 return $rl->createLoaderURL( 'local', $derivative );
351 }
352
358 global $IP;
359 if ( $context->getOnly() !== 'scripts' ) {
360 return '/* Requires only=script */';
361 }
362
363 $out = file_get_contents( "$IP/resources/src/startup.js" );
364
365 $pairs = array_map( function ( $value ) {
366 $value = FormatJson::encode( $value, ResourceLoader::inDebugMode(), FormatJson::ALL_OK );
367 // Fix indentation
368 $value = str_replace( "\n", "\n\t", $value );
369 return $value;
370 }, [
371 '$VARS.wgLegacyJavaScriptGlobals' => $this->getConfig()->get( 'LegacyJavaScriptGlobals' ),
372 '$VARS.configuration' => $this->getConfigSettings( $context ),
373 // This url may be preloaded. See getPreloadLinks().
374 '$VARS.baseModulesUri' => self::getStartupModulesUrl( $context ),
375 ] );
376 $pairs['$CODE.registrations()'] = str_replace(
377 "\n",
378 "\n\t",
379 trim( $this->getModuleRegistrations( $context ) )
380 );
381
382 return strtr( $out, $pairs );
383 }
384
388 public function supportsURLLoading() {
389 return false;
390 }
391
399 global $IP;
400 $summary = parent::getDefinitionSummary( $context );
401 $summary[] = [
402 // Detect changes to variables exposed in mw.config (T30899).
403 'vars' => $this->getConfigSettings( $context ),
404 // Changes how getScript() creates mw.Map for mw.config
405 'wgLegacyJavaScriptGlobals' => $this->getConfig()->get( 'LegacyJavaScriptGlobals' ),
406 // Detect changes to the module registrations
407 'moduleHashes' => $this->getAllModuleHashes( $context ),
408
409 'fileMtimes' => [
410 filemtime( "$IP/resources/src/startup.js" ),
411 ],
412 ];
413 return $summary;
414 }
415
423 $rl = $context->getResourceLoader();
424 // Preload for getCombinedVersion()
425 $rl->preloadModuleInfo( $rl->getModuleNames(), $context );
426
427 // ATTENTION: Because of the line below, this is not going to cause infinite recursion.
428 // Think carefully before making changes to this code!
429 // Pre-populate versionHash with something because the loop over all modules below includes
430 // the startup module (this module).
431 // See ResourceLoaderModule::getVersionHash() for usage of this cache.
432 $this->versionHash[$context->getHash()] = null;
433
434 return $rl->getCombinedVersion( $context, $rl->getModuleNames() );
435 }
436
440 public function getGroup() {
441 return 'startup';
442 }
443}
$wgIncludeLegacyJavaScript
Whether to ensure the mediawiki.legacy library is loaded before other modules.
wfUrlProtocols( $includeProtocolRelative=true)
Returns a regular expression of url protocols.
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
Allows changing specific properties of a context object, without changing the main one.
Object passed around to modules which contains information about the state of a specific loader reque...
Abstraction for ResourceLoader modules, with name registration and maxage functionality.
getScript(ResourceLoaderContext $context)
static getImplicitDependencies(array $registryData, $moduleName)
Recursively get all explicit and implicit dependencies for to the given module.
static getStartupModules()
Base modules required for the base environment of ResourceLoader.
getPreloadLinks(ResourceLoaderContext $context)
getDefinitionSummary(ResourceLoaderContext $context)
Get the definition summary for this module.
getAllModuleHashes(ResourceLoaderContext $context)
Helper method for getDefinitionSummary().
static compileUnresolvedDependencies(array &$registryData)
Optimize the dependency tree in $this->modules.
static getStartupModulesUrl(ResourceLoaderContext $context)
Get the load URL of the startup modules.
getModuleRegistrations(ResourceLoaderContext $context)
Get registration code for all modules.
static makeLoaderStateScript( $name, $state=null)
Returns a JS call to mw.loader.state, which sets the state of a module or modules to a given value.
static inDebugMode()
Determine whether debug mode was requested Order of priority is 1) request param, 2) cookie,...
static makeLoaderSourcesScript( $id, $loadUrl=null)
Returns JS code which calls mw.loader.addSource() with the given parameters.
static makeLoaderRegisterScript( $name, $version=null, $dependencies=null, $group=null, $source=null, $skip=null)
Returns JS code which calls mw.loader.register with the given parameters.
static makeHash( $value)
static filter( $filter, $data, array $options=[])
Run JavaScript or CSS data through a filter, caching the filtered result for future calls.
static getSkinNames()
Fetch the set of available skins.
Definition Skin.php:51
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition design.txt:57
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
Definition hooks.txt:2198
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition hooks.txt:2780
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition hooks.txt:862
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext such as when responding to a resource loader request or generating HTML output & $resourceLoader
Definition hooks.txt:2787
returning false will NOT prevent logging $e
Definition hooks.txt:2146
$IP
Definition update.php:3
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining however some of the most important ones are listed below They are typically initialised either in index php or in Setup php For a description of the see design txt $wgTitle Title object created from the request URL $wgOut OutputPage object for HTTP response $wgUser User object for the user associated with the current request $wgLang Language object selected by user preferences $wgContLang Language object associated with the wiki being viewed $wgParser Parser object Parser extensions register their hooks here $wgRequest WebRequest object
Definition globals.txt:64