diff options
author | Tim Starling <tstarling@wikimedia.org> | 2022-05-06 19:09:56 +1000 |
---|---|---|
committer | Tim Starling <tstarling@wikimedia.org> | 2022-05-16 14:41:27 +1000 |
commit | e08ea8ccb9932f9924a613056afcb2d01c8c7b39 (patch) | |
tree | 6255aeccef4fe82e5cbf425aea42d6c891c55b7b /includes/ResourceLoader/WikiModule.php | |
parent | 5029306c80fa804fe09c27bf12b7b46599fdc556 (diff) | |
download | mediawikicore-e08ea8ccb9932f9924a613056afcb2d01c8c7b39.tar.gz mediawikicore-e08ea8ccb9932f9924a613056afcb2d01c8c7b39.zip |
ResourceLoader namespace
Move ResourceLoader classes to their own namespace. Strip the
"ResourceLoader" prefix from all except ResourceLoader and
ResourceLoaderContext.
Move the tests by analogy.
I used a namespace alias "RL" in some callers since RL\Module is less
ambiguous at the call site than just "Module".
I did not address DependencyStore which continues to have a non-standard
location and namespace.
Change-Id: I92998ae6a82e0b935c13e02a183e7c324fa410a3
Diffstat (limited to 'includes/ResourceLoader/WikiModule.php')
-rw-r--r-- | includes/ResourceLoader/WikiModule.php | 721 |
1 files changed, 721 insertions, 0 deletions
diff --git a/includes/ResourceLoader/WikiModule.php b/includes/ResourceLoader/WikiModule.php new file mode 100644 index 000000000000..a7ff21703b58 --- /dev/null +++ b/includes/ResourceLoader/WikiModule.php @@ -0,0 +1,721 @@ +<?php +/** + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + * @author Trevor Parscal + * @author Roan Kattouw + */ + +namespace MediaWiki\ResourceLoader; + +use Content; +use CSSJanus; +use FormatJson; +use MediaWiki\Linker\LinkTarget; +use MediaWiki\MainConfigNames; +use MediaWiki\MediaWikiServices; +use MediaWiki\Page\PageIdentity; +use MediaWiki\Revision\RevisionRecord; +use MediaWiki\Revision\SlotRecord; +use MemoizedCallable; +use Title; +use TitleValue; +use Wikimedia\Minify\CSSMin; +use Wikimedia\Rdbms\Database; +use Wikimedia\Rdbms\IDatabase; +use Wikimedia\Timestamp\ConvertibleTimestamp; + +/** + * 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: + * - Option getters: + * - getGroup() + * - getPages() + * - Basic methods that strictly involve the foreign database + * - getDB() + * - isKnownEmpty() + * - getTitleInfo() + * + * @ingroup ResourceLoader + * @since 1.17 + */ +class WikiModule extends Module { + /** @var string Origin defaults to users with sitewide authority */ + protected $origin = self::ORIGIN_USER_SITEWIDE; + + /** + * 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 self::fetchTitleInfo() + * @see self::makeTitleKey() + * @var array + */ + protected $titleInfo = []; + + /** @var array List of page names that contain CSS */ + protected $styles = []; + + /** @var array List of page names that contain JavaScript */ + protected $scripts = []; + + /** @var array List of page names that contain JSON */ + protected $datas = []; + + /** @var string|null Group of module */ + protected $group; + + /** + * @param array|null $options For back-compat, this can be omitted in favour of overwriting + * getPages. + */ + public function __construct( array $options = null ) { + if ( $options === null ) { + return; + } + + foreach ( $options as $member => $option ) { + switch ( $member ) { + case 'styles': + case 'scripts': + case 'datas': + case 'group': + case 'targets': + $this->{$member} = $option; + break; + } + } + } + + /** + * 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. + * + * @param ResourceLoaderContext $context + * @return array[] + * @phan-return array<string,array{type:string,media?:string}> + */ + protected function getPages( ResourceLoaderContext $context ) { + $config = $this->getConfig(); + $pages = []; + + // Filter out pages from origins not allowed by the current wiki configuration. + if ( $config->get( MainConfigNames::UseSiteJs ) ) { + foreach ( $this->scripts as $script ) { + $pages[$script] = [ 'type' => 'script' ]; + } + foreach ( $this->datas as $data ) { + $pages[$data] = [ 'type' => 'data' ]; + } + } + + if ( $config->get( MainConfigNames::UseSiteCss ) ) { + foreach ( $this->styles as $style ) { + $pages[$style] = [ 'type' => 'style' ]; + } + } + + return $pages; + } + + /** + * Get group name + * + * @return string|null + */ + public function getGroup() { + return $this->group; + } + + /** + * 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. + * + * @return IDatabase + */ + protected function getDB() { + return wfGetDB( DB_REPLICA ); + } + + /** + * @param string $titleText + * @param ResourceLoaderContext $context + * @return null|string + * @since 1.32 added the $context parameter + */ + protected function getContent( $titleText, ResourceLoaderContext $context ) { + $pageStore = MediaWikiServices::getInstance()->getPageStore(); + $title = $pageStore->getPageByText( $titleText ); + if ( !$title ) { + return null; // Bad title + } + + $content = $this->getContentObj( $title, $context ); + if ( !$content ) { + return null; // No content found + } + + $handler = $content->getContentHandler(); + if ( $handler->isSupportedFormat( CONTENT_FORMAT_CSS ) ) { + $format = CONTENT_FORMAT_CSS; + } elseif ( $handler->isSupportedFormat( CONTENT_FORMAT_JAVASCRIPT ) ) { + $format = CONTENT_FORMAT_JAVASCRIPT; + } elseif ( $handler->isSupportedFormat( CONTENT_FORMAT_JSON ) ) { + $format = CONTENT_FORMAT_JSON; + } else { + return null; // Bad content model + } + + return $content->serialize( $format ); + } + + /** + * @param PageIdentity $page + * @param ResourceLoaderContext $context + * @param int $maxRedirects Maximum number of redirects to follow. + * Either 0 or 1. + * @return Content|null + * @since 1.32 added the $context and $maxRedirects parameters + * @internal for testing + */ + protected function getContentObj( + PageIdentity $page, ResourceLoaderContext $context, $maxRedirects = 1 + ) { + $overrideCallback = $context->getContentOverrideCallback(); + $content = $overrideCallback ? call_user_func( $overrideCallback, $page ) : null; + if ( $content ) { + if ( !$content instanceof Content ) { + $this->getLogger()->error( + 'Bad content override for "{title}" in ' . __METHOD__, + [ 'title' => (string)$page ] + ); + return null; + } + } else { + $revision = MediaWikiServices::getInstance() + ->getRevisionLookup() + ->getKnownCurrentRevision( $page ); + if ( !$revision ) { + return null; + } + $content = $revision->getContent( SlotRecord::MAIN, RevisionRecord::RAW ); + + if ( !$content ) { + $this->getLogger()->error( + 'Failed to load content of CSS/JS/JSON page "{title}" in ' . __METHOD__, + [ 'title' => (string)$page ] + ); + return null; + } + } + + if ( $maxRedirects > 0 && $content->isRedirect() ) { + $newTitle = $content->getRedirectTarget(); + return $newTitle ? $this->getContentObj( $newTitle, $context, 0 ) : null; + } + + return $content; + } + + /** + * @param ResourceLoaderContext $context + * @return bool + */ + public function shouldEmbedModule( ResourceLoaderContext $context ) { + $overrideCallback = $context->getContentOverrideCallback(); + if ( $overrideCallback && $this->getSource() === 'local' ) { + foreach ( $this->getPages( $context ) as $page => $info ) { + $title = Title::newFromText( $page ); + if ( $title && call_user_func( $overrideCallback, $title ) !== null ) { + return true; + } + } + } + + return parent::shouldEmbedModule( $context ); + } + + /** + * @param ResourceLoaderContext $context + * @return string|array JavaScript code, or a package files array + */ + public function getScript( ResourceLoaderContext $context ) { + if ( $this->isPackaged() ) { + return $this->getPackageFiles( $context ); + } else { + $scripts = ''; + foreach ( $this->getPages( $context ) as $titleText => $options ) { + if ( $options['type'] !== 'script' ) { + continue; + } + $script = $this->getContent( $titleText, $context ); + if ( strval( $script ) !== '' ) { + $script = $this->validateScriptFile( $titleText, $script ); + $scripts .= ResourceLoader::makeComment( $titleText ) . $script . "\n"; + } + } + return $scripts; + } + } + + /** + * 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. + * + * @stable to override + * @since 1.38 + * @return bool + */ + protected function isPackaged(): bool { + // Packaged mode is disabled by default for backwards compatibility. + // Subclasses may opt-in to this feature. + return false; + } + + /** + * @return bool + */ + public function supportsURLLoading() { + // If package files are involved, don't support URL loading + return !$this->isPackaged(); + } + + /** + * 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()`. + * + * @stable to override + * @since 1.38 + * @param string $titleText + * @return string + */ + protected function getRequireKey( string $titleText ): string { + return $titleText; + } + + /** + * @param ResourceLoaderContext $context + * @return array + * @phan-return array{main:string,files:string[][]} + */ + private function getPackageFiles( ResourceLoaderContext $context ): array { + $main = null; + + $files = []; + foreach ( $this->getPages( $context ) as $titleText => $options ) { + if ( $options['type'] !== 'script' && $options['type'] !== 'data' ) { + continue; + } + $content = $this->getContent( $titleText, $context ); + if ( strval( $content ) !== '' ) { + $fileKey = $this->getRequireKey( $titleText ); + if ( $options['type'] === 'script' ) { + $script = $this->validateScriptFile( $titleText, $content ); + $files[$fileKey] = [ + 'type' => 'script', + 'content' => $script, + ]; + // First script becomes the "main" script + if ( $main === null ) { + $main = $fileKey; + } + } elseif ( $options['type'] === 'data' ) { + $data = FormatJson::decode( $content ); + if ( $data == null ) { + // This is unlikely to happen since we only load JSON from + // wiki pages with a JSON content model, which are validated + // during edit save. + $data = [ 'error' => 'Invalid JSON' ]; + } + $files[$fileKey] = [ + 'type' => 'data', + 'content' => $data, + ]; + } + } + } + + return [ + 'main' => $main, + 'files' => $files, + ]; + } + + /** + * @param ResourceLoaderContext $context + * @return array + */ + public function getStyles( ResourceLoaderContext $context ) { + $styles = []; + foreach ( $this->getPages( $context ) as $titleText => $options ) { + if ( $options['type'] !== 'style' ) { + continue; + } + $media = $options['media'] ?? 'all'; + $style = $this->getContent( $titleText, $context ); + if ( strval( $style ) === '' ) { + continue; + } + if ( $this->getFlip( $context ) ) { + $style = CSSJanus::transform( $style, true, false ); + } + $remoteDir = $this->getConfig()->get( MainConfigNames::ScriptPath ); + if ( $remoteDir === '' ) { + // When the site is configured with the script path at the + // document root, MediaWiki uses an empty string but that is + // not a valid URI path. Expand to a slash to avoid fatals + // later in CSSMin::resolveUrl(). + // See also FilePath::extractBasePaths, T282280. + $remoteDir = '/'; + } + + $style = MemoizedCallable::call( + [ CSSMin::class, 'remap' ], + [ $style, false, $remoteDir, true ] + ); + if ( !isset( $styles[$media] ) ) { + $styles[$media] = []; + } + $style = ResourceLoader::makeComment( $titleText ) . $style; + $styles[$media][] = $style; + } + return $styles; + } + + /** + * 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. + * + * @return bool + */ + public function enableModuleContentVersion() { + return false; + } + + /** + * @param ResourceLoaderContext $context + * @return array + */ + public function getDefinitionSummary( ResourceLoaderContext $context ) { + $summary = parent::getDefinitionSummary( $context ); + $summary[] = [ + 'pages' => $this->getPages( $context ), + // Includes meta data of current revisions + 'titleInfo' => $this->getTitleInfo( $context ), + ]; + return $summary; + } + + /** + * @param ResourceLoaderContext $context + * @return bool + */ + public function isKnownEmpty( ResourceLoaderContext $context ) { + // If a module has dependencies it cannot be empty. An empty array will be cast to false + if ( $this->getDependencies() ) { + return false; + } + + // Optimisation: For user modules, don't needlessly load if there are no non-empty pages + // This is worthwhile because unlike most modules, user modules require their own + // separate embedded request (managed by ResourceLoaderClientHtml). + $revisions = $this->getTitleInfo( $context ); + if ( $this->getGroup() === self::GROUP_USER ) { + foreach ( $revisions as $revision ) { + if ( $revision['page_len'] > 0 ) { + // At least one non-empty page, module should be loaded + return false; + } + } + return true; + } + + // T70488: For non-user modules (i.e. ones that are called in cached HTML output) only check + // page existence. This ensures that, if some pages in a module are temporarily blanked, + // we don't stop embedding the module's script or link tag on newly cached pages. + return count( $revisions ) === 0; + } + + private function setTitleInfo( $batchKey, array $titleInfo ) { + $this->titleInfo[$batchKey] = $titleInfo; + } + + private static function makeTitleKey( LinkTarget $title ) { + // Used for keys in titleInfo. + return "{$title->getNamespace()}:{$title->getDBkey()}"; + } + + /** + * Get the information about the wiki pages for a given context. + * @param ResourceLoaderContext $context + * @return array[] Keyed by page name + */ + protected function getTitleInfo( ResourceLoaderContext $context ) { + $dbr = $this->getDB(); + + $pageNames = array_keys( $this->getPages( $context ) ); + sort( $pageNames ); + $batchKey = implode( '|', $pageNames ); + if ( !isset( $this->titleInfo[$batchKey] ) ) { + $this->titleInfo[$batchKey] = static::fetchTitleInfo( $dbr, $pageNames, __METHOD__ ); + } + + $titleInfo = $this->titleInfo[$batchKey]; + + // Override the title info from the overrides, if any + $overrideCallback = $context->getContentOverrideCallback(); + if ( $overrideCallback ) { + foreach ( $pageNames as $page ) { + $title = Title::newFromText( $page ); + $content = $title ? call_user_func( $overrideCallback, $title ) : null; + if ( $content !== null ) { + $titleInfo[$title->getPrefixedText()] = [ + 'page_len' => $content->getSize(), + 'page_latest' => 'TBD', // None available + 'page_touched' => ConvertibleTimestamp::now( TS_MW ), + ]; + } + } + } + + return $titleInfo; + } + + /** + * @param IDatabase $db + * @param array $pages + * @param string $fname + * @return array + */ + protected static function fetchTitleInfo( IDatabase $db, array $pages, $fname = __METHOD__ ) { + $titleInfo = []; + $linkBatchFactory = MediaWikiServices::getInstance()->getLinkBatchFactory(); + $batch = $linkBatchFactory->newLinkBatch(); + foreach ( $pages as $titleText ) { + $title = Title::newFromText( $titleText ); + if ( $title ) { + // Page name may be invalid if user-provided (e.g. gadgets) + $batch->addObj( $title ); + } + } + if ( !$batch->isEmpty() ) { + $res = $db->select( 'page', + // Include page_touched to allow purging if cache is poisoned (T117587, T113916) + [ 'page_namespace', 'page_title', 'page_touched', 'page_len', 'page_latest' ], + $batch->constructSet( 'page', $db ), + $fname + ); + foreach ( $res as $row ) { + // Avoid including ids or timestamps of revision/page tables so + // that versions are not wasted + $title = new TitleValue( (int)$row->page_namespace, $row->page_title ); + $titleInfo[self::makeTitleKey( $title )] = [ + 'page_len' => $row->page_len, + 'page_latest' => $row->page_latest, + 'page_touched' => $row->page_touched, + ]; + } + } + return $titleInfo; + } + + /** + * @since 1.28 + * @param ResourceLoaderContext $context + * @param IDatabase $db + * @param string[] $moduleNames + */ + public static function preloadTitleInfo( + ResourceLoaderContext $context, IDatabase $db, array $moduleNames + ) { + $rl = $context->getResourceLoader(); + // getDB() can be overridden to point to a foreign database. + // For now, only preload local. In the future, we could preload by wikiID. + $allPages = []; + /** @var WikiModule[] $wikiModules */ + $wikiModules = []; + foreach ( $moduleNames as $name ) { + $module = $rl->getModule( $name ); + if ( $module instanceof self ) { + $mDB = $module->getDB(); + // Subclasses may implement getDB differently + if ( $mDB->getDomainID() === $db->getDomainID() ) { + $wikiModules[] = $module; + $allPages += $module->getPages( $context ); + } + } + } + + if ( !$wikiModules ) { + // Nothing to preload + return; + } + + $pageNames = array_keys( $allPages ); + sort( $pageNames ); + $hash = sha1( implode( '|', $pageNames ) ); + + // Avoid Zend bug where "static::" does not apply LSB in the closure + $func = [ static::class, 'fetchTitleInfo' ]; + $fname = __METHOD__; + + $cache = MediaWikiServices::getInstance()->getMainWANObjectCache(); + $allInfo = $cache->getWithSetCallback( + $cache->makeGlobalKey( 'resourceloader-titleinfo', $db->getDomainID(), $hash ), + $cache::TTL_HOUR, + static function ( $curVal, &$ttl, array &$setOpts ) use ( $func, $pageNames, $db, $fname ) { + $setOpts += Database::getCacheSetOptions( $db ); + + return call_user_func( $func, $db, $pageNames, $fname ); + }, + [ + 'checkKeys' => [ + $cache->makeGlobalKey( 'resourceloader-titleinfo', $db->getDomainID() ) ] + ] + ); + + foreach ( $wikiModules as $wikiModule ) { + $pages = $wikiModule->getPages( $context ); + // Before we intersect, map the names to canonical form (T145673). + $intersect = []; + foreach ( $pages as $pageName => $unused ) { + $title = Title::newFromText( $pageName ); + if ( $title ) { + $intersect[ self::makeTitleKey( $title ) ] = 1; + } else { + // Page name may be invalid if user-provided (e.g. gadgets) + $rl->getLogger()->info( + 'Invalid wiki page title "{title}" in ' . __METHOD__, + [ 'title' => $pageName ] + ); + } + } + $info = array_intersect_key( $allInfo, $intersect ); + $pageNames = array_keys( $pages ); + sort( $pageNames ); + $batchKey = implode( '|', $pageNames ); + $wikiModule->setTitleInfo( $batchKey, $info ); + } + } + + /** + * Clear the preloadTitleInfo() cache for all wiki modules on this wiki on + * page change if it was a JS or CSS page + * + * @internal + * @param PageIdentity $page + * @param RevisionRecord|null $old Prior page revision + * @param RevisionRecord|null $new New page revision + * @param string $domain Database domain ID + */ + public static function invalidateModuleCache( + PageIdentity $page, + ?RevisionRecord $old, + ?RevisionRecord $new, + string $domain + ) { + static $models = [ CONTENT_MODEL_CSS, CONTENT_MODEL_JAVASCRIPT ]; + + $purge = false; + // TODO: MCR: differentiate between page functionality and content model! + // Not all pages containing CSS or JS have to be modules! [PageType] + if ( $old ) { + $oldModel = $old->getSlot( SlotRecord::MAIN, RevisionRecord::RAW )->getModel(); + if ( in_array( $oldModel, $models ) ) { + $purge = true; + } + } + + if ( !$purge && $new ) { + $newModel = $new->getSlot( SlotRecord::MAIN, RevisionRecord::RAW )->getModel(); + if ( in_array( $newModel, $models ) ) { + $purge = true; + } + } + + if ( !$purge ) { + $title = Title::castFromPageIdentity( $page ); + $purge = ( $title->isSiteConfigPage() || $title->isUserConfigPage() ); + } + + if ( $purge ) { + $cache = MediaWikiServices::getInstance()->getMainWANObjectCache(); + $key = $cache->makeGlobalKey( 'resourceloader-titleinfo', $domain ); + $cache->touchCheckKey( $key ); + } + } + + /** + * @since 1.28 + * @return string + */ + public function getType() { + // Check both because subclasses don't always pass pages via the constructor, + // they may also override getPages() instead, in which case we should keep + // defaulting to LOAD_GENERAL and allow them to override getType() separately. + return ( $this->styles && !$this->scripts ) ? self::LOAD_STYLES : self::LOAD_GENERAL; + } +} + +/** @deprecated since 1.39 */ +class_alias( WikiModule::class, 'ResourceLoaderWikiModule' ); |