* @author Roan Kattouw
*/
-defined( 'MEDIAWIKI' ) || die( 1 );
-
/**
* ResourceLoader module based on local JavaScript/CSS files.
*/
/* Protected Members */
+ /** String: Local base path, see __construct() */
+ protected $localBasePath = '';
+ /** String: Remote base path, see __construct() */
+ protected $remoteBasePath = '';
/**
- * @var {array} List of paths to JavaScript files to always include
- * @format array( [file-path], [file-path], ... )
+ * Array: List of paths to JavaScript files to always include
+ * @example array( [file-path], [file-path], ... )
*/
protected $scripts = array();
/**
- * @var {array} List of JavaScript files to include when using a specific language
- * @format array( [language-code] => array( [file-path], [file-path], ... ), ... )
+ * Array: List of JavaScript files to include when using a specific language
+ * @example array( [language-code] => array( [file-path], [file-path], ... ), ... )
*/
protected $languageScripts = array();
/**
- * @var {array} List of JavaScript files to include when using a specific skin
- * @format array( [skin-name] => array( [file-path], [file-path], ... ), ... )
+ * Array: List of JavaScript files to include when using a specific skin
+ * @example array( [skin-name] => array( [file-path], [file-path], ... ), ... )
*/
protected $skinScripts = array();
/**
- * @var {array} List of paths to JavaScript files to include in debug mode
- * @format array( [skin-name] => array( [file-path], [file-path], ... ), ... )
+ * Array: List of paths to JavaScript files to include in debug mode
+ * @example array( [skin-name] => array( [file-path], [file-path], ... ), ... )
*/
protected $debugScripts = array();
/**
- * @var {array} List of paths to JavaScript files to include in the startup module
- * @format array( [file-path], [file-path], ... )
+ * Array: List of paths to JavaScript files to include in the startup module
+ * @example array( [file-path], [file-path], ... )
*/
protected $loaderScripts = array();
/**
- * @var {array} List of paths to CSS files to always include
- * @format array( [file-path], [file-path], ... )
+ * Array: List of paths to CSS files to always include
+ * @example array( [file-path], [file-path], ... )
*/
protected $styles = array();
/**
- * @var {array} List of paths to CSS files to include when using specific skins
- * @format array( [file-path], [file-path], ... )
+ * Array: List of paths to CSS files to include when using specific skins
+ * @example array( [file-path], [file-path], ... )
*/
protected $skinStyles = array();
/**
- * @var {array} List of modules this module depends on
- * @format array( [file-path], [file-path], ... )
+ * Array: List of modules this module depends on
+ * @example array( [file-path], [file-path], ... )
*/
protected $dependencies = array();
/**
- * @var {array} List of message keys used by this module
- * @format array( [module-name], [module-name], ... )
+ * Array: List of message keys used by this module
+ * @example array( [message-key], [message-key], ... )
*/
protected $messages = array();
- /**
- * @var {string} Name of group this module should be loaded in
- * @format array( [message-key], [message-key], ... )
- */
+ /** String: Name of group to load this module in */
protected $group;
- /** @var {boolean} Link to raw files in debug mode */
+ /** Boolean: Link to raw files in debug mode */
protected $debugRaw = true;
/**
- * @var {array} Cache for mtime
- * @format array( [hash] => [mtime], [hash] => [mtime], ... )
+ * Array: Cache for mtime
+ * @example array( [hash] => [mtime], [hash] => [mtime], ... )
*/
protected $modifiedTime = array();
+ /**
+ * Array: Place where readStyleFile() tracks file dependencies
+ * @example array( [file-path], [file-path], ... )
+ */
+ protected $localFileRefs = array();
/* Methods */
/**
* Constructs a new module from an options array.
*
- * @param {array} $options Options array. If not given or empty, an empty module will be constructed
- * @param {string} $basePath base path to prepend to all paths in $options
+ * @param $options Array: List of options; if not given or empty, an empty module will be
+ * constructed
+ * @param $localBasePath String: Base path to prepend to all local paths in $options. Defaults
+ * to $IP
+ * @param $remoteBasePath String: Base path to prepend to all remote paths in $options. Defaults
+ * to $wgScriptPath
*
- * @format $options
+ * @example $options
* array(
+ * // Base path to prepend to all local paths in $options. Defaults to $IP
+ * 'localBasePath' => [base path],
+ * // Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath
+ * 'remoteBasePath' => [base path],
+ * // Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath
+ * 'remoteExtPath' => [base path],
* // Scripts to always include
* 'scripts' => [file path string or array of file path strings],
* // Scripts to include in specific language contexts
* 'group' => [group name string],
* )
*/
- public function __construct( $options = array(), $basePath = null ) {
+ public function __construct( $options = array(), $localBasePath = null,
+ $remoteBasePath = null )
+ {
+ global $IP, $wgScriptPath;
+ $this->localBasePath = $localBasePath === null ? $IP : $localBasePath;
+ $this->remoteBasePath = $remoteBasePath === null ? $wgScriptPath : $remoteBasePath;
+
+ if ( isset( $options['remoteExtPath'] ) ) {
+ global $wgExtensionAssetsPath;
+ $this->remoteBasePath = $wgExtensionAssetsPath . '/' . $options['remoteExtPath'];
+ }
+
foreach ( $options as $member => $option ) {
switch ( $member ) {
// Lists of file paths
case 'debugScripts':
case 'loaderScripts':
case 'styles':
- $this->{$member} = self::prefixFilePathList( (array) $option, $basePath );
+ $this->{$member} = (array) $option;
break;
// Collated lists of file paths
case 'languageScripts':
case 'skinScripts':
case 'skinStyles':
- foreach ( (array) $option as $key => $value ) {
- $this->{$member}[$key] = self::prefixFilePathList( (array) $value, $basePath );
+ if ( !is_array( $option ) ) {
+ throw new MWException(
+ "Invalid collated file path list error. " .
+ "'$option' given, array expected."
+ );
}
+ foreach ( $option as $key => $value ) {
+ if ( !is_string( $key ) ) {
+ throw new MWException(
+ "Invalid collated file path list key error. " .
+ "'$key' given, string expected."
+ );
+ }
+ $this->{$member}[$key] = (array) $value;
+ }
+ break;
// Lists of strings
case 'dependencies':
case 'messages':
break;
// Single strings
case 'group':
+ case 'localBasePath':
+ case 'remoteBasePath':
$this->{$member} = (string) $option;
break;
// Single booleans
break;
}
}
+ // Make sure the remote base path is a complete valid url
+ $this->remoteBasePath = wfExpandUrl( $this->remoteBasePath );
}
/**
* Gets all scripts for a given context concatenated together.
*
- * @param {ResourceLoaderContext} $context Context in which to generate script
- * @return {string} JavaScript code for $context
+ * @param $context ResourceLoaderContext: Context in which to generate script
+ * @return String: JavaScript code for $context
*/
public function getScript( ResourceLoaderContext $context ) {
- global $wgServer, $wgScriptPath;
-
$files = array_merge(
$this->scripts,
self::tryForKey( $this->languageScripts, $context->getLanguage() ),
if ( $this->debugRaw ) {
$script = '';
foreach ( $files as $file ) {
- $path = FormatJson::encode( "$wgServer$wgScriptPath/$file" );
- $script .= "\n\tmediaWiki.loader.load( $path );";
+ $path = $this->getRemotePath( $file );
+ $script .= "\n\t" . Xml::encodeJsCall( 'mediaWiki.loader.load', array( $path ) );
}
return $script;
}
}
- return self::readScriptFiles( $files );
+ return $this->readScriptFiles( $files );
}
/**
* Gets loader script.
*
- * @return {string} JavaScript code to be added to startup module
+ * @return String: JavaScript code to be added to startup module
*/
public function getLoaderScript() {
if ( count( $this->loaderScripts ) == 0 ) {
return false;
}
- return self::readScriptFiles( $this->loaderScripts );
+ return $this->readScriptFiles( $this->loaderScripts );
}
/**
* Gets all styles for a given context concatenated together.
*
- * @param {ResourceLoaderContext} $context Context in which to generate styles
- * @return {string} CSS code for $context
+ * @param $context ResourceLoaderContext: Context in which to generate styles
+ * @return String: CSS code for $context
*/
public function getStyles( ResourceLoaderContext $context ) {
// Merge general styles and skin specific styles, retaining media type collation
- $styles = self::readStyleFiles( $this->styles );
- $skinStyles = self::readStyleFiles( self::tryForKey( $this->skinStyles, $context->getSkin(), 'default' ) );
+ $styles = $this->readStyleFiles( $this->styles, $this->getFlip( $context ) );
+ $skinStyles = $this->readStyleFiles(
+ self::tryForKey( $this->skinStyles, $context->getSkin(), 'default' ),
+ $this->getFlip( $context )
+ );
+
foreach ( $skinStyles as $media => $style ) {
if ( isset( $styles[$media] ) ) {
$styles[$media] .= $style;
}
}
// Collect referenced files
- $files = array();
- foreach ( $styles as /* $media => */ $style ) {
- $files = array_merge( $files, CSSMin::getLocalFileReferences( $style ) );
- }
+ $this->localFileRefs = array_unique( $this->localFileRefs );
// If the list has been modified since last time we cached it, update the cache
- if ( $files !== $this->getFileDependencies( $context->getSkin() ) ) {
+ if ( $this->localFileRefs !== $this->getFileDependencies( $context->getSkin() ) ) {
$dbw = wfGetDB( DB_MASTER );
$dbw->replace( 'module_deps',
array( array( 'md_module', 'md_skin' ) ), array(
'md_module' => $this->getName(),
'md_skin' => $context->getSkin(),
- 'md_deps' => FormatJson::encode( $files ),
+ 'md_deps' => FormatJson::encode( $this->localFileRefs ),
)
);
}
/**
* Gets list of message keys used by this module.
*
- * @return {array} List of message keys
+ * @return Array: List of message keys
*/
public function getMessages() {
return $this->messages;
/**
* Gets the name of the group this module should be loaded in.
*
- * @return {string} Group name
+ * @return String: Group name
*/
public function getGroup() {
return $this->group;
/**
* Gets list of names of modules this module depends on.
*
- * @return {array} List of module names
+ * @return Array: List of module names
*/
public function getDependencies() {
return $this->dependencies;
/**
* Get the last modified timestamp of this module.
*
- * Last modified timestamps are calculated from the highest last modified timestamp of this module's constituent
- * files as well as the files it depends on. This function is context-sensitive, only performing calculations on
- * files relevant to the given language, skin and debug mode.
+ * Last modified timestamps are calculated from the highest last modified
+ * timestamp of this module's constituent files as well as the files it
+ * depends on. This function is context-sensitive, only performing
+ * calculations on files relevant to the given language, skin and debug
+ * mode.
*
- * @param {ResourceLoaderContext} $context Context in which to calculate the modified time
- * @return {integer} UNIX timestamp
- * @see {ResourceLoaderModule::getFileDependencies}
+ * @param $context ResourceLoaderContext: Context in which to calculate
+ * the modified time
+ * @return Integer: UNIX timestamp
+ * @see ResourceLoaderModule::getFileDependencies
*/
public function getModifiedTime( ResourceLoaderContext $context ) {
if ( isset( $this->modifiedTime[$context->getHash()] ) ) {
$files = array_merge( $files, $styleFiles );
}
$skinFiles = self::tryForKey(
- self::collateFilePathListByOption( $this->skinStyles, 'media', 'all' ), $context->getSkin(), 'default'
+ self::collateFilePathListByOption( $this->skinStyles, 'media', 'all' ),
+ $context->getSkin(),
+ 'default'
);
foreach ( $skinFiles as $styleFiles ) {
$files = array_merge( $files, $styleFiles );
$context->getDebug() ? $this->debugScripts : array(),
self::tryForKey( $this->languageScripts, $context->getLanguage() ),
self::tryForKey( $this->skinScripts, $context->getSkin(), 'default' ),
- $this->loaderScripts,
- $this->getFileDependencies( $context->getSkin() )
+ $this->loaderScripts
);
+ $files = array_map( array( $this, 'getLocalPath' ), $files );
+ // File deps need to be treated separately because they're already prefixed
+ $files = array_merge( $files, $this->getFileDependencies( $context->getSkin() ) );
- // If a module is nothing but a list of dependencies, we need to avoid giving max() an empty array
+ // If a module is nothing but a list of dependencies, we need to avoid
+ // giving max() an empty array
if ( count( $files ) === 0 ) {
+ wfProfileOut( __METHOD__ );
return $this->modifiedTime[$context->getHash()] = 1;
}
wfProfileIn( __METHOD__.'-filemtime' );
- $filesMtime = max( array_map( 'filemtime', array_map( array( __CLASS__, 'resolveFilePath' ), $files ) ) );
+ $filesMtime = max( array_map( 'filemtime', $files ) );
wfProfileOut( __METHOD__.'-filemtime' );
- $this->modifiedTime[$context->getHash()] = max( $filesMtime, $this->getMsgBlobMtime( $context->getLanguage() ) );
+ $this->modifiedTime[$context->getHash()] = max(
+ $filesMtime,
+ $this->getMsgBlobMtime( $context->getLanguage() ) );
+
wfProfileOut( __METHOD__ );
return $this->modifiedTime[$context->getHash()];
}
/* Protected Members */
- /**
- * Prefixes each file path in a list.
- *
- * @param {array} $list List of file paths in any combination of index/path or path/options pairs
- * @param {string} $prefix String to prepend to each file path in $list
- * @return {array} List of prefixed file paths
- */
- protected static function prefixFilePathList( array $list, $prefix ) {
- $prefixed = array();
- foreach ( $list as $key => $value ) {
- if ( is_array( $value ) ) {
- // array( [path] => array( [options] ) )
- $prefixed[$prefix . $key] = $value;
- } else {
- // array( [path] )
- $prefixed[$key] = $prefix . $value;
- }
- }
- return $prefixed;
+ protected function getLocalPath( $path ) {
+ return "{$this->localBasePath}/$path";
+ }
+
+ protected function getRemotePath( $path ) {
+ return "{$this->remoteBasePath}/$path";
}
/**
* Collates file paths by option (where provided).
*
- * @param {array} $list List of file paths in any combination of index/path or path/options pairs
- * @return {array} List of file paths, collated by $option
+ * @param $list Array: List of file paths in any combination of index/path
+ * or path/options pairs
+ * @param $option String: option name
+ * @param $default Mixed: default value if the option isn't set
+ * @return Array: List of file paths, collated by $option
*/
protected static function collateFilePathListByOption( array $list, $option, $default ) {
$collatedFiles = array();
/**
* Gets a list of element that match a key, optionally using a fallback key.
*
- * @param {array} $list List of lists to select from
- * @param {string} $key Key to look for in $map
- * @param {string} $fallback Key to look for in $list if $key doesn't exist
- * @return {array} List of elements from $map which matched $key or $fallback, or an empty list in case of no match
+ * @param $list Array: List of lists to select from
+ * @param $key String: Key to look for in $map
+ * @param $fallback String: Key to look for in $list if $key doesn't exist
+ * @return Array: List of elements from $map which matched $key or $fallback,
+ * or an empty list in case of no match
*/
protected static function tryForKey( array $list, $key, $fallback = null ) {
if ( isset( $list[$key] ) && is_array( $list[$key] ) ) {
return $list[$key];
- } else if ( is_string( $fallback ) && isset( $list[$fallback] ) && is_array( $list[$fallback] ) ) {
+ } else if ( is_string( $fallback )
+ && isset( $list[$fallback] )
+ && is_array( $list[$fallback] ) )
+ {
return $list[$fallback];
}
return array();
/**
* Gets the contents of a list of JavaScript files.
*
- * @param {array} $scripts List of file paths to scripts to read, remap and concetenate
- * @return {string} Concatenated and remapped JavaScript data from $scripts
+ * @param $scripts Array: List of file paths to scripts to read, remap and concetenate
+ * @return String: Concatenated and remapped JavaScript data from $scripts
*/
- protected static function readScriptFiles( array $scripts ) {
+ protected function readScriptFiles( array $scripts ) {
if ( empty( $scripts ) ) {
return '';
}
- return implode( "\n", array_map( array( __CLASS__, 'readScriptFile' ), array_unique( $scripts ) ) );
+ $js = '';
+ foreach ( array_unique( $scripts ) as $fileName ) {
+ $localPath = $this->getLocalPath( $fileName );
+ $contents = file_get_contents( $localPath );
+ if ( $contents === false ) {
+ throw new MWException( __METHOD__.": script file not found: \"$localPath\"" );
+ }
+ $js .= $contents . "\n";
+ }
+ return $js;
}
/**
* Gets the contents of a list of CSS files.
*
- * @param {array} $styles List of file paths to styles to read, remap and concetenate
- * @return {array} List of concatenated and remapped CSS data from $styles, keyed by media type
+ * @param $styles Array: List of file paths to styles to read, remap and concetenate
+ * @return Array: List of concatenated and remapped CSS data from $styles,
+ * keyed by media type
*/
- protected static function readStyleFiles( array $styles ) {
+ protected function readStyleFiles( array $styles, $flip ) {
if ( empty( $styles ) ) {
return array();
}
$styles = self::collateFilePathListByOption( $styles, 'media', 'all' );
foreach ( $styles as $media => $files ) {
+ $uniqueFiles = array_unique( $files );
$styles[$media] = implode(
- "\n", array_map( array( __CLASS__, 'readStyleFile' ), array_unique( $files ) )
+ "\n",
+ array_map(
+ array( $this, 'readStyleFile' ),
+ $uniqueFiles,
+ array_fill( 0, count( $uniqueFiles ), $flip )
+ )
);
}
return $styles;
}
- /**
- * Reads a script file.
- *
- * This method can be used as a callback for array_map()
- *
- * @param {string} $path File path of script file to read
- * @return {string} JavaScript data in script file
- */
- protected static function readScriptFile( $path ) {
- global $IP;
-
- return file_get_contents( "$IP/$path" );
- }
-
/**
* Reads a style file.
*
* This method can be used as a callback for array_map()
*
- * @param {string} $path File path of script file to read
- * @return {string} CSS data in script file
+ * @param $path String: File path of script file to read
+ * @return String: CSS data in script file
*/
- protected static function readStyleFile( $path ) {
- global $wgScriptPath, $IP;
-
+ protected function readStyleFile( $path, $flip ) {
+ $localPath = $this->getLocalPath( $path );
+ $style = file_get_contents( $localPath );
+ if ( $style === false ) {
+ throw new MWException( __METHOD__.": style file not found: \"$localPath\"" );
+ }
+ if ( $flip ) {
+ $style = CSSJanus::transform( $style, true, false );
+ }
+ $dirname = dirname( $path );
+ if ( $dirname == '.' ) {
+ // If $path doesn't have a directory component, don't prepend a dot
+ $dirname = '';
+ }
+ $dir = $this->getLocalPath( $dirname );
+ $remoteDir = $this->getRemotePath( $dirname );
+ // Get and register local file references
+ $this->localFileRefs = array_merge(
+ $this->localFileRefs,
+ CSSMin::getLocalFileReferences( $style, $dir ) );
return CSSMin::remap(
- file_get_contents( "$IP/$path" ), dirname( "$IP/$path" ), $wgScriptPath . '/' . dirname( $path ), true
+ $style, $dir, $remoteDir, true
);
}
-
- /**
- * Resolves a file name.
- *
- * This method can be used as a callback for array_map()
- *
- * @param {string} $path File path to resolve
- * @return {string} Absolute file path
- */
- protected static function resolveFilePath( $path ) {
- global $IP;
-
- return "$IP/$path";
- }
}
dépôts / lhc / web / wiklou.git / blobdiff