<!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>[18659] trunk: Improve cron locking.</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, #logmsg > ol { margin-left: 0; 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/18659">18659</a></dd>
<dt>Author</dt> <dd>ryan</dd>
<dt>Date</dt> <dd>2011-09-09 19:59:44 +0000 (Fri, 09 Sep 2011)</dd>
</dl>

<h3>Log Message</h3>
<pre>Improve cron locking. Avoid multiple cron processes looping over the same events. fixes <a href="http://core.trac.wordpress.org/ticket/17462">#17462</a></pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpcronphp">trunk/wp-cron.php</a></li>
<li><a href="#trunkwpincludescachephp">trunk/wp-includes/cache.php</a></li>
<li><a href="#trunkwpincludescronphp">trunk/wp-includes/cron.php</a></li>
<li><a href="#trunkwpincludesdefaultconstantsphp">trunk/wp-includes/default-constants.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpcronphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-cron.php (18658 => 18659)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-cron.php        2011-09-09 17:53:41 UTC (rev 18658)
+++ trunk/wp-cron.php        2011-09-09 19:59:44 UTC (rev 18659)
</span><span class="lines">@@ -26,6 +26,24 @@
</span><span class="cx">         require_once('./wp-load.php');
</span><span class="cx"> }
</span><span class="cx"> 
</span><ins>+// Uncached doing_cron transient fetch
+function _get_cron_lock() {
+        global $_wp_using_ext_object_cache, $wpdb;
+
+        $value = 0;
+        if ( $_wp_using_ext_object_cache ) {
+                // Skip local cache and force refetch of doing_cron transient in case
+                // another processs updated the cache
+                $value = wp_cache_get( 'doing_cron', 'transient', true );
+        } else {
+                $row = $wpdb-&gt;get_row( $wpdb-&gt;prepare( &quot;SELECT option_value FROM $wpdb-&gt;options WHERE option_name = %s LIMIT 1&quot;, '_transient_doing_cron' ) );
+                if ( is_object( $row ) )
+                        $value = $row-&gt;option_value;
+        }
+
+        return $value;
+}
+
</ins><span class="cx"> if ( false === $crons = _get_cron_array() )
</span><span class="cx">         die();
</span><span class="cx"> 
</span><span class="lines">@@ -35,26 +53,52 @@
</span><span class="cx"> if ( isset($keys[0]) &amp;&amp; $keys[0] &gt; $local_time )
</span><span class="cx">         die();
</span><span class="cx"> 
</span><del>-foreach ($crons as $timestamp =&gt; $cronhooks) {
</del><ins>+$doing_cron_transient = get_transient( 'doing_cron');
+
+// Use global $doing_wp_cron lock otherwise use the GET lock. If no lock, trying grabbing a new lock.
+if ( empty( $doing_wp_cron ) ) {
+        if ( empty( $_GET[ 'doing_wp_cron' ] ) ) {
+                // Called from external script/job. Try setting a lock.
+                if ( $doing_cron_transient &amp;&amp; ( $doing_cron_transient + WP_CRON_LOCK_TIMEOUT &gt; $local_time ) )
+                        return;
+                $doing_cron_transient = $doing_wp_cron = time();
+                set_transient( 'doing_cron', $doing_wp_cron );
+        } else {
+                $doing_wp_cron = $_GET[ 'doing_wp_cron' ];
+        }
+}
+
+// Check lock
+if ( $doing_cron_transient != $doing_wp_cron )
+        return;
+
+foreach ( $crons as $timestamp =&gt; $cronhooks ) {
</ins><span class="cx">         if ( $timestamp &gt; $local_time )
</span><span class="cx">                 break;
</span><span class="cx"> 
</span><del>-        foreach ($cronhooks as $hook =&gt; $keys) {
</del><ins>+        foreach ( $cronhooks as $hook =&gt; $keys ) {
</ins><span class="cx"> 
</span><del>-                foreach ($keys as $k =&gt; $v) {
</del><ins>+                foreach ( $keys as $k =&gt; $v ) {
</ins><span class="cx"> 
</span><span class="cx">                         $schedule = $v['schedule'];
</span><span class="cx"> 
</span><del>-                        if ($schedule != false) {
</del><ins>+                        if ( $schedule != false ) {
</ins><span class="cx">                                 $new_args = array($timestamp, $schedule, $hook, $v['args']);
</span><span class="cx">                                 call_user_func_array('wp_reschedule_event', $new_args);
</span><span class="cx">                         }
</span><span class="cx"> 
</span><del>-                        wp_unschedule_event($timestamp, $hook, $v['args']);
</del><ins>+                        wp_unschedule_event( $timestamp, $hook, $v['args'] );
</ins><span class="cx"> 
</span><del>-                         do_action_ref_array($hook, $v['args']);
</del><ins>+                         do_action_ref_array( $hook, $v['args'] );
+
+                        // If the hook ran too long and another cron process stole the lock, quit.
+                        if ( _get_cron_lock() != $doing_wp_cron )
+                                return;
</ins><span class="cx">                 }
</span><span class="cx">         }
</span><span class="cx"> }
</span><span class="cx"> 
</span><ins>+if ( _get_cron_lock() == $doing_wp_cron )
+        delete_transient( 'doing_cron' );
+
</ins><span class="cx"> die();
</span></span></pre></div>
<a id="trunkwpincludescachephp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/cache.php (18658 => 18659)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/cache.php        2011-09-09 17:53:41 UTC (rev 18658)
+++ trunk/wp-includes/cache.php        2011-09-09 19:59:44 UTC (rev 18659)
</span><span class="lines">@@ -102,13 +102,14 @@
</span><span class="cx">  *
</span><span class="cx">  * @param int|string $key What the contents in the cache are called
</span><span class="cx">  * @param string $group Where the cache contents are grouped
</span><ins>+ * @param bool $force Whether to force an update of the local cache from the persistent cache (default is false)
</ins><span class="cx">  * @return bool|mixed False on failure to retrieve contents or the cache
</span><span class="cx">  *                contents on success
</span><span class="cx">  */
</span><del>-function wp_cache_get($key, $group = '') {
</del><ins>+function wp_cache_get( $key, $group = '', $force = false ) {
</ins><span class="cx">         global $wp_object_cache;
</span><span class="cx"> 
</span><del>-        return $wp_object_cache-&gt;get($key, $group);
</del><ins>+        return $wp_object_cache-&gt;get( $key, $group, $force );
</ins><span class="cx"> }
</span><span class="cx"> 
</span><span class="cx"> /**
</span><span class="lines">@@ -403,10 +404,11 @@
</span><span class="cx">          *
</span><span class="cx">          * @param int|string $key What the contents in the cache are called
</span><span class="cx">          * @param string $group Where the cache contents are grouped
</span><ins>+         * @param string $force Whether to force a refetch rather than relying on the local cache (default is false)
</ins><span class="cx">          * @return bool|mixed False on failure to retrieve contents or the cache
</span><span class="cx">          *                contents on success
</span><span class="cx">          */
</span><del>-        function get($key, $group = 'default') {
</del><ins>+        function get( $key, $group = 'default', $force = false) {
</ins><span class="cx">                 if ( empty ($group) )
</span><span class="cx">                         $group = 'default';
</span><span class="cx"> 
</span></span></pre></div>
<a id="trunkwpincludescronphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/cron.php (18658 => 18659)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/cron.php        2011-09-09 17:53:41 UTC (rev 18658)
+++ trunk/wp-includes/cron.php        2011-09-09 19:59:44 UTC (rev 18659)
</span><span class="lines">@@ -204,13 +204,13 @@
</span><span class="cx">         * multiple processes on multiple web servers can run this code concurrently
</span><span class="cx">         * try to make this as atomic as possible by setting doing_cron switch
</span><span class="cx">         */
</span><del>-        $flag = get_transient('doing_cron');
</del><ins>+        $lock = get_transient('doing_cron');
</ins><span class="cx"> 
</span><del>-        if ( $flag &gt; $local_time + 10*60 )
-                $flag = 0;
</del><ins>+        if ( $lock &gt; $local_time + 10*60 )
+                $lock = 0;
</ins><span class="cx"> 
</span><span class="cx">         // don't run if another process is currently running it or more than once every 60 sec.
</span><del>-        if ( $flag + 60 &gt; $local_time )
</del><ins>+        if ( $lock + WP_CRON_LOCK_TIMEOUT &gt; $local_time )
</ins><span class="cx">                 return;
</span><span class="cx"> 
</span><span class="cx">         //sanity check
</span><span class="lines">@@ -226,10 +226,11 @@
</span><span class="cx">                 if ( !empty($_POST) || defined('DOING_AJAX') )
</span><span class="cx">                         return;
</span><span class="cx"> 
</span><del>-                set_transient( 'doing_cron', $local_time );
</del><ins>+                $doing_wp_cron = $local_time;
+                set_transient( 'doing_cron', $doing_wp_cron );
</ins><span class="cx"> 
</span><span class="cx">                 ob_start();
</span><del>-                wp_redirect( add_query_arg('doing_wp_cron', '', stripslashes($_SERVER['REQUEST_URI'])) );
</del><ins>+                wp_redirect( add_query_arg('doing_wp_cron', $doing_wp_cron, stripslashes($_SERVER['REQUEST_URI'])) );
</ins><span class="cx">                 echo ' ';
</span><span class="cx"> 
</span><span class="cx">                 // flush any buffers and send the headers
</span><span class="lines">@@ -240,9 +241,10 @@
</span><span class="cx">                 return;
</span><span class="cx">         }
</span><span class="cx"> 
</span><del>-        set_transient( 'doing_cron', $local_time );
</del><ins>+        $doing_wp_cron = $local_time;
+        set_transient( 'doing_cron', $doing_wp_cron );
</ins><span class="cx"> 
</span><del>-        $cron_url = get_option( 'siteurl' ) . '/wp-cron.php?doing_wp_cron';
</del><ins>+        $cron_url = get_option( 'siteurl' ) . '/wp-cron.php?doing_wp_cron=' . $doing_wp_cron;
</ins><span class="cx">         wp_remote_post( $cron_url, array('timeout' =&gt; 0.01, 'blocking' =&gt; false, 'sslverify' =&gt; apply_filters('https_local_ssl_verify', true)) );
</span><span class="cx"> }
</span><span class="cx"> 
</span></span></pre></div>
<a id="trunkwpincludesdefaultconstantsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/default-constants.php (18658 => 18659)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/default-constants.php        2011-09-09 17:53:41 UTC (rev 18658)
+++ trunk/wp-includes/default-constants.php        2011-09-09 19:59:44 UTC (rev 18659)
</span><span class="lines">@@ -268,6 +268,12 @@
</span><span class="cx"> 
</span><span class="cx">         if ( !defined('WP_POST_REVISIONS') )
</span><span class="cx">                 define('WP_POST_REVISIONS', true);
</span><ins>+
+        /**
+         * @since 3.3.0
+         */
+        if ( !defined( 'WP_CRON_LOCK_TIMEOUT' ) )
+                define('WP_CRON_LOCK_TIMEOUT', 60);  // In seconds
</ins><span class="cx"> }
</span><span class="cx"> 
</span><span class="cx"> /**
</span></span></pre>
</div>
</div>

</body>
</html>