Page MenuHomeWickedGov Phorge
Files F4109940

hide.js
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

hide.js
View Options

/**
* Retrieves, processes and stores 'hide' cookies, which prevent banners from
* showing in certain circumstances. Provides cn.internal.hide.
*/
( function () {
var hide,
category,
cookieName,
shouldHide,
reason,
durations = mw.config.get( 'wgNoticeCookieDurations' ),
HIDE_COOKIE_PREFIX = 'centralnotice_hide_',
// Maximum duration of hide cookies with reasons other than those
// configured in wgNoticeCookieDurations.
MAX_CUSTOM_HIDE_DURATION = 2592000;
function removeCookie() {
$.cookie( cookieName, null, { path: '/' } );
}
/**
* Hide object (intended for access from within this RL module)
*/
hide = mw.centralNotice.internal.hide = {
setCategory: function ( c ) {
shouldHide = false;
reason = null;
category = c;
cookieName = HIDE_COOKIE_PREFIX + category;
},
processCookie: function () {
var rawCookieVal = $.cookie( cookieName ),
hideData,
now;
// No cookie
if ( !rawCookieVal ) {
return;
}
// An old-format cookie; just delete it :)
if ( rawCookieVal === 'hide' ) {
removeCookie();
return;
}
// Try to parse the cookie
try {
hideData = JSON.parse( rawCookieVal );
} catch ( e ) {
// Corrupt cookie contents
removeCookie();
return;
}
now = Date.now() / 1000;
// Duration isn't stored in the cookie. Cookies should expire
// after the duration is up, some hide reasons have server-side
// duration settings, which we check. This allows us to shorten the
// effective duration of hide cookies via server config, if
// necessary.
// For custom hide reasons with shorter durations than
// MAX_CUSTOM_HIDE_DURATION, the cookie itself should expire
// if the duration has been exceeded. In any case, don't allow
// the cookie to have any effect beyond MAX_CUSTOM_HIDE_DURATION.
// TODO Update and improve this server-side switch.
if ( now < hideData.created +
( durations[ hideData.reason ] || MAX_CUSTOM_HIDE_DURATION ) ) {
shouldHide = true;
reason = hideData.reason;
}
},
shouldHide: function () {
return shouldHide;
},
getReason: function () {
return reason;
},
/**
* Set a hide cookies for this domain and others in wgNoticeHideUrls
* with the given reason and duration.
*
* @param {string} newReason Reason to store in the hide cookie
* @param {number} duration Cookie duration, in seconds
*/
setHideCookies: function ( newReason, duration ) {
var date = new Date(),
hideData = {
v: 1,
created: Math.floor( date.getTime() / 1000 ),
reason: newReason
};
// If this reason doesn't have an entry configured in
// wgNoticeCookieDurations, don't allow a longer duration than
// MAX_CUSTOM_HIDE_DURATION.
if ( !( newReason in durations ) ) {
duration = Math.min( MAX_CUSTOM_HIDE_DURATION, duration );
}
// Re-use the same date object to set the cookie's expiry time
date.setSeconds( date.getSeconds() + duration );
$.cookie(
cookieName,
JSON.stringify( hideData ),
{ expires: date, path: '/' }
);
// Iterate over all configured URLs to hide this category of banner
// for all wikis in a cluster
mw.config.get( 'wgNoticeHideUrls' ).forEach( function ( val ) {
var url = new mw.Uri( val );
url.extend(
{
duration: duration,
category: category,
reason: newReason
}
);
// TODO Can we use sendBeacon here? Would it be worth it?
document.createElement( 'img' ).src = url.toString();
} );
},
setHideWithCloseButtonCookies: function () {
// 'close' must be in REASONS in ext.centralNotice.display.state
hide.setHideCookies( 'close', durations.close );
}
};
}() );

File Metadata

Mime Type
text/plain
Expires
Tue, Aug 18, 21:19 (5 d, 12 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
0f/02/9de1a7b4f2b239771a9e69912698
Default Alt Text
hide.js (3 KB)

Event Timeline