forked from josebalius/jquery-idleTimeout
-
Notifications
You must be signed in to change notification settings - Fork 79
/
jquery-idleTimeout-iframes.js
384 lines (298 loc) · 13.5 KB
/
jquery-idleTimeout-iframes.js
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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
/**
* This work is licensed under the Creative Commons Attribution-Share Alike 3.0
* United States License. To view a copy of this license,
* visit http://creativecommons.org/licenses/by-sa/3.0/us/ or send a letter
* to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA.
*
* Modified by: Jill Elaine
* Email: [email protected]
*
* Configurable idle (no activity) timer and logout redirect for jQuery.
* Works across multiple windows, tabs and iframes from the same domain.
*
* Dependencies: JQuery v1.7+, JQuery UI, store.js from https://github.com/marcuswestin/store.js - v1.3.4+
*
* version 1.0.10
**/
/*global jQuery: false, document: false, store: false, clearInterval: false, setInterval: false, setTimeout: false, clearTimeout: false, window: false, alert: false*/
/*jslint indent: 2, sloppy: true, plusplus: true*/
(function ($) {
$.fn.idleTimeout = function (userRuntimeConfig) {
//##############################
//## Public Configuration Variables
//##############################
var defaultConfig = {
redirectUrl: '/logout', // redirect to this url on logout. Set to "redirectUrl: false" to disable redirect
// idle settings
idleTimeLimit: 1200, // 'No activity' time limit in seconds. 1200 = 20 Minutes
idleCheckHeartbeat: 2, // Frequency to check for idle timeouts in seconds
// optional custom callback to perform before logout
customCallback: false, // set to false for no customCallback
// customCallback: function () { // define optional custom js function
// perform custom action before logout
// },
// configure which activity events to detect
// http://www.quirksmode.org/dom/events/
// https://developer.mozilla.org/en-US/docs/Web/Reference/Events
activityEvents: 'click keypress scroll wheel mousewheel mousemove', // separate each event with a space
// warning dialog box configuration
enableDialog: true, // set to false for logout without warning dialog
dialogDisplayLimit: 180, // Time to display the warning dialog before logout (and optional callback) in seconds. 180 = 3 Minutes
dialogTitle: 'Session Expiration Warning', // also displays on browser title bar
dialogText: 'Because you have been inactive, your session is about to expire.',
dialogTimeRemaining: 'Time remaining',
dialogStayLoggedInButton: 'Stay Logged In',
dialogLogOutNowButton: 'Log Out Now',
// error message if https://github.com/marcuswestin/store.js not enabled
errorAlertMessage: 'Please disable "Private Mode", or upgrade to a modern browser. Or perhaps a dependent file missing. Please see: https://github.com/marcuswestin/store.js',
// server-side session keep-alive timer
sessionKeepAliveTimer: 600, // ping the server at this interval in seconds. 600 = 10 Minutes. Set to false to disable pings
sessionKeepAliveUrl: window.location.href // set URL to ping - does not apply if sessionKeepAliveTimer: false
},
//##############################
//## Private Variables
//##############################
currentConfig = $.extend(defaultConfig, userRuntimeConfig), // merge default and user runtime configuration
origTitle = document.title, // save original browser title
storeConfiguration, // public function support, store private configuration variables
activityDetector,
startKeepSessionAlive, stopKeepSessionAlive, keepSession, keepAlivePing, // session keep alive
idleTimer, remainingTimer, checkIdleTimeout, checkIdleTimeoutLoop, startIdleTimer, stopIdleTimer, // idle timer
openWarningDialog, dialogTimer, checkDialogTimeout, startDialogTimer, stopDialogTimer, isDialogOpen, destroyWarningDialog, countdownDisplay, // warning dialog
logoutUser,
checkForIframes, includeIframes, attachEventIframe; // iframes
//##############################
//## Public Functions
//##############################
// trigger a manual user logout
// use this code snippet on your site's Logout button: $.fn.idleTimeout().logout();
this.logout = function () {
store.set('idleTimerLoggedOut', true);
};
// trigger a recheck for iframes
// use this code snippet after an iframe is inserted into the document: $.fn.idleTimeout().iframeRecheck()
this.iframeRecheck = function () {
checkForIframes();
};
//##############################
//## Private Functions
//##############################
//----------- PUBLIC FUNCTION SUPPORT --------------//
// WORK AROUND - save currentConfig.activityEvents value to 'store.js' variable for use in function: attachEventIframe
storeConfiguration = function () {
store.set('activityEvents', currentConfig.activityEvents);
};
//----------- KEEP SESSION ALIVE FUNCTIONS --------------//
startKeepSessionAlive = function () {
keepSession = function () {
$.get(currentConfig.sessionKeepAliveUrl);
startKeepSessionAlive();
};
keepAlivePing = setTimeout(keepSession, (currentConfig.sessionKeepAliveTimer * 1000));
};
stopKeepSessionAlive = function () {
clearTimeout(keepAlivePing);
};
//----------- ACTIVITY DETECTION FUNCTION --------------//
activityDetector = function () {
$('body').on(currentConfig.activityEvents, function () {
if (!currentConfig.enableDialog || (currentConfig.enableDialog && isDialogOpen() !== true)) {
startIdleTimer();
}
});
};
//----------- IDLE TIMER FUNCTIONS --------------//
checkIdleTimeout = function () {
var timeIdleTimeout = (store.get('idleTimerLastActivity') + (currentConfig.idleTimeLimit * 1000));
if ($.now() > timeIdleTimeout) {
if (!currentConfig.enableDialog) { // warning dialog is disabled
logoutUser(); // immediately log out user when user is idle for idleTimeLimit
} else if (currentConfig.enableDialog && isDialogOpen() !== true) {
openWarningDialog();
startDialogTimer(); // start timing the warning dialog
}
} else if (store.get('idleTimerLoggedOut') === true) { //a 'manual' user logout?
logoutUser();
} else {
if (currentConfig.enableDialog && isDialogOpen() === true) {
destroyWarningDialog();
stopDialogTimer();
}
}
};
startIdleTimer = function () {
stopIdleTimer();
store.set('idleTimerLastActivity', $.now());
checkIdleTimeoutLoop();
};
checkIdleTimeoutLoop = function () {
checkIdleTimeout();
idleTimer = setTimeout(checkIdleTimeoutLoop, (currentConfig.idleCheckHeartbeat * 1000));
};
stopIdleTimer = function () {
clearTimeout(idleTimer);
};
//----------- WARNING DIALOG FUNCTIONS --------------//
openWarningDialog = function () {
var dialogContent = "<div id='idletimer_warning_dialog'><p>" + currentConfig.dialogText + "</p><p style='display:inline'>" + currentConfig.dialogTimeRemaining + ": <div style='display:inline' id='countdownDisplay'></div></p></div>";
$(dialogContent).dialog({
buttons: [{
text: currentConfig.dialogStayLoggedInButton,
click: function () {
destroyWarningDialog();
stopDialogTimer();
startIdleTimer();
}
},
{
text: currentConfig.dialogLogOutNowButton,
click: function () {
logoutUser();
}
}
],
closeOnEscape: false,
modal: true,
title: currentConfig.dialogTitle,
open: function () {
$(this).closest('.ui-dialog').find('.ui-dialog-titlebar-close').hide();
}
});
countdownDisplay();
document.title = currentConfig.dialogTitle;
if (currentConfig.sessionKeepAliveTimer) {
stopKeepSessionAlive();
}
};
checkDialogTimeout = function () {
var timeDialogTimeout = (store.get('idleTimerLastActivity') + (currentConfig.idleTimeLimit * 1000) + (currentConfig.dialogDisplayLimit * 1000));
if (($.now() > timeDialogTimeout) || (store.get('idleTimerLoggedOut') === true)) {
logoutUser();
}
};
startDialogTimer = function () {
dialogTimer = setInterval(checkDialogTimeout, (currentConfig.idleCheckHeartbeat * 1000));
};
stopDialogTimer = function () {
clearInterval(dialogTimer);
clearInterval(remainingTimer);
};
isDialogOpen = function () {
var dialogOpen = $("#idletimer_warning_dialog").is(":visible");
if (dialogOpen === true) {
return true;
}
return false;
};
destroyWarningDialog = function () {
$("#idletimer_warning_dialog").dialog('destroy').remove();
document.title = origTitle;
if (currentConfig.sessionKeepAliveTimer) {
startKeepSessionAlive();
}
};
countdownDisplay = function () {
var dialogDisplaySeconds = currentConfig.dialogDisplayLimit, mins, secs;
remainingTimer = setInterval(function () {
mins = Math.floor(dialogDisplaySeconds / 60); // minutes
if (mins < 10) { mins = '0' + mins; }
secs = dialogDisplaySeconds - (mins * 60); // seconds
if (secs < 10) { secs = '0' + secs; }
$('#countdownDisplay').html(mins + ':' + secs);
dialogDisplaySeconds -= 1;
}, 1000);
};
//----------- LOGOUT USER FUNCTION --------------//
logoutUser = function () {
store.set('idleTimerLoggedOut', true);
if (currentConfig.sessionKeepAliveTimer) {
stopKeepSessionAlive();
}
if (currentConfig.customCallback) {
currentConfig.customCallback();
}
if (currentConfig.redirectUrl) {
window.location.href = currentConfig.redirectUrl;
}
};
//----------- IFRAME FUNCTIONS --------------//
$("body").on("dialogopen", function () {
if (currentConfig.enableDialog && isDialogOpen() !== true) {
checkForIframes();
}
});
// document must be in readyState 'complete' before checking for iframes - $(document).ready() is not good enough!
checkForIframes = function () {
var docReadyCheck, isDocReady;
docReadyCheck = function () {
if (document.readyState === "complete") {
clearInterval(isDocReady);
includeIframes();
}
};
isDocReady = setInterval(docReadyCheck, 1000); // check once a second to see if document is complete
};
includeIframes = function (elementContents) {
if (!elementContents) {
elementContents = $(document);
}
var iframeCount = 0;
elementContents.find('iframe,frame').each(function () {
if ($(this).hasClass('jit-inspected') === false) {
try {
includeIframes($(this).contents()); // recursive call to include nested iframes
// attach event code for most modern browsers
$(this).on('load', attachEventIframe($(this))); // Browser NOT IE < 11
// attach event code for older Internet Explorer browsers
var domElement = $(this)[iframeCount]; // convert jquery object to dom element
if (domElement.attachEvent) { // Older IE Browser < 11
domElement.attachEvent('onload', attachEventIframe($(this)));
}
iframeCount++;
} catch (err) {
/* Unfortunately, if the 'includeIframes' function is manually triggered multiple times in quick succession,
* this 'try/catch' block may not have time to complete,
* and so it might error out,
* and iframes that are NOT cross-site may be set to "cross-site"
* and activity may or may not bubble to parent page.
* Fortunately, this is a rare occurrence!
*/
$(this).addClass('jit-inspected cross-site');
}
}
});
};
attachEventIframe = function (iframeItem) {
// retrieve stored value as currentConfig will not include private userRuntimeConfig
// when this function is called by public function, iframeRecheck
var iframeContents = iframeItem.contents(), storeActivityEvents = store.get('activityEvents');
try {
iframeContents.on(storeActivityEvents, function (event) {
$('body').trigger(event);
});
iframeItem.addClass('jit-inspected'); // add "jit-inspected" class, so we don't need to check this iframe again
} catch (ignore) {
// nothing to do
}
};
//###############################
// Build & Return the instance of the item as a plugin
// This is your construct.
//###############################
return this.each(function () {
if (store.enabled) {
store.set('idleTimerLastActivity', $.now());
store.set('idleTimerLoggedOut', false);
storeConfiguration();
activityDetector();
if (currentConfig.sessionKeepAliveTimer) {
startKeepSessionAlive();
}
startIdleTimer();
checkForIframes();
} else {
alert(currentConfig.errorAlertMessage);
}
});
};
}(jQuery));