MediaWiki  master
ResourceLoaderWikiModule Class Reference

Abstraction for ResourceLoader modules which pull from wiki pages. More...

Inheritance diagram for ResourceLoaderWikiModule:
Collaboration diagram for ResourceLoaderWikiModule:

Public Member Functions

 __construct (array $options=null)
 
 enableModuleContentVersion ()
 Disable module content versioning. More...
 
 getDefinitionSummary (ResourceLoaderContext $context)
 
 getGroup ()
 Get group name. More...
 
 getScript (ResourceLoaderContext $context)
 
 getStyles (ResourceLoaderContext $context)
 
 getType ()
 
 isKnownEmpty (ResourceLoaderContext $context)
 
 shouldEmbedModule (ResourceLoaderContext $context)
 
 supportsURLLoading ()
 
- Public Member Functions inherited from ResourceLoaderModule
 getConfig ()
 
 getDependencies (ResourceLoaderContext $context=null)
 Get a list of modules this module depends on. More...
 
 getDeprecationInformation (ResourceLoaderContext $context)
 Get JS representing deprecation information for the current module if available. More...
 
 getFlip (ResourceLoaderContext $context)
 
 getHeaders (ResourceLoaderContext $context)
 Get headers to send as part of a module web response. More...
 
 getMessages ()
 Get the messages needed for this module. More...
 
 getModuleContent (ResourceLoaderContext $context)
 Get an array of this module's resources. More...
 
 getName ()
 Get this module's name. More...
 
 getOrigin ()
 Get this module's origin. More...
 
 getScriptURLsForDebug (ResourceLoaderContext $context)
 Get alternative script URLs for legacy debug mode. More...
 
 getSkipFunction ()
 Get the skip function. More...
 
 getSource ()
 Get the source of this module. More...
 
 getStyleURLsForDebug (ResourceLoaderContext $context)
 Get the URL or URLs to load for this module's CSS in debug mode. More...
 
 getTargets ()
 Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile']. More...
 
 getTemplates ()
 Takes named templates by the module and returns an array mapping. More...
 
 getVersionHash (ResourceLoaderContext $context)
 Get a string identifying the current version of this module in a given context. More...
 
 requiresES6 ()
 Whether the module requires ES6 support in the client. More...
 
 setConfig (Config $config)
 
 setDependencyAccessCallbacks (callable $loadCallback, callable $saveCallback)
 Inject the functions that load/save the indirect file path dependency list from storage. More...
 
 setFileDependencies (ResourceLoaderContext $context, array $paths)
 Set the indirect dependencies for this module pursuant to the skin/language context. More...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLogger (LoggerInterface $logger)
 
 setMessageBlob ( $blob, $lang)
 Set in-object cache for message blobs. More...
 
 setName ( $name)
 Set this module's name. More...
 
 setSkinStylesOverride (array $moduleSkinStyles)
 Provide overrides for skinStyles to modules that support that. More...
 

Static Public Member Functions

static invalidateModuleCache (PageIdentity $page, ?RevisionRecord $old, ?RevisionRecord $new, string $domain)
 Clear the preloadTitleInfo() cache for all wiki modules on this wiki on page change if it was a JS or CSS page. More...
 
static preloadTitleInfo (ResourceLoaderContext $context, IDatabase $db, array $moduleNames)
 
- Static Public Member Functions inherited from ResourceLoaderModule
static expandRelativePaths (array $filePaths)
 Expand directories relative to $IP. More...
 
static getRelativePaths (array $filePaths)
 Make file paths relative to MediaWiki directory. More...
 
static getVary (ResourceLoaderContext $context)
 Get vary string. More...
 

Protected Member Functions

 getContent ( $titleText, ResourceLoaderContext $context)
 
 getContentObj (PageIdentity $page, ResourceLoaderContext $context, $maxRedirects=null)
 
 getDB ()
 Get the Database handle used for computing the module version. More...
 
 getPages (ResourceLoaderContext $context)
 Subclasses should return an associative array of resources in the module. More...
 
 getRequireKey (string $titleText)
 Convert a namespace-formatted page title to a virtual package file name. More...
 
 getTitleInfo (ResourceLoaderContext $context)
 Get the information about the wiki pages for a given context. More...
 
 isPackaged ()
 Get whether this module is a packaged module. More...
 
- Protected Member Functions inherited from ResourceLoaderModule
 buildContent (ResourceLoaderContext $context)
 Bundle all resources attached to this module into an array. More...
 
 getFileDependencies (ResourceLoaderContext $context)
 Get the indirect dependencies for this module pursuant to the skin/language context. More...
 
 getHookRunner ()
 Get a HookRunner for running core hooks. More...
 
 getLessVars (ResourceLoaderContext $context)
 Get module-specific LESS variables, if any. More...
 
 getLogger ()
 
 getMessageBlob (ResourceLoaderContext $context)
 Get the hash of the message blob. More...
 
 getPreloadLinks (ResourceLoaderContext $context)
 Get a list of resources that web browsers may preload. More...
 
 saveFileDependencies (ResourceLoaderContext $context, array $curFileRefs)
 Save the indirect dependencies for this module pursuant to the skin/language context. More...
 
 validateScriptFile ( $fileName, $contents)
 Validate a user-provided JavaScript blob. More...
 

Static Protected Member Functions

static fetchTitleInfo (IDatabase $db, array $pages, $fname=__METHOD__)
 
- Static Protected Member Functions inherited from ResourceLoaderModule
static safeFileHash ( $filePath)
 Compute a non-cryptographic string hash of a file's contents. More...
 

Protected Attributes

array $datas = []
 List of page names that contain JSON. More...
 
string null $group
 Group of module. More...
 
string $origin = self::ORIGIN_USER_SITEWIDE
 Origin defaults to users with sitewide authority. More...
 
array $scripts = []
 List of page names that contain JavaScript. More...
 
array $styles = []
 List of page names that contain CSS. More...
 
array $titleInfo = []
 In-process cache for title info, structured as an array [ <batchKey> // Pipe-separated list of sorted keys from getPages => [ <titleKey> => [ // Normalised title key 'page_len' => .., 'page_latest' => .., 'page_touched' => .., ] ] ]. More...
 
- Protected Attributes inherited from ResourceLoaderModule
Config $config
 
array $contents = []
 Map of (context hash => cached module content) More...
 
string bool $deprecated = false
 Deprecation string or true if deprecated; false otherwise. More...
 
array $fileDeps = []
 Map of (variant => indirect file dependencies) More...
 
LoggerInterface $logger
 
array $msgBlobs = []
 Map of (language => in-object cache for message blob) More...
 
string null $name = null
 Module name. More...
 
int $origin = self::ORIGIN_CORE_SITEWIDE
 Script and style modules form a hierarchy of trustworthiness, with core modules like skins and jQuery as most trustworthy, and user scripts as least trustworthy. More...
 
string[] $targets = [ 'desktop' ]
 What client platforms the module targets (e.g. More...
 
array $versionHash = []
 Map of (context hash => cached module version hash) More...
 

Private Member Functions

 getPackageFiles (ResourceLoaderContext $context)
 
 setTitleInfo ( $batchKey, array $titleInfo)
 

Static Private Member Functions

static makeTitleKey (LinkTarget $title)
 

Detailed Description

Abstraction for ResourceLoader modules which pull from wiki pages.

This can only be used for wiki pages in the MediaWiki and User namespaces, because of its dependence on the functionality of Title::isUserConfigPage() and Title::isSiteConfigPage().

This module supports being used as a placeholder for a module on a remote wiki. To do so, getDB() must be overloaded to return a foreign database object that allows local wikis to query page metadata.

Safe for calls on local wikis are:

Since
1.17

Definition at line 56 of file ResourceLoaderWikiModule.php.

Constructor & Destructor Documentation

◆ __construct()

ResourceLoaderWikiModule::__construct ( array  $options = null)
Parameters
array | null$optionsFor back-compat, this can be omitted in favour of overwriting getPages.

Definition at line 94 of file ResourceLoaderWikiModule.php.

Member Function Documentation

◆ enableModuleContentVersion()

ResourceLoaderWikiModule::enableModuleContentVersion ( )

Disable module content versioning.

This class does not support generating content outside of a module request due to foreign database support.

See getDefinitionSummary() for meta-data versioning.

Returns
bool

Reimplemented from ResourceLoaderModule.

Definition at line 446 of file ResourceLoaderWikiModule.php.

◆ fetchTitleInfo()

static ResourceLoaderWikiModule::fetchTitleInfo ( IDatabase  $db,
array  $pages,
  $fname = __METHOD__ 
)
staticprotected
Parameters
IDatabase$db
array$pages
string$fname
Returns
array

Definition at line 543 of file ResourceLoaderWikiModule.php.

References $res, $title, $titleInfo, makeTitleKey(), Title\newFromText(), and Wikimedia\Rdbms\IDatabase\select().

◆ getContent()

ResourceLoaderWikiModule::getContent (   $titleText,
ResourceLoaderContext  $context 
)
protected
Parameters
string$titleText
ResourceLoaderContext$context
Returns
null|string
Since
1.32 added the $context parameter

Definition at line 186 of file ResourceLoaderWikiModule.php.

References $content, $title, CONTENT_FORMAT_CSS, CONTENT_FORMAT_JAVASCRIPT, CONTENT_FORMAT_JSON, and getContentObj().

Referenced by getPackageFiles(), getScript(), and getStyles().

◆ getContentObj()

ResourceLoaderWikiModule::getContentObj ( PageIdentity  $page,
ResourceLoaderContext  $context,
  $maxRedirects = null 
)
protected
Parameters
PageIdentity$page
ResourceLoaderContext$context
int | null$maxRedirectsMaximum number of redirects to follow. If null, uses $wgMaxRedirects
Returns
Content|null
Since
1.32 added the $context and $maxRedirects parameters

Definition at line 220 of file ResourceLoaderWikiModule.php.

References $content, ResourceLoaderModule\getConfig(), ResourceLoaderContext\getContentOverrideCallback(), and ResourceLoaderModule\getLogger().

Referenced by getContent().

◆ getDB()

ResourceLoaderWikiModule::getDB ( )
protected

Get the Database handle used for computing the module version.

Subclasses may override this to return a foreign database, which would allow them to register a module on wiki A that fetches wiki pages from wiki B.

The way this works is that the local module is a placeholder that can only computer a module version hash. The 'source' of the module must be set to the foreign wiki directly. Methods getScript() and getContent() will not use this handle and are not valid on the local wiki.

Returns
IDatabase

Definition at line 176 of file ResourceLoaderWikiModule.php.

References DB_REPLICA, and wfGetDB().

Referenced by getTitleInfo().

◆ getDefinitionSummary()

ResourceLoaderWikiModule::getDefinitionSummary ( ResourceLoaderContext  $context)
Parameters
ResourceLoaderContext$context
Returns
array

Reimplemented from ResourceLoaderModule.

Definition at line 454 of file ResourceLoaderWikiModule.php.

References getPages(), and getTitleInfo().

◆ getGroup()

ResourceLoaderWikiModule::getGroup ( )

Get group name.

Returns
string|null

Reimplemented from ResourceLoaderModule.

Reimplemented in ResourceLoaderUserStylesModule, ResourceLoaderUserModule, and ResourceLoaderSiteStylesModule.

Definition at line 158 of file ResourceLoaderWikiModule.php.

References $group.

Referenced by isKnownEmpty().

◆ getPackageFiles()

ResourceLoaderWikiModule::getPackageFiles ( ResourceLoaderContext  $context)
private

◆ getPages()

ResourceLoaderWikiModule::getPages ( ResourceLoaderContext  $context)
protected

Subclasses should return an associative array of resources in the module.

Keys should be the title of a page in the MediaWiki or User namespace.

Values should be a nested array of options. The supported keys are 'type' and (CSS only) 'media'.

For scripts, 'type' should be 'script'. For JSON files, 'type' should be 'data'. For stylesheets, 'type' should be 'style'.

There is an optional 'media' key, the value of which can be the medium ('screen', 'print', etc.) of the stylesheet.

Parameters
ResourceLoaderContext$context
Returns
array[]

Reimplemented in ResourceLoaderUserStylesModule, ResourceLoaderUserModule, ResourceLoaderSiteStylesModule, and ResourceLoaderSiteModule.

Definition at line 130 of file ResourceLoaderWikiModule.php.

References ResourceLoaderModule\$config, Config\get(), and ResourceLoaderModule\getConfig().

Referenced by getDefinitionSummary(), getPackageFiles(), getScript(), getStyles(), getTitleInfo(), and shouldEmbedModule().

◆ getRequireKey()

ResourceLoaderWikiModule::getRequireKey ( string  $titleText)
protected

Convert a namespace-formatted page title to a virtual package file name.

This determines how the page may be imported in client-side code via require().

Stability: stable
to override
Since
1.38
Parameters
string$titleText
Returns
string

Definition at line 343 of file ResourceLoaderWikiModule.php.

Referenced by getPackageFiles().

◆ getScript()

ResourceLoaderWikiModule::getScript ( ResourceLoaderContext  $context)
Parameters
ResourceLoaderContext$context
Returns
string|array JavaScript code, or a package files array

Reimplemented from ResourceLoaderModule.

Definition at line 286 of file ResourceLoaderWikiModule.php.

References $scripts, getContent(), getPackageFiles(), getPages(), isPackaged(), ResourceLoader\makeComment(), and ResourceLoaderModule\validateScriptFile().

◆ getStyles()

ResourceLoaderWikiModule::getStyles ( ResourceLoaderContext  $context)

◆ getTitleInfo()

ResourceLoaderWikiModule::getTitleInfo ( ResourceLoaderContext  $context)
protected

Get the information about the wiki pages for a given context.

Parameters
ResourceLoaderContext$context
Returns
array[] Keyed by page name

Definition at line 506 of file ResourceLoaderWikiModule.php.

References $content, $dbr, $title, $titleInfo, ResourceLoaderContext\getContentOverrideCallback(), getDB(), getPages(), and Title\newFromText().

Referenced by getDefinitionSummary(), and isKnownEmpty().

◆ getType()

ResourceLoaderWikiModule::getType ( )
Since
1.28
Returns
string

Reimplemented from ResourceLoaderModule.

Reimplemented in ResourceLoaderUserStylesModule, and ResourceLoaderSiteStylesModule.

Definition at line 705 of file ResourceLoaderWikiModule.php.

◆ invalidateModuleCache()

static ResourceLoaderWikiModule::invalidateModuleCache ( PageIdentity  $page,
?RevisionRecord  $old,
?RevisionRecord  $new,
string  $domain 
)
static

Clear the preloadTitleInfo() cache for all wiki modules on this wiki on page change if it was a JS or CSS page.

Access: internal
Parameters
PageIdentity$page
RevisionRecord | null$oldPrior page revision
RevisionRecord | null$newNew page revision
string$domainDatabase domain ID

Definition at line 664 of file ResourceLoaderWikiModule.php.

References $cache, $title, Title\castFromPageIdentity(), CONTENT_MODEL_CSS, CONTENT_MODEL_JAVASCRIPT, and MediaWiki\Revision\RevisionRecord\getSlot().

Referenced by Page\DeletePage\doDeleteUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), and Title\invalidateCache().

◆ isKnownEmpty()

ResourceLoaderWikiModule::isKnownEmpty ( ResourceLoaderContext  $context)
Parameters
ResourceLoaderContext$context
Returns
bool

Reimplemented from ResourceLoaderModule.

Definition at line 468 of file ResourceLoaderWikiModule.php.

References ResourceLoaderModule\getDependencies(), getGroup(), and getTitleInfo().

◆ isPackaged()

ResourceLoaderWikiModule::isPackaged ( )
protected

Get whether this module is a packaged module.

If false (the default), JavaScript pages are concatenated and executed as a single script. JSON pages are not supported.

If true, the pages are bundled such that each page gets a virtual file name, where only the "main" script will be executed at first, and other JS or JSON pages may be be imported in client-side code through the require() function.

Stability: stable
to override
Since
1.38
Returns
bool

Definition at line 319 of file ResourceLoaderWikiModule.php.

Referenced by getScript(), and supportsURLLoading().

◆ makeTitleKey()

static ResourceLoaderWikiModule::makeTitleKey ( LinkTarget  $title)
staticprivate

Definition at line 496 of file ResourceLoaderWikiModule.php.

Referenced by fetchTitleInfo(), and preloadTitleInfo().

◆ preloadTitleInfo()

static ResourceLoaderWikiModule::preloadTitleInfo ( ResourceLoaderContext  $context,
IDatabase  $db,
array  $moduleNames 
)
static

◆ setTitleInfo()

ResourceLoaderWikiModule::setTitleInfo (   $batchKey,
array  $titleInfo 
)
private

Definition at line 492 of file ResourceLoaderWikiModule.php.

References $titleInfo.

◆ shouldEmbedModule()

ResourceLoaderWikiModule::shouldEmbedModule ( ResourceLoaderContext  $context)

◆ supportsURLLoading()

ResourceLoaderWikiModule::supportsURLLoading ( )
Returns
bool

Reimplemented from ResourceLoaderModule.

Definition at line 328 of file ResourceLoaderWikiModule.php.

References isPackaged().

Member Data Documentation

◆ $datas

array ResourceLoaderWikiModule::$datas = []
protected

List of page names that contain JSON.

Definition at line 85 of file ResourceLoaderWikiModule.php.

◆ $group

string null ResourceLoaderWikiModule::$group
protected

◆ $origin

string ResourceLoaderWikiModule::$origin = self::ORIGIN_USER_SITEWIDE
protected

Origin defaults to users with sitewide authority.

Definition at line 58 of file ResourceLoaderWikiModule.php.

◆ $scripts

array ResourceLoaderWikiModule::$scripts = []
protected

List of page names that contain JavaScript.

Definition at line 82 of file ResourceLoaderWikiModule.php.

Referenced by getScript().

◆ $styles

array ResourceLoaderWikiModule::$styles = []
protected

List of page names that contain CSS.

Definition at line 79 of file ResourceLoaderWikiModule.php.

Referenced by getStyles().

◆ $titleInfo

array ResourceLoaderWikiModule::$titleInfo = []
protected

In-process cache for title info, structured as an array [ <batchKey> // Pipe-separated list of sorted keys from getPages => [ <titleKey> => [ // Normalised title key 'page_len' => .., 'page_latest' => .., 'page_touched' => .., ] ] ].

See also
self::fetchTitleInfo()
self::makeTitleKey()

Definition at line 76 of file ResourceLoaderWikiModule.php.

Referenced by fetchTitleInfo(), getTitleInfo(), and setTitleInfo().


The documentation for this class was generated from the following file: