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
|
( function ( mw, $ ) {
'use strict';
/**
* Provides an API for getting and setting cookies that is
* syntactically and functionally similar to the server-side cookie
* API (`WebRequest#getCookie` and `WebResponse#setcookie`).
*
* @author Sam Smith <samsmith@wikimedia.org>
* @author Matthew Flaschen <mflaschen@wikimedia.org>
* @author Timo Tijhof <krinklemail@gmail.com>
*
* @class mw.cookie
* @singleton
*/
mw.cookie = {
/**
* Sets or deletes a cookie.
*
* While this is natural in JavaScript, contrary to `WebResponse#setcookie` in PHP, the
* default values for the `options` properties only apply if that property isn't set
* already in your options object (e.g. passing `{ secure: null }` or `{ secure: undefined }`
* overrides the default value for `options.secure`).
*
* @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} [options] Options object, or expiry date
* @param {Date|null} [options.expires=wgCookieExpiration] The expiry date of the cookie.
*
* Default cookie expiration is based on `wgCookieExpiration`. If `wgCookieExpiration` is
* 0, a session cookie is set (expires when the browser is closed). For non-zero values of
* `wgCookieExpiration`, the cookie expires `wgCookieExpiration` seconds from now.
*
* If options.expires is null, 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 config, defaultOptions, date;
// wgCookieSecure is not used for now, since 'detect' could not work with
// ResourceLoaderStartUpModule, as module cache is not fragmented by protocol.
config = mw.config.get( [
'wgCookiePrefix',
'wgCookieDomain',
'wgCookiePath',
'wgCookieExpiration'
] );
defaultOptions = {
prefix: config.wgCookiePrefix,
domain: config.wgCookieDomain,
path: config.wgCookiePath,
secure: false
};
// Options argument can also be a shortcut for the expiry
// Expiry can be a Date or null
if ( $.type( options ) !== 'object' ) {
// Also takes care of options = undefined, in which case we also don't need $.extend()
defaultOptions.expires = options;
options = defaultOptions;
} else {
options = $.extend( defaultOptions, options );
}
// $.cookie makes session cookies when expiry is omitted,
// however our default is to expire wgCookieExpiration seconds from now.
// Note: If wgCookieExpiration is 0, that is considered a special value indicating
// all cookies should be session cookies by default.
if ( options.expires === undefined && config.wgCookieExpiration !== 0 ) {
date = new Date();
date.setTime( Number( date ) + ( config.wgCookieExpiration * 1000 ) );
options.expires = date;
} else if ( options.expires === null ) {
// $.cookie makes a session cookie when expires is omitted
delete options.expires;
}
// Process prefix
key = options.prefix + key;
delete options.prefix;
// Process value
if ( value !== null ) {
value = String( value );
}
// Other options are handled by $.cookie
$.cookie( key, value, options );
},
/**
* Gets 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} 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 = mw.config.get( 'wgCookiePrefix' );
}
// Was defaultValue omitted?
if ( arguments.length < 3 ) {
defaultValue = null;
}
result = $.cookie( prefix + key );
return result !== null ? result : defaultValue;
}
};
} ( mediaWiki, jQuery ) );
|
