<!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>[44917] trunk: Cron: Ensure identical single events aren't scheduled less than 10min apart.</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 { white-space: pre-line; 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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/44917">44917</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/44917","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-03-16 06:41:23 +0000 (Sat, 16 Mar 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Cron: Ensure identical single events aren't scheduled less than 10min apart.
Improves the logic in `wp_schedule_single_event()` to ensure an identical event is not scheduled within ten minutes.
This moves the logic for checking for identical events to be self contained rather than relying on `wp_next_scheduled()` as this fails to account for events with a past timestamp when wp-cron fails to trigger or for multiple identical events being scheduled already.
Props bodohugobarwich.
Fixes <a href="https://core.trac.wordpress.org/ticket/44818">#44818</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescronphp">trunk/src/wp-includes/cron.php</a></li>
<li><a href="#trunktestsphpunittestscronphp">trunk/tests/phpunit/tests/cron.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescronphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/cron.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/cron.php 2019-03-15 22:13:30 UTC (rev 44916)
+++ trunk/src/wp-includes/cron.php 2019-03-16 06:41:23 UTC (rev 44917)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -79,9 +79,49 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $pre;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Don't schedule a duplicate if there's already an identical event due within 10 minutes of it
- $next = wp_next_scheduled( $hook, $args );
- if ( $next && abs( $next - $timestamp ) <= 10 * MINUTE_IN_SECONDS ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Check for a duplicated event.
+ *
+ * Don't schedule an event if there's already an identical event
+ * within 10 minutes.
+ *
+ * When scheduling events within ten minutes of the current time,
+ * all past identical events are considered duplicates.
+ *
+ * When scheduling an event with a past timestamp (ie, before the
+ * current time) all events scheduled within the next ten minutes
+ * are considered duplicates.
+ */
+ $crons = (array) _get_cron_array();
+ $key = md5( serialize( $event->args ) );
+ $duplicate = false;
+
+ if ( $event->timestamp < time() + 10 * MINUTE_IN_SECONDS ) {
+ $min_timestamp = 0;
+ } else {
+ $min_timestamp = $event->timestamp - 10 * MINUTE_IN_SECONDS;
+ }
+
+ if ( $event->timestamp < time() ) {
+ $max_timestamp = time() + 10 * MINUTE_IN_SECONDS;
+ } else {
+ $max_timestamp = $event->timestamp + 10 * MINUTE_IN_SECONDS;
+ }
+
+ foreach ( $crons as $event_timestamp => $cron ) {
+ if ( $event_timestamp < $min_timestamp ) {
+ continue;
+ }
+ if ( $event_timestamp > $max_timestamp ) {
+ break;
+ }
+ if ( isset( $cron[ $event->hook ][ $key ] ) ) {
+ $duplicate = true;
+ break;
+ }
+ }
+
+ if ( $duplicate ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -107,9 +147,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $key = md5( serialize( $event->args ) );
-
- $crons = _get_cron_array();
</del><span class="cx" style="display: block; padding: 0 10px"> $crons[ $event->timestamp ][ $event->hook ][ $key ] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'schedule' => $event->schedule,
</span><span class="cx" style="display: block; padding: 0 10px"> 'args' => $event->args,
</span></span></pre></div>
<a id="trunktestsphpunittestscronphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/cron.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/cron.php 2019-03-15 22:13:30 UTC (rev 44916)
+++ trunk/tests/phpunit/tests/cron.php 2019-03-16 06:41:23 UTC (rev 44917)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -596,4 +596,88 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( wp_get_scheduled_event( $hook, $args, 'Words Fail!' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Ensure any past event counts as a duplicate.
+ *
+ * @ticket 44818
+ */
+ function test_duplicate_past_event() {
+ $hook = __FUNCTION__;
+ $args = array( 'arg1' );
+ $ts1 = strtotime( '-14 minutes' );
+ $ts2 = strtotime( '+5 minutes' );
+ $ts3 = strtotime( '-2 minutes' );
+
+ // First event scheduled successfully.
+ $this->assertTrue( wp_schedule_single_event( $ts1, $hook, $args ) );
+
+ // Second event fails.
+ $this->assertFalse( wp_schedule_single_event( $ts2, $hook, $args ) );
+
+ // Third event fails.
+ $this->assertFalse( wp_schedule_single_event( $ts3, $hook, $args ) );
+ }
+
+ /**
+ * Ensure any near future event counts as a duplicate.
+ *
+ * @ticket 44818
+ */
+ function test_duplicate_near_future_event() {
+ $hook = __FUNCTION__;
+ $args = array( 'arg1' );
+ $ts1 = strtotime( '+4 minutes' );
+ $ts2 = strtotime( '-15 minutes' );
+ $ts3 = strtotime( '+12 minutes' );
+
+ // First event scheduled successfully.
+ $this->assertTrue( wp_schedule_single_event( $ts1, $hook, $args ) );
+
+ // Second event fails.
+ $this->assertFalse( wp_schedule_single_event( $ts2, $hook, $args ) );
+
+ // Third event fails.
+ $this->assertFalse( wp_schedule_single_event( $ts3, $hook, $args ) );
+ }
+
+ /**
+ * Duplicate future events are disallowed.
+ *
+ * @ticket 44818
+ */
+ function test_duplicate_future_event() {
+ $hook = __FUNCTION__;
+ $args = array( 'arg1' );
+ $ts1 = strtotime( '+15 minutes' );
+ $ts2 = strtotime( '-600 seconds', $ts1 );
+ $ts3 = strtotime( '+600 seconds', $ts1 );
+
+ // First event scheduled successfully.
+ $this->assertTrue( wp_schedule_single_event( $ts1, $hook, $args ) );
+
+ // Events within ten minutes should fail.
+ $this->assertFalse( wp_schedule_single_event( $ts2, $hook, $args ) );
+ $this->assertFalse( wp_schedule_single_event( $ts3, $hook, $args ) );
+ }
+
+ /**
+ * Future events are allowed.
+ *
+ * @ticket 44818
+ */
+ function test_not_duplicate_future_event() {
+ $hook = __FUNCTION__;
+ $args = array( 'arg1' );
+ $ts1 = strtotime( '+15 minutes' );
+ $ts2 = strtotime( '-601 seconds', $ts1 );
+ $ts3 = strtotime( '+601 seconds', $ts1 );
+
+ // First event scheduled successfully.
+ $this->assertTrue( wp_schedule_single_event( $ts1, $hook, $args ) );
+
+ // Events over ten minutes should work.
+ $this->assertTrue( wp_schedule_single_event( $ts2, $hook, $args ) );
+ $this->assertTrue( wp_schedule_single_event( $ts3, $hook, $args ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>