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
|
( function () {
'use strict';
var config = require( './config.json' ),
defaults = {
prefix: config.prefix,
domain: config.domain,
path: config.path,
expires: config.expires,
secure: false
};
/**
* Manage cookies in a way that is syntactically and functionally similar
* to the `WebRequest#getCookie` and `WebResponse#setcookie` methods in PHP.
*
* @author Sam Smith <samsmith@wikimedia.org>
* @author Matthew Flaschen <mflaschen@wikimedia.org>
*
* @class mw.cookie
* @singleton
*/
mw.cookie = {
/**
* Set or delete a cookie.
*
* **Note:** If explicitly passing `null` or `undefined` for an options key,
* that will override the default. This is natural in JavaScript, but noted
* here because it is contrary to MediaWiki's `WebResponse#setcookie()` method
* in PHP.
*
* @param {string} key
* @param {string|null} value Value of cookie. If `value` is `null` then this method will
* instead remove a cookie by name of `key`.
* @param {Object|Date|number} [options] Options object, or expiry date
* @param {Date|number|null} [options.expires=wgCookieExpiration] The expiry date of the cookie,
* or lifetime in seconds. If `options.expires` is null or 0, then a session cookie is set.
* @param {string} [options.prefix=wgCookiePrefix] The prefix of the key
* @param {string} [options.domain=wgCookieDomain] The domain attribute of the cookie
* @param {string} [options.path=wgCookiePath] The path attribute of the cookie
* @param {boolean} [options.secure=false] Whether or not to include the secure attribute.
* (Does **not** use the wgCookieSecure configuration variable)
*/
set: function ( key, value, options ) {
var date;
// The 'options' parameter may be a shortcut for the expiry.
if ( arguments.length > 2 && ( !options || options instanceof Date || typeof options === 'number' ) ) {
options = { expires: options };
}
// Apply defaults
options = $.extend( {}, defaults, options );
// Handle prefix
key = options.prefix + key;
// Don't pass invalid option to $.cookie
delete options.prefix;
if ( !options.expires ) {
// Session cookie (null or zero)
// Normalize to absent (undefined) for $.cookie.
delete options.expires;
} else if ( typeof options.expires === 'number' ) {
// Lifetime in seconds
date = new Date();
date.setTime( Number( date ) + ( options.expires * 1000 ) );
options.expires = date;
}
if ( value !== null ) {
value = String( value );
}
$.cookie( key, value, options );
},
/**
* Get the value of a cookie.
*
* @param {string} key
* @param {string} [prefix=wgCookiePrefix] The prefix of the key. If `prefix` is
* `undefined` or `null`, then `wgCookiePrefix` is used
* @param {Mixed} [defaultValue=null]
* @return {string|null|Mixed} If the cookie exists, then the value of the
* cookie, otherwise `defaultValue`
*/
get: function ( key, prefix, defaultValue ) {
var result;
if ( prefix === undefined || prefix === null ) {
prefix = defaults.prefix;
}
// Was defaultValue omitted?
if ( arguments.length < 3 ) {
defaultValue = null;
}
result = $.cookie( prefix + key );
return result !== null ? result : defaultValue;
}
};
if ( window.QUnit ) {
module.exports = {
setDefaults: function ( value ) {
var prev = defaults;
defaults = value;
return prev;
}
};
}
}() );
|
