Changeset 48337

Timestamp:

07/06/2020 04:12:24 PM (3 years ago)

Author:

azaozz

Message:

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.

File:

• trunk/src/js/_enqueues/lib/auth-check.js (modified) (9 diffs)

trunk/src/js/_enqueues/lib/auth-check.js

@@ -6 +6 @@
 
 /* global adminpage */
-(function($){
-    var wrap;
+( function( $ ) {
+    var wrap,
+        tempHidden,
+        tempHiddenTimeout;
 
     /**
@@ -16 +18 @@
      */
     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;
@@ -36 +38 @@
 
                 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();
@@ -47 +49 @@
 
                 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 );
@@ -65 +68 @@
 
         $( 'body' ).addClass( 'modal-open' );
-        wrap.removeClass('hidden');
+        wrap.removeClass( 'hidden' );
 
         if ( frame ) {
@@ -76 +79 @@
             setTimeout( function() {
                 if ( ! loaded ) {
-                    wrap.addClass('fallback');
+                    wrap.addClass( 'fallback' );
                     form.remove();
                     noframe.focus();
@@ -93 +96 @@
      */
     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.
+        );
     }
 
@@ -127 +148 @@
     $( 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();
             }
@@ -142 +163 @@
          * @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();
         });
     });