5 /* global Uint32Array */
7 var userInfoPromise
, pageviewRandomId
;
10 * Get the current user's groups or rights
13 * @return {jQuery.Promise}
15 function getUserInfo() {
16 if ( !userInfoPromise
) {
17 userInfoPromise
= new mw
.Api().getUserInfo();
19 return userInfoPromise
;
22 // mw.user with the properties options and tokens gets defined in mediawiki.js.
26 * Generate a random user session ID.
28 * This information would potentially be stored in a cookie to identify a user during a
29 * session or series of sessions. Its uniqueness should not be depended on unless the
30 * browser supports the crypto API.
32 * Known problems with Math.random():
33 * Using the Math.random function we have seen sets
34 * with 1% of non uniques among 200,000 values with Safari providing most of these.
35 * Given the prevalence of Safari in mobile the percentage of duplicates in
36 * mobile usages of this code is probably higher.
39 * We need about 64 bits to make sure that probability of collision
40 * on 500 million (5*10^8) is <= 1%
41 * See https://en.wikipedia.org/wiki/Birthday_problem#Probability_table
43 * @return {string} 64 bit integer in hex format, padded
45 generateRandomSessionId: function () {
47 hexRnds
= new Array( 2 ),
49 crypto
= window
.crypto
|| window
.msCrypto
;
51 if ( crypto
&& crypto
.getRandomValues
&& typeof Uint32Array
=== 'function' ) {
52 // Fill an array with 2 random values, each of which is 32 bits.
53 // Note that Uint32Array is array-like but does not implement Array.
54 rnds
= new Uint32Array( 2 );
55 crypto
.getRandomValues( rnds
);
58 Math
.floor( Math
.random() * 0x100000000 ),
59 Math
.floor( Math
.random() * 0x100000000 )
62 // Convert number to a string with 16 hex characters
63 for ( i
= 0; i
< 2; i
++ ) {
64 // Add 0x100000000 before converting to hex and strip the extra character
65 // after converting to keep the leading zeros.
66 hexRnds
[ i
] = ( rnds
[ i
] + 0x100000000 ).toString( 16 ).slice( 1 );
69 // Concatenation of two random integers with entropy n and m
70 // returns a string with entropy n+m if those strings are independent
71 return hexRnds
.join( '' );
75 * A sticky generateRandomSessionId for the current JS execution context,
76 * cached within this class (also known as a page view token).
79 * @return {string} 64 bit integer in hex format, padded
81 getPageviewToken: function () {
82 if ( !pageviewRandomId
) {
83 pageviewRandomId
= mw
.user
.generateRandomSessionId();
86 return pageviewRandomId
;
90 * Get the current user's database id
92 * Not to be confused with #id.
94 * @return {number} Current user's id, or 0 if user is anonymous
97 return mw
.config
.get( 'wgUserId' ) || 0;
101 * Get the current user's name
103 * @return {string|null} User name string or null if user is anonymous
105 getName: function () {
106 return mw
.config
.get( 'wgUserName' );
110 * Get date user registered, if available
112 * @return {boolean|null|Date} False for anonymous users, null if data is
113 * unavailable, or Date for when the user registered.
115 getRegistration: function () {
117 if ( mw
.user
.isAnon() ) {
120 registration
= mw
.config
.get( 'wgUserRegistration' );
121 // Registration may be unavailable if the user signed up before MediaWiki
122 // began tracking this.
123 return !registration
? null : new Date( registration
);
127 * Whether the current user is anonymous
131 isAnon: function () {
132 return mw
.user
.getName() === null;
136 * Get an automatically generated random ID (persisted in sessionStorage)
138 * This ID is ephemeral for everyone, staying in their browser only until they
139 * close their browsing session.
141 * @return {string} Random session ID
143 sessionId: function () {
144 var sessionId
= mw
.storage
.session
.get( 'mwuser-sessionId' );
146 sessionId
= mw
.user
.generateRandomSessionId();
147 mw
.storage
.session
.set( 'mwuser-sessionId', sessionId
);
153 * Get the current user's name or the session ID
155 * Not to be confused with #getId.
157 * @return {string} User name or random session ID
160 return mw
.user
.getName() || mw
.user
.sessionId();
164 * Get the current user's groups
166 * @param {Function} [callback]
167 * @return {jQuery.Promise}
169 getGroups: function ( callback
) {
170 var userGroups
= mw
.config
.get( 'wgUserGroups', [] );
172 // Uses promise for backwards compatibility
173 return $.Deferred().resolve( userGroups
).done( callback
);
177 * Get the current user's rights
179 * @param {Function} [callback]
180 * @return {jQuery.Promise}
182 getRights: function ( callback
) {
183 return getUserInfo().then(
184 function ( userInfo
) { return userInfo
.rights
; },
185 function () { return []; }
191 * @method stickyRandomId
192 * @deprecated since 1.32 use getPageviewToken instead
194 mw
.log
.deprecate( mw
.user
, 'stickyRandomId', mw
.user
.getPageviewToken
, 'Please use getPageviewToken instead' );
196 }( mediaWiki
, jQuery
) );