52a1efb42b34dde95768cb61a11a8e1bffb11952
11 * Get the current user's groups or rights
14 * @return {jQuery.Promise}
16 function getUserInfo() {
17 if ( !userInfoPromise
) {
18 userInfoPromise
= new mw
.Api().getUserInfo();
20 return userInfoPromise
;
23 // Map from numbers 0-255 to a hex string (with padding)
24 for ( i
= 0; i
< 256; i
++ ) {
25 // Padding: Add a full byte (0x100, 256) and strip the extra character
26 byteToHex
[ i
] = ( i
+ 256 ).toString( 16 ).slice( 1 );
29 // mw.user with the properties options and tokens gets defined in mediawiki.js.
33 * Generate a random user session ID.
35 * This information would potentially be stored in a cookie to identify a user during a
36 * session or series of sessions. Its uniqueness should not be depended on unless the
37 * browser supports the crypto API.
39 * Known problems with Math.random():
40 * Using the Math.random function we have seen sets
41 * with 1% of non uniques among 200,000 values with Safari providing most of these.
42 * Given the prevalence of Safari in mobile the percentage of duplicates in
43 * mobile usages of this code is probably higher.
46 * We need about 64 bits to make sure that probability of collision
47 * on 500 million (5*10^8) is <= 1%
48 * See https://en.wikipedia.org/wiki/Birthday_problem#Probability_table
50 * @return {string} 64 bit integer in hex format, padded
52 generateRandomSessionId: function () {
53 /*jshint bitwise:false */
55 hexRnds
= new Array( 8 ),
57 crypto
= window
.crypto
|| window
.msCrypto
;
59 // Based on https://github.com/broofa/node-uuid/blob/bfd9f96127/uuid.js
60 if ( crypto
&& crypto
.getRandomValues
) {
61 // Fill an array with 8 random values, each of which is 8 bits.
62 // Note that Uint8Array is array-like but does not implement Array.
63 rnds
= new Uint8Array( 8 );
64 crypto
.getRandomValues( rnds
);
66 rnds
= new Array( 8 );
67 for ( i
= 0; i
< 8; i
++ ) {
68 if ( ( i
& 3 ) === 0 ) {
69 r
= Math
.random() * 0x100000000;
71 rnds
[ i
] = r
>>> ( ( i
& 3 ) << 3 ) & 255;
74 // Convert from number to hex
75 for ( i
= 0; i
< 8; i
++ ) {
76 hexRnds
[ i
] = byteToHex
[ rnds
[ i
] ];
79 // Concatenation of two random integers with entropy n and m
80 // returns a string with entropy n+m if those strings are independent
81 return hexRnds
.join( '' );
85 * Get the current user's database id
87 * Not to be confused with #id.
89 * @return {number} Current user's id, or 0 if user is anonymous
92 return mw
.config
.get( 'wgUserId', 0 );
96 * Get the current user's name
98 * @return {string|null} User name string or null if user is anonymous
100 getName: function () {
101 return mw
.config
.get( 'wgUserName' );
105 * Get date user registered, if available
107 * @return {boolean|null|Date} False for anonymous users, null if data is
108 * unavailable, or Date for when the user registered.
110 getRegistration: function () {
111 if ( mw
.user
.isAnon() ) {
114 var registration
= mw
.config
.get( 'wgUserRegistration' );
115 // Registration may be unavailable if the user signed up before MediaWiki
116 // began tracking this.
117 return !registration
? null : new Date( registration
);
121 * Whether the current user is anonymous
125 isAnon: function () {
126 return mw
.user
.getName() === null;
130 * Get an automatically generated random ID (stored in a session cookie)
132 * This ID is ephemeral for everyone, staying in their browser only until they close
135 * @return {string} Random session ID
137 sessionId: function () {
138 var sessionId
= mw
.cookie
.get( 'mwuser-sessionId' );
139 if ( sessionId
=== null ) {
140 sessionId
= mw
.user
.generateRandomSessionId();
141 mw
.cookie
.set( 'mwuser-sessionId', sessionId
, { expires
: null } );
147 * Get the current user's name or the session ID
149 * Not to be confused with #getId.
151 * @return {string} User name or random session ID
154 return mw
.user
.getName() || mw
.user
.sessionId();
158 * Get the user's bucket (place them in one if not done already)
160 * mw.user.bucket( 'test', {
161 * buckets: { ignored: 50, control: 25, test: 25 },
166 * @deprecated since 1.23
167 * @param {string} key Name of bucket
168 * @param {Object} options Bucket configuration options
169 * @param {Object} options.buckets List of bucket-name/relative-probability pairs (required,
170 * must have at least one pair)
171 * @param {number} [options.version=0] Version of bucket test, changing this forces
173 * @param {number} [options.expires=30] Length of time (in days) until the user gets
175 * @return {string} Bucket name - the randomly chosen key of the `options.buckets` object
177 bucket: function ( key
, options
) {
178 var cookie
, parts
, version
, bucket
,
179 range
, k
, rand
, total
;
181 options
= $.extend( {
187 cookie
= mw
.cookie
.get( 'mwuser-bucket:' + key
);
189 // Bucket information is stored as 2 integers, together as version:bucket like: "1:2"
190 if ( typeof cookie
=== 'string' && cookie
.length
> 2 && cookie
.indexOf( ':' ) !== -1 ) {
191 parts
= cookie
.split( ':' );
192 if ( parts
.length
> 1 && Number( parts
[ 0 ] ) === options
.version
) {
193 version
= Number( parts
[ 0 ] );
194 bucket
= String( parts
[ 1 ] );
198 if ( bucket
=== undefined ) {
199 if ( !$.isPlainObject( options
.buckets
) ) {
200 throw new Error( 'Invalid bucket. Object expected for options.buckets.' );
203 version
= Number( options
.version
);
207 for ( k
in options
.buckets
) {
208 range
+= options
.buckets
[ k
];
211 // Select random value within range
212 rand
= Math
.random() * range
;
214 // Determine which bucket the value landed in
216 for ( k
in options
.buckets
) {
218 total
+= options
.buckets
[ k
];
219 if ( total
>= rand
) {
225 'mwuser-bucket:' + key
,
226 version
+ ':' + bucket
,
227 { expires
: Number( options
.expires
) * 86400 }
235 * Get the current user's groups
237 * @param {Function} [callback]
238 * @return {jQuery.Promise}
240 getGroups: function ( callback
) {
241 var userGroups
= mw
.config
.get( 'wgUserGroups', [] );
243 // Uses promise for backwards compatibility
244 return $.Deferred().resolve( userGroups
).done( callback
);
248 * Get the current user's rights
250 * @param {Function} [callback]
251 * @return {jQuery.Promise}
253 getRights: function ( callback
) {
254 return getUserInfo().then(
255 function ( userInfo
) { return userInfo
.rights
; },
256 function () { return []; }
261 }( mediaWiki
, jQuery
) );