1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
/**
* @class mw.user
* @singleton
*/
( function ( mw, $ ) {
var user,
callbacks = {},
// Extend the skeleton mw.user from mediawiki.js
// This is kind of ugly but we're stuck with this for b/c reasons
options = mw.user.options || new mw.Map(),
tokens = mw.user.tokens || new mw.Map();
/**
* Get the current user's groups or rights
*
* @private
* @param {string} info One of 'groups' or 'rights'
* @param {Function} callback
*/
function getUserInfo( info, callback ) {
var api;
if ( callbacks[info] ) {
callbacks[info].add( callback );
return;
}
callbacks.rights = $.Callbacks('once memory');
callbacks.groups = $.Callbacks('once memory');
callbacks[info].add( callback );
api = new mw.Api();
api.get( {
action: 'query',
meta: 'userinfo',
uiprop: 'rights|groups'
} ).always( function ( data ) {
var rights, groups;
if ( data.query && data.query.userinfo ) {
rights = data.query.userinfo.rights;
groups = data.query.userinfo.groups;
}
callbacks.rights.fire( rights || [] );
callbacks.groups.fire( groups || [] );
} );
}
mw.user = user = {
options: options,
tokens: tokens,
/**
* Generate a random user session ID (32 alpha-numeric characters)
*
* This information would potentially be stored in a cookie to identify a user during a
* session or series of sessions. Its uniqueness should not be depended on.
*
* @return {string} Random set of 32 alpha-numeric characters
*/
generateRandomSessionId: function () {
var i, r,
id = '',
seed = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
for ( i = 0; i < 32; i++ ) {
r = Math.floor( Math.random() * seed.length );
id += seed.substring( r, r + 1 );
}
return id;
},
/**
* Get the current user's database id
*
* Not to be confused with #id.
*
* @return {number} Current user's id, or 0 if user is anonymous
*/
getId: function () {
return mw.config.get( 'wgUserId', 0 );
},
/**
* Get the current user's name
*
* @return {string|null} User name string or null if user is anonymous
*/
getName: function () {
return mw.config.get( 'wgUserName' );
},
/**
* @inheritdoc #getName
* @deprecated since 1.20 use #getName instead
*/
name: function () {
return user.getName();
},
/**
* Get date user registered, if available
*
* @return {Date|boolean|null} Date user registered, or false for anonymous users, or
* null when data is not available
*/
getRegistration: function () {
var registration = mw.config.get( 'wgUserRegistration' );
if ( user.isAnon() ) {
return false;
} else if ( registration === null ) {
// Information may not be available if they signed up before
// MW began storing this.
return null;
} else {
return new Date( registration );
}
},
/**
* Whether the current user is anonymous
*
* @return {boolean}
*/
isAnon: function () {
return user.getName() === null;
},
/**
* @inheritdoc #isAnon
* @deprecated since 1.20 use #isAnon instead
*/
anonymous: function () {
return user.isAnon();
},
/**
* Get an automatically generated random ID (stored in a session cookie)
*
* This ID is ephemeral for everyone, staying in their browser only until they close
* their browser.
*
* @return {string} Random session ID
*/
sessionId: function () {
var sessionId = $.cookie( 'mediaWiki.user.sessionId' );
if ( sessionId === undefined || sessionId === null ) {
sessionId = user.generateRandomSessionId();
$.cookie( 'mediaWiki.user.sessionId', sessionId, { expires: null, path: '/' } );
}
return sessionId;
},
/**
* Get the current user's name or the session ID
*
* Not to be confused with #getId.
*
* @return {string} User name or random session ID
*/
id: function () {
return user.getName() || 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
* } );
*
* @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 = $.cookie( 'mediaWiki.user.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;
}
}
$.cookie(
'mediaWiki.user.bucket:' + key,
version + ':' + bucket,
{ path: '/', expires: Number( options.expires ) }
);
}
return bucket;
},
/**
* Get the current user's groups
*
* @param {Function} callback
*/
getGroups: function ( callback ) {
getUserInfo( 'groups', callback );
},
/**
* Get the current user's rights
*
* @param {Function} callback
*/
getRights: function ( callback ) {
getUserInfo( 'rights', callback );
}
};
}( mediaWiki, jQuery ) );
|
