class-cron-options-cpt.php 7.88 KB
Newer Older
1
<?php
2
3
4

namespace WP_Cron_Control_Revisited;

5
class Cron_Options_CPT extends Singleton {
6
7
8
9
10
11
12
	/**
	 * PLUGIN SETUP
	 */

	/**
	 * Class properties
	 */
13
14
	private $post_type   = 'wpccr_events';
	private $post_status = 'inherit';
15

16
17
	private $posts_to_clean = array();

18
19
20
	/**
	 * Register hooks
	 */
21
	protected function class_init() {
22
		// Data storage
23
		add_action( 'init', array( $this, 'register_post_type' ) );
24
25
26
27

		// Option interception
		add_filter( 'pre_option_cron', array( $this, 'get_option' ) );
		add_filter( 'pre_update_option_cron', array( $this, 'update_option' ), 10, 2 );
28
29
30
31
32
33
34
	}

	/**
	 * Register a private post type to store cron events
	 */
	public function register_post_type() {
		register_post_type( $this->post_type, array(
35
36
37
38
39
			'label'               => 'Cron Events',
			'public'              => false,
			'rewrite'             => false,
			'export'              => false,
			'exclude_from_search' => true,
40
		) );
41
42
43
44
45
46
47

		// Clear caches for any manually-inserted posts, lest stale caches be used
		if ( ! empty( $this->posts_to_clean ) ) {
			foreach ( $this->posts_to_clean as $post_to_clean ) {
				clean_post_cache( $post_to_clean );
			}
		}
48
49
50
51
52
	}

	/**
	 * PLUGIN FUNCTIONALITY
	 */
53
54
55
56
57
58
59
60
61
62

	/**
	 * Override cron option requests with data from CPT
	 */
	public function get_option( $value ) {
		$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
63
		$jobs_posts = $this->get_jobs( array(
64
65
66
67
			'post_type'        => $this->post_type,
			'post_status'      => $this->post_status,
			'suppress_filters' => false,
			'posts_per_page'   => 1000,
68
69
			'orderby'          => 'date',
			'order'            => 'ASC',
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
		) );

		// Loop through results and built output Core expects
		if ( ! empty( $jobs_posts ) ) {
			foreach ( $jobs_posts as $jobs_post ) {
				$timestamp = strtotime( $jobs_post->post_date_gmt );

				$job_args = maybe_unserialize( $jobs_post->post_content_filtered );
				if ( ! is_array( $job_args ) ) {
					continue;
				}

				$action   = $job_args['action'];
				$instance = $job_args['instance'];
				$args     = $job_args['args'];

				$cron_array[ $timestamp ][ $action ][ $instance ] = array(
					'schedule' => $args['schedule'],
					'args'     => $args['args'],
				);

				if ( isset( $args['interval'] ) ) {
					$cron_array[ $timestamp ][ $action ][ $instance ]['interval'] = $args['interval'];
				}

			}
		}

98
		uksort( $cron_array, 'strnatcasecmp' );
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

		return $cron_array;
	}

	/**
	 * Save cron events in CPT
	 *
	 * By returning $old_value, `cron` option won't be updated
	 */
	public function update_option( $new_value, $old_value ) {
		if ( is_array( $new_value ) && ! empty( $new_value ) ) {
			foreach ( $new_value as $timestamp => $timestamp_events ) {
				// Skip non-event data that Core includes in the option
				if ( ! is_numeric( $timestamp ) ) {
					continue;
				}

				foreach ( $timestamp_events as $action => $action_instances ) {
					foreach ( $action_instances as $instance => $instance_args ) {
						// Check if post exists and bail
119
						$job_exists = $this->job_exists( array(
120
121
122
123
124
125
126
127
							'name'             => sprintf( '%s-%s-%s', $timestamp, md5( $action ), $instance ),
							'post_type'        => $this->post_type,
							'post_status'      => $this->post_status,
							'suppress_filters' => false,
							'posts_per_page'   => 1,
						) );

						// Create a post, if needed
128
129
130
131
						if ( ! $job_exists ) {
							// Build minimum information needed to create a post
							// Sufficient for `wp_insert_post()`, but requires additional massaging for `$wpdb->insert()`
							$job_post = array(
132
133
								'post_title'            => sprintf( '%s | %s | %s', $timestamp, $action, $instance ),
								'post_name'             => sprintf( '%s-%s-%s', $timestamp, md5( $action ), $instance ),
134
135
136
137
138
								'post_content_filtered' => maybe_serialize( array(
									'action'   => $action,
									'instance' => $instance,
									'args'     => $instance_args,
								) ),
139
140
141
142
								'post_date'             => date( 'Y-m-d H:i:s', $timestamp ),
								'post_date_gmt'         => date( 'Y-m-d H:i:s', $timestamp ),
								'post_type'             => $this->post_type,
								'post_status'           => $this->post_status,
143
144
							);

145
							$this->create_job( $job_post );
146
147
148
149
150
151
152
153
154
155
156
157
158
						}
					}
				}
			}
		}

		return $old_value;
	}

	/**
	 * PLUGIN UTILITY METHODS
	 */

159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
	/**
	 * Retrieve list of jobs, respecting whether or not the CPT is registered
	 */
	private function get_jobs( $args ) {
		// If called before `init`, we need to query directly because post types aren't registered earlier
		if ( did_action( 'init' ) ) {
			return get_posts( $args );
		} else {
			global $wpdb;

			$orderby = 'date' === $args['orderby'] ? 'post_date' : $args['orderby'];

			return $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$wpdb->posts} WHERE post_type = %s AND post_status = %s ORDER BY %s %s LIMIT %d;", $args['post_type'], $args['post_status'], $orderby, $args['order'], $args['posts_per_page'] ), 'OBJECT' );
		}
	}

175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
	/**
	 * Check if a job post exists, respecting Core's loading order
	 */
	private function job_exists( $job_post ) {
		// If called before `init`, we need to insert directly because post types aren't registered earlier
		if ( did_action( 'init' ) ) {
			$exists = get_posts( $job_post );
		} else {
			global $wpdb;

			$exists = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM {$wpdb->posts} WHERE post_name = %s AND post_type = %s AND post_status = %s LIMIT 1;", $job_post['name'], $this->post_type, $this->post_status ) );
		}

		return ! empty( $exists );
	}

	/**
	 * Create a job post, respecting whether or not Core is ready for CPTs
	 */
194
	private function create_job( $job_post ) {
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
		// If called before `init`, we need to insert directly because post types aren't registered earlier
		if ( did_action( 'init' ) ) {
			wp_insert_post( $job_post );
		} else {
			global $wpdb;

			// Additional data needed to manually create a post
			$job_post = wp_parse_args( $job_post, array(
				'post_author'       => 0,
				'comment_status'    => 'closed',
				'ping_status'       => 'closed',
				'post_parent'       => 0,
				'post_modified'     => current_time( 'mysql' ),
				'post_modified_gmt' => current_time( 'mysql', true ),
			) );

			// Some sanitization in place of `sanitize_post()`, which we can't use this early
			foreach ( array( 'post_title', 'post_name', 'post_content_filtered' ) as $field ) {
				$job_post[ $field ] = sanitize_text_field( $job_post[ $field ] );
			}

			// Duplicate some processing performed in `wp_insert_post()`
			$charset = $wpdb->get_col_charset( $wpdb->posts, 'post_title' );
			if ( 'utf8' === $charset ) {
				$job_post['post_title'] = wp_encode_emoji( $job_post['post_title'] );
			}

			$job_post = wp_unslash( $job_post );

			// Set this so it isn't empty, even though it serves us no purpose
			$job_post['guid'] = esc_url( add_query_arg( $this->post_type, $job_post['post_name'], home_url( '/' ) ) );

			// Create the post
			$inserted = $wpdb->insert( $wpdb->posts, $job_post );

			// Clear caches for new posts once the post type is registered
			if ( $inserted ) {
				$this->posts_to_clean[] = $wpdb->insert_id;
			}
		}
	}

237
238
239
240
241
242
243
244
245
	/**
	 * Remove an event's CPT entry
	 *
	 * @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
	 */
246
	public function delete_job( $timestamp, $action, $instance ) {
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
		$job_exists = get_posts( array(
			'name'             => sprintf( '%s-%s-%s', $timestamp, md5( $action ), $instance ),
			'post_type'        => $this->post_type,
			'post_status'      => $this->post_status,
			'suppress_filters' => false,
			'posts_per_page'   => 1,
		) );

		if ( empty( $job_exists ) ) {
			return false;
		}

		wp_delete_post( $job_exists[0]->ID, true );
		return true;
	}
262
263
264
}

Cron_Options_CPT::instance();