Ticket #49693: 49693-2.patch

src/wp-includes/cron.php

@@ -179 +179 @@
  *
  * @link https://developer.wordpress.org/reference/functions/wp_schedule_event/
  *
- * @param int    $timestamp  Unix timestamp (UTC) for when to next run the event.
- * @param string $recurrence How often the event should subsequently recur. See wp_get_schedules() for accepted values.
- * @param string $hook       Action hook to execute when the event is run.
- * @param array  $args       Optional. Array containing each separate argument to pass to the hook's callback function.
+ * @param int    $timestamp    Unix timestamp (UTC) for when to next run the event.
+ * @param string $recurrence   How often the event should subsequently recur. See wp_get_schedules() for accepted values.
+ * @param string $hook         Action hook to execute when the event is run.
+ * @param array  $args         Optional. Array containing each separate argument to pass to the hook's callback function.
+ * @param bool   $rescheduling Optional. Whether this is an event rescheduling. Mostly for internal use.
  * @return bool True if event successfully scheduled. False for failure.
  */
-function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array() ) {
+function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array(), $rescheduling = false ) {
         // Make sure timestamp is a positive integer.
         if ( ! is_numeric( $timestamp ) || $timestamp <= 0 ) {
                 return false;
@@ -220 +221 @@
         }
 
         $key = md5( serialize( $event->args ) );
+        $crons = (array) _get_cron_array();
+
+        // If we're not rescheduling an event, drop if it has the same hook, args and schedule.
+        if ( false === $rescheduling ) {
+                foreach ( $crons as $event_timestamp => $cron ) {
+                        if ( isset( $cron[ $event->hook ][ $key ] ) && $cron[ $event->hook ][ $key ]['schedule'] === $event->schedule ) {
+                                return false;
+                        }
+                }
+        }
 
-        $crons = _get_cron_array();
         $crons[ $event->timestamp ][ $event->hook ][ $key ] = array(
                 'schedule' => $event->schedule,
                 'args'     => $event->args,
@@ -320 +330 @@
                 $timestamp = $now + ( $interval - ( ( $now - $timestamp ) % $interval ) );
         }
 
-        return wp_schedule_event( $timestamp, $recurrence, $hook, $args );
+        return wp_schedule_event( $timestamp, $recurrence, $hook, $args, true );
 }
 
 /**

tests/phpunit/tests/cron.php

@@ -534 +534 @@
          * @ticket 45976.
          */
         function test_get_scheduled_event_recurring() {
-                $hook     = __FUNCTION__;
-                $args     = array( 'arg1' );
-                $ts_late  = strtotime( '+30 minutes' );
-                $ts_next  = strtotime( '+3 minutes' );
-                $schedule = 'hourly';
-                $interval = HOUR_IN_SECONDS;
+                $hook         = __FUNCTION__;
+                $args         = array( 'arg1' );
+                $ts_late      = strtotime( '+30 minutes' );
+                $ts_next      = strtotime( '+3 minutes' );
+                $schedule_one = 'hourly';
+                $schedule_two = 'daily';
+                $interval_one = HOUR_IN_SECONDS;
+                $interval_two = DAY_IN_SECONDS;
 
                 $expected1 = (object) array(
                         'hook'      => $hook,
                         'timestamp' => $ts_late,
-                        'schedule'  => $schedule,
+                        'schedule'  => $schedule_one,
                         'args'      => $args,
-                        'interval'  => $interval,
+                        'interval'  => $interval_one,
                 );
 
                 $expected2 = (object) array(
                         'hook'      => $hook,
                         'timestamp' => $ts_next,
-                        'schedule'  => $schedule,
+                        'schedule'  => $schedule_two,
                         'args'      => $args,
-                        'interval'  => $interval,
+                        'interval'  => $interval_two,
                 );
 
                 // Schedule late running event.
-                wp_schedule_event( $ts_late, $schedule, $hook, $args );
+                wp_schedule_event( $ts_late, $schedule_one, $hook, $args );
                 // Schedule next running event.
-                wp_schedule_event( $ts_next, $schedule, $hook, $args );
+                wp_schedule_event( $ts_next, $schedule_two, $hook, $args );
 
                 // Late running, timestamp specified.
                 $this->assertEquals( $expected1, wp_get_scheduled_event( $hook, $args, $ts_late ) );
@@ -680 +682 @@
                 $this->assertTrue( wp_schedule_single_event( $ts2, $hook, $args ) );
                 $this->assertTrue( wp_schedule_single_event( $ts3, $hook, $args ) );
         }
+
+        /**
+         * Recurring events that have the same hook, args and schedule are not allowed.
+         *
+         * @ticket 49693
+         */
+        function test_duplicate_recurring_event() {
+                $hook           = __FUNCTION__;
+                $args           = array( 'arg1' );
+                $timestamp      = strtotime( '+60 minutes' );
+                $timestamp_next = strtotime( '+120 minutes' );
+                $schedule       = 'hourly';
+
+                // Schedule recurring event.
+                $this->assertNotFalse( wp_schedule_event( $timestamp, $schedule, $hook, $args ) );
+                // Make sure the event is correctly scheduled
+                $this->assertNotFalse( wp_get_scheduled_event( $hook, $args ) );
+
+                $expected = _get_cron_array();
+
+                // Scheduling the same recurring event (hook and args), but with different timestamp should fail.
+                $this->assertFalse( wp_schedule_event( $timestamp_next, $schedule, $hook, $args ) );
+
+                // Check cron option is unchanged.
+                $this->assertEquals( $expected, _get_cron_array() );
+        }
+
+        /**
+         * Recurring events that have the same hook but different args or schedule are allowed.
+         *
+         * @ticket 49693
+         */
+        function test_not_duplicate_recurring_event() {
+                $hook         = __FUNCTION__;
+                $args_one     = array( 'arg1' );
+                $args_two     = array( 'arg2' );
+                $timestamp    = strtotime( '+60 minutes' );
+                $schedule_one = 'hourly';
+                $schedule_two = 'daily';
+
+                // Schedule recurring event.
+                $this->assertNotFalse( wp_schedule_event( $timestamp, $schedule_one, $hook, $args_one ) );
+
+                // Schedule recurring event as above, but with different schedule is allowed.
+                $this->assertNotFalse( wp_schedule_event( $timestamp, $schedule_two, $hook, $args_one ) );
+
+                // Schedule recurring event as above, but with different args is allowed.
+                $this->assertNotFalse( wp_schedule_event( $timestamp, $schedule_one, $hook, $args_two ) );
+        }
+
+        /**
+         * Make sure that rescheduling still works after duplicate removal.
+         *
+         * @ticket 49693
+         */
+        function test_reschedule_recurring_event() {
+                $hook   = __FUNCTION__;
+                $ts_one = strtotime( '+30 minutes' );
+
+                // Confirm there's no events.
+                $this->assertEmpty( _get_cron_array() );
+
+                // Add an event.
+                $this->assertTrue( wp_schedule_event( $ts_one, 'hourly', $hook ) );
+
+                // Reschedule it.
+                $this->assertNotFalse( wp_reschedule_event( $ts_one, 'hourly', $hook ) );
+
+                // Make sure the original event is still there.
+                $this->assertNotFalse( wp_get_scheduled_event( $hook, array(), $ts_one ) );
+
+                // Make sure the rescheduled event is also there.
+                $this->assertEquals( 2, count( _get_cron_array() ) );
+        }
 }