Page MenuHomeWickedGov Phorge
Files F5970019

index.js
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

index.js
View Options

'use strict';
const config = require( './config.json' ),
jar = require( './jar.js' );
let defaults = {
prefix: config.prefix,
domain: config.domain,
path: config.path,
expires: config.expires,
secure: false,
sameSite: ''
};
// define jQuery Cookie methods
require( './jquery.js' );
/**
* 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>
*
* @module mediawiki.cookie
* @example
* mw.loader.using( 'mediawiki.cookie' ).then( () => {
* mw.cookie.set('hello', 'world' );
* })
*/
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.
*
* When using this for persistent storage of identifiers (e.g. for tracking
* sessions), be aware that persistence may vary slightly across browsers and
* browser versions, and can be affected by a number of factors such as
* storage limits (cookie eviction) and session restore features.
*
* Without an expiry, this creates a session cookie. In a browser, session cookies persist
* for the lifetime of the browser *process*. Including across tabs, page views, and windows,
* until the browser itself is *fully* closed, or until the browser clears all storage for
* a given website. An exception to this is if the user evokes a "restore previous
* session" feature that some browsers have.
*
* @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 {module:mediawiki.cookie~CookieOptions|Date|number} [options] Options object, or expiry date
* @memberof module:mediawiki.cookie
*/
set: function ( key, value, options ) {
// 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 = Object.assign( {}, defaults, options );
// Don't pass invalid option to jar.cookie
const prefix = options.prefix;
delete options.prefix;
if ( !options.expires ) {
// Session cookie (null or zero)
// Normalize to absent (undefined) for jar.cookie.
delete options.expires;
} else if ( typeof options.expires === 'number' ) {
// Lifetime in seconds
const date = new Date();
date.setTime( Number( date ) + ( options.expires * 1000 ) );
options.expires = date;
}
// Ignore sameSiteLegacy (T344791)
delete options.sameSiteLegacy;
if ( value !== null ) {
value = String( value );
}
jar.cookie( prefix + 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 {null|string} [defaultValue] defaults to null
* @return {string|null} If the cookie exists, then the value of the
* cookie, otherwise `defaultValue`
* @memberof module:mediawiki.cookie
*/
get: function ( key, prefix, defaultValue ) {
if ( prefix === undefined || prefix === null ) {
prefix = defaults.prefix;
}
// Was defaultValue omitted?
if ( arguments.length < 3 ) {
defaultValue = null;
}
const result = jar.cookie( prefix + key );
return result !== null ? result : defaultValue;
},
/**
* Get the value of a cookie.
*
* @deprecated since 1.43, use {@link module:mediawiki.cookie.get mw.cookie.get}
*
* @param {string} key
* @param {string} [prefix=wgCookiePrefix] The prefix of the key. If `prefix` is
* `undefined` or `null`, then `wgCookiePrefix` is used
* @param {null|string} [defaultValue]
* @return {string|null} If the cookie exists, then the value of the
* cookie, otherwise `defaultValue`
* @memberof module:mediawiki.cookie
*/
getCrossSite: function ( key, prefix, defaultValue ) {
return this.get( key, prefix, defaultValue );
}
};
mw.log.deprecate( mw.cookie, 'getCrossSite', mw.cookie.getCrossSite,
'Use mw.cookie.get instead.', 'mw.cookie.getCrossSite' );
if ( window.QUnit ) {
module.exports = {
jar,
setDefaults: function ( value ) {
const prev = defaults;
defaults = value;
return prev;
}
};
}

File Metadata

Mime Type
text/plain
Expires
Sat, Oct 3, 14:10 (12 h, 54 m ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
84/f9/f04331f3c0e806853f695aeafbb1
Default Alt Text
index.js (4 KB)

Event Timeline