5 /* global Uint8Array */
12 * Get the current user's groups or rights
15 * @return {jQuery.Promise}
17 function getUserInfo() {
18 if ( !userInfoPromise
) {
19 userInfoPromise
= new mw
.Api().getUserInfo();
21 return userInfoPromise
;
24 // Map from numbers 0-255 to a hex string (with padding)
25 for ( i
= 0; i
< 256; i
++ ) {
26 // Padding: Add a full byte (0x100, 256) and strip the extra character
27 byteToHex
[ i
] = ( i
+ 256 ).toString( 16 ).slice( 1 );
30 // mw.user with the properties options and tokens gets defined in mediawiki.js.
34 * Generate a random user session ID.
36 * This information would potentially be stored in a cookie to identify a user during a
37 * session or series of sessions. Its uniqueness should not be depended on unless the
38 * browser supports the crypto API.
40 * Known problems with Math.random():
41 * Using the Math.random function we have seen sets
42 * with 1% of non uniques among 200,000 values with Safari providing most of these.
43 * Given the prevalence of Safari in mobile the percentage of duplicates in
44 * mobile usages of this code is probably higher.
47 * We need about 64 bits to make sure that probability of collision
48 * on 500 million (5*10^8) is <= 1%
49 * See https://en.wikipedia.org/wiki/Birthday_problem#Probability_table
51 * @return {string} 64 bit integer in hex format, padded
53 generateRandomSessionId: function () {
54 /* eslint-disable no-bitwise */
56 hexRnds
= new Array( 8 ),
58 crypto
= window
.crypto
|| window
.msCrypto
;
60 // Based on https://github.com/broofa/node-uuid/blob/bfd9f96127/uuid.js
61 if ( crypto
&& crypto
.getRandomValues
) {
62 // Fill an array with 8 random values, each of which is 8 bits.
63 // Note that Uint8Array is array-like but does not implement Array.
64 rnds
= new Uint8Array( 8 );
65 crypto
.getRandomValues( rnds
);
67 rnds
= new Array( 8 );
68 for ( i
= 0; i
< 8; i
++ ) {
69 if ( ( i
& 3 ) === 0 ) {
70 r
= Math
.random() * 0x100000000;
72 rnds
[ i
] = r
>>> ( ( i
& 3 ) << 3 ) & 255;
75 // Convert from number to hex
76 for ( i
= 0; i
< 8; i
++ ) {
77 hexRnds
[ i
] = byteToHex
[ rnds
[ i
] ];
80 // Concatenation of two random integers with entropy n and m
81 // returns a string with entropy n+m if those strings are independent
82 return hexRnds
.join( '' );
83 /* eslint-enable no-bitwise */
87 * Get the current user's database id
89 * Not to be confused with #id.
91 * @return {number} Current user's id, or 0 if user is anonymous
94 return mw
.config
.get( 'wgUserId' ) || 0;
98 * Get the current user's name
100 * @return {string|null} User name string or null if user is anonymous
102 getName: function () {
103 return mw
.config
.get( 'wgUserName' );
107 * Get date user registered, if available
109 * @return {boolean|null|Date} False for anonymous users, null if data is
110 * unavailable, or Date for when the user registered.
112 getRegistration: function () {
114 if ( mw
.user
.isAnon() ) {
117 registration
= mw
.config
.get( 'wgUserRegistration' );
118 // Registration may be unavailable if the user signed up before MediaWiki
119 // began tracking this.
120 return !registration
? null : new Date( registration
);
124 * Whether the current user is anonymous
128 isAnon: function () {
129 return mw
.user
.getName() === null;
133 * Get an automatically generated random ID (stored in a session cookie)
135 * This ID is ephemeral for everyone, staying in their browser only until they close
138 * @return {string} Random session ID
140 sessionId: function () {
141 var sessionId
= mw
.cookie
.get( 'mwuser-sessionId' );
142 if ( sessionId
=== null ) {
143 sessionId
= mw
.user
.generateRandomSessionId();
144 mw
.cookie
.set( 'mwuser-sessionId', sessionId
, { expires
: null } );
150 * Get the current user's name or the session ID
152 * Not to be confused with #getId.
154 * @return {string} User name or random session ID
157 return mw
.user
.getName() || mw
.user
.sessionId();
161 * Get the user's bucket (place them in one if not done already)
163 * mw.user.bucket( 'test', {
164 * buckets: { ignored: 50, control: 25, test: 25 },
169 * @deprecated since 1.23
170 * @param {string} key Name of bucket
171 * @param {Object} options Bucket configuration options
172 * @param {Object} options.buckets List of bucket-name/relative-probability pairs (required,
173 * must have at least one pair)
174 * @param {number} [options.version=0] Version of bucket test, changing this forces
176 * @param {number} [options.expires=30] Length of time (in days) until the user gets
178 * @return {string} Bucket name - the randomly chosen key of the `options.buckets` object
180 bucket: function ( key
, options
) {
181 var cookie
, parts
, version
, bucket
,
182 range
, k
, rand
, total
;
184 options
= $.extend( {
190 cookie
= mw
.cookie
.get( 'mwuser-bucket:' + key
);
192 // Bucket information is stored as 2 integers, together as version:bucket like: "1:2"
193 if ( typeof cookie
=== 'string' && cookie
.length
> 2 && cookie
.indexOf( ':' ) !== -1 ) {
194 parts
= cookie
.split( ':' );
195 if ( parts
.length
> 1 && Number( parts
[ 0 ] ) === options
.version
) {
196 version
= Number( parts
[ 0 ] );
197 bucket
= String( parts
[ 1 ] );
201 if ( bucket
=== undefined ) {
202 if ( !$.isPlainObject( options
.buckets
) ) {
203 throw new Error( 'Invalid bucket. Object expected for options.buckets.' );
206 version
= Number( options
.version
);
210 for ( k
in options
.buckets
) {
211 range
+= options
.buckets
[ k
];
214 // Select random value within range
215 rand
= Math
.random() * range
;
217 // Determine which bucket the value landed in
219 for ( k
in options
.buckets
) {
221 total
+= options
.buckets
[ k
];
222 if ( total
>= rand
) {
228 'mwuser-bucket:' + key
,
229 version
+ ':' + bucket
,
230 { expires
: Number( options
.expires
) * 86400 }
238 * Get the current user's groups
240 * @param {Function} [callback]
241 * @return {jQuery.Promise}
243 getGroups: function ( callback
) {
244 var userGroups
= mw
.config
.get( 'wgUserGroups', [] );
246 // Uses promise for backwards compatibility
247 return $.Deferred().resolve( userGroups
).done( callback
);
251 * Get the current user's rights
253 * @param {Function} [callback]
254 * @return {jQuery.Promise}
256 getRights: function ( callback
) {
257 return getUserInfo().then(
258 function ( userInfo
) { return userInfo
.rights
; },
259 function () { return []; }
264 }( mediaWiki
, jQuery
) );