diff options
Diffstat (limited to 'includes/resourceloader/ResourceLoader.php')
| -rw-r--r-- | includes/resourceloader/ResourceLoader.php | 297 |
1 files changed, 203 insertions, 94 deletions
diff --git a/includes/resourceloader/ResourceLoader.php b/includes/resourceloader/ResourceLoader.php index 191bc9f0..2a2e2981 100644 --- a/includes/resourceloader/ResourceLoader.php +++ b/includes/resourceloader/ResourceLoader.php @@ -29,7 +29,7 @@ class ResourceLoader { /* Protected Static Members */ - protected static $filterCacheVersion = 2; + protected static $filterCacheVersion = 4; /** Array: List of module name/ResourceLoaderModule object pairs */ protected $modules = array(); @@ -40,15 +40,15 @@ class ResourceLoader { /** * Loads information stored in the database about modules. - * - * This method grabs modules dependencies from the database and updates modules + * + * This method grabs modules dependencies from the database and updates modules * objects. - * - * This is not inside the module code because it is much faster to - * request all of the information at once than it is to have each module + * + * This is not inside the module code because it is much faster to + * request all of the information at once than it is to have each module * requests its own information. This sacrifice of modularity yields a substantial * performance improvement. - * + * * @param $modules Array: List of module names to preload information for * @param $context ResourceLoaderContext: Context to load the information within */ @@ -59,11 +59,11 @@ class ResourceLoader { $dbr = wfGetDB( DB_SLAVE ); $skin = $context->getSkin(); $lang = $context->getLanguage(); - + // Get file dependency information $res = $dbr->select( 'module_deps', array( 'md_module', 'md_deps' ), array( 'md_module' => $modules, - 'md_skin' => $context->getSkin() + 'md_skin' => $skin ), __METHOD__ ); @@ -80,7 +80,7 @@ class ResourceLoader { foreach ( array_diff( $modules, $modulesWithDeps ) as $name ) { $this->getModule( $name )->setFileDependencies( $skin, array() ); } - + // Get message blob mtimes. Only do this for modules with messages $modulesWithMessages = array(); foreach ( $modules as $name ) { @@ -96,11 +96,11 @@ class ResourceLoader { ), __METHOD__ ); foreach ( $res as $row ) { - $this->getModule( $row->mr_resource )->setMsgBlobMtime( $lang, + $this->getModule( $row->mr_resource )->setMsgBlobMtime( $lang, wfTimestamp( TS_UNIX, $row->mr_timestamp ) ); unset( $modulesWithoutMessages[$row->mr_resource] ); } - } + } foreach ( array_keys( $modulesWithoutMessages ) as $name ) { $this->getModule( $name )->setMsgBlobMtime( $lang, 0 ); } @@ -108,14 +108,14 @@ class ResourceLoader { /** * Runs JavaScript or CSS data through a filter, caching the filtered result for future calls. - * + * * Available filters are: * - minify-js \see JavaScriptMinifier::minify * - minify-css \see CSSMin::minify - * - * If $data is empty, only contains whitespace or the filter was unknown, + * + * If $data is empty, only contains whitespace or the filter was unknown, * $data is returned unmodified. - * + * * @param $filter String: Name of filter to run * @param $data String: Text to filter, such as JavaScript or CSS text * @return String: Filtered data, or a comment containing an error message @@ -124,10 +124,10 @@ class ResourceLoader { global $wgResourceLoaderMinifierStatementsOnOwnLine, $wgResourceLoaderMinifierMaxLineLength; wfProfileIn( __METHOD__ ); - // For empty/whitespace-only data or for unknown filters, don't perform + // For empty/whitespace-only data or for unknown filters, don't perform // any caching or processing - if ( trim( $data ) === '' - || !in_array( $filter, array( 'minify-js', 'minify-css' ) ) ) + if ( trim( $data ) === '' + || !in_array( $filter, array( 'minify-js', 'minify-css' ) ) ) { wfProfileOut( __METHOD__ ); return $data; @@ -135,7 +135,7 @@ class ResourceLoader { // Try for cache hit // Use CACHE_ANYTHING since filtering is very slow compared to DB queries - $key = wfMemcKey( 'resourceloader', 'filter', $filter, md5( $data ) ); + $key = wfMemcKey( 'resourceloader', 'filter', $filter, self::$filterCacheVersion, md5( $data ) ); $cache = wfGetCache( CACHE_ANYTHING ); $cacheEntry = $cache->get( $key ); if ( is_string( $cacheEntry ) ) { @@ -143,6 +143,7 @@ class ResourceLoader { return $cacheEntry; } + $result = ''; // Run the filter - we've already verified one of these will work try { switch ( $filter ) { @@ -151,9 +152,11 @@ class ResourceLoader { $wgResourceLoaderMinifierStatementsOnOwnLine, $wgResourceLoaderMinifierMaxLineLength ); + $result .= "\n\n/* cache key: $key */\n"; break; case 'minify-css': $result = CSSMin::minify( $data ); + $result .= "\n\n/* cache key: $key */\n"; break; } @@ -165,7 +168,7 @@ class ResourceLoader { } wfProfileOut( __METHOD__ ); - + return $result; } @@ -176,24 +179,24 @@ class ResourceLoader { */ public function __construct() { global $IP, $wgResourceModules; - + wfProfileIn( __METHOD__ ); - + // Register core modules $this->register( include( "$IP/resources/Resources.php" ) ); // Register extension modules wfRunHooks( 'ResourceLoaderRegisterModules', array( &$this ) ); $this->register( $wgResourceModules ); - + wfProfileOut( __METHOD__ ); } /** * Registers a module with the ResourceLoader system. - * + * * @param $name Mixed: Name of module as a string or List of name/object pairs as an array - * @param $info Module info array. For backwards compatibility with 1.17alpha, - * this may also be a ResourceLoaderModule object. Optional when using + * @param $info Module info array. For backwards compatibility with 1.17alpha, + * this may also be a ResourceLoaderModule object. Optional when using * multiple-registration calling style. * @throws MWException: If a duplicate module registration is attempted * @throws MWException: If a module name contains illegal characters (pipes or commas) @@ -217,14 +220,14 @@ class ResourceLoader { if ( isset( $this->moduleInfos[$name] ) ) { // A module has already been registered by this name throw new MWException( - 'ResourceLoader duplicate registration error. ' . + 'ResourceLoader duplicate registration error. ' . 'Another module has already been registered as ' . $name ); } - + // Check $name for illegal characters - if ( preg_match( '/[|,]/', $name ) ) { - throw new MWException( "ResourceLoader module name '$name' is invalid. Names may not contain pipes (|) or commas (,)" ); + if ( preg_match( '/[|,!]/', $name ) ) { + throw new MWException( "ResourceLoader module name '$name' is invalid. Names may not contain pipes (|), commas (,) or exclamation marks (!)" ); } // Attach module @@ -232,7 +235,7 @@ class ResourceLoader { // Old calling convention // Validate the input if ( !( $info instanceof ResourceLoaderModule ) ) { - throw new MWException( 'ResourceLoader invalid module error. ' . + throw new MWException( 'ResourceLoader invalid module error. ' . 'Instances of ResourceLoaderModule expected.' ); } @@ -260,7 +263,7 @@ class ResourceLoader { * Get the ResourceLoaderModule object for a given module name. * * @param $name String: Module name - * @return Mixed: ResourceLoaderModule if module has been registered, null otherwise + * @return ResourceLoaderModule if module has been registered, null otherwise */ public function getModule( $name ) { if ( !isset( $this->modules[$name] ) ) { @@ -295,7 +298,7 @@ class ResourceLoader { */ public function respond( ResourceLoaderContext $context ) { global $wgResourceLoaderMaxage, $wgCacheEpoch; - + // Buffer output to catch warnings. Normally we'd use ob_clean() on the // top-level output buffer to clear warnings, but that breaks when ob_gzhandler // is used: ob_clean() will clear the GZIP header in that case and it won't come @@ -319,13 +322,13 @@ class ResourceLoader { } } - // If a version wasn't specified we need a shorter expiry time for updates + // If a version wasn't specified we need a shorter expiry time for updates // to propagate to clients quickly if ( is_null( $context->getVersion() ) ) { $maxage = $wgResourceLoaderMaxage['unversioned']['client']; $smaxage = $wgResourceLoaderMaxage['unversioned']['server']; } - // If a version was specified we can use a longer expiry time since changing + // If a version was specified we can use a longer expiry time since changing // version numbers causes cache misses else { $maxage = $wgResourceLoaderMaxage['versioned']['client']; @@ -343,7 +346,7 @@ class ResourceLoader { wfProfileIn( __METHOD__.'-getModifiedTime' ); $private = false; - // To send Last-Modified and support If-Modified-Since, we need to detect + // To send Last-Modified and support If-Modified-Since, we need to detect // the last modified time $mtime = wfTimestamp( TS_UNIX, $wgCacheEpoch ); foreach ( $modules as $module ) { @@ -387,7 +390,8 @@ class ResourceLoader { // Some clients send "timestamp;length=123". Strip the part after the first ';' // so we get a valid timestamp. $ims = $context->getRequest()->getHeader( 'If-Modified-Since' ); - if ( $ims !== false ) { + // Never send 304s in debug mode + if ( $ims !== false && !$context->getDebug() ) { $imsTS = strtok( $ims, ';' ); if ( $mtime <= wfTimestamp( TS_UNIX, $imsTS ) ) { // There's another bug in ob_gzhandler (see also the comment at @@ -406,17 +410,17 @@ class ResourceLoader { for ( $i = 0; $i < ob_get_level(); $i++ ) { ob_end_clean(); } - + header( 'HTTP/1.0 304 Not Modified' ); header( 'Status: 304 Not Modified' ); wfProfileOut( __METHOD__ ); return; } } - + // Generate a response $response = $this->makeModuleResponse( $context, $modules, $missing ); - + // Prepend comments indicating exceptions $response = $exceptions . $response; @@ -435,21 +439,21 @@ class ResourceLoader { /** * Generates code for a response - * + * * @param $context ResourceLoaderContext: Context in which to generate a response * @param $modules Array: List of module objects keyed by module name * @param $missing Array: List of unavailable modules (optional) * @return String: Response data */ - public function makeModuleResponse( ResourceLoaderContext $context, - array $modules, $missing = array() ) + public function makeModuleResponse( ResourceLoaderContext $context, + array $modules, $missing = array() ) { $out = ''; $exceptions = ''; if ( $modules === array() && $missing === array() ) { return '/* No modules requested. Max made me put this here */'; } - + wfProfileIn( __METHOD__ ); // Pre-fetch blobs if ( $context->shouldIncludeMessages() ) { @@ -467,18 +471,33 @@ class ResourceLoader { foreach ( $modules as $name => $module ) { wfProfileIn( __METHOD__ . '-' . $name ); try { - // Scripts $scripts = ''; if ( $context->shouldIncludeScripts() ) { - // bug 27054: Append semicolon to prevent weird bugs - // caused by files not terminating their statements right - $scripts .= $module->getScript( $context ) . ";\n"; + // If we are in debug mode, we'll want to return an array of URLs if possible + // However, we can't do this if the module doesn't support it + // We also can't do this if there is an only= parameter, because we have to give + // the module a way to return a load.php URL without causing an infinite loop + if ( $context->getDebug() && !$context->getOnly() && $module->supportsURLLoading() ) { + $scripts = $module->getScriptURLsForDebug( $context ); + } else { + $scripts = $module->getScript( $context ); + if ( is_string( $scripts ) ) { + // bug 27054: Append semicolon to prevent weird bugs + // caused by files not terminating their statements right + $scripts .= ";\n"; + } + } } - // Styles $styles = array(); if ( $context->shouldIncludeStyles() ) { - $styles = $module->getStyles( $context ); + // If we are in debug mode, we'll want to return an array of URLs + // See comment near shouldIncludeScripts() for more details + if ( $context->getDebug() && !$context->getOnly() && $module->supportsURLLoading() ) { + $styles = $module->getStyleURLsForDebug( $context ); + } else { + $styles = $module->getStyles( $context ); + } } // Messages @@ -487,7 +506,11 @@ class ResourceLoader { // Append output switch ( $context->getOnly() ) { case 'scripts': - $out .= $scripts; + if ( is_string( $scripts ) ) { + $out .= $scripts; + } elseif ( is_array( $scripts ) ) { + $out .= self::makeLoaderImplementScript( $name, $scripts, array(), array() ); + } break; case 'styles': $out .= self::makeCombinedStyles( $styles ); @@ -496,11 +519,13 @@ class ResourceLoader { $out .= self::makeMessageSetScript( new XmlJsCode( $messagesBlob ) ); break; default: - // Minify CSS before embedding in mediaWiki.loader.implement call + // Minify CSS before embedding in mw.loader.implement call // (unless in debug mode) if ( !$context->getDebug() ) { foreach ( $styles as $media => $style ) { - $styles[$media] = $this->filter( 'minify-css', $style ); + if ( is_string( $style ) ) { + $styles[$media] = $this->filter( 'minify-css', $style ); + } } } $out .= self::makeLoaderImplementScript( $name, $scripts, $styles, @@ -521,10 +546,10 @@ class ResourceLoader { // Update module states if ( $context->shouldIncludeScripts() ) { // Set the state of modules loaded as only scripts to ready - if ( count( $modules ) && $context->getOnly() === 'scripts' - && !isset( $modules['startup'] ) ) + if ( count( $modules ) && $context->getOnly() === 'scripts' + && !isset( $modules['startup'] ) ) { - $out .= self::makeLoaderStateScript( + $out .= self::makeLoaderStateScript( array_fill_keys( array_keys( $modules ), 'ready' ) ); } // Set the state of modules which were requested but unavailable as missing @@ -540,7 +565,7 @@ class ResourceLoader { $out = $this->filter( 'minify-js', $out ); } } - + wfProfileOut( __METHOD__ ); return $exceptions . $out; } @@ -548,26 +573,30 @@ class ResourceLoader { /* Static Methods */ /** - * Returns JS code to call to mediaWiki.loader.implement for a module with + * Returns JS code to call to mw.loader.implement for a module with * given properties. * * @param $name Module name - * @param $scripts Array: List of JavaScript code snippets to be executed after the - * module is loaded - * @param $styles Array: List of CSS strings keyed by media type - * @param $messages Mixed: List of messages associated with this module. May either be an + * @param $scripts Mixed: List of URLs to JavaScript files or String of JavaScript code + * @param $styles Mixed: List of CSS strings keyed by media type, or list of lists of URLs to + * CSS files keyed by media type + * @param $messages Mixed: List of messages associated with this module. May either be an * associative array mapping message key to value, or a JSON-encoded message blob containing * the same data, wrapped in an XmlJsCode object. + * + * @return string */ public static function makeLoaderImplementScript( $name, $scripts, $styles, $messages ) { - if ( is_array( $scripts ) ) { - $scripts = implode( $scripts, "\n" ); + if ( is_string( $scripts ) ) { + $scripts = new XmlJsCode( "function( $ ) {{$scripts}}" ); + } elseif ( !is_array( $scripts ) ) { + throw new MWException( 'Invalid scripts error. Array of URLs or string of code expected.' ); } - return Xml::encodeJsCall( - 'mediaWiki.loader.implement', + return Xml::encodeJsCall( + 'mw.loader.implement', array( $name, - new XmlJsCode( "function( $, mw ) {{$scripts}}" ), + $scripts, (object)$styles, (object)$messages ) ); @@ -578,16 +607,20 @@ class ResourceLoader { * * @param $messages Mixed: Either an associative array mapping message key to value, or a * JSON-encoded message blob containing the same data, wrapped in an XmlJsCode object. + * + * @return string */ public static function makeMessageSetScript( $messages ) { - return Xml::encodeJsCall( 'mediaWiki.messages.set', array( (object)$messages ) ); + return Xml::encodeJsCall( 'mw.messages.set', array( (object)$messages ) ); } /** - * Combines an associative array mapping media type to CSS into a + * Combines an associative array mapping media type to CSS into a * single stylesheet with @media blocks. * * @param $styles Array: List of CSS strings keyed by media type + * + * @return string */ public static function makeCombinedStyles( array $styles ) { $out = ''; @@ -595,10 +628,10 @@ class ResourceLoader { // Transform the media type based on request params and config // The way that this relies on $wgRequest to propagate request params is slightly evil $media = OutputPage::transformCssMedia( $media ); - + if ( $media === null ) { // Skip - } else if ( $media === '' || $media == 'all' ) { + } elseif ( $media === '' || $media == 'all' ) { // Don't output invalid or frivolous @media statements $out .= "$style\n"; } else { @@ -609,7 +642,7 @@ class ResourceLoader { } /** - * Returns a JS call to mediaWiki.loader.state, which sets the state of a + * Returns a JS call to mw.loader.state, which sets the state of a * module or modules to a given value. Has two calling conventions: * * - ResourceLoader::makeLoaderStateScript( $name, $state ): @@ -617,36 +650,43 @@ class ResourceLoader { * * - ResourceLoader::makeLoaderStateScript( array( $name => $state, ... ) ): * Set the state of modules with the given names to the given states + * + * @param $name string + * @param $state + * + * @return string */ public static function makeLoaderStateScript( $name, $state = null ) { if ( is_array( $name ) ) { - return Xml::encodeJsCall( 'mediaWiki.loader.state', array( $name ) ); + return Xml::encodeJsCall( 'mw.loader.state', array( $name ) ); } else { - return Xml::encodeJsCall( 'mediaWiki.loader.state', array( $name, $state ) ); + return Xml::encodeJsCall( 'mw.loader.state', array( $name, $state ) ); } } /** * Returns JS code which calls the script given by $script. The script will - * be called with local variables name, version, dependencies and group, - * which will have values corresponding to $name, $version, $dependencies - * and $group as supplied. + * be called with local variables name, version, dependencies and group, + * which will have values corresponding to $name, $version, $dependencies + * and $group as supplied. * * @param $name String: Module name * @param $version Integer: Module version number as a timestamp * @param $dependencies Array: List of module names on which this module depends * @param $group String: Group which the module is in. * @param $script String: JavaScript code + * + * @return string */ public static function makeCustomLoaderScript( $name, $version, $dependencies, $group, $script ) { $script = str_replace( "\n", "\n\t", trim( $script ) ); - return Xml::encodeJsCall( + return Xml::encodeJsCall( "( function( name, version, dependencies, group ) {\n\t$script\n} )", array( $name, $version, $dependencies, $group ) ); } /** - * Returns JS code which calls mediaWiki.loader.register with the given + * Returns JS code which calls mw.loader.register with the given * parameters. Has three calling conventions: * * - ResourceLoader::makeLoaderRegisterScript( $name, $version, $dependencies, $group ): @@ -666,43 +706,49 @@ class ResourceLoader { * @param $version Integer: Module version number as a timestamp * @param $dependencies Array: List of module names on which this module depends * @param $group String: group which the module is in. + * + * @return string */ - public static function makeLoaderRegisterScript( $name, $version = null, - $dependencies = null, $group = null ) + public static function makeLoaderRegisterScript( $name, $version = null, + $dependencies = null, $group = null ) { if ( is_array( $name ) ) { - return Xml::encodeJsCall( 'mediaWiki.loader.register', array( $name ) ); + return Xml::encodeJsCall( 'mw.loader.register', array( $name ) ); } else { $version = (int) $version > 1 ? (int) $version : 1; - return Xml::encodeJsCall( 'mediaWiki.loader.register', + return Xml::encodeJsCall( 'mw.loader.register', array( $name, $version, $dependencies, $group ) ); } } /** - * Returns JS code which runs given JS code if the client-side framework is + * Returns JS code which runs given JS code if the client-side framework is * present. * * @param $script String: JavaScript code + * + * @return string */ public static function makeLoaderConditionalScript( $script ) { $script = str_replace( "\n", "\n\t", trim( $script ) ); - return "if ( window.mediaWiki ) {\n\t$script\n}\n"; + return "if(window.mw){\n\t$script\n}\n"; } /** - * Returns JS code which will set the MediaWiki configuration array to + * Returns JS code which will set the MediaWiki configuration array to * the given value. * * @param $configuration Array: List of configuration values keyed by variable name + * + * @return string */ public static function makeConfigSetScript( array $configuration ) { - return Xml::encodeJsCall( 'mediaWiki.config.set', array( $configuration ) ); + return Xml::encodeJsCall( 'mw.config.set', array( $configuration ) ); } - + /** * Convert an array of module names to a packed query string. - * + * * For example, array( 'foo.bar', 'foo.baz', 'bar.baz', 'bar.quux' ) * becomes 'foo.bar,baz|bar.baz,quux' * @param $modules array of module names (strings) @@ -716,15 +762,16 @@ class ResourceLoader { $suffix = $pos === false ? $module : substr( $module, $pos + 1 ); $groups[$prefix][] = $suffix; } - + $arr = array(); foreach ( $groups as $prefix => $suffixes ) { $p = $prefix === '' ? '' : $prefix . '.'; $arr[] = $p . implode( ',', $suffixes ); } - return implode( '|', $arr ); + $str = implode( '|', $arr ); + return $str; } - + /** * Determine whether debug mode was requested * Order of priority is 1) request param, 2) cookie, 3) $wg setting @@ -733,9 +780,71 @@ class ResourceLoader { public static function inDebugMode() { global $wgRequest, $wgResourceLoaderDebug; static $retval = null; - if ( !is_null( $retval ) ) + if ( !is_null( $retval ) ) { return $retval; + } return $retval = $wgRequest->getFuzzyBool( 'debug', $wgRequest->getCookie( 'resourceLoaderDebug', '', $wgResourceLoaderDebug ) ); } + + /** + * Build a load.php URL + * @param $modules array of module names (strings) + * @param $lang string Language code + * @param $skin string Skin name + * @param $user string|null User name. If null, the &user= parameter is omitted + * @param $version string|null Versioning timestamp + * @param $debug bool Whether the request should be in debug mode + * @param $only string|null &only= parameter + * @param $printable bool Printable mode + * @param $handheld bool Handheld mode + * @param $extraQuery array Extra query parameters to add + * @return string URL to load.php. May be protocol-relative (if $wgLoadScript is procol-relative) + */ + public static function makeLoaderURL( $modules, $lang, $skin, $user = null, $version = null, $debug = false, $only = null, + $printable = false, $handheld = false, $extraQuery = array() ) { + global $wgLoadScript; + $query = self::makeLoaderQuery( $modules, $lang, $skin, $user, $version, $debug, + $only, $printable, $handheld, $extraQuery + ); + + // Prevent the IE6 extension check from being triggered (bug 28840) + // by appending a character that's invalid in Windows extensions ('*') + return wfExpandUrl( wfAppendQuery( $wgLoadScript, $query ) . '&*', PROTO_RELATIVE ); + } + + /** + * Build a query array (array representation of query string) for load.php. Helper + * function for makeLoaderURL(). + * @return array + */ + public static function makeLoaderQuery( $modules, $lang, $skin, $user = null, $version = null, $debug = false, $only = null, + $printable = false, $handheld = false, $extraQuery = array() ) { + $query = array( + 'modules' => self::makePackedModulesString( $modules ), + 'lang' => $lang, + 'skin' => $skin, + 'debug' => $debug ? 'true' : 'false', + ); + if ( $user !== null ) { + $query['user'] = $user; + } + if ( $version !== null ) { + $query['version'] = $version; + } + if ( $only !== null ) { + $query['only'] = $only; + } + if ( $printable ) { + $query['printable'] = 1; + } + if ( $handheld ) { + $query['handheld'] = 1; + } + $query += $extraQuery; + + // Make queries uniform in order + ksort( $query ); + return $query; + } } |