/**
* Change the state of one or more modules.
*
- * @param {string|Object} module module name or object of module name/state pairs
- * @param {string} state state name
+ * @param {string|Object} module Module name or object of module name/state pairs
+ * @param {string} state State name
*/
state: function ( module, state ) {
var m;
/**
* Get the state of a module.
*
- * @param {string} module name of module to get state for
+ * @param {string} module Name of module to get state for
*/
getState: function ( module ) {
if ( registry[module] !== undefined && registry[module].state !== undefined ) {
},
/**
- * Initialize the store by retrieving it from localStorage and (if successfully
- * retrieved) decoding the stored JSON value to a plain object.
+ * Initialize the store.
+ *
+ * Retrieves store from localStorage and (if successfully retrieved) decoding
+ * the stored JSON value to a plain object.
*
* The try / catch block is used for JSON & localStorage feature detection.
* See the in-line documentation for Modernizr's localStorage feature detection
- * code for a full account of why we need a try / catch: <http://git.io/4NEwKg>.
+ * code for a full account of why we need a try / catch:
+ * https://github.com/Modernizr/Modernizr/blob/v2.7.1/modernizr.js#L771-L796
*/
init: function () {
- var raw, data, optedIn;
+ var raw, data;
if ( mw.loader.store.enabled !== null ) {
- // #init already ran.
+ // Init already ran
return;
}
- // Temporarily allow users to opt-in during mw.loader.store test phase by
- // manually setting a cookie (bug 56397).
- optedIn = /ResourceLoaderStorageEnabled=1/.test( document.cookie );
-
- if ( !( mw.config.get( 'wgResourceLoaderStorageEnabled' ) || optedIn ) || mw.config.get( 'debug' ) ) {
- // Disabled by configuration, or because debug mode is set.
+ if ( !mw.config.get( 'wgResourceLoaderStorageEnabled' ) || mw.config.get( 'debug' ) ) {
+ // Disabled by configuration, or because debug mode is set
mw.loader.store.enabled = false;
return;
}
try {
raw = localStorage.getItem( mw.loader.store.getStoreKey() );
- // If we get here, localStorage is available; mark enabled.
+ // If we get here, localStorage is available; mark enabled
mw.loader.store.enabled = true;
data = JSON.parse( raw );
if ( data && typeof data.items === 'object' && data.vary === mw.loader.store.getVary() ) {
} catch (e) {}
if ( raw === undefined ) {
- mw.loader.store.enabled = false; // localStorage failed; disable store.
+ // localStorage failed; disable store
+ mw.loader.store.enabled = false;
} else {
mw.loader.store.update();
}
get: function ( module ) {
var key;
- if ( mw.loader.store.enabled !== true ) {
+ if ( !mw.loader.store.enabled ) {
return false;
}
set: function ( module, descriptor ) {
var args, key;
- if ( mw.loader.store.enabled !== true ) {
+ if ( !mw.loader.store.enabled ) {
return false;
}
key = mw.loader.store.getModuleKey( module );
- if ( key in mw.loader.store.items ) {
- // Already set; decline to store.
- return false;
- }
-
- if ( descriptor.state !== 'ready' ) {
- // Module failed to load; decline to store.
- return false;
- }
-
- if ( !descriptor.version || $.inArray( descriptor.group, [ 'private', 'user', 'site' ] ) !== -1 ) {
- // Unversioned, private, or site-/user-specific; decline to store.
- return false;
- }
-
- if ( $.inArray( undefined, [ descriptor.script, descriptor.style, descriptor.messages ] ) !== -1 ) {
- // Partial descriptor; decline to store.
+ if (
+ // Already stored a copy of this exact version
+ key in mw.loader.store.items ||
+ // Module failed to load
+ descriptor.state !== 'ready' ||
+ // Unversioned, private, or site-/user-specific
+ ( !descriptor.version || $.inArray( descriptor.group, [ 'private', 'user', 'site' ] ) !== -1 ) ||
+ // Partial descriptor
+ $.inArray( undefined, [ descriptor.script, descriptor.style, descriptor.messages ] ) !== -1
+ ) {
+ // Decline to store
return false;
}
args = [
JSON.stringify( module ),
typeof descriptor.script === 'function' ?
- String( descriptor.script ) : JSON.stringify( descriptor.script ),
+ String( descriptor.script ) :
+ JSON.stringify( descriptor.script ),
JSON.stringify( descriptor.style ),
JSON.stringify( descriptor.messages )
];
- } catch (e) {
+ } catch ( e ) {
return;
}
+
mw.loader.store.items[key] = 'mw.loader.implement(' + args.join(',') + ');';
mw.loader.store.update();
},
prune: function () {
var key, module;
- if ( mw.loader.store.enabled !== true ) {
+ if ( !mw.loader.store.enabled ) {
return false;
}
var timer;
function flush() {
- var data;
- if ( mw.loader.store.enabled !== true ) {
+ var data,
+ key = mw.loader.store.getStoreKey();
+
+ if ( !mw.loader.store.enabled ) {
return false;
}
mw.loader.store.prune();
try {
+ // Replacing the content of the module store might fail if the new
+ // contents would exceed the browser's localStorage size limit. To
+ // avoid clogging the browser with stale data, always remove the old
+ // value before attempting to set the new one.
+ localStorage.removeItem( key );
data = JSON.stringify( mw.loader.store );
- localStorage.setItem( mw.loader.store.getStoreKey(), data );
- } catch (e) {}
+ localStorage.setItem( key, data );
+ } catch ( e ) {}
}
return function () {
dépôts / lhc / web / wiklou.git / blobdiff