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
|
/*
* Implementation for mediaWiki.user
*/
( function ( mw, $ ) {
/**
* User object
*/
function User( options, tokens ) {
var user, callbacks;
/* Private Members */
user = this;
callbacks = {};
/**
* Gets the current user's groups or rights.
* @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 || [] );
} );
}
/* Public Members */
this.options = options || new mw.Map();
this.tokens = tokens || new mw.Map();
/* Public Methods */
/**
* Generates 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
*/
function generateId() {
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;
}
/**
* Gets the current user's name.
*
* @return Mixed: User name string or null if users is anonymous
*/
this.getName = function () {
return mw.config.get( 'wgUserName' );
};
/**
* @deprecated since 1.20 use mw.user.getName() instead
*/
this.name = function () {
return this.getName();
};
/**
* Checks if the current user is anonymous.
*
* @return Boolean
*/
this.isAnon = function () {
return user.getName() === null;
};
/**
* @deprecated since 1.20 use mw.user.isAnon() instead
*/
this.anonymous = function () {
return user.isAnon();
};
/**
* Gets a random session ID automatically generated and kept in a cookie.
*
* This ID is ephemeral for everyone, staying in their browser only until they close
* their browser.
*
* @return String: User name or random session ID
*/
this.sessionId = function () {
var sessionId = $.cookie( 'mediaWiki.user.sessionId' );
if ( typeof sessionId === 'undefined' || sessionId === null ) {
sessionId = generateId();
$.cookie( 'mediaWiki.user.sessionId', sessionId, { 'expires': null, 'path': '/' } );
}
return sessionId;
};
/**
* Gets the current user's name or a random ID automatically generated and kept in a cookie.
*
* This ID is persistent for anonymous users, staying in their browser up to 1 year. The
* expiration time is reset each time the ID is queried, so in most cases this ID will
* persist until the browser's cookies are cleared or the user doesn't visit for 1 year.
*
* @return String: User name or random session ID
*/
this.id = function() {
var id,
name = user.getName();
if ( name ) {
return name;
}
id = $.cookie( 'mediaWiki.user.id' );
if ( typeof id === 'undefined' || id === null ) {
id = generateId();
}
// Set cookie if not set, or renew it if already set
$.cookie( 'mediaWiki.user.id', id, {
expires: 365,
path: '/'
} );
return id;
};
/**
* Gets the user's bucket, placing them in one at random based on set odds if needed.
*
* @param key String: Name of bucket
* @param options Object: Bucket configuration options
* @param options.buckets Object: List of bucket-name/relative-probability pairs (required,
* must have at least one pair)
* @param options.version Number: Version of bucket test, changing this forces rebucketing
* (optional, default: 0)
* @param options.tracked Boolean: Track the event of bucketing through the API module of
* the ClickTracking extension (optional, default: false)
* @param options.expires Number: Length of time (in days) until the user gets rebucketed
* (optional, default: 30)
* @return String: Bucket name - the randomly chosen key of the options.buckets object
*
* @example
* mw.user.bucket( 'test', {
* 'buckets': { 'ignored': 50, 'control': 25, 'test': 25 },
* 'version': 1,
* 'tracked': true,
* 'expires': 7
* } );
*/
this.bucket = function ( key, options ) {
var cookie, parts, version, bucket,
range, k, rand, total;
options = $.extend( {
buckets: {},
version: 0,
tracked: false,
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( ':' ) > 0 ) {
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 'Invalid buckets error. 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;
}
}
if ( options.tracked ) {
mw.loader.using( 'jquery.clickTracking', function () {
$.trackAction(
'mediaWiki.user.bucket:' + key + '@' + version + ':' + bucket
);
} );
}
$.cookie(
'mediaWiki.user.bucket:' + key,
version + ':' + bucket,
{ 'path': '/', 'expires': Number( options.expires ) }
);
}
return bucket;
};
/**
* Gets the current user's groups.
*/
this.getGroups = function ( callback ) {
getUserInfo( 'groups', callback );
};
/**
* Gets the current user's rights.
*/
this.getRights = function ( callback ) {
getUserInfo( 'rights', callback );
};
}
// Extend the skeleton mw.user from mediawiki.js
// This is kind of ugly but we're stuck with this for b/c reasons
mw.user = new User( mw.user.options, mw.user.tokens );
}( mediaWiki, jQuery ) );
|
