f831b28d16
This was added in 2009 withcf75bdf4ba(r54384) and moved to the startup module in 2010 witha99f9ec28b(r72772). It is no longer used by any extension in Wikimedia Git, nor elsewhere indexed by MediaWiki Codesearch. It also no longer has any uses in mwgrep from public WMF wikis. Bug: T220926 Depends-On: Ifdedccb513f5dd4636a37badc329ac5f1c4dd943 Change-Id: Id2729653cd450d31c1d903358ccf5e4fac564228
457 lines
15 KiB
PHP
457 lines
15 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @author Trevor Parscal
|
|
* @author Roan Kattouw
|
|
*/
|
|
|
|
use MediaWiki\MediaWikiServices;
|
|
|
|
/**
|
|
* Module for ResourceLoader initialization.
|
|
*
|
|
* See also <https://www.mediawiki.org/wiki/ResourceLoader/Features#Startup_Module>
|
|
*
|
|
* The startup module, as being called only from ResourceLoaderClientHtml, has
|
|
* the ability to vary based extra query parameters, in addition to those
|
|
* from ResourceLoaderContext:
|
|
*
|
|
* - target: Only register modules in the client intended for this target.
|
|
* Default: "desktop".
|
|
* See also: OutputPage::setTarget(), ResourceLoaderModule::getTargets().
|
|
*
|
|
* - safemode: Only register modules that have ORIGIN_CORE as their origin.
|
|
* This effectively disables ORIGIN_USER modules. (T185303)
|
|
* See also: OutputPage::disallowUserJs()
|
|
*/
|
|
class ResourceLoaderStartUpModule extends ResourceLoaderModule {
|
|
protected $targets = [ 'desktop', 'mobile' ];
|
|
|
|
/**
|
|
* @param ResourceLoaderContext $context
|
|
* @return array
|
|
*/
|
|
private function getConfigSettings( $context ) {
|
|
$conf = $this->getConfig();
|
|
|
|
/**
|
|
* Namespace related preparation
|
|
* - wgNamespaceIds: Key-value pairs of all localized, canonical and aliases for namespaces.
|
|
* - wgCaseSensitiveNamespaces: Array of namespaces that are case-sensitive.
|
|
*/
|
|
$contLang = MediaWikiServices::getInstance()->getContentLanguage();
|
|
$namespaceIds = $contLang->getNamespaceIds();
|
|
$caseSensitiveNamespaces = [];
|
|
foreach ( MWNamespace::getCanonicalNamespaces() as $index => $name ) {
|
|
$namespaceIds[$contLang->lc( $name )] = $index;
|
|
if ( !MWNamespace::isCapitalized( $index ) ) {
|
|
$caseSensitiveNamespaces[] = $index;
|
|
}
|
|
}
|
|
|
|
$illegalFileChars = $conf->get( 'IllegalFileChars' );
|
|
|
|
// Build list of variables
|
|
$skin = $context->getSkin();
|
|
$vars = [
|
|
'wgLoadScript' => wfScript( 'load' ),
|
|
'debug' => $context->getDebug(),
|
|
'skin' => $skin,
|
|
'stylepath' => $conf->get( 'StylePath' ),
|
|
'wgUrlProtocols' => wfUrlProtocols(),
|
|
'wgArticlePath' => $conf->get( 'ArticlePath' ),
|
|
'wgScriptPath' => $conf->get( 'ScriptPath' ),
|
|
'wgScript' => wfScript(),
|
|
'wgSearchType' => $conf->get( 'SearchType' ),
|
|
'wgVariantArticlePath' => $conf->get( 'VariantArticlePath' ),
|
|
// Force object to avoid "empty" associative array from
|
|
// becoming [] instead of {} in JS (T36604)
|
|
'wgActionPaths' => (object)$conf->get( 'ActionPaths' ),
|
|
'wgServer' => $conf->get( 'Server' ),
|
|
'wgServerName' => $conf->get( 'ServerName' ),
|
|
'wgUserLanguage' => $context->getLanguage(),
|
|
'wgContentLanguage' => $contLang->getCode(),
|
|
'wgTranslateNumerals' => $conf->get( 'TranslateNumerals' ),
|
|
'wgVersion' => $conf->get( 'Version' ),
|
|
'wgEnableAPI' => true, // Deprecated since MW 1.32
|
|
'wgEnableWriteAPI' => true, // Deprecated since MW 1.32
|
|
'wgFormattedNamespaces' => $contLang->getFormattedNamespaces(),
|
|
'wgNamespaceIds' => $namespaceIds,
|
|
'wgContentNamespaces' => MWNamespace::getContentNamespaces(),
|
|
'wgSiteName' => $conf->get( 'Sitename' ),
|
|
'wgDBname' => $conf->get( 'DBname' ),
|
|
'wgExtraSignatureNamespaces' => $conf->get( 'ExtraSignatureNamespaces' ),
|
|
'wgExtensionAssetsPath' => $conf->get( 'ExtensionAssetsPath' ),
|
|
// MediaWiki sets cookies to have this prefix by default
|
|
'wgCookiePrefix' => $conf->get( 'CookiePrefix' ),
|
|
'wgCookieDomain' => $conf->get( 'CookieDomain' ),
|
|
'wgCookiePath' => $conf->get( 'CookiePath' ),
|
|
'wgCookieExpiration' => $conf->get( 'CookieExpiration' ),
|
|
'wgCaseSensitiveNamespaces' => $caseSensitiveNamespaces,
|
|
'wgLegalTitleChars' => Title::convertByteClassToUnicodeClass( Title::legalChars() ),
|
|
'wgIllegalFileChars' => Title::convertByteClassToUnicodeClass( $illegalFileChars ),
|
|
'wgResourceLoaderStorageVersion' => $conf->get( 'ResourceLoaderStorageVersion' ),
|
|
'wgResourceLoaderStorageEnabled' => $conf->get( 'ResourceLoaderStorageEnabled' ),
|
|
'wgForeignUploadTargets' => $conf->get( 'ForeignUploadTargets' ),
|
|
'wgEnableUploads' => $conf->get( 'EnableUploads' ),
|
|
'wgCommentByteLimit' => null,
|
|
'wgCommentCodePointLimit' => CommentStore::COMMENT_CHARACTER_LIMIT,
|
|
];
|
|
|
|
Hooks::run( 'ResourceLoaderGetConfigVars', [ &$vars, $skin ] );
|
|
|
|
return $vars;
|
|
}
|
|
|
|
/**
|
|
* Recursively get all explicit and implicit dependencies for to the given module.
|
|
*
|
|
* @param array $registryData
|
|
* @param string $moduleName
|
|
* @return array
|
|
*/
|
|
protected static function getImplicitDependencies( array $registryData, $moduleName ) {
|
|
static $dependencyCache = [];
|
|
|
|
// The list of implicit dependencies won't be altered, so we can
|
|
// cache them without having to worry.
|
|
if ( !isset( $dependencyCache[$moduleName] ) ) {
|
|
if ( !isset( $registryData[$moduleName] ) ) {
|
|
// Dependencies may not exist
|
|
$dependencyCache[$moduleName] = [];
|
|
} else {
|
|
$data = $registryData[$moduleName];
|
|
$dependencyCache[$moduleName] = $data['dependencies'];
|
|
|
|
foreach ( $data['dependencies'] as $dependency ) {
|
|
// Recursively get the dependencies of the dependencies
|
|
$dependencyCache[$moduleName] = array_merge(
|
|
$dependencyCache[$moduleName],
|
|
self::getImplicitDependencies( $registryData, $dependency )
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
return $dependencyCache[$moduleName];
|
|
}
|
|
|
|
/**
|
|
* Optimize the dependency tree in $this->modules.
|
|
*
|
|
* The optimization basically works like this:
|
|
* Given we have module A with the dependencies B and C
|
|
* and module B with the dependency C.
|
|
* Now we don't have to tell the client to explicitly fetch module
|
|
* C as that's already included in module B.
|
|
*
|
|
* This way we can reasonably reduce the amount of module registration
|
|
* data send to the client.
|
|
*
|
|
* @param array &$registryData Modules keyed by name with properties:
|
|
* - string 'version'
|
|
* - array 'dependencies'
|
|
* - string|null 'group'
|
|
* - string 'source'
|
|
*/
|
|
public static function compileUnresolvedDependencies( array &$registryData ) {
|
|
foreach ( $registryData as $name => &$data ) {
|
|
$dependencies = $data['dependencies'];
|
|
foreach ( $data['dependencies'] as $dependency ) {
|
|
$implicitDependencies = self::getImplicitDependencies( $registryData, $dependency );
|
|
$dependencies = array_diff( $dependencies, $implicitDependencies );
|
|
}
|
|
// Rebuild keys
|
|
$data['dependencies'] = array_values( $dependencies );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get registration code for all modules.
|
|
*
|
|
* @param ResourceLoaderContext $context
|
|
* @return string JavaScript code for registering all modules with the client loader
|
|
*/
|
|
public function getModuleRegistrations( ResourceLoaderContext $context ) {
|
|
$resourceLoader = $context->getResourceLoader();
|
|
// Future developers: Use WebRequest::getRawVal() instead getVal().
|
|
// The getVal() method performs slow Language+UTF logic. (f303bb9360)
|
|
$target = $context->getRequest()->getRawVal( 'target', 'desktop' );
|
|
$safemode = $context->getRequest()->getRawVal( 'safemode' ) === '1';
|
|
// Bypass target filter if this request is Special:JavaScriptTest.
|
|
// To prevent misuse in production, this is only allowed if testing is enabled server-side.
|
|
$byPassTargetFilter = $this->getConfig()->get( 'EnableJavaScriptTest' ) && $target === 'test';
|
|
|
|
$out = '';
|
|
$states = [];
|
|
$registryData = [];
|
|
$moduleNames = $resourceLoader->getModuleNames();
|
|
|
|
// Preload with a batch so that the below calls to getVersionHash() for each module
|
|
// don't require on-demand loading of more information.
|
|
try {
|
|
$resourceLoader->preloadModuleInfo( $moduleNames, $context );
|
|
} catch ( Exception $e ) {
|
|
// Don't fail the request (T152266)
|
|
// Also print the error in the main output
|
|
$resourceLoader->outputErrorAndLog( $e,
|
|
'Preloading module info from startup failed: {exception}',
|
|
[ 'exception' => $e ]
|
|
);
|
|
}
|
|
|
|
// Get registry data
|
|
foreach ( $moduleNames as $name ) {
|
|
$module = $resourceLoader->getModule( $name );
|
|
$moduleTargets = $module->getTargets();
|
|
if (
|
|
( !$byPassTargetFilter && !in_array( $target, $moduleTargets ) )
|
|
|| ( $safemode && $module->getOrigin() > ResourceLoaderModule::ORIGIN_CORE_INDIVIDUAL )
|
|
) {
|
|
continue;
|
|
}
|
|
|
|
if ( $module->isRaw() ) {
|
|
// Don't register "raw" modules (like 'startup') client-side because depending on them
|
|
// is illegal anyway and would only lead to them being loaded a second time,
|
|
// causing any state to be lost.
|
|
|
|
// ATTENTION: Because of the line below, this is not going to cause infinite recursion.
|
|
// Think carefully before making changes to this code!
|
|
// The below code is going to call ResourceLoaderModule::getVersionHash() for every module.
|
|
// For StartUpModule (this module) the hash is computed based on the manifest content,
|
|
// which is the very thing we are computing right here. As such, this must skip iterating
|
|
// over 'startup' itself.
|
|
continue;
|
|
}
|
|
|
|
try {
|
|
$versionHash = $module->getVersionHash( $context );
|
|
} catch ( Exception $e ) {
|
|
// Don't fail the request (T152266)
|
|
// Also print the error in the main output
|
|
$resourceLoader->outputErrorAndLog( $e,
|
|
'Calculating version for "{module}" failed: {exception}',
|
|
[
|
|
'module' => $name,
|
|
'exception' => $e,
|
|
]
|
|
);
|
|
$versionHash = '';
|
|
$states[$name] = 'error';
|
|
}
|
|
|
|
if ( $versionHash !== '' && strlen( $versionHash ) !== 7 ) {
|
|
$context->getLogger()->warning(
|
|
"Module '{module}' produced an invalid version hash: '{version}'.",
|
|
[
|
|
'module' => $name,
|
|
'version' => $versionHash,
|
|
]
|
|
);
|
|
// Module implementation either broken or deviated from ResourceLoader::makeHash
|
|
// Asserted by tests/phpunit/structure/ResourcesTest.
|
|
$versionHash = ResourceLoader::makeHash( $versionHash );
|
|
}
|
|
|
|
$skipFunction = $module->getSkipFunction();
|
|
if ( $skipFunction !== null && !ResourceLoader::inDebugMode() ) {
|
|
$skipFunction = ResourceLoader::filter( 'minify-js', $skipFunction );
|
|
}
|
|
|
|
$registryData[$name] = [
|
|
'version' => $versionHash,
|
|
'dependencies' => $module->getDependencies( $context ),
|
|
'group' => $module->getGroup(),
|
|
'source' => $module->getSource(),
|
|
'skip' => $skipFunction,
|
|
];
|
|
}
|
|
|
|
self::compileUnresolvedDependencies( $registryData );
|
|
|
|
// Register sources
|
|
$out .= ResourceLoader::makeLoaderSourcesScript( $resourceLoader->getSources() );
|
|
|
|
// Figure out the different call signatures for mw.loader.register
|
|
$registrations = [];
|
|
foreach ( $registryData as $name => $data ) {
|
|
// Call mw.loader.register(name, version, dependencies, group, source, skip)
|
|
$registrations[] = [
|
|
$name,
|
|
$data['version'],
|
|
$data['dependencies'],
|
|
$data['group'],
|
|
// Swap default (local) for null
|
|
$data['source'] === 'local' ? null : $data['source'],
|
|
$data['skip']
|
|
];
|
|
}
|
|
|
|
// Register modules
|
|
$out .= "\n" . ResourceLoader::makeLoaderRegisterScript( $registrations );
|
|
|
|
if ( $states ) {
|
|
$out .= "\n" . ResourceLoader::makeLoaderStateScript( $states );
|
|
}
|
|
|
|
return $out;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isRaw() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Internal modules used by ResourceLoader that cannot be depended on.
|
|
*
|
|
* These module(s) should have isRaw() return true, and are not
|
|
* legal dependencies (enforced by structure/ResourcesTest).
|
|
*
|
|
* @deprecated since 1.32 No longer used.
|
|
* @return array
|
|
*/
|
|
public static function getStartupModules() {
|
|
wfDeprecated( __METHOD__, '1.32' );
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* @deprecated since 1.32 No longer used.
|
|
* @return array
|
|
*/
|
|
public static function getLegacyModules() {
|
|
wfDeprecated( __METHOD__, '1.32' );
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* @private For internal use by SpecialJavaScriptTest
|
|
* @since 1.32
|
|
* @return array
|
|
*/
|
|
public function getBaseModulesInternal() {
|
|
return $this->getBaseModules();
|
|
}
|
|
|
|
/**
|
|
* Base modules implicitly available to all modules.
|
|
*
|
|
* @return array
|
|
*/
|
|
private function getBaseModules() {
|
|
global $wgIncludeLegacyJavaScript;
|
|
|
|
$baseModules = [ 'jquery', 'mediawiki.base' ];
|
|
if ( $wgIncludeLegacyJavaScript ) {
|
|
$baseModules[] = 'mediawiki.legacy.wikibits';
|
|
}
|
|
|
|
return $baseModules;
|
|
}
|
|
|
|
/**
|
|
* @param ResourceLoaderContext $context
|
|
* @return string JavaScript code
|
|
*/
|
|
public function getScript( ResourceLoaderContext $context ) {
|
|
global $IP;
|
|
$conf = $this->getConfig();
|
|
|
|
if ( $context->getOnly() !== 'scripts' ) {
|
|
return '/* Requires only=script */';
|
|
}
|
|
|
|
$startupCode = file_get_contents( "$IP/resources/src/startup/startup.js" );
|
|
|
|
// The files read here MUST be kept in sync with maintenance/jsduck/eg-iframe.html,
|
|
// and MUST be considered by 'fileHashes' in StartUpModule::getDefinitionSummary().
|
|
$mwLoaderCode = file_get_contents( "$IP/resources/src/startup/mediawiki.js" ) .
|
|
file_get_contents( "$IP/resources/src/startup/mediawiki.requestIdleCallback.js" );
|
|
if ( $context->getDebug() ) {
|
|
$mwLoaderCode .= file_get_contents( "$IP/resources/src/startup/mediawiki.log.js" );
|
|
}
|
|
if ( $conf->get( 'ResourceLoaderEnableJSProfiler' ) ) {
|
|
$mwLoaderCode .= file_get_contents( "$IP/resources/src/startup/profiler.js" );
|
|
}
|
|
|
|
// Perform replacements for mediawiki.js
|
|
$mwLoaderPairs = [
|
|
'$VARS.baseModules' => ResourceLoader::encodeJsonForScript( $this->getBaseModules() ),
|
|
'$VARS.maxQueryLength' => ResourceLoader::encodeJsonForScript(
|
|
$conf->get( 'ResourceLoaderMaxQueryLength' )
|
|
),
|
|
];
|
|
$profilerStubs = [
|
|
'$CODE.profileExecuteStart();' => 'mw.loader.profiler.onExecuteStart( module );',
|
|
'$CODE.profileExecuteEnd();' => 'mw.loader.profiler.onExecuteEnd( module );',
|
|
'$CODE.profileScriptStart();' => 'mw.loader.profiler.onScriptStart( module );',
|
|
'$CODE.profileScriptEnd();' => 'mw.loader.profiler.onScriptEnd( module );',
|
|
];
|
|
if ( $conf->get( 'ResourceLoaderEnableJSProfiler' ) ) {
|
|
// When profiling is enabled, insert the calls.
|
|
$mwLoaderPairs += $profilerStubs;
|
|
} else {
|
|
// When disabled (by default), insert nothing.
|
|
$mwLoaderPairs += array_fill_keys( array_keys( $profilerStubs ), '' );
|
|
}
|
|
$mwLoaderCode = strtr( $mwLoaderCode, $mwLoaderPairs );
|
|
|
|
// Perform string replacements for startup.js
|
|
$pairs = [
|
|
'$VARS.wgLegacyJavaScriptGlobals' => ResourceLoader::encodeJsonForScript(
|
|
$conf->get( 'LegacyJavaScriptGlobals' )
|
|
),
|
|
'$VARS.configuration' => ResourceLoader::encodeJsonForScript(
|
|
$this->getConfigSettings( $context )
|
|
),
|
|
// Raw JavaScript code (not JSON)
|
|
'$CODE.registrations();' => trim( $this->getModuleRegistrations( $context ) ),
|
|
'$CODE.defineLoader();' => $mwLoaderCode,
|
|
];
|
|
$startupCode = strtr( $startupCode, $pairs );
|
|
|
|
return $startupCode;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function supportsURLLoading() {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function enableModuleContentVersion() {
|
|
// Enabling this means that ResourceLoader::getVersionHash will simply call getScript()
|
|
// and hash it to determine the version (as used by E-Tag HTTP response header).
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getGroup() {
|
|
return 'startup';
|
|
}
|
|
}
|