Ticket #23295: 23295.patch

wp-includes/default-filters.php

@@ -293 +293 @@
 // Default settings for heartbeat
 add_filter( 'heartbeat_settings', 'wp_heartbeat_settings' );
 
+// Ready WP_Auth_Check
+add_action( 'init', 'wp_auth_check_load' );
+
+
 unset($filter, $action);
+
+//EOF

wp-includes/js/wp-auth-check.js

@@ +1 @@
+/**
+ * WP Auth Check object
+ */
+wp_auth_check = {
+
+        /**
+         * Holds the button state so we aren't unnecessarily enabling/disabling
+         * and so we don't have to continually check a bunch of stuff
+         *
+         * @var bool
+         */
+        buttons_disabled: false,
+
+        /**
+         * Holds the ID of the notice container so that the notice parts can be abstracted out
+         *
+         * @var string
+         */
+        notice_container_id: "wp-auth-check-notice",
+
+        /**
+         * Holds the notice container's jQuery object
+         *
+         * @var obj|null
+         */
+        notice_container: null,
+
+        /**
+         * Boots up the wp_auth_check object and heartbeat listener
+         *
+         * @return void
+         */
+        init: function() {
+                if ( "true" == wp_auth_check_opts.is_interim_login ) {
+                        this.hijack_interim_login_close_button();
+                        return; // no auth check on the login screen
+                }
+
+                jQuery( document ).on( "heartbeat-tick.auth-check", function( e, data ) {
+                        if ( ! data["auth-check"] ) {
+                                wp_auth_check.show_login_notice();
+                                return;
+                        }
+
+                        if ( "logged_in" == data["auth-check"] ) {
+                                wp_auth_check.hide_login_notice();
+                                return;
+                        }
+
+                        var container_html = ( data["auth-check-html"] ) ? data["auth-check-html"] : "";
+
+                        wp_auth_check.show_login_notice( container_html );
+                } );
+
+        },
+
+        /**
+         * Display a login window and disable the save buttons
+         * show_notice() has been abstracted out to make it easier to refactor it
+         * into a more generic notification object for general use.
+         *
+         * @return void
+         */
+        show_login_notice: function( container_html ) {
+                if ( this.notice_is_visible() ) {
+                        return;
+                }
+
+                var message = "<p>" + wp_auth_check_text.not_logged_in + "</p>";
+                message += '<p><a href="#" class="button" onclick="wp_auth_check.show_interim_login();">' + wp_auth_check_text.log_in + '</a></p>';
+                message += "<p>" + wp_auth_check_text.after_login_button + "</p>";
+
+                wp_auth_check.show_notice( message, container_html );
+
+                wp_auth_check.disable_action_buttons();
+        },
+
+        /**
+         * Hides the notice container and re-enables action buttons
+         * hide_notice() has been abstracted out to make it easier to refactor it
+         * into a more generic notification object for general use.
+         *
+         * @return void
+         */
+        hide_login_notice: function() {
+                if ( ! this.notice_is_visible() ) {
+                        return;
+                }
+
+                this.hide_notice();
+
+                this.enable_action_buttons();
+        },
+
+        /**
+         * Fills the notice window with the interim login page
+         *
+         * @return void
+         */
+        show_interim_login: function() {
+                this.notice_container.html( "" ).html( '<iframe width="' + this.notice_container.width() + '" height="' + this.notice_container.height() + '" src="' + wp_auth_check_opts.login_url + '"></iframe>' );
+        },
+
+        /**
+         * Targets the "Close" button on wp-login.php's "interim login"
+         * screen, and binds the click event to close the modal dialogue.
+         *
+         * @return void
+         */
+        hijack_interim_login_close_button: function() {
+                jQuery( "#login :button" ).click( function( e ) {
+                        parent.window.wp_auth_check.hide_notice();
+                        e.preventDefault();
+                        return false;
+                } );
+        },
+
+        /**
+         * Creates a nice notice overlay on the screen.
+         * Based on P2's newNotification() function
+         *
+         * @param message HTML to put in the notice container
+         * @param container_html
+         * @return void
+         */
+        show_notice: function( message, container_html ) {
+                if ( this.notice_is_visible() ) {
+                        return;
+                }
+
+                jQuery("body").append( container_html );
+
+                this.notice_container = jQuery( "#" + this.notice_container_id );
+
+                // Calculate the highest z-index on the page, so that this can overlay
+                // on top of it
+                var highest_z_index = parseInt( this.notice_container.css( "z-index" ) );
+                jQuery( "body" ).find( "*" ).each( function() {
+                        var this_z_index = parseInt( jQuery( this ).css( "z-index" ) );
+                        if ( ( ! isNaN( this_z_index ) ) && this_z_index > highest_z_index ) {
+                                highest_z_index = this_z_index;
+                        }
+                } );
+
+                this.notice_container
+                        .css( "z-index", ( highest_z_index + 1 ) )
+                        .stop( true )
+                        .prepend( message )
+                        .fadeIn();
+        },
+
+        /**
+         * Hides the #wp-auth-check-notice modal dialogue and re-enables save buttons
+         *
+         * @return void
+         */
+        hide_notice: function() {
+                if ( ! this.notice_is_visible() ) {
+                        return;
+                }
+
+                this.notice_container
+                        .stop( true )
+                        .fadeOut( "fast" )
+                        .remove();
+
+                this.notice_container = null;
+        },
+
+        /**
+         * Helper method for checking whether the notice container is present and visible
+         *
+         * @return bool
+         */
+        notice_is_visible: function() {
+                return ( this.notice_container && this.notice_container.is( ":visible" ) );
+        },
+
+        /**
+         * Disable the save/publish/update/move to trash buttons.
+         *
+         * @return void
+         */
+        disable_action_buttons: function() {
+                if ( true == wp_auth_check.buttons_disabled ) {
+                        return;
+                }
+
+                blockSave = true;
+
+                jQuery( ":button, :submit, #post-preview, .submitdelete", "#submitpost" ).each( function() {
+                        var t = jQuery( this );
+                        if ( t.hasClass( "button-primary" ) )
+                                t.addClass( "button-primary-disabled" );
+                        else
+                                t.addClass( "button-disabled" );
+
+                        t.prop( "disabled", true );
+                } );
+
+                wp_auth_check.buttons_disabled = true;
+        },
+
+        /**
+         * Re-enable the save/publish/update/move to trash buttons.
+         *
+         * @return void
+         */
+        enable_action_buttons: function() {
+                if ( false == wp_auth_check.buttons_disabled ) {
+                        return;
+                }
+
+                blockSave = false;
+
+                jQuery( ":button, :submit, #post-preview, .submitdelete", "#submitpost" ).each( function() {
+                        var t = jQuery( this );
+                        if ( t.hasClass( "button-primary-disabled" ) )
+                                t.removeClass( "button-primary-disabled" );
+                        else
+                                t.removeClass( "button-disabled" );
+
+                        t.prop( "disabled", false );
+                } );
+
+                wp_auth_check.buttons_disabled = false;
+        }
+
+}
+
+jQuery( document ).ready( function() {
+        wp_auth_check.init();
+} );
+
+//EOF
+ No newline at end of file

wp-includes/functions.php

@@ -3883 +3883 @@
  */
 function wp_checkdate( $month, $day, $year, $source_date ) {
         return apply_filters( 'wp_checkdate', checkdate( $month, $day, $year ), $source_date );
-}
- No newline at end of file
+}
+
+/**
+ * Load the auth check, for monitoring whether the user is still logged in
+ *
+ * @since 3.6.0
+ *
+ * @return void
+ */
+function wp_auth_check_load() {
+        WP_Auth_Check::get_instance();
+}
+
+//EOF
+ No newline at end of file

wp-includes/class-wp-auth-check.php

@@ +1 @@
+<?php
+/**
+ * Test the user's current authorization state
+ *
+ * @package WordPress
+ * @since 3.6.0
+ */
+class WP_Auth_Check {
+
+        /**
+         * Holds the singleton instance of this object
+         */
+        private static $_instance = null;
+
+        /**
+         * Private constructor because we're a singleton
+         */
+        private function __construct() {}
+
+        /**
+         * Initialize the singleton
+         */
+        public static function get_instance() {
+                $this_class = get_called_class(); // gets the right class when this is extended
+                if ( ! ( self::$_instance instanceof $this_class ) ) {
+                        self::$_instance = new $this_class;
+                        self::$_instance->_init();
+                }
+
+                return self::$_instance;
+        }
+
+        /**
+         * Object init, sets up hooks. Not done in the constructor so that the
+         * _init() method may be extended without breaking the singleton.
+         */
+        protected function _init() {
+                add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
+
+                add_action( 'login_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
+
+                add_action( 'admin_footer', array( $this, 'render_notice_container' ) );
+
+                add_filter( 'heartbeat_send', array( $this, 'test_login' ) );
+
+        }
+
+        public function test_login( $response ) {
+                // There are 2 known instances of being logged out:
+                // 1) User's login has expired
+                // 2) User's /wp-admin/ auth cookie is missing
+                // Checking for those two scenarios in case we want to take different
+                // action for them in the future.
+                if ( ! isset( $_COOKIE[LOGGED_IN_COOKIE] ) ) {
+                        $response['auth-check'] = 'not_logged_in';
+                        $response['auth-check-html'] = $this->notice_container();
+                } elseif ( ! wp_validate_auth_cookie() ) {
+                        $response['auth-check'] = 'no_admin_auth';
+                        $response['auth-check-html'] = $this->notice_container();
+                } else {
+                        $response['auth-check'] = 'logged_in'; // This is what the AJAX poll looks for
+                }
+
+                return $response;
+        }
+
+        /**
+         * Enqueue styles, scripts and script data as needed
+         */
+        public function enqueue_scripts() {
+                wp_enqueue_script( 'wp-auth-check' );
+
+                $login_url = add_query_arg( array(
+                        'interim-login' => 'true',
+                ), wp_login_url( ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) );
+
+                // Overloading l10n to port variables from PHP to JS
+                wp_localize_script( 'wp-auth-check', 'wp_auth_check_opts', array(
+                        'login_url' => $login_url,
+                        'is_interim_login' => ( isset($GLOBALS['interim_login']) ) ? 'true' : 'false',
+                ) );
+
+        }
+
+        /**
+         * Enqueue javascript for the interim login screen
+         */
+        public function interim_login_enqueue() {
+                wp_enqueue_script( 'wp-auth-check' );
+        }
+
+        /**
+         * Adds a div for displaying the login notice
+         */
+        public function notice_container() {
+                // Inline CSS because it doesn't make sense to use a separate CSS file
+                // for 1 rule, and keeps the notice container portable.
+                $html = '
+<style>
+#wp-auth-check-notice {
+        background-color: rgba(0, 0, 0, 0.7);
+        color: #FFFFFF;
+        font-size: 1.5em;
+        text-align: center;
+        position: fixed;
+        display: none;
+        top: 30%;
+        left: 33%;
+        width: 50%;
+        height: 66%;
+        margin: -10% 0 0 -10%;
+        padding: 30px;
+        -webkit-border-radius: 10px;
+        -moz-border-radius: 10px;
+        border-radius: 10px;
+}
+</style>
+';
+                $html .= '<div id="wp-auth-check-notice"></div>';
+
+                return $html;
+        }
+
+}
+
+// EOF
+ No newline at end of file

wp-includes/script-loader.php

@@ -348 +348 @@
         $scripts->add( 'media-editor', "/wp-includes/js/media-editor$suffix.js", array( 'shortcode', 'media-views' ), false, 1 );
         $scripts->add( 'mce-view', "/wp-includes/js/mce-view$suffix.js", array( 'shortcode', 'media-models' ), false, 1 );
 
+        $scripts->add( 'wp-auth-check', "/wp-includes/js/wp-auth-check$suffix.js", array( 'jquery', 'heartbeat' ), false, 1 );
+        did_action( 'init' ) && $scripts->localize( 'wp-auth-check', 'wp_auth_check_text', array(
+                'not_logged_in'      => __( 'Oops! Looks like you are not logged in.' ),
+                'log_in'             => __( 'Log in' ),
+                'after_login_button' => __( 'You will not leave this screen.' ),
+        ) );
+
         if ( is_admin() ) {
                 $scripts->add( 'ajaxcat', "/wp-admin/js/cat$suffix.js", array( 'wp-lists' ) );
                 $scripts->add_data( 'ajaxcat', 'group', 1 );
@@ -876 +883 @@
 
 add_action( 'wp_default_styles', 'wp_default_styles' );
 add_filter( 'style_loader_src', 'wp_style_loader_src', 10, 2 );
+
+//EOF
+ No newline at end of file

wp-settings.php

@@ -142 +142 @@
 require( ABSPATH . WPINC . '/nav-menu.php' );
 require( ABSPATH . WPINC . '/nav-menu-template.php' );
 require( ABSPATH . WPINC . '/admin-bar.php' );
+require( ABSPATH . WPINC . '/class-wp-auth-check.php' );
 
 // Load multisite-specific files.
 if ( is_multisite() ) {
@@ -325 +326 @@
  * @since 3.0.0
  */
 do_action('wp_loaded');
+
+//EOF