From 9f8a9a3239454c6cdebdba4f49afcad6c57b2cd5 Mon Sep 17 00:00:00 2001
From: Andrew Ozz <azaozz@git.wordpress.org>
Date: Mon, 6 Jul 2020 16:12:24 +0000
Subject: [PATCH] Heartbeat: Do not disable the login prompts when the user
 needs to log in again but has closed the log in modal. Add a 5 minutes
 timeout before asking them to log in again.

Props dsixinetu, adamsilverstein, azaozz.
Fixes #49573.

git-svn-id: https://develop.svn.wordpress.org/trunk@48337 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/js/_enqueues/lib/auth-check.js | 78 +++++++++++++++++++-----------
 1 file changed, 50 insertions(+), 28 deletions(-)

diff --git a/src/js/_enqueues/lib/auth-check.js b/src/js/_enqueues/lib/auth-check.js
index be2a37cfc0..c5d3af18af 100644
--- a/src/js/_enqueues/lib/auth-check.js
+++ b/src/js/_enqueues/lib/auth-check.js
@@ -5,8 +5,10 @@
  */
 
 /* global adminpage */
-(function($){
-	var wrap;
+( function( $ ) {
+	var wrap,
+		tempHidden,
+		tempHiddenTimeout;
 
 	/**
 	 * Shows the authentication form popup.
@@ -15,18 +17,18 @@
 	 * @private
 	 */
 	function show() {
-		var parent = $('#wp-auth-check'),
-			form = $('#wp-auth-check-form'),
-			noframe = wrap.find('.wp-auth-fallback-expired'),
+		var parent = $( '#wp-auth-check' ),
+			form = $( '#wp-auth-check-form' ),
+			noframe = wrap.find( '.wp-auth-fallback-expired' ),
 			frame, loaded = false;
 
 		if ( form.length ) {
 			// Add unload confirmation to counter (frame-busting) JS redirects.
-			$(window).on( 'beforeunload.wp-auth-check', function(e) {
-				e.originalEvent.returnValue = wp.i18n.__( 'Your session has expired. You can log in again from this page or go to the login page.' );
+			$( window ).on( 'beforeunload.wp-auth-check', function( event ) {
+				event.originalEvent.returnValue = window.wp.i18n.__( 'Your session has expired. You can log in again from this page or go to the login page.' );
 			});
 
-			frame = $('<iframe id="wp-auth-check-frame" frameborder="0">').attr( 'title', noframe.text() );
+			frame = $( '<iframe id="wp-auth-check-frame" frameborder="0">' ).attr( 'title', noframe.text() );
 			frame.on( 'load', function() {
 				var height, body;
 
@@ -35,10 +37,10 @@
 				form.removeClass( 'loading' );
 
 				try {
-					body = $(this).contents().find('body');
+					body = $( this ).contents().find( 'body' );
 					height = body.height();
-				} catch(e) {
-					wrap.addClass('fallback');
+				} catch( er ) {
+					wrap.addClass( 'fallback' );
 					parent.css( 'max-height', '' );
 					form.remove();
 					noframe.focus();
@@ -46,25 +48,26 @@
 				}
 
 				if ( height ) {
-					if ( body && body.hasClass('interim-login-success') )
+					if ( body && body.hasClass( 'interim-login-success' ) ) {
 						hide();
-					else
+					} else {
 						parent.css( 'max-height', height + 40 + 'px' );
+					}
 				} else if ( ! body || ! body.length ) {
 					// Catch "silent" iframe origin exceptions in WebKit
 					// after another page is loaded in the iframe.
-					wrap.addClass('fallback');
+					wrap.addClass( 'fallback' );
 					parent.css( 'max-height', '' );
 					form.remove();
 					noframe.focus();
 				}
-			}).attr( 'src', form.data('src') );
+			}).attr( 'src', form.data( 'src' ) );
 
 			form.append( frame );
 		}
 
 		$( 'body' ).addClass( 'modal-open' );
-		wrap.removeClass('hidden');
+		wrap.removeClass( 'hidden' );
 
 		if ( frame ) {
 			frame.focus();
@@ -75,7 +78,7 @@
 			 */
 			setTimeout( function() {
 				if ( ! loaded ) {
-					wrap.addClass('fallback');
+					wrap.addClass( 'fallback' );
 					form.remove();
 					noframe.focus();
 				}
@@ -92,24 +95,42 @@
 	 * @private
 	 */
 	function hide() {
-		$(window).off( 'beforeunload.wp-auth-check' );
+		var adminpage = window.adminpage,
+			wp        = window.wp;
+
+		$( window ).off( 'beforeunload.wp-auth-check' );
 
 		// When on the Edit Post screen, speed up heartbeat
 		// after the user logs in to quickly refresh nonces.
-		if ( typeof adminpage !== 'undefined' && ( adminpage === 'post-php' || adminpage === 'post-new-php' ) &&
-			typeof wp !== 'undefined' && wp.heartbeat ) {
-
-			$(document).off( 'heartbeat-tick.wp-auth-check' );
+		if ( ( adminpage === 'post-php' || adminpage === 'post-new-php' ) && wp && wp.heartbeat ) {
 			wp.heartbeat.connectNow();
 		}
 
 		wrap.fadeOut( 200, function() {
-			wrap.addClass('hidden').css('display', '');
-			$('#wp-auth-check-frame').remove();
+			wrap.addClass( 'hidden' ).css( 'display', '' );
+			$( '#wp-auth-check-frame' ).remove();
 			$( 'body' ).removeClass( 'modal-open' );
 		});
 	}
 
+	/**
+	 * Set or reset the tempHidden variable used to pause showing of the modal
+	 * after a user closes it without logging in.
+	 *
+	 * @since 5.5.0
+	 * @private
+	 */
+	function setShowTimeout() {
+		tempHidden = true;
+		window.clearTimeout( tempHiddenTimeout );
+		tempHiddenTimeout = window.setTimeout(
+			function() {
+				tempHidden = false;
+			},
+			300000 // 5 min.
+		);
+	}
+
 	/**
 	 * Binds to the Heartbeat Tick event.
 	 *
@@ -126,9 +147,9 @@
 	 */
 	$( document ).on( 'heartbeat-tick.wp-auth-check', function( e, data ) {
 		if ( 'wp-auth-check' in data ) {
-			if ( ! data['wp-auth-check'] && wrap.hasClass('hidden') ) {
+			if ( ! data['wp-auth-check'] && wrap.hasClass( 'hidden' ) && ! tempHidden ) {
 				show();
-			} else if ( data['wp-auth-check'] && ! wrap.hasClass('hidden') ) {
+			} else if ( data['wp-auth-check'] && ! wrap.hasClass( 'hidden' ) ) {
 				hide();
 			}
 		}
@@ -141,9 +162,10 @@
 		 *
 		 * @since 3.6.0
 		 */
-		wrap = $('#wp-auth-check-wrap');
-		wrap.find('.wp-auth-check-close').on( 'click', function() {
+		wrap = $( '#wp-auth-check-wrap' );
+		wrap.find( '.wp-auth-check-close' ).on( 'click', function() {
 			hide();
+			setShowTimeout();
 		});
 	});