25use Psr\Log\LoggerAwareInterface;
26use Psr\Log\LoggerInterface;
27use Psr\Log\NullLogger;
28use WrappedString\WrappedString;
91 const FILTER_NOMIN =
'/*@nomin*/';
108 if ( !$moduleNames ) {
117 $vary =
"$skin|$lang";
118 $res =
$dbr->select(
'module_deps', [
'md_module',
'md_deps' ], [
119 'md_module' => $moduleNames,
125 $modulesWithDeps = [];
126 foreach (
$res as $row ) {
127 $module = $this->
getModule( $row->md_module );
130 FormatJson::decode( $row->md_deps,
true )
132 $modulesWithDeps[] = $row->md_module;
136 foreach ( array_diff( $moduleNames, $modulesWithDeps )
as $name ) {
148 foreach ( $moduleNames
as $name ) {
150 if ( $module && $module->getMessages() ) {
179 if ( strpos( $data, ResourceLoader::FILTER_NOMIN ) !==
false ) {
190 $key =
$cache->makeGlobalKey(
194 self::$filterCacheVersion, md5( $data )
199 $stats->increment(
"resourceloader_cache.$filter.miss" );
203 $stats->increment(
"resourceloader_cache.$filter.hit" );
214 $data = trim( $data );
217 $data = ( $filter ===
'minify-css' )
220 }
catch ( Exception
$e ) {
221 MWExceptionHandler::logException(
$e );
238 $this->logger =
$logger ?:
new NullLogger();
241 $this->logger->debug( __METHOD__ .
' was called without providing a Config instance' );
242 $config = ConfigFactory::getDefaultInstance()->makeConfig(
'main' );
253 $this->
register( include
"$IP/resources/Resources.php" );
254 $this->
register( include
"$IP/resources/ResourcesOOUI.php" );
256 $this->
register(
$config->get(
'ResourceModules' ) );
260 Hooks::run(
'ResourceLoaderRegisterModules', [ &$rl ] );
262 if (
$config->get(
'EnableJavaScriptTest' ) ===
true ) {
321 public function register(
$name, $info = null ) {
322 $moduleSkinStyles = $this->config->
get(
'ResourceModuleSkinStyles' );
326 foreach ( $registrations
as $name => $info ) {
328 if ( isset( $this->moduleInfos[
$name] ) ) {
330 $this->logger->warning(
331 'ResourceLoader duplicate registration warning. ' .
332 'Another module has already been registered as ' .
$name
337 if ( !self::isValidModuleName(
$name ) ) {
338 throw new MWException(
"ResourceLoader module name '$name' is invalid, "
339 .
"see ResourceLoader::isValidModuleName()" );
344 $this->moduleInfos[
$name] = [
'object' => $info ];
345 $info->setName(
$name );
346 $this->modules[
$name] = $info;
347 } elseif ( is_array( $info ) ) {
349 $this->moduleInfos[
$name] = $info;
352 'ResourceLoader module info type error for module \'' .
$name .
357 // Last-minute changes
359 // Apply custom skin-defined styles to existing modules.
360 if ( $this->isFileModule( $name ) ) {
361 foreach ( $moduleSkinStyles as $skinName => $skinStyles ) {
362 // If this module already defines skinStyles for this skin, ignore $wgResourceModuleSkinStyles.
363 if ( isset( $this->moduleInfos[$name]['skinStyles
'][$skinName] ) ) {
367 // If $name is preceded with a '+
', the defined style files will be added to 'default'
368 // skinStyles, otherwise 'default' will be ignored as it normally would be.
369 if ( isset( $skinStyles[$name] ) ) {
370 $paths = (array)$skinStyles[$name];
372 } elseif ( isset( $skinStyles['+
' . $name] ) ) {
373 $paths = (array)$skinStyles['+
' . $name];
374 $styleFiles = isset( $this->moduleInfos[$name]['skinStyles
']['default'] ) ?
375 (array)$this->moduleInfos[$name]['skinStyles
']['default'] :
381 // Add new file paths, remapping them to refer to our directories and not use settings
382 // from the module we're modifying, which come
from the base
definition.
383 list( $localBasePath, $remoteBasePath ) =
390 $this->moduleInfos[
$name][
'skinStyles'][$skinName] = $styleFiles;
402 if ( $this->config->get(
'EnableJavaScriptTest' ) !==
true ) {
403 throw new MWException(
'Attempt to register JavaScript test modules '
404 .
'but <code>$wgEnableJavaScriptTest</code> is false. '
405 .
'Edit your <code>LocalSettings.php</code> to enable it.' );
410 $testModules[
'qunit'] = [];
414 Hooks::run(
'ResourceLoaderTestModules', [ &$testModules, &$rl ] );
418 foreach ( $testModules[
'qunit']
as &$module ) {
422 $module[
'position'] =
'top';
423 $module[
'dependencies'][] =
'test.mediawiki.qunit.testrunner';
426 $testModules[
'qunit'] =
427 ( include
"$IP/tests/qunit/QUnitTestResources.php" ) + $testModules[
'qunit'];
429 foreach ( $testModules
as $id => $names ) {
431 $this->
register( $testModules[$id] );
434 $this->testModuleNames[$id] = array_keys( $testModules[$id] );
451 if ( is_array( $id ) ) {
453 $this->addSource( $key,
$value );
459 if ( isset( $this->sources[$id] ) ) {
461 'ResourceLoader duplicate source addition error. ' .
462 'Another source has already been registered as ' . $id
467 if ( is_array( $loadUrl ) ) {
468 if ( !isset( $loadUrl[
'loadScript'] ) ) {
470 __METHOD__ .
' was passed an array with no "loadScript" key.'
474 $loadUrl = $loadUrl[
'loadScript'];
477 $this->sources[$id] = $loadUrl;
486 return array_keys( $this->moduleInfos );
501 if ( $framework ==
'all' ) {
502 return $this->testModuleNames;
503 } elseif ( isset( $this->testModuleNames[$framework] )
504 && is_array( $this->testModuleNames[$framework] )
506 return $this->testModuleNames[$framework];
520 return isset( $this->moduleInfos[
$name] );
535 if ( !isset( $this->modules[
$name] ) ) {
536 if ( !isset( $this->moduleInfos[
$name] ) ) {
541 $info = $this->moduleInfos[
$name];
543 if ( isset( $info[
'object'] ) ) {
545 $object = $info[
'object'];
547 if ( !isset( $info[
'class'] ) ) {
548 $class =
'ResourceLoaderFileModule';
550 $class = $info[
'class'];
553 $object =
new $class( $info );
554 $object->setConfig( $this->getConfig() );
555 $object->setLogger( $this->logger );
557 $object->setName(
$name );
558 $this->modules[
$name] = $object;
561 return $this->modules[
$name];
571 if ( !isset( $this->moduleInfos[
$name] ) ) {
574 $info = $this->moduleInfos[
$name];
575 if ( isset( $info[
'object'] ) || isset( $info[
'class'] ) ) {
587 return $this->sources;
600 if ( !isset( $this->sources[
$source] ) ) {
601 throw new MWException(
"The $source source was never registered in ResourceLoader." );
603 return $this->sources[
$source];
612 $hash = hash(
'fnv132',
$value );
613 return Wikimedia\base_convert( $hash, 16, 36, 7 );
625 if ( !$moduleNames ) {
629 return $this->getModule( $module )->getVersionHash(
$context );
631 return self::makeHash( implode(
'',
$hashes ) );
656 if ( !$this->getModule(
$name ) ) {
661 $moduleNames[] =
$name;
663 return $this->getCombinedVersion(
$context, $moduleNames );
685 $module = $this->getModule(
$name );
689 if ( $module->getGroup() ===
'private' ) {
690 $this->logger->debug(
"Request for private module '$name' denied" );
691 $this->
errors[] =
"Cannot show private module \"$name\"";
703 }
catch ( Exception
$e ) {
704 MWExceptionHandler::logException(
$e );
705 $this->logger->warning(
'Preloading module info failed: {exception}', [
708 $this->
errors[] = self::formatExceptionNoComment(
$e );
714 $versionHash = $this->getCombinedVersion(
$context, array_keys(
$modules ) );
715 }
catch ( Exception
$e ) {
716 MWExceptionHandler::logException(
$e );
717 $this->logger->warning(
'Calculating version hash failed: {exception}', [
720 $this->
errors[] = self::formatExceptionNoComment(
$e );
725 $etag =
'W/"' . $versionHash .
'"';
728 if ( $this->tryRespondNotModified(
$context, $etag ) ) {
733 if ( $this->config->get(
'UseFileCache' ) ) {
735 if ( $this->tryRespondFromFileCache( $fileCache,
$context, $etag ) ) {
746 $warnings = ob_get_contents();
747 if ( strlen( $warnings ) ) {
748 $this->
errors[] = $warnings;
753 if ( isset( $fileCache ) && !$this->
errors && !count( $missing ) ) {
756 if ( $fileCache->isCacheWorthy() ) {
759 $fileCache->incrMissesRecent(
$context->getRequest() );
764 $this->sendResponseHeaders(
$context, $etag, (
bool)$this->
errors );
769 if (
$context->getImageObj() && $this->errors ) {
771 $response = implode(
"\n\n", $this->errors );
772 } elseif ( $this->errors ) {
773 $errorText = implode(
"\n\n", $this->errors );
774 $errorResponse = self::makeComment( $errorText );
775 if (
$context->shouldIncludeScripts() ) {
776 $errorResponse .=
'if (window.console && console.error) {'
801 $rlMaxage = $this->config->get(
'ResourceLoaderMaxage' );
806 if ( is_null(
$context->getVersion() )
810 $maxage = $rlMaxage[
'unversioned'][
'client'];
811 $smaxage = $rlMaxage[
'unversioned'][
'server'];
815 $maxage = $rlMaxage[
'versioned'][
'client'];
816 $smaxage = $rlMaxage[
'versioned'][
'server'];
821 header(
'Content-Type: text/plain; charset=utf-8' );
825 } elseif (
$context->getOnly() ===
'styles' ) {
826 header(
'Content-Type: text/css; charset=utf-8' );
827 header(
'Access-Control-Allow-Origin: *' );
829 header(
'Content-Type: text/javascript; charset=utf-8' );
833 header(
'ETag: ' . $etag );
836 header(
'Cache-Control: private, no-cache, must-revalidate' );
837 header(
'Pragma: no-cache' );
839 header(
"Cache-Control: public, max-age=$maxage, s-maxage=$smaxage" );
840 $exp = min( $maxage, $smaxage );
858 $clientKeys =
$context->getRequest()->getHeader(
'If-None-Match', WebRequest::GETHEADER_LIST );
860 if ( $clientKeys !==
false && !
$context->getDebug() && in_array( $etag, $clientKeys ) ) {
874 $this->sendResponseHeaders(
$context, $etag,
false );
893 $rlMaxage = $this->config->get(
'ResourceLoaderMaxage' );
897 $maxage = is_null(
$context->getVersion() )
898 ? $rlMaxage[
'unversioned'][
'server']
899 : $rlMaxage[
'versioned'][
'server'];
912 $this->sendResponseHeaders(
$context, $etag,
false );
917 $warnings = ob_get_contents();
918 if ( strlen( $warnings ) ) {
942 $encText = str_replace(
'*/',
'* /', $text );
943 return "/*\n$encText\n*/\n";
953 return self::makeComment( self::formatExceptionNoComment(
$e ) );
967 return MWExceptionHandler::getPublicLogMessage(
$e );
970 return MWExceptionHandler::getLogMessage(
$e );
987 if ( !count(
$modules ) && !count( $missing ) ) {
998 if ( $data ===
false ) {
1000 $this->
errors[] =
'Image generation failed';
1005 foreach ( $missing
as $name ) {
1006 $states[
$name] =
'missing';
1012 $filter =
$context->getOnly() ===
'styles' ?
'minify-css' :
'minify-js';
1017 $implementKey =
$name .
'@' . $module->getVersionHash(
$context );
1024 if ( is_string( $scripts ) ) {
1026 $strContent = $scripts;
1027 } elseif ( is_array( $scripts ) ) {
1029 $strContent = self::makeLoaderImplementScript( $implementKey, $scripts, [], [], [] );
1037 $strContent = isset( $styles[
'css'] ) ? implode(
'', $styles[
'css'] ) :
'';
1041 if ( is_string( $scripts ) ) {
1042 if (
$name ===
'site' ||
$name ===
'user' ) {
1048 $scripts = self::filter(
'minify-js', $scripts );
1054 $strContent = self::makeLoaderImplementScript(
1065 $strContent = self::filter( $filter, $strContent );
1068 $out .= $strContent;
1070 }
catch ( Exception
$e ) {
1071 MWExceptionHandler::logException(
$e );
1072 $this->logger->warning(
'Generating module package failed: {exception}', [
1075 $this->
errors[] = self::formatExceptionNoComment(
$e );
1078 $states[
$name] =
'error';
1081 $isRaw |= $module->isRaw();
1085 if (
$context->shouldIncludeScripts() && !
$context->getRaw() && !$isRaw ) {
1090 $states[
$name] =
'ready';
1095 if ( count( $states ) ) {
1096 $stateScript = self::makeLoaderStateScript( $states );
1098 $stateScript = self::filter(
'minify-js', $stateScript );
1100 $out .= $stateScript;
1103 if ( count( $states ) ) {
1104 $this->
errors[] =
'Problematic modules: ' .
1118 public function getModulesByMessage( $messageKey ) {
1120 foreach ( $this->getModuleNames() as $moduleName ) {
1121 $module = $this->getModule( $moduleName );
1122 if ( in_array( $messageKey, $module->getMessages() ) ) {
1123 $moduleNames[] = $moduleName;
1126 return $moduleNames;
1147 protected static function makeLoaderImplementScript(
1148 $name, $scripts, $styles,
$messages, $templates
1152 $scripts =
new XmlJsCode(
"function ( $, jQuery, require, module ) {\n{$scripts->value}\n}" );
1153 } elseif ( !is_string( $scripts ) && !is_array( $scripts ) ) {
1154 throw new MWException(
'Invalid scripts error. Array of URLs or string of code expected.' );
1166 self::trimArray( $module );
1178 public static function makeMessageSetScript(
$messages ) {
1193 public static function makeCombinedStyles(
array $stylePairs ) {
1195 foreach ( $stylePairs as $media => $styles ) {
1199 $styles = (
array)$styles;
1200 foreach ( $styles as $style ) {
1201 $style = trim( $style );
1203 if ( $style !==
'' ) {
1208 if ( $media ===
'' || $media ==
'all' ) {
1210 } elseif ( is_string( $media ) ) {
1211 $out[] =
"@media $media {\n" . str_replace(
"\n",
"\n\t",
"\t" . $style ) .
"}";
1234 public static function makeLoaderStateScript( $name, $state =
null ) {
1235 if ( is_array( $name ) ) {
1264 public static function makeCustomLoaderScript( $name, $version, $dependencies,
1267 $script = str_replace(
"\n",
"\n\t", trim( $script ) );
1269 "( function ( name, version, dependencies, group, source ) {\n\t$script\n} )",
1270 [ $name, $version, $dependencies, $group,
$source ],
1275 private static function isEmptyObject( stdClass $obj ) {
1276 foreach ( $obj
as $key =>
$value ) {
1294 private static function trimArray(
array &$array ) {
1295 $i = count( $array );
1297 if ( $array[$i] ===
null
1298 || $array[$i] === []
1299 || ( $array[$i] instanceof
XmlJsCode && $array[$i]->value ===
'{}' )
1300 || ( $array[$i] instanceof stdClass && self::isEmptyObject( $array[$i] ) )
1302 unset( $array[$i] );
1336 public static function makeLoaderRegisterScript( $name, $version =
null,
1337 $dependencies =
null, $group =
null,
$source =
null, $skip =
null
1339 if ( is_array( $name ) ) {
1342 foreach ( $name as $i => &$module ) {
1343 $index[$module[0]] = $i;
1348 foreach ( $name as &$module ) {
1349 if ( isset( $module[2] ) ) {
1350 foreach ( $module[2] as &$dependency ) {
1351 if ( isset( $index[$dependency] ) ) {
1352 $dependency = $index[$dependency];
1358 array_walk( $name, [
'self',
'trimArray' ] );
1361 'mw.loader.register',
1366 $registration = [
$name, $version, $dependencies, $group,
$source, $skip ];
1367 self::trimArray( $registration );
1369 'mw.loader.register',
1390 public static function makeLoaderSourcesScript( $id, $loadUrl =
null ) {
1391 if ( is_array( $id ) ) {
1393 'mw.loader.addSource',
1399 'mw.loader.addSource',
1414 public static function makeLoaderConditionalScript( $script ) {
1415 return '(window.RLQ=window.RLQ||[]).push(function(){' .
1416 trim( $script ) .
'});';
1428 public static function makeInlineScript( $script ) {
1429 $js = self::makeLoaderConditionalScript( $script );
1430 return new WrappedString(
1431 Html::inlineScript( $js ),
1432 '<script>(window.RLQ=window.RLQ||[]).push(function(){',
1444 public static function makeConfigSetScript(
array $configuration ) {
1460 public static function makePackedModulesString(
$modules ) {
1463 $pos = strrpos( $module,
'.' );
1464 $prefix = $pos ===
false ?
'' : substr( $module, 0, $pos );
1465 $suffix = $pos ===
false ? $module : substr( $module, $pos + 1 );
1466 $groups[$prefix][] = $suffix;
1470 foreach ( $groups as $prefix => $suffixes ) {
1471 $p = $prefix ===
'' ?
'' : $prefix .
'.';
1472 $arr[] = $p . implode(
',', $suffixes );
1474 $str = implode(
'|', $arr );
1483 public static function inDebugMode() {
1484 if ( self::$debugMode ===
null ) {
1486 self::$debugMode =
$wgRequest->getFuzzyBool(
'debug',
1490 return self::$debugMode;
1500 public static function clearCache() {
1501 self::$debugMode =
null;
1517 $script = $this->getLoadScript(
$source );
1532 return self::makeLoaderQuery(
1540 $context->getRequest()->getBool(
'printable' ),
1541 $context->getRequest()->getBool(
'handheld' ),
1563 public static function makeLoaderQuery(
$modules,
$lang, $skin, $user =
null,
1564 $version =
null,
$debug =
false, $only =
null, $printable =
false,
1565 $handheld =
false, $extraQuery = []
1568 'modules' => self::makePackedModulesString(
$modules ),
1571 'debug' =>
$debug ?
'true' :
'false',
1573 if ( $user !==
null ) {
1576 if ( $version !==
null ) {
1577 $query[
'version'] = $version;
1579 if ( $only !==
null ) {
1604 public static function isValidModuleName( $moduleName ) {
1605 return strcspn( $moduleName,
'!,|', 0, 255 ) === strlen( $moduleName );
1617 public function getLessCompiler( $extraVars = [] ) {
1621 if ( !class_exists(
'Less_Parser' ) ) {
1622 throw new MWException(
'MediaWiki requires the less.php parser' );
1626 $parser->ModifyVars( array_merge( $this->getLessVars(), $extraVars ) );
1628 array_fill_keys( $this->config->get(
'ResourceLoaderLESSImportPaths' ),
'' )
1630 $parser->SetOption(
'relativeUrls',
false );
1641 public function getLessVars() {
1642 if ( !$this->lessVars ) {
1643 $lessVars = $this->config->get(
'ResourceLoaderLESSVars' );
1644 Hooks::run(
'ResourceLoaderGetLessVars', [ &$lessVars ] );
1645 $this->lessVars = $lessVars;
1647 return $this->lessVars;
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this definition
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable from
$wgResourceLoaderDebug
The default debug mode (on/off) for of ResourceLoader requests.
$wgShowExceptionDetails
If set to true, uncaught exceptions will print a complete stack trace to output.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
wfResetOutputBuffers( $resetGzipEncoding=true)
Clear away any user-level output buffers, discarding contents.
if(! $wgDBerrorLogTZ) $wgRequest
static minify( $css)
Removes whitespace from CSS data.
isCacheGood( $timestamp='')
Check if up to date cache file exists.
fetchText()
Get the uncompressed text from the cache.
cacheTimestamp()
Get the last-modified timestamp of the cache file.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
static header( $code)
Output an HTTP status code header.
static minify( $s, $statementsOnOwnLine=false, $maxLineLength=1000)
Returns minified JavaScript code.
This class generates message blobs for use by ResourceLoader modules.
get(ResourceLoader $resourceLoader, $modules, $lang)
static transformCssMedia( $media)
Transform "media" attribute based on request parameters.
static getMain()
Static methods.
ResourceLoader request result caching in the file system.
static useFileCache(ResourceLoaderContext $context)
Check if an RL request can be cached.
static newFromContext(ResourceLoaderContext $context)
Construct an ResourceFileCache from a context.
Object passed around to modules which contains information about the state of a specific loader reque...
static extractBasePaths( $options=[], $localBasePath=null, $remoteBasePath=null)
Extract a pair of local and remote base paths from module definition information.
An object to represent a path to a JavaScript/CSS file, along with a remote and local base path,...
Abstraction for ResourceLoader modules, with name registration and maxage functionality.
static expandRelativePaths(array $filePaths)
Expand directories relative to $IP.
static preloadTitleInfo(ResourceLoaderContext $context, IDatabase $db, array $moduleNames)
Dynamic JavaScript and CSS resource loading system.
__construct(Config $config=null, LoggerInterface $logger=null)
Register core modules and runs registration hooks.
static formatExceptionNoComment( $e)
Handle exception display.
tryRespondFromFileCache(ResourceFileCache $fileCache, ResourceLoaderContext $context, $etag)
Send out code for a response from file cache if possible.
isFileModule( $name)
Return whether the definition of a module corresponds to a simple ResourceLoaderFileModule.
getModuleNames()
Get a list of module names.
setMessageBlobStore(MessageBlobStore $blobStore)
static inDebugMode()
Determine whether debug mode was requested Order of priority is 1) request param, 2) cookie,...
makeModuleResponse(ResourceLoaderContext $context, array $modules, array $missing=[])
Generate code for a response.
setLogger(LoggerInterface $logger)
getTestModuleNames( $framework='all')
Get a list of test module names for one (or all) frameworks.
getLoadScript( $source)
Get the URL to the load.php endpoint for the given ResourceLoader source.
tryRespondNotModified(ResourceLoaderContext $context, $etag)
Respond with HTTP 304 Not Modified if appropiate.
static int $filterCacheVersion
getSources()
Get the list of sources.
addSource( $id, $loadUrl=null)
Add a foreign source of modules.
array $moduleInfos
Associative array mapping module name to info associative array.
sendResponseHeaders(ResourceLoaderContext $context, $etag, $errors)
Send main response headers to the client.
array $testModuleNames
Associative array mapping framework ids to a list of names of test suite modules like [ 'qunit' => [ ...
makeVersionQuery(ResourceLoaderContext $context)
Get the expected value of the 'version' query parameter.
getModule( $name)
Get the ResourceLoaderModule object for a given module name.
array $modules
Module name/ResourceLoaderModule object pairs.
isModuleRegistered( $name)
Check whether a ResourceLoader module is registered.
static applyFilter( $filter, $data)
static formatException( $e)
Handle exception display.
MessageBlobStore $blobStore
array $errors
Errors accumulated during current respond() call.
static makeComment( $text)
Generate a CSS or JS comment block.
getCombinedVersion(ResourceLoaderContext $context, array $moduleNames)
Helper method to get and combine versions of multiple modules.
respond(ResourceLoaderContext $context)
Output a response to a load request, including the content-type header.
static filter( $filter, $data, array $options=[])
Run JavaScript or CSS data through a filter, caching the filtered result for future calls.
preloadModuleInfo(array $moduleNames, ResourceLoaderContext $context)
Load information stored in the database about modules.
A wrapper class which causes Xml::encodeJsVar() and Xml::encodeJsCall() to interpret a given string a...
static encodeJsCall( $name, $args, $pretty=false)
Create a call to a JavaScript function.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
when a variable name is used in a it is silently declared as a new local masking the global
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
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
the array() calling protocol came about after MediaWiki 1.4rc1.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
namespace are movable Hooks may change this value to override the return value of MWNamespace::isMovable(). 'NewDifferenceEngine' do that in ParserLimitReportFormat instead $parser
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
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 modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check $image
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
if the prop value should be in the metadata multi language array can modify can modify indexed by page_id indexed by prefixed DB keys can modify can modify can modify this should be populated with an alert message to that effect to be fed to an HTMLForm object and populate $result with the reason in the form of error messages should be plain text with no special etc to show that they re errors
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
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned $skin
this hook is for auditing only $response
Allows to change the fields on the form that will be generated $name
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
returning false will NOT prevent logging $e
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Interface for configuration instances.
if(!isset( $args[0])) $lang
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
const TS_RFC2822
RFC 2822 format, for E-mail and HTTP headers.