class-events-store.php 16.5 KB
Newer Older
Erick Hitter's avatar
Erick Hitter committed
1
2
3
4
5
6
7
8
9
10
11
12
<?php

namespace Automattic\WP\Cron_Control;

class Events_Store extends Singleton {
	/**
	 * PLUGIN SETUP
	 */

	/**
	 * Class properties
	 */
13
	const TABLE_SUFFIX = 'a8c_cron_control_jobs';
14
15
16

	const DB_VERSION        = 1;
	const DB_VERSION_OPTION = 'a8c_cron_control_db_version';
17
	const TABLE_CREATE_LOCK = 'a8c_cron_control_creating_table';
18

19
20
21
22
23
24
25
26
27
	const STATUS_PENDING   = 'pending';
	const STATUS_RUNNING   = 'running';
	const STATUS_COMPLETED = 'complete';

	const CACHE_KEY = 'a8c_cron_ctrl_option';

	private $option_before_unscheduling = null;

	private $job_creation_suspended = false;
Erick Hitter's avatar
Erick Hitter committed
28
29
30
31

	/**
	 * Register hooks
	 */
32
33
	protected function class_init() {
		// Check that the table exists and is the correct version
34
		$this->prepare_tables();
35
36
37
38

		// Option interception
		add_filter( 'pre_option_cron', array( $this, 'get_option' ) );
		add_filter( 'pre_update_option_cron', array( $this, 'update_option' ), 10, 2 );
Erick Hitter's avatar
Erick Hitter committed
39
40
41

		// Disallow duplicates
		add_filter( 'schedule_event', array( $this, 'block_creation_if_job_exists' ) );
42
43
44
45
46
	}

	/**
	 * Build appropriate table name for this install
	 */
47
	public function get_table_name() {
48
49
50
51
52
		global $wpdb;

		return $wpdb->base_prefix . self::TABLE_SUFFIX;
	}

Erick Hitter's avatar
Erick Hitter committed
53
54
55
56
57
58
59
60
61
62
63
	/**
	 * Build array of valid event statuses
	 */
	public function get_allowed_statuses() {
		return array(
			self::STATUS_PENDING,
			self::STATUS_RUNNING,
			self::STATUS_COMPLETED,
		);
	}

64
65
66
	/**
	 * Create the plugin's DB table when necessary
	 */
67
	protected function prepare_tables() {
68
69
70
71
72
		// Nothing to do
		if ( (int) get_option( self::DB_VERSION_OPTION ) === self::DB_VERSION ) {
			return;
		}

73
74
75
76
77
		// Limit chance of race conditions when creating table
		if ( false === wp_cache_add( self::TABLE_CREATE_LOCK, 1, null, 1 * \MINUTE_IN_SECONDS ) ) {
			return;
		}

78
79
80
81
82
83
84
85
		// Use Core's method of creating/updating tables
		if ( ! function_exists( 'dbDelta' ) ) {
			require_once ABSPATH . '/wp-admin/includes/upgrade.php';
		}

		global $wpdb;

		// Define schema and create the table
86
		$schema = "CREATE TABLE `{$this->get_table_name()}` (
87
			`ID` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
88
89
90

			`timestamp` bigint(20) unsigned NOT NULL,
			`action` varchar(255) NOT NULL,
91
			`action_hashed` varchar(32) NOT NULL,
92
93
94
95
			`instance` varchar(32) NOT NULL,

			`args` longtext NOT NULL,
			`schedule` varchar(255) DEFAULT NULL,
96
97
			`interval` int unsigned DEFAULT 0,
			`status` varchar(32) NOT NULL DEFAULT 'pending',
98
99
100
101

			`created` datetime NOT NULL,
			`last_modified` datetime NOT NULL,

Erick Hitter's avatar
Erick Hitter committed
102
			PRIMARY KEY (`ID`),
103
			UNIQUE KEY `ts_action_instance` (`timestamp`, `action`, `instance`, `status`)
104
105
106
107
108
109
110
111
112
113
114
115
116
		) ENGINE=InnoDB;\n";

		dbDelta( $schema, true );

		// Confirm that the table was created, and set the option to prevent further updates
		$table_count = count( $wpdb->get_col( "SHOW TABLES LIKE '{$this->get_table_name()}'" ) );

		if ( 1 === $table_count ) {
			update_option( self::DB_VERSION_OPTION, self::DB_VERSION, true );
		} else {
			delete_option( self::DB_VERSION_OPTION );
		}
	}
117
118
119
120
121
122

	/**
	 * PLUGIN FUNCTIONALITY
	 */

	/**
123
	 * Override cron option requests with data from custom table
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
	 */
	public function get_option() {
		// Use cached value for reads, except when we're unscheduling and state is important
		if ( ! $this->is_unscheduling() ) {
			$cached_option = wp_cache_get( self::CACHE_KEY, null, true );

			if ( false !== $cached_option ) {
				return $cached_option;
			}
		}

		// Start building a new cron option
		$cron_array = array(
			'version' => 2, // Core versions the cron array; without this, events will continually requeue
		);

		// Get events to re-render as the cron option
		$page = 1;

		do {
			$jobs_posts = $this->get_jobs( array(
				'status'   => self::STATUS_PENDING,
				'quantity' => 100,
				'page'     => 1,
			) );

			// Nothing more to add
			if ( empty( $jobs_posts ) ) {
				break;
			}

			$page++;

			// Something's probably wrong if a site has more than 1,500 pending cron actions
			if ( $page > 15 ) {
				do_action( 'a8c_cron_control_stopped_runaway_cron_option_rebuild' );
				break;
			}

			// Loop through results and built output Core expects
			if ( ! empty( $jobs_posts ) ) {
				foreach ( $jobs_posts as $jobs_post ) {
					// Alias event timestamp
167
					$timestamp = $jobs_post->timestamp;
168
169
170
171
172
173
174
175
176
177
178
179
180
181

					// If timestamp is invalid, event is removed to let its source fix it
					if ( $timestamp <= 0 ) {
						$this->mark_job_record_completed( $jobs_post->ID );
						continue;
					}

					// Basic arguments to add a job to the array format Core expects
					$action   = $jobs_post->action;
					$instance = $jobs_post->instance;

					// Populate remaining job data
					$cron_array[ $timestamp ][ $action ][ $instance ] = array(
						'schedule' => $jobs_post->schedule,
182
						'args'     => $jobs_post->args,
183
						'interval' => 0,
184
185
186
					);

					if ( isset( $jobs_post->interval ) ) {
187
						$cron_array[ $timestamp ][ $action ][ $instance ]['interval'] = $jobs_post->interval;
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
					}

				}
			}
		} while( true );

		// Re-sort the array just as Core does when events are scheduled
		// Ensures events are sorted chronologically
		uksort( $cron_array, 'strnatcasecmp' );

		// If we're unscheduling an event, hold onto the previous value so we can identify what's unscheduled
		if ( $this->is_unscheduling() ) {
			$this->option_before_unscheduling = $cron_array;
		} else {
			$this->option_before_unscheduling = null;
		}

		// Cache the results, bearing in mind that they won't be used during unscheduling events
		wp_cache_set( self::CACHE_KEY, $cron_array, null, 1 * \HOUR_IN_SECONDS );

		return $cron_array;
	}

	/**
	 * Handle requests to update the cron option
	 *
	 * By returning $old_value, `cron` option won't be updated
	 */
	public function update_option( $new_value, $old_value ) {
217
218
219
		if ( $this->is_scheduling() ) {
			$this->convert_option( $new_value );
		} elseif ( $this->is_unscheduling() ) {
220
221
			$this->unschedule_job( $new_value, $this->option_before_unscheduling );
		} else {
222
			$this->force_update( $new_value );
223
224
225
226
227
		}

		return $old_value;
	}

228
229
230
231
232
233
	/**
	 * Overwrite all existing data with a new value
	 */
	private function force_update( $new_value ) {
		global $wpdb;

234
		// Remove all existing data
235
		$this->suspend_event_creation();
236

237
238
239
		$wpdb->update( $this->get_table_name(), array( 'status' => self::STATUS_COMPLETED, ), array( 'status' => self::STATUS_PENDING, ) );
		$wpdb->update( $this->get_table_name(), array( 'status' => self::STATUS_COMPLETED, ), array( 'status' => self::STATUS_RUNNING, ) );
		$this->option_before_unscheduling = null;
240

241
		$this->flush_internal_caches();
242

243
244
		$this->resume_event_creation();

245
		// Write new events to store
246
247
248
		$this->convert_option( $new_value );
	}

249
250
251
252
253
254
255
256
257
258
259
260
	/**
	 * Delete jobs that are unscheduled using `wp_unschedule_event()`
	 */
	private function unschedule_job( $new_value, $old_value ) {
		$jobs = $this->find_unscheduled_jobs( $new_value, $old_value );

		foreach ( $jobs as $job ) {
			$this->mark_job_completed( $job['timestamp'], $job['action'], $job['instance'] );
		}
	}

	/**
261
	 * Save cron events in custom table
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
	 */
	private function convert_option( $new_value ) {
		if ( is_array( $new_value ) && ! empty( $new_value ) ) {
			$events = collapse_events_array( $new_value );

			foreach ( $events as $event ) {
				$job_exists = $this->job_exists( $event['timestamp'], $event['action'], $event['instance'] );

				if ( ! $job_exists ) {
					$this->create_or_update_job( $event['timestamp'], $event['action'], $event['args'] );
				}
			}
		}
	}

Erick Hitter's avatar
Erick Hitter committed
277
278
279
280
281
282
283
284
285
286
287
288
	/**
	 * When an entry exists, don't try to create it again
	 */
	public function block_creation_if_job_exists( $job ) {
		$instance = md5( maybe_serialize( $job->args ) );
		if ( $this->job_exists( $job->timestamp, $job->hook, $instance ) ) {
			return false;
		}

		return $job;
	}

289
290
291
292
293
	/**
	 * PLUGIN UTILITY METHODS
	 */

	/**
Erick Hitter's avatar
Erick Hitter committed
294
295
296
297
	 * Retrieve jobs given a set of parameters
	 *
	 * @param array $args
	 * @return array|false
298
	 */
299
	public function get_jobs( $args ) {
300
301
302
303
304
305
306
307
308
309
310
311
312
		global $wpdb;

		if ( ! isset( $args['quantity'] ) || ! is_numeric( $args['quantity'] ) ) {
			$args['quantity'] = 100;
		}

		if ( isset( $args['page'] ) ) {
			$page  = max( 0, $args['page'] - 1 );
			$offset = $page * $args['quantity'];
		} else {
			$offset = 0;
		}

313
		$jobs = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$this->get_table_name()} WHERE status = %s ORDER BY timestamp ASC LIMIT %d,%d;", $args['status'], $offset, $args['quantity'] ), 'OBJECT' );
314
315
316
317
318
319
320
321

		if ( is_array( $jobs ) ) {
			$jobs = array_map( array( $this, 'format_job' ), $jobs );
		} else {
			$jobs = false;
		}

		return $jobs;
322
323
	}

324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
	/**
	 * Retrieve a single event by ID, or by a combination of its timestamp, instance identifier, and either action or the action's hashed representation
	 *
	 * @param  array $attrs Array of event attributes to query by
	 * @return object|false
	 */
	public function get_job( $attrs ) {
		global $wpdb;

		// Validate basic inputs
		if ( ! is_array( $attrs ) || empty( $attrs ) ) {
			return false;
		}

		// Validate requested status
Erick Hitter's avatar
Erick Hitter committed
339
340
		$allowed_status = $this->get_allowed_statuses();
		$allowed_status[] = 'any';
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387

		if ( ! isset( $attrs['status'] ) || ! in_array( $attrs['status'], $allowed_status, true ) ) {
			$attrs['status'] = self::STATUS_PENDING;
		}

		// Validate attributes provided to query for a post
		if ( isset( $attrs['ID'] ) ) {
			$query = $wpdb->prepare( "SELECT * FROM {$this->get_table_name()} WHERE ID = %d", $attrs['ID'] );
		} else {
			// Need a timestamp, an instance, and either an action or its hashed representation
			if ( ! isset( $attrs['timestamp'] ) || ! isset( $attrs['instance'] ) ) {
				return false;
			} elseif ( ! isset( $attrs['action'] ) && ! isset( $attrs['action_hashed'] ) ) {
				return false;
			}

			// Build query
			if ( isset( $attrs['action'] ) ) {
				$action_column = 'action';
				$action_value  = $attrs['action'];
			} else {
				$action_column = 'action_hashed';
				$action_value  = $attrs['action_hashed'];
			}

			$query = $wpdb->prepare( "SELECT * FROM {$this->get_table_name()} WHERE timestamp = %d AND {$action_column} = %s AND instance = %s", $attrs['timestamp'], $action_value, $attrs['instance'] );
		}

		// Final query preparations
		if ( 'any' !== $attrs['status'] ) {
			$query .= " AND status = '{$attrs['status']}'";
		}

		$query .= ' LIMIT 1';

		// Query and format results
		$job = $wpdb->get_row( $query );

		if ( is_object( $job ) && ! is_wp_error( $job ) ) {
			$job = $this->format_job( $job );
		} else {
			$job = false;
		}

		return $job;
	}

388
389
	/**
	 * Standardize formatting and expand serialized data
390
391
392
	 *
	 * @param  object $job Job row from DB, in object form
	 * @return object
393
	 */
394
395
396
	private function format_job( $job ) {
		if ( ! is_object( $job ) || is_wp_error( $job ) ) {
			return $job;
397
398
		}

399
400
401
402
		$job->ID        = (int) $job->ID;
		$job->timestamp = (int) $job->timestamp;
		$job->interval  = (int) $job->interval;
		$job->args      = maybe_unserialize( $job->args );
403

404
405
406
407
		if ( empty( $job->schedule ) ) {
			$job->schedule = false;
		}

408
		return $job;
409
410
411
412
413
414
415
416
417
418
	}

	/**
	 * Check if a job post exists
	 *
	 * Uses a direct query to avoid stale caches that result in duplicate events
	 */
	public function job_exists( $timestamp, $action, $instance, $return_id = false ) {
		global $wpdb;

419
		$exists = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM {$this->get_table_name()} WHERE timestamp = %d AND action = %s AND instance = %s AND status = %s LIMIT 1;", $timestamp, $action, $instance, self::STATUS_PENDING ) );
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444

		if ( $return_id ) {
			return empty( $exists ) ? 0 : (int) array_shift( $exists );
		} else {
			return ! empty( $exists );
		}
	}

	/**
	 * Create a post object for a given event
	 *
	 * Can't call `wp_insert_post()` because `wp_unique_post_slug()` breaks the plugin's expectations
	 * Also doesn't call `wp_insert_post()` because this function is needed before post types and capabilities are ready.
	 */
	public function create_or_update_job( $timestamp, $action, $args, $update_id = null ) {
		// Don't create new jobs when manipulating jobs via the plugin's CLI commands
		if ( $this->job_creation_suspended ) {
			return;
		}

		global $wpdb;

		$job_post = array(
			'timestamp'     => $timestamp,
			'action'        => $action,
445
			'action_hashed' => md5( $action ),
446
			'instance'      => md5( maybe_serialize( $args['args'] ) ),
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
			'args'          => maybe_serialize( $args['args'] ),
			'last_modified' => current_time( 'mysql', true ),
		);

		if ( isset( $args['schedule'] ) && ! empty( $args['schedule'] ) ) {
			$job_post['schedule'] = $args['schedule'];
		}

		if ( isset( $args['interval'] ) && ! empty( $args['interval'] ) && is_numeric( $args['interval'] ) ) {
			$job_post['interval'] = (int) $args['interval'];
		}

		// Create the post, or update an existing entry to run again in the future
		if ( is_int( $update_id ) && $update_id > 0 ) {
			$wpdb->update( $this->get_table_name(), $job_post, array( 'ID' => $update_id, ) );
		} else {
Erick Hitter's avatar
Erick Hitter committed
463
			$job_post['created'] = current_time( 'mysql', true );
464
465
466
467

			$wpdb->insert( $this->get_table_name(), $job_post );
		}

Erick Hitter's avatar
Erick Hitter committed
468
		$this->flush_internal_caches();
469
470
471
	}

	/**
472
	 * Mark an event's entry as completed
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
	 *
	 * Completed entries will be cleaned up by an internal job
	 *
	 * @param $timestamp  int     Unix timestamp
	 * @param $action     string  name of action used when the event is registered (unhashed)
	 * @param $instance   string  md5 hash of the event's arguments array, which Core uses to index the `cron` option
	 *
	 * @return bool
	 */
	public function mark_job_completed( $timestamp, $action, $instance ) {
		$job_id = $this->job_exists( $timestamp, $action, $instance, true );

		if ( ! $job_id ) {
			return false;
		}

		return $this->mark_job_record_completed( $job_id );
	}

	/**
	 * Set a job post to the "completed" status
	 */
Erick Hitter's avatar
Erick Hitter committed
495
	public function mark_job_record_completed( $job_id, $flush_cache = true ) {
496
497
		global $wpdb;

Erick Hitter's avatar
Erick Hitter committed
498
		$success = $wpdb->update( $this->get_table_name(), array( 'status' => self::STATUS_COMPLETED, ), array( 'ID' => $job_id, ) );
499
500
501
502

		// Delete internal cache
		// Should only be skipped when deleting duplicates, as they are excluded from the cache
		if ( $flush_cache ) {
Erick Hitter's avatar
Erick Hitter committed
503
			$this->flush_internal_caches();
504
505
		}

Erick Hitter's avatar
Erick Hitter committed
506
		return (bool) $success;
507
508
	}

509
	/**
510
	 * Determine if current request is a call to one of Core's functions for scheduling events
511
512
513
	 *
	 * @return bool
	 */
514
	private function is_scheduling() {
515
516
		$trace = wp_debug_backtrace_summary( __CLASS__, null, false );

517
		$scheduling_callbacks = array(
518
519
520
521
			'wp_schedule_single_event',
			'wp_schedule_event',
		);

522
		$is_scheduling = false;
523

524
		foreach ( $scheduling_callbacks as $cb ) {
525
			if ( false !== array_search( $cb, $trace ) ) {
526
				$is_scheduling = true;
527
528
529
530
				break;
			}
		}

531
		return $is_scheduling;
532
533
	}

534
535
	/**
	 * Determine if current request is a call to `wp_unschedule_event()`
536
537
	 *
	 * @return bool
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
	 */
	private function is_unscheduling() {
		return false !== array_search( 'wp_unschedule_event', wp_debug_backtrace_summary( __CLASS__, null, false ) );
	}

	/**
	 * Identify jobs unscheduled using `wp_unschedule_event()` by comparing current value with previous
	 */
	private function find_unscheduled_jobs( $new, $old ) {
		$differences = array();

		$old = collapse_events_array( $old );

		foreach ( $old as $event ) {
			$timestamp = $event['timestamp'];
			$action    = $event['action'];
			$instance  = $event['instance'];

			if ( ! isset( $new[ $timestamp ][ $action ][ $instance ] ) ) {
				$differences[] = array(
					'timestamp' => $timestamp,
					'action'    => $action,
					'instance'  => $instance,
				);
			}
		}

		return $differences;
	}

Erick Hitter's avatar
Erick Hitter committed
568
569
570
571
572
573
574
	/**
	 * Delete the cached representation of the cron option
	 */
	public function flush_internal_caches() {
		return wp_cache_delete( self::CACHE_KEY );
	}

575
	/**
576
	 * Prevent event store from creating new entries
577
578
579
580
581
582
583
584
	 *
	 * Should be used sparingly, and followed by a call to resume_event_creation(), during bulk operations
	 */
	public function suspend_event_creation() {
		$this->job_creation_suspended = true;
	}

	/**
585
	 * Stop discarding events, once again storing them in the table
Erick Hitter's avatar
Erick Hitter committed
586
587
	 *
	 * First clears any completed events to free unique timestamp-action-instance key
588
589
	 */
	public function resume_event_creation() {
Erick Hitter's avatar
Erick Hitter committed
590
591
		$this->purge_completed_events();

592
593
594
595
596
597
598
599
600
601
602
		$this->job_creation_suspended = false;
	}

	/**
	 * Remove entries for non-recurring events that have been run
	 */
	public function purge_completed_events() {
		global $wpdb;

		$wpdb->delete( $this->get_table_name(), array( 'status' => self::STATUS_COMPLETED, ) );
	}
Erick Hitter's avatar
Erick Hitter committed
603
604
605
606
607
608
609
610
611
612

	/**
	 * Count number of events with a given status
	 *
	 * @param string $status
	 * @return int|false
	 */
	public function count_events_by_status( $status ) {
		global $wpdb;

Erick Hitter's avatar
Erick Hitter committed
613
		if ( ! in_array( $status, $this->get_allowed_statuses(), true ) ) {
Erick Hitter's avatar
Erick Hitter committed
614
615
616
617
618
			return false;
		}

		return (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(action) FROM {$this->get_table_name()} WHERE status = %s", $status ) );
	}
Erick Hitter's avatar
Erick Hitter committed
619
620
621
}

Events_Store::instance();