WordPress 4.4
[autoinstalls/wordpress.git] / wp-includes / cron.php
index be9ea67e3c71c1ed5e9aa642e2df31584429b07b..60492c5d045a97391afe096989c4aeb675250592 100644 (file)
@@ -8,26 +8,48 @@
 /**
  * Schedules a hook to run only once.
  *
- * Schedules a hook which will be executed once by the Wordpress actions core at
+ * Schedules a hook which will be executed once by the WordPress actions core at
  * a time which you specify. The action will fire off when someone visits your
  * WordPress site, if the schedule time has passed.
  *
  * @since 2.1.0
- * @link http://codex.wordpress.org/Function_Reference/wp_schedule_single_event
+ * @link https://codex.wordpress.org/Function_Reference/wp_schedule_single_event
  *
  * @param int $timestamp Timestamp for when to run the event.
  * @param string $hook Action hook to execute when cron is run.
  * @param array $args Optional. Arguments to pass to the hook's callback function.
+ * @return false|void False when an event is not scheduled.
  */
 function wp_schedule_single_event( $timestamp, $hook, $args = array()) {
-       // don't schedule a duplicate if there's already an identical event due in the next 10 minutes
+       // Make sure timestamp is a positive integer
+       if ( ! is_numeric( $timestamp ) || $timestamp <= 0 ) {
+               return false;
+       }
+
+       // 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 && $next <= $timestamp + 600 )
-               return;
+       if ( $next && abs( $next - $timestamp ) <= 10 * MINUTE_IN_SECONDS ) {
+               return false;
+       }
 
        $crons = _get_cron_array();
-       $key = md5(serialize($args));
-       $crons[$timestamp][$hook][$key] = array( 'schedule' => false, 'args' => $args );
+       $event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => false, 'args' => $args );
+       /**
+        * Filter a single event before it is scheduled.
+        *
+        * @since 3.1.0
+        *
+        * @param object $event An object containing an event's data.
+        */
+       $event = apply_filters( 'schedule_event', $event );
+
+       // A plugin disallowed this event
+       if ( ! $event )
+               return false;
+
+       $key = md5(serialize($event->args));
+
+       $crons[$event->timestamp][$event->hook][$key] = array( 'schedule' => $event->schedule, 'args' => $event->args );
        uksort( $crons, "strnatcasecmp" );
        _set_cron_array( $crons );
 }
@@ -39,24 +61,42 @@ function wp_schedule_single_event( $timestamp, $hook, $args = array()) {
  * specific interval, specified by you. The action will trigger when someone
  * visits your WordPress site, if the scheduled time has passed.
  *
- * Valid values for the recurrence are hourly, daily and twicedaily.  These can
+ * Valid values for the recurrence are hourly, daily and twicedaily. These can
  * be extended using the cron_schedules filter in wp_get_schedules().
  *
+ * Use wp_next_scheduled() to prevent duplicates
+ *
  * @since 2.1.0
  *
  * @param int $timestamp Timestamp for when to run the event.
  * @param string $recurrence How often the event should recur.
  * @param string $hook Action hook to execute when cron is run.
  * @param array $args Optional. Arguments to pass to the hook's callback function.
- * @return bool|null False on failure, null when complete with scheduling event.
+ * @return false|void False when an event is not scheduled.
  */
 function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array()) {
+       // Make sure timestamp is a positive integer
+       if ( ! is_numeric( $timestamp ) || $timestamp <= 0 ) {
+               return false;
+       }
+
        $crons = _get_cron_array();
        $schedules = wp_get_schedules();
-       $key = md5(serialize($args));
+
        if ( !isset( $schedules[$recurrence] ) )
                return false;
-       $crons[$timestamp][$hook][$key] = array( 'schedule' => $recurrence, 'args' => $args, 'interval' => $schedules[$recurrence]['interval'] );
+
+       $event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => $recurrence, 'args' => $args, 'interval' => $schedules[$recurrence]['interval'] );
+       /** This filter is documented in wp-includes/cron.php */
+       $event = apply_filters( 'schedule_event', $event );
+
+       // A plugin disallowed this event
+       if ( ! $event )
+               return false;
+
+       $key = md5(serialize($event->args));
+
+       $crons[$event->timestamp][$event->hook][$key] = array( 'schedule' => $event->schedule, 'args' => $event->args, 'interval' => $event->interval );
        uksort( $crons, "strnatcasecmp" );
        _set_cron_array( $crons );
 }
@@ -70,30 +110,39 @@ function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array()) {
  * @param string $recurrence How often the event should recur.
  * @param string $hook Action hook to execute when cron is run.
  * @param array $args Optional. Arguments to pass to the hook's callback function.
- * @return bool|null False on failure. Null when event is rescheduled.
+ * @return false|void False when an event is not scheduled.
  */
-function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array()) {
+function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array() ) {
+       // Make sure timestamp is a positive integer
+       if ( ! is_numeric( $timestamp ) || $timestamp <= 0 ) {
+               return false;
+       }
+
        $crons = _get_cron_array();
        $schedules = wp_get_schedules();
-       $key = md5(serialize($args));
+       $key = md5( serialize( $args ) );
        $interval = 0;
 
        // First we try to get it from the schedule
-       if ( 0 == $interval )
-               $interval = $schedules[$recurrence]['interval'];
+       if ( isset( $schedules[ $recurrence ] ) ) {
+               $interval = $schedules[ $recurrence ]['interval'];
+       }
        // Now we try to get it from the saved interval in case the schedule disappears
-       if ( 0 == $interval )
-               $interval = $crons[$timestamp][$hook][$key]['interval'];
+       if ( 0 == $interval ) {
+               $interval = $crons[ $timestamp ][ $hook ][ $key ]['interval'];
+       }
        // Now we assume something is wrong and fail to schedule
-       if ( 0 == $interval )
+       if ( 0 == $interval ) {
                return false;
+       }
 
        $now = time();
 
-    if ( $timestamp >= $now )
-        $timestamp = $now + $interval;
-    else
-        $timestamp = $now + ($interval - (($now - $timestamp) % $interval));
+       if ( $timestamp >= $now ) {
+               $timestamp = $now + $interval;
+       } else {
+               $timestamp = $now + ( $interval - ( ( $now - $timestamp ) % $interval ) );
+       }
 
        wp_schedule_event( $timestamp, $recurrence, $hook, $args );
 }
@@ -112,8 +161,14 @@ function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array()) {
  * Although not passed to a callback function, these arguments are used
  * to uniquely identify the scheduled event, so they should be the same
  * as those used when originally scheduling the event.
+ * @return false|void False when an event is not unscheduled.
  */
 function wp_unschedule_event( $timestamp, $hook, $args = array() ) {
+       // Make sure timestamp is a positive integer
+       if ( ! is_numeric( $timestamp ) || $timestamp <= 0 ) {
+               return false;
+       }
+
        $crons = _get_cron_array();
        $key = md5(serialize($args));
        unset( $crons[$timestamp][$hook][$key] );
@@ -130,13 +185,29 @@ function wp_unschedule_event( $timestamp, $hook, $args = array() ) {
  * @since 2.1.0
  *
  * @param string $hook Action hook, the execution of which will be unscheduled.
- * @param mixed $args,... Optional. Event arguments.
+ * @param array $args Optional. Arguments that were to be pass to the hook's callback function.
  */
-function wp_clear_scheduled_hook( $hook ) {
-       $args = array_slice( func_get_args(), 1 );
+function wp_clear_scheduled_hook( $hook, $args = array() ) {
+       // Backward compatibility
+       // Previously this function took the arguments as discrete vars rather than an array like the rest of the API
+       if ( !is_array($args) ) {
+               _deprecated_argument( __FUNCTION__, '3.0', __('This argument has changed to an array to match the behavior of the other cron functions.') );
+               $args = array_slice( func_get_args(), 1 );
+       }
+
+       // This logic duplicates wp_next_scheduled()
+       // It's required due to a scenario where wp_unschedule_event() fails due to update_option() failing,
+       // and, wp_next_scheduled() returns the same schedule in an infinite loop.
+       $crons = _get_cron_array();
+       if ( empty( $crons ) )
+               return;
 
-       while ( $timestamp = wp_next_scheduled( $hook, $args ) )
-               wp_unschedule_event( $timestamp, $hook, $args );
+       $key = md5( serialize( $args ) );
+       foreach ( $crons as $timestamp => $cron ) {
+               if ( isset( $cron[ $hook ][ $key ] ) ) {
+                       wp_unschedule_event( $timestamp, $hook, $args );
+               }
+       }
 }
 
 /**
@@ -146,7 +217,7 @@ function wp_clear_scheduled_hook( $hook ) {
  *
  * @param string $hook Action hook to execute when cron is run.
  * @param array $args Optional. Arguments to pass to the hook's callback function.
- * @return bool|int The UNIX timestamp of the next time the scheduled event will occur.
+ * @return false|int The UNIX timestamp of the next time the scheduled event will occur.
  */
 function wp_next_scheduled( $hook, $args = array() ) {
        $crons = _get_cron_array();
@@ -164,36 +235,28 @@ function wp_next_scheduled( $hook, $args = array() ) {
  * Send request to run cron through HTTP request that doesn't halt page loading.
  *
  * @since 2.1.0
- *
- * @return null Cron could not be spawned, because it is not needed to run.
  */
-function spawn_cron( $local_time = 0 ) {
-
-       if ( !$local_time )
-               $local_time = time();
+function spawn_cron( $gmt_time = 0 ) {
+       if ( ! $gmt_time )
+               $gmt_time = microtime( true );
 
        if ( defined('DOING_CRON') || isset($_GET['doing_wp_cron']) )
                return;
 
        /*
-        * do not even start the cron if local server timer has drifted
-        * such as due to power failure, or misconfiguration
+        * Get the cron lock, which is a unix timestamp of when the last cron was spawned
+        * and has not finished running.
+        *
+        * Multiple processes on multiple web servers can run this code concurrently,
+        * this lock attempts to make spawning as atomic as possible.
         */
-       $timer_accurate = check_server_timer( $local_time );
-       if ( !$timer_accurate )
-               return;
-
-       /*
-       * multiple processes on multiple web servers can run this code concurrently
-       * try to make this as atomic as possible by setting doing_cron switch
-       */
-       $flag = get_transient('doing_cron');
+       $lock = get_transient('doing_cron');
 
-       if ( $flag > $local_time + 10*60 )
-               $flag = 0;
+       if ( $lock > $gmt_time + 10 * MINUTE_IN_SECONDS )
+               $lock = 0;
 
        // don't run if another process is currently running it or more than once every 60 sec.
-       if ( $flag + 60 > $local_time )
+       if ( $lock + WP_CRON_LOCK_TIMEOUT > $gmt_time )
                return;
 
        //sanity check
@@ -202,42 +265,72 @@ function spawn_cron( $local_time = 0 ) {
                return;
 
        $keys = array_keys( $crons );
-       if ( isset($keys[0]) && $keys[0] > $local_time )
+       if ( isset($keys[0]) && $keys[0] > $gmt_time )
                return;
 
-       if ( defined('ALTERNATE_WP_CRON') && ALTERNATE_WP_CRON ) {
-               if ( !empty($_POST) || defined('DOING_AJAX') )
+       if ( defined( 'ALTERNATE_WP_CRON' ) && ALTERNATE_WP_CRON ) {
+               if ( 'GET' !== $_SERVER['REQUEST_METHOD'] || defined( 'DOING_AJAX' ) ||  defined( 'XMLRPC_REQUEST' ) ) {
                        return;
+               }
 
-               set_transient( 'doing_cron', $local_time );
+               $doing_wp_cron = sprintf( '%.22F', $gmt_time );
+               set_transient( 'doing_cron', $doing_wp_cron );
 
                ob_start();
-               wp_redirect( add_query_arg('doing_wp_cron', '', stripslashes($_SERVER['REQUEST_URI'])) );
+               wp_redirect( add_query_arg( 'doing_wp_cron', $doing_wp_cron, wp_unslash( $_SERVER['REQUEST_URI'] ) ) );
                echo ' ';
 
                // flush any buffers and send the headers
                while ( @ob_end_flush() );
                flush();
 
-               @include_once(ABSPATH . 'wp-cron.php');
+               WP_DEBUG ? include_once( ABSPATH . 'wp-cron.php' ) : @include_once( ABSPATH . 'wp-cron.php' );
                return;
        }
 
-       set_transient( 'doing_cron', $local_time );
-
-       $cron_url = get_option( 'siteurl' ) . '/wp-cron.php?doing_wp_cron';
-       wp_remote_post( $cron_url, array('timeout' => 0.01, 'blocking' => false, 'sslverify' => apply_filters('https_local_ssl_verify', true)) );
+       // Set the cron lock with the current unix timestamp, when the cron is being spawned.
+       $doing_wp_cron = sprintf( '%.22F', $gmt_time );
+       set_transient( 'doing_cron', $doing_wp_cron );
+
+       /**
+        * Filter the cron request arguments.
+        *
+        * @since 3.5.0
+        *
+        * @param array $cron_request_array {
+        *     An array of cron request URL arguments.
+        *
+        *     @type string $url  The cron request URL.
+        *     @type int    $key  The 22 digit GMT microtime.
+        *     @type array  $args {
+        *         An array of cron request arguments.
+        *
+        *         @type int  $timeout   The request timeout in seconds. Default .01 seconds.
+        *         @type bool $blocking  Whether to set blocking for the request. Default false.
+        *         @type bool $sslverify Whether SSL should be verified for the request. Default false.
+        *     }
+        * }
+        */
+       $cron_request = apply_filters( 'cron_request', array(
+               'url'  => add_query_arg( 'doing_wp_cron', $doing_wp_cron, site_url( 'wp-cron.php' ) ),
+               'key'  => $doing_wp_cron,
+               'args' => array(
+                       'timeout'   => 0.01,
+                       'blocking'  => false,
+                       /** This filter is documented in wp-includes/class-wp-http-streams.php */
+                       'sslverify' => apply_filters( 'https_local_ssl_verify', false )
+               )
+       ) );
+
+       wp_remote_post( $cron_request['url'], $cron_request['args'] );
 }
 
 /**
  * Run scheduled callbacks or spawn cron for all scheduled events.
  *
  * @since 2.1.0
- *
- * @return null When doesn't need to run Cron.
  */
 function wp_cron() {
-
        // Prevent infinite loops caused by lack of wp-cron.php
        if ( strpos($_SERVER['REQUEST_URI'], '/wp-cron.php') !== false || ( defined('DISABLE_WP_CRON') && DISABLE_WP_CRON ) )
                return;
@@ -245,18 +338,18 @@ function wp_cron() {
        if ( false === $crons = _get_cron_array() )
                return;
 
-       $local_time = time();
+       $gmt_time = microtime( true );
        $keys = array_keys( $crons );
-       if ( isset($keys[0]) && $keys[0] > $local_time )
+       if ( isset($keys[0]) && $keys[0] > $gmt_time )
                return;
 
        $schedules = wp_get_schedules();
        foreach ( $crons as $timestamp => $cronhooks ) {
-               if ( $timestamp > $local_time ) break;
+               if ( $timestamp > $gmt_time ) break;
                foreach ( (array) $cronhooks as $hook => $args ) {
                        if ( isset($schedules[$hook]['callback']) && !call_user_func( $schedules[$hook]['callback'] ) )
                                continue;
-                       spawn_cron( $local_time );
+                       spawn_cron( $gmt_time );
                        break 2;
                }
        }
@@ -276,17 +369,17 @@ function wp_cron() {
  * 60*60*24*7 or 604800. The value of 'interval' would then be 604800.
  *
  * The 'display' is the description. For the 'weekly' key, the 'display' would
- * be <code>__('Once Weekly')</code>.
+ * be `__( 'Once Weekly' )`.
  *
  * For your plugin, you will be passed an array. you can easily add your
  * schedule by doing the following.
- * <code>
- * // filter parameter variable name is 'array'
- *     $array['weekly'] = array(
- *             'interval' => 604800,
- *             'display' => __('Once Weekly')
- *     );
- * </code>
+ *
+ *     // Filter parameter variable name is 'array'.
+ *     $array['weekly'] = array(
+ *         'interval' => 604800,
+ *                'display'  => __( 'Once Weekly' )
+ *     );
+ *
  *
  * @since 2.1.0
  *
@@ -294,10 +387,17 @@ function wp_cron() {
  */
 function wp_get_schedules() {
        $schedules = array(
-               'hourly' => array( 'interval' => 3600, 'display' => __('Once Hourly') ),
-               'twicedaily' => array( 'interval' => 43200, 'display' => __('Twice Daily') ),
-               'daily' => array( 'interval' => 86400, 'display' => __('Once Daily') ),
+               'hourly'     => array( 'interval' => HOUR_IN_SECONDS,      'display' => __( 'Once Hourly' ) ),
+               'twicedaily' => array( 'interval' => 12 * HOUR_IN_SECONDS, 'display' => __( 'Twice Daily' ) ),
+               'daily'      => array( 'interval' => DAY_IN_SECONDS,       'display' => __( 'Once Daily' ) ),
        );
+       /**
+        * Filter the non-default cron schedules.
+        *
+        * @since 2.1.0
+        *
+        * @param array $new_schedules An array of non-default cron schedules. Default empty.
+        */
        return array_merge( apply_filters( 'cron_schedules', array() ), $schedules );
 }
 
@@ -308,7 +408,7 @@ function wp_get_schedules() {
  *
  * @param string $hook Action hook to execute when cron is run.
  * @param array $args Optional. Arguments to pass to the hook's callback function.
- * @return string|bool False, if no schedule. Schedule on success.
+ * @return string|false False, if no schedule. Schedule on success.
  */
 function wp_get_schedule($hook, $args = array()) {
        $crons = _get_cron_array();
@@ -332,7 +432,7 @@ function wp_get_schedule($hook, $args = array()) {
  * @since 2.1.0
  * @access private
  *
- * @return array CRON info array.
+ * @return false|array CRON info array.
  */
 function _get_cron_array()  {
        $cron = get_option('cron');
@@ -388,10 +488,3 @@ function _upgrade_cron_array($cron) {
        update_option( 'cron', $new_cron );
        return $new_cron;
 }
-
-// stub for checking server timer accuracy, using outside standard time sources
-function check_server_timer( $local_time ) {
-       return true;
-}
-
-?>