<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[26428] trunk/src: Heartbeat: introduce "suspend" functionality and enable it after 20 min.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/26428">26428</a></dd>
<dt>Author</dt> <dd>azaozz</dd>
<dt>Date</dt> <dd>2013-11-27 01:55:59 +0000 (Wed, 27 Nov 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Heartbeat: introduce "suspend" functionality and enable it after 20 min. of inactivity, see <a href="http://core.trac.wordpress.org/ticket/25073">#25073</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesmiscphp">trunk/src/wp-admin/includes/misc.php</a></li>
<li><a href="#trunksrcwpincludesjsheartbeatjs">trunk/src/wp-includes/js/heartbeat.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesmiscphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/includes/misc.php (26427 => 26428)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/includes/misc.php 2013-11-27 01:41:27 UTC (rev 26427)
+++ trunk/src/wp-admin/includes/misc.php 2013-11-27 01:55:59 UTC (rev 26428)
</span><span class="lines">@@ -739,3 +739,19 @@
</span><span class="cx"> return $response;
</span><span class="cx"> }
</span><span class="cx"> add_filter( 'heartbeat_received', 'wp_refresh_post_nonces', 10, 3 );
</span><ins>+
+/**
+ * Disable suspending of Heartbeat on the Add/Edit Post screens
+ *
+ * @since 3.8
+ */
+function wp_disable_heartbeat_suspend( $settings ) {
+ global $pagenow;
+
+ if ( 'post.php' === $pagenow || 'post-new.php' === $pagenow ) {
+ $settings['suspend'] = 'disable';
+ }
+
+ return $settings;
+}
+add_filter( 'heartbeat_settings', 'wp_disable_heartbeat_suspend' );
</ins></span></pre></div>
<a id="trunksrcwpincludesjsheartbeatjs"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/js/heartbeat.js (26427 => 26428)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/js/heartbeat.js 2013-11-27 01:41:27 UTC (rev 26427)
+++ trunk/src/wp-includes/js/heartbeat.js 2013-11-27 01:55:59 UTC (rev 26428)
</span><span class="lines">@@ -34,9 +34,12 @@
</span><span class="cx"> var Heartbeat = function() {
</span><span class="cx"> var $document = $(document),
</span><span class="cx"> settings = {
</span><del>- // Used to stop the "beat"
- isRunning: true,
</del><ins>+ // Suspend/resume
+ suspend: false,
</ins><span class="cx">
</span><ins>+ // Whether suspending is enabled
+ suspendEnabled: true,
+
</ins><span class="cx"> // Current screen id, defaults to the JS global 'pagenow' when present (in the admin) or 'front'
</span><span class="cx"> screenId: '',
</span><span class="cx">
</span><span class="lines">@@ -128,6 +131,10 @@
</span><span class="cx"> if ( ! settings.screenId ) {
</span><span class="cx"> settings.screenId = options.screenId || 'front';
</span><span class="cx"> }
</span><ins>+
+ if ( options.suspend === 'disable' ) {
+ settings.suspendEnabled = false;
+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // Convert to milliseconds
</span><span class="lines">@@ -145,7 +152,12 @@
</span><span class="cx"> focused();
</span><span class="cx"> }).on( 'unload.wp-heartbeat', function() {
</span><span class="cx"> // Don't connect any more
</span><del>- settings.isRunning = false;
</del><ins>+ settings.suspend = true;
+
+ // Abort the last request if not completed
+ if ( settings.xhr && settings.xhr.readyState !== 4 ) {
+ settings.xhr.abort();
+ }
</ins><span class="cx"> });
</span><span class="cx">
</span><span class="cx"> // Check for user activity every 30 seconds.
</span><span class="lines">@@ -274,7 +286,7 @@
</span><span class="cx">
</span><span class="cx"> // If the connection to the server is slower than the interval,
</span><span class="cx"> // heartbeat connects as soon as the previous connection's response is received.
</span><del>- if ( settings.connecting ) {
</del><ins>+ if ( settings.connecting || settings.suspend ) {
</ins><span class="cx"> return;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -351,7 +363,7 @@
</span><span class="cx"> var delta = time() - settings.lastTick,
</span><span class="cx"> interval = settings.mainInterval;
</span><span class="cx">
</span><del>- if ( ! settings.isRunning ) {
</del><ins>+ if ( settings.suspend ) {
</ins><span class="cx"> return;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -403,6 +415,9 @@
</span><span class="cx"> clearFocusTimers();
</span><span class="cx"> settings.userActivity = time();
</span><span class="cx">
</span><ins>+ // Resume if suspended
+ settings.suspend = false;
+
</ins><span class="cx"> if ( ! settings.hasFocus ) {
</span><span class="cx"> settings.hasFocus = true;
</span><span class="cx"> scheduleNextTick();
</span><span class="lines">@@ -513,6 +528,11 @@
</span><span class="cx"> blurred();
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ if ( settings.suspendEnabled && lastActive > 1200000 ) {
+ // Suspend after 20 min. of inactivity
+ settings.suspend = true;
+ }
+
</ins><span class="cx"> if ( ! settings.userActivityEvents ) {
</span><span class="cx"> $document.on( 'mouseover.wp-heartbeat-active keyup.wp-heartbeat-active', function(){ userIsActive(); } );
</span><span class="cx">
</span><span class="lines">@@ -562,6 +582,19 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Disable suspending
+ *
+ * Should be used only when Heartbeat is performing critical tasks like autosave, post-locking, etc.
+ * Using this on many screens may overload the user's hosting account if several
+ * browser windows/tabs are left open for a long time.
+ *
+ * @return void
+ */
+ function disableSuspend() {
+ settings.suspendEnabled = false;
+ }
+
+ /**
</ins><span class="cx"> * Get/Set the interval
</span><span class="cx"> *
</span><span class="cx"> * When setting to 'fast' or 5, by default interval is 5 sec. for the next 30 ticks (for 2 min and 30 sec).
</span><span class="lines">@@ -691,6 +724,7 @@
</span><span class="cx"> return {
</span><span class="cx"> hasFocus: hasFocus,
</span><span class="cx"> connectNow: connectNow,
</span><ins>+ disableSuspend: disableSuspend,
</ins><span class="cx"> setInterval: setInterval,
</span><span class="cx"> hasConnectionError: hasConnectionError,
</span><span class="cx"> enqueue: enqueue,
</span></span></pre>
</div>
</div>
</body>
</html>