* @class mw.user
* @singleton
*/
-/* global Uint8Array */
+/* global Uint32Array */
( function ( mw, $ ) {
- var i,
- userInfoPromise,
- byteToHex = [];
+ var userInfoPromise;
/**
* Get the current user's groups or rights
return userInfoPromise;
}
- // Map from numbers 0-255 to a hex string (with padding)
- for ( i = 0; i < 256; i++ ) {
- // Padding: Add a full byte (0x100, 256) and strip the extra character
- byteToHex[ i ] = ( i + 256 ).toString( 16 ).slice( 1 );
- }
-
// mw.user with the properties options and tokens gets defined in mediawiki.js.
$.extend( mw.user, {
* @return {string} 64 bit integer in hex format, padded
*/
generateRandomSessionId: function () {
- /* eslint-disable no-bitwise */
- var rnds, i, r,
- hexRnds = new Array( 8 ),
+ var rnds, i,
+ hexRnds = new Array( 2 ),
// Support: IE 11
crypto = window.crypto || window.msCrypto;
- // Based on https://github.com/broofa/node-uuid/blob/bfd9f96127/uuid.js
if ( crypto && crypto.getRandomValues ) {
- // Fill an array with 8 random values, each of which is 8 bits.
- // Note that Uint8Array is array-like but does not implement Array.
- rnds = new Uint8Array( 8 );
+ // Fill an array with 2 random values, each of which is 32 bits.
+ // Note that Uint32Array is array-like but does not implement Array.
+ rnds = new Uint32Array( 2 );
crypto.getRandomValues( rnds );
} else {
- rnds = new Array( 8 );
- for ( i = 0; i < 8; i++ ) {
- if ( ( i & 3 ) === 0 ) {
- r = Math.random() * 0x100000000;
- }
- rnds[ i ] = r >>> ( ( i & 3 ) << 3 ) & 255;
- }
+ rnds = [
+ Math.floor( Math.random() * 0x100000000 ),
+ Math.floor( Math.random() * 0x100000000 )
+ ];
}
- // Convert from number to hex
- for ( i = 0; i < 8; i++ ) {
- hexRnds[ i ] = byteToHex[ rnds[ i ] ];
+ // Convert number to a string with 16 hex characters
+ for ( i = 0; i < 2; i++ ) {
+ // Add 0x100000000 before converting to hex and strip the extra character
+ // after converting to keep the leading zeros.
+ hexRnds[ i ] = ( rnds[ i ] + 0x100000000 ).toString( 16 ).slice( 1 );
}
// Concatenation of two random integers with entropy n and m
// returns a string with entropy n+m if those strings are independent
return hexRnds.join( '' );
- /* eslint-enable no-bitwise */
},
/**
},
/**
- * Get an automatically generated random ID (stored in a session cookie)
+ * Get an automatically generated random ID (persisted in sessionStorage)
*
- * This ID is ephemeral for everyone, staying in their browser only until they close
- * their browser.
+ * This ID is ephemeral for everyone, staying in their browser only until they
+ * close their browsing session.
*
* @return {string} Random session ID
*/
sessionId: function () {
- var sessionId = mw.cookie.get( 'mwuser-sessionId' );
- if ( sessionId === null ) {
+ var sessionId = mw.storage.session.get( 'mwuser-sessionId' );
+ if ( !sessionId ) {
sessionId = mw.user.generateRandomSessionId();
- mw.cookie.set( 'mwuser-sessionId', sessionId, { expires: null } );
+ mw.storage.session.set( 'mwuser-sessionId', sessionId );
}
return sessionId;
},
return mw.user.getName() || mw.user.sessionId();
},
- /**
- * Get the user's bucket (place them in one if not done already)
- *
- * mw.user.bucket( 'test', {
- * buckets: { ignored: 50, control: 25, test: 25 },
- * version: 1,
- * expires: 7
- * } );
- *
- * @deprecated since 1.23
- * @param {string} key Name of bucket
- * @param {Object} options Bucket configuration options
- * @param {Object} options.buckets List of bucket-name/relative-probability pairs (required,
- * must have at least one pair)
- * @param {number} [options.version=0] Version of bucket test, changing this forces
- * rebucketing
- * @param {number} [options.expires=30] Length of time (in days) until the user gets
- * rebucketed
- * @return {string} Bucket name - the randomly chosen key of the `options.buckets` object
- */
- bucket: function ( key, options ) {
- var cookie, parts, version, bucket,
- range, k, rand, total;
-
- options = $.extend( {
- buckets: {},
- version: 0,
- expires: 30
- }, options || {} );
-
- cookie = mw.cookie.get( 'mwuser-bucket:' + key );
-
- // Bucket information is stored as 2 integers, together as version:bucket like: "1:2"
- if ( typeof cookie === 'string' && cookie.length > 2 && cookie.indexOf( ':' ) !== -1 ) {
- parts = cookie.split( ':' );
- if ( parts.length > 1 && Number( parts[ 0 ] ) === options.version ) {
- version = Number( parts[ 0 ] );
- bucket = String( parts[ 1 ] );
- }
- }
-
- if ( bucket === undefined ) {
- if ( !$.isPlainObject( options.buckets ) ) {
- throw new Error( 'Invalid bucket. Object expected for options.buckets.' );
- }
-
- version = Number( options.version );
-
- // Find range
- range = 0;
- for ( k in options.buckets ) {
- range += options.buckets[ k ];
- }
-
- // Select random value within range
- rand = Math.random() * range;
-
- // Determine which bucket the value landed in
- total = 0;
- for ( k in options.buckets ) {
- bucket = k;
- total += options.buckets[ k ];
- if ( total >= rand ) {
- break;
- }
- }
-
- mw.cookie.set(
- 'mwuser-bucket:' + key,
- version + ':' + bucket,
- { expires: Number( options.expires ) * 86400 }
- );
- }
-
- return bucket;
- },
-
/**
* Get the current user's groups
*