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 ) {
145 foreach ( $moduleNames
as $name ) {
147 if ( $module && $module->getMessages() ) {
176 if ( strpos( $data, ResourceLoader::FILTER_NOMIN ) !==
false ) {
187 $key =
$cache->makeGlobalKey(
191 self::$filterCacheVersion, md5( $data )
196 $stats->increment(
"resourceloader_cache.$filter.miss" );
200 $stats->increment(
"resourceloader_cache.$filter.hit" );
211 $data = trim( $data );
214 $data = ( $filter ===
'minify-css' )
217 }
catch ( Exception
$e ) {
218 MWExceptionHandler::logException(
$e );
235 $this->logger =
$logger ?:
new NullLogger();
238 $this->logger->debug( __METHOD__ .
' was called without providing a Config instance' );
239 $config = ConfigFactory::getDefaultInstance()->makeConfig(
'main' );
250 $this->
register( include
"$IP/resources/Resources.php" );
251 $this->
register( include
"$IP/resources/ResourcesOOUI.php" );
253 $this->
register(
$config->get(
'ResourceModules' ) );
257 Hooks::run(
'ResourceLoaderRegisterModules', [ &$rl ] );
259 if (
$config->get(
'EnableJavaScriptTest' ) ===
true ) {
318 public function register(
$name, $info = null ) {
322 foreach ( $registrations
as $name => $info ) {
324 if ( isset( $this->moduleInfos[
$name] ) ) {
326 $this->logger->warning(
327 'ResourceLoader duplicate registration warning. ' .
328 'Another module has already been registered as ' .
$name
333 if ( !self::isValidModuleName(
$name ) ) {
334 throw new MWException(
"ResourceLoader module name '$name' is invalid, "
335 .
"see ResourceLoader::isValidModuleName()" );
340 $this->moduleInfos[
$name] = [
'object' => $info ];
341 $info->setName(
$name );
342 $this->modules[
$name] = $info;
343 } elseif ( is_array( $info ) ) {
345 $this->moduleInfos[
$name] = $info;
348 'ResourceLoader module info type error for module \'' .
$name .
353 // Last-minute changes
355 // Apply custom skin-defined styles to existing modules.
356 if ( $this->isFileModule( $name ) ) {
357 foreach ( $this->config->get( 'ResourceModuleSkinStyles
' ) as $skinName => $skinStyles ) {
358 // If this module already defines skinStyles for this skin, ignore $wgResourceModuleSkinStyles.
359 if ( isset( $this->moduleInfos[$name]['skinStyles
'][$skinName] ) ) {
363 // If $name is preceded with a '+
', the defined style files will be added to 'default'
364 // skinStyles, otherwise 'default' will be ignored as it normally would be.
365 if ( isset( $skinStyles[$name] ) ) {
366 $paths = (array)$skinStyles[$name];
368 } elseif ( isset( $skinStyles['+
' . $name] ) ) {
369 $paths = (array)$skinStyles['+
' . $name];
370 $styleFiles = isset( $this->moduleInfos[$name]['skinStyles
']['default'] ) ?
371 (array)$this->moduleInfos[$name]['skinStyles
']['default'] :
377 // Add new file paths, remapping them to refer to our directories and not use settings
379 list( $localBasePath, $remoteBasePath ) =
386 $this->moduleInfos[
$name][
'skinStyles'][$skinName] = $styleFiles;
398 if ( $this->config->get(
'EnableJavaScriptTest' ) !==
true ) {
399 throw new MWException(
'Attempt to register JavaScript test modules '
400 .
'but <code>$wgEnableJavaScriptTest</code> is false. '
401 .
'Edit your <code>LocalSettings.php</code> to enable it.' );
406 $testModules[
'qunit'] = [];
410 Hooks::run(
'ResourceLoaderTestModules', [ &$testModules, &$rl ] );
414 foreach ( $testModules[
'qunit']
as &$module ) {
418 $module[
'position'] =
'top';
419 $module[
'dependencies'][] =
'test.mediawiki.qunit.testrunner';
422 $testModules[
'qunit'] =
423 ( include
"$IP/tests/qunit/QUnitTestResources.php" ) + $testModules[
'qunit'];
425 foreach ( $testModules
as $id => $names ) {
427 $this->
register( $testModules[$id] );
430 $this->testModuleNames[$id] = array_keys( $testModules[$id] );
447 if ( is_array( $id ) ) {
449 $this->addSource( $key,
$value );
455 if ( isset( $this->sources[$id] ) ) {
457 'ResourceLoader duplicate source addition error. ' .
458 'Another source has already been registered as ' . $id
463 if ( is_array( $loadUrl ) ) {
464 if ( !isset( $loadUrl[
'loadScript'] ) ) {
466 __METHOD__ .
' was passed an array with no "loadScript" key.'
470 $loadUrl = $loadUrl[
'loadScript'];
473 $this->sources[$id] = $loadUrl;
482 return array_keys( $this->moduleInfos );
497 if ( $framework ==
'all' ) {
498 return $this->testModuleNames;
499 } elseif ( isset( $this->testModuleNames[$framework] )
500 && is_array( $this->testModuleNames[$framework] )
502 return $this->testModuleNames[$framework];
516 return isset( $this->moduleInfos[
$name] );
531 if ( !isset( $this->modules[
$name] ) ) {
532 if ( !isset( $this->moduleInfos[
$name] ) ) {
537 $info = $this->moduleInfos[
$name];
539 if ( isset( $info[
'object'] ) ) {
541 $object = $info[
'object'];
543 if ( !isset( $info[
'class'] ) ) {
544 $class =
'ResourceLoaderFileModule';
546 $class = $info[
'class'];
549 $object =
new $class( $info );
550 $object->setConfig( $this->getConfig() );
551 $object->setLogger( $this->logger );
553 $object->setName(
$name );
554 $this->modules[
$name] = $object;
557 return $this->modules[
$name];
567 if ( !isset( $this->moduleInfos[
$name] ) ) {
570 $info = $this->moduleInfos[
$name];
571 if ( isset( $info[
'object'] ) || isset( $info[
'class'] ) ) {
583 return $this->sources;
596 if ( !isset( $this->sources[
$source] ) ) {
597 throw new MWException(
"The $source source was never registered in ResourceLoader." );
599 return $this->sources[
$source];
611 return substr( base64_encode( sha1(
$value,
true ) ), 0, 8 );
627 return $this->getModule( $module )->getVersionHash(
$context );
629 return self::makeHash( implode(
$hashes ) );
651 $module = $this->getModule(
$name );
655 if ( $module->getGroup() ===
'private' ) {
656 $this->logger->debug(
"Request for private module '$name' denied" );
657 $this->
errors[] =
"Cannot show private module \"$name\"";
660 $modules[
$name] = $module;
668 $this->preloadModuleInfo( array_keys( $modules ),
$context );
669 }
catch ( Exception
$e ) {
670 MWExceptionHandler::logException(
$e );
671 $this->logger->warning(
'Preloading module info failed: {exception}', [
674 $this->
errors[] = self::formatExceptionNoComment(
$e );
680 $versionHash = $this->getCombinedVersion(
$context, array_keys( $modules ) );
681 }
catch ( Exception
$e ) {
682 MWExceptionHandler::logException(
$e );
683 $this->logger->warning(
'Calculating version hash failed: {exception}', [
686 $this->
errors[] = self::formatExceptionNoComment(
$e );
691 $etag =
'W/"' . $versionHash .
'"';
694 if ( $this->tryRespondNotModified(
$context, $etag ) ) {
699 if ( $this->config->get(
'UseFileCache' ) ) {
701 if ( $this->tryRespondFromFileCache( $fileCache,
$context, $etag ) ) {
712 $warnings = ob_get_contents();
713 if ( strlen( $warnings ) ) {
714 $this->
errors[] = $warnings;
719 if ( isset( $fileCache ) && !$this->
errors && !count( $missing ) ) {
722 if ( $fileCache->isCacheWorthy() ) {
725 $fileCache->incrMissesRecent(
$context->getRequest() );
730 $this->sendResponseHeaders(
$context, $etag, (
bool)$this->
errors );
735 if (
$context->getImageObj() && $this->errors ) {
737 $response = implode(
"\n\n", $this->errors );
738 } elseif ( $this->errors ) {
739 $errorText = implode(
"\n\n", $this->errors );
740 $errorResponse = self::makeComment( $errorText );
741 if (
$context->shouldIncludeScripts() ) {
742 $errorResponse .=
'if (window.console && console.error) {'
767 $rlMaxage = $this->config->get(
'ResourceLoaderMaxage' );
771 if ( is_null(
$context->getVersion() ) || $errors ) {
772 $maxage = $rlMaxage[
'unversioned'][
'client'];
773 $smaxage = $rlMaxage[
'unversioned'][
'server'];
777 $maxage = $rlMaxage[
'versioned'][
'client'];
778 $smaxage = $rlMaxage[
'versioned'][
'server'];
783 header(
'Content-Type: text/plain; charset=utf-8' );
787 } elseif (
$context->getOnly() ===
'styles' ) {
788 header(
'Content-Type: text/css; charset=utf-8' );
789 header(
'Access-Control-Allow-Origin: *' );
791 header(
'Content-Type: text/javascript; charset=utf-8' );
795 header(
'ETag: ' . $etag );
798 header(
'Cache-Control: private, no-cache, must-revalidate' );
799 header(
'Pragma: no-cache' );
801 header(
"Cache-Control: public, max-age=$maxage, s-maxage=$smaxage" );
802 $exp = min( $maxage, $smaxage );
820 $clientKeys =
$context->getRequest()->getHeader(
'If-None-Match', WebRequest::GETHEADER_LIST );
822 if ( $clientKeys !==
false && !
$context->getDebug() && in_array( $etag, $clientKeys ) ) {
836 $this->sendResponseHeaders(
$context, $etag,
false );
855 $rlMaxage = $this->config->get(
'ResourceLoaderMaxage' );
859 $maxage = is_null(
$context->getVersion() )
860 ? $rlMaxage[
'unversioned'][
'server']
861 : $rlMaxage[
'versioned'][
'server'];
874 $this->sendResponseHeaders(
$context, $etag,
false );
879 $warnings = ob_get_contents();
880 if ( strlen( $warnings ) ) {
904 $encText = str_replace(
'*/',
'* /', $text );
905 return "/*\n$encText\n*/\n";
915 return self::makeComment( self::formatExceptionNoComment(
$e ) );
929 return MWExceptionHandler::getPublicLogMessage(
$e );
932 return MWExceptionHandler::getLogMessage(
$e );
949 if ( !count( $modules ) && !count( $missing ) ) {
960 if ( $data ===
false ) {
962 $this->
errors[] =
'Image generation failed';
967 foreach ( $missing
as $name ) {
968 $states[
$name] =
'missing';
974 $filter =
$context->getOnly() ===
'styles' ?
'minify-css' :
'minify-js';
976 foreach ( $modules
as $name => $module ) {
985 if ( is_string( $scripts ) ) {
987 $strContent = $scripts;
988 } elseif ( is_array( $scripts ) ) {
990 $strContent = self::makeLoaderImplementScript(
$name, $scripts, [], [], [] );
998 $strContent = isset( $styles[
'css'] ) ? implode(
'', $styles[
'css'] ) :
'';
1001 $strContent = self::makeLoaderImplementScript(
1012 $strContent = self::filter( $filter, $strContent );
1015 $out .= $strContent;
1017 }
catch ( Exception
$e ) {
1018 MWExceptionHandler::logException(
$e );
1019 $this->logger->warning(
'Generating module package failed: {exception}', [
1022 $this->
errors[] = self::formatExceptionNoComment(
$e );
1025 $states[
$name] =
'error';
1026 unset( $modules[
$name] );
1028 $isRaw |= $module->isRaw();
1032 if (
$context->shouldIncludeScripts() && !
$context->getRaw() && !$isRaw ) {
1033 if ( count( $modules ) &&
$context->getOnly() ===
'scripts' ) {
1036 foreach ( $modules
as $name => $module ) {
1037 $states[
$name] =
'ready';
1042 if ( count( $states ) ) {
1043 $stateScript = self::makeLoaderStateScript( $states );
1045 $stateScript = self::filter(
'minify-js', $stateScript );
1047 $out .= $stateScript;
1050 if ( count( $states ) ) {
1051 $this->
errors[] =
'Problematic modules: ' .
1065 public function getModulesByMessage( $messageKey ) {
1067 foreach ( $this->getModuleNames() as $moduleName ) {
1068 $module = $this->getModule( $moduleName );
1069 if ( in_array( $messageKey, $module->getMessages() ) ) {
1070 $moduleNames[] = $moduleName;
1073 return $moduleNames;
1093 public static function makeLoaderImplementScript(
1094 $name, $scripts, $styles,
$messages, $templates
1096 if ( is_string( $scripts ) ) {
1099 if ( $name ===
'site' || $name ===
'user' ) {
1103 $scripts = self::filter(
'minify-js', $scripts );
1106 $scripts =
new XmlJsCode(
"function ( $, jQuery, require, module ) {\n{$scripts}\n}" );
1108 } elseif ( !is_array( $scripts ) ) {
1109 throw new MWException(
'Invalid scripts error. Array of URLs or string of code expected.' );
1121 self::trimArray( $module );
1133 public static function makeMessageSetScript(
$messages ) {
1148 public static function makeCombinedStyles(
array $stylePairs ) {
1150 foreach ( $stylePairs as $media => $styles ) {
1154 $styles = (
array)$styles;
1155 foreach ( $styles as $style ) {
1156 $style = trim( $style );
1158 if ( $style !==
'' ) {
1163 if ( $media ===
'' || $media ==
'all' ) {
1165 } elseif ( is_string( $media ) ) {
1166 $out[] =
"@media $media {\n" . str_replace(
"\n",
"\n\t",
"\t" . $style ) .
"}";
1189 public static function makeLoaderStateScript( $name,
$state =
null ) {
1190 if ( is_array( $name ) ) {
1219 public static function makeCustomLoaderScript( $name,
$version, $dependencies,
1222 $script = str_replace(
"\n",
"\n\t", trim( $script ) );
1224 "( function ( name, version, dependencies, group, source ) {\n\t$script\n} )",
1230 private static function isEmptyObject( stdClass $obj ) {
1231 foreach ( $obj
as $key =>
$value ) {
1249 private static function trimArray(
array &$array ) {
1250 $i = count( $array );
1252 if ( $array[
$i] ===
null
1253 || $array[
$i] === []
1254 || ( $array[
$i] instanceof
XmlJsCode && $array[
$i]->value ===
'{}' )
1255 || ( $array[
$i] instanceof stdClass && self::isEmptyObject( $array[
$i] ) )
1257 unset( $array[
$i] );
1291 public static function makeLoaderRegisterScript( $name,
$version =
null,
1292 $dependencies =
null, $group =
null,
$source =
null, $skip =
null
1294 if ( is_array( $name ) ) {
1297 foreach ( $name as
$i => &$module ) {
1298 $index[$module[0]] =
$i;
1303 foreach ( $name as &$module ) {
1304 if ( isset( $module[2] ) ) {
1305 foreach ( $module[2] as &$dependency ) {
1306 if ( isset( $index[$dependency] ) ) {
1307 $dependency = $index[$dependency];
1313 array_walk( $name, [
'self',
'trimArray' ] );
1316 'mw.loader.register',
1322 self::trimArray( $registration );
1324 'mw.loader.register',
1345 public static function makeLoaderSourcesScript( $id, $properties =
null ) {
1346 if ( is_array( $id ) ) {
1348 'mw.loader.addSource',
1354 'mw.loader.addSource',
1355 [ $id, $properties ],
1369 public static function makeLoaderConditionalScript( $script ) {
1370 return '(window.RLQ=window.RLQ||[]).push(function(){' .
1371 trim( $script ) .
'});';
1383 public static function makeInlineScript( $script ) {
1384 $js = self::makeLoaderConditionalScript( $script );
1385 return new WrappedString(
1387 '<script>(window.RLQ=window.RLQ||[]).push(function(){',
1399 public static function makeConfigSetScript(
array $configuration ) {
1415 public static function makePackedModulesString( $modules ) {
1417 foreach ( $modules as $module ) {
1418 $pos = strrpos( $module,
'.' );
1419 $prefix = $pos ===
false ?
'' : substr( $module, 0, $pos );
1420 $suffix = $pos ===
false ? $module : substr( $module, $pos + 1 );
1421 $groups[$prefix][] = $suffix;
1425 foreach ( $groups as $prefix => $suffixes ) {
1426 $p = $prefix ===
'' ?
'' : $prefix .
'.';
1427 $arr[] = $p . implode(
',', $suffixes );
1429 $str = implode(
'|', $arr );
1438 public static function inDebugMode() {
1439 if ( self::$debugMode ===
null ) {
1441 self::$debugMode =
$wgRequest->getFuzzyBool(
'debug',
1445 return self::$debugMode;
1455 public static function clearCache() {
1456 self::$debugMode =
null;
1472 $script = $this->getLoadScript(
$source );
1492 public static function makeLoaderURL( $modules,
$lang, $skin, $user =
null,
1493 $version =
null,
$debug =
false, $only =
null, $printable =
false,
1494 $handheld =
false, $extraQuery = []
1499 $only, $printable, $handheld, $extraQuery
1515 return self::makeLoaderQuery(
1523 $context->getRequest()->getBool(
'printable' ),
1524 $context->getRequest()->getBool(
'handheld' ),
1546 public static function makeLoaderQuery( $modules,
$lang, $skin, $user =
null,
1547 $version =
null,
$debug =
false, $only =
null, $printable =
false,
1548 $handheld =
false, $extraQuery = []
1551 'modules' => self::makePackedModulesString( $modules ),
1554 'debug' =>
$debug ?
'true' :
'false',
1556 if ( $user !==
null ) {
1562 if ( $only !==
null ) {
1587 public static function isValidModuleName( $moduleName ) {
1588 return strcspn( $moduleName,
'!,|', 0, 255 ) === strlen( $moduleName );
1600 public function getLessCompiler( $extraVars = [] ) {
1604 if ( !class_exists(
'Less_Parser' ) ) {
1605 throw new MWException(
'MediaWiki requires the less.php parser' );
1609 $parser->ModifyVars( array_merge( $this->getLessVars(), $extraVars ) );
1611 array_fill_keys( $this->config->get(
'ResourceLoaderLESSImportPaths' ),
'' )
1613 $parser->SetOption(
'relativeUrls',
false );
1614 $parser->SetCacheDir( $this->config->get(
'CacheDirectory' ) ?:
wfTempDir() );
1625 public function getLessVars() {
1626 if ( !$this->lessVars ) {
1627 $lessVars = $this->config->get(
'ResourceLoaderLESSVars' );
1628 Hooks::run(
'ResourceLoaderGetLessVars', [ &$lessVars ] );
1629 $this->lessVars = $lessVars;
1631 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.
$wgLoadScript
The URL path to load.php.
wfTempDir()
Tries to get the system directory for temporary files.
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...
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
const TS_RFC2822
RFC 2822 format, for E-mail and HTTP headers.
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(is_null($wgLocalTZoffset)) 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 inlineScript( $contents)
Output a "<script>" tag with the given contents.
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.
static getLocalServerInstance( $fallback=CACHE_NONE)
Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
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.
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
getCombinedVersion(ResourceLoaderContext $context, array $modules)
Helper method to get and combine versions of multiple modules.
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 array( 'qunit' ...
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.
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
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':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.
#define the
table suitable for use with IDatabase::select()
if(!isset( $args[0])) $lang