Passed
Push — master ( 495efb...ace576 )
by Brian
06:14 queued 01:46
created

ActionScheduler_wpPostStore::find_action()   B

Complexity

Conditions 8
Paths 40

Size

Total Lines 47
Code Lines 36

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 8
eloc 36
c 1
b 0
f 0
nc 40
nop 2
dl 0
loc 47
rs 8.0995
1
<?php
2
3
/**
4
 * Class ActionScheduler_wpPostStore
5
 */
6
class ActionScheduler_wpPostStore extends ActionScheduler_Store {
7
	const POST_TYPE = 'scheduled-action';
8
	const GROUP_TAXONOMY = 'action-group';
9
	const SCHEDULE_META_KEY = '_action_manager_schedule';
10
	const DEPENDENCIES_MET = 'as-post-store-dependencies-met';
11
12
	/** @var DateTimeZone */
13
	protected $local_timezone = NULL;
14
15
	public function save_action( ActionScheduler_Action $action, DateTime $scheduled_date = NULL ){
16
		try {
17
			$this->validate_action( $action );
18
			$post_array = $this->create_post_array( $action, $scheduled_date );
19
			$post_id = $this->save_post_array( $post_array );
20
			$this->save_post_schedule( $post_id, $action->get_schedule() );
21
			$this->save_action_group( $post_id, $action->get_group() );
22
			do_action( 'action_scheduler_stored_action', $post_id );
23
			return $post_id;
0 ignored issues
show
Bug Best Practice introduced by
The expression return $post_id also could return the type WP_Error which is incompatible with the return type mandated by ActionScheduler_Store::save_action() of string.
Loading history...
24
		} catch ( Exception $e ) {
25
			throw new RuntimeException( sprintf( __( 'Error saving action: %s', 'action-scheduler' ), $e->getMessage() ), 0 );
26
		}
27
	}
28
29
	protected function create_post_array( ActionScheduler_Action $action, DateTime $scheduled_date = NULL ) {
30
		$post = array(
31
			'post_type' => self::POST_TYPE,
32
			'post_title' => $action->get_hook(),
33
			'post_content' => json_encode($action->get_args()),
34
			'post_status' => ( $action->is_finished() ? 'publish' : 'pending' ),
35
			'post_date_gmt' => $this->get_scheduled_date_string( $action, $scheduled_date ),
36
			'post_date'     => $this->get_scheduled_date_string_local( $action, $scheduled_date ),
37
		);
38
		return $post;
39
	}
40
41
	protected function save_post_array( $post_array ) {
42
		add_filter( 'wp_insert_post_data', array( $this, 'filter_insert_post_data' ), 10, 1 );
43
		add_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10, 5 );
44
45
		$has_kses = false !== has_filter( 'content_save_pre', 'wp_filter_post_kses' );
46
47
		if ( $has_kses ) {
48
			// Prevent KSES from corrupting JSON in post_content.
49
			kses_remove_filters();
50
		}
51
52
		$post_id = wp_insert_post($post_array);
53
54
		if ( $has_kses ) {
55
			kses_init_filters();
56
		}
57
58
		remove_filter( 'wp_insert_post_data', array( $this, 'filter_insert_post_data' ), 10 );
59
		remove_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10 );
60
61
		if ( is_wp_error($post_id) || empty($post_id) ) {
62
			throw new RuntimeException( __( 'Unable to save action.', 'action-scheduler' ) );
63
		}
64
		return $post_id;
65
	}
66
67
	public function filter_insert_post_data( $postdata ) {
68
		if ( $postdata['post_type'] == self::POST_TYPE ) {
69
			$postdata['post_author'] = 0;
70
			if ( $postdata['post_status'] == 'future' ) {
71
				$postdata['post_status'] = 'publish';
72
			}
73
		}
74
		return $postdata;
75
	}
76
77
	/**
78
	 * Create a (probably unique) post name for scheduled actions in a more performant manner than wp_unique_post_slug().
79
	 *
80
	 * When an action's post status is transitioned to something other than 'draft', 'pending' or 'auto-draft, like 'publish'
81
	 * or 'failed' or 'trash', WordPress will find a unique slug (stored in post_name column) using the wp_unique_post_slug()
82
	 * function. This is done to ensure URL uniqueness. The approach taken by wp_unique_post_slug() is to iterate over existing
83
	 * post_name values that match, and append a number 1 greater than the largest. This makes sense when manually creating a
84
	 * post from the Edit Post screen. It becomes a bottleneck when automatically processing thousands of actions, with a
85
	 * database containing thousands of related post_name values.
86
	 *
87
	 * WordPress 5.1 introduces the 'pre_wp_unique_post_slug' filter for plugins to address this issue.
88
	 *
89
	 * We can short-circuit WordPress's wp_unique_post_slug() approach using the 'pre_wp_unique_post_slug' filter. This
90
	 * method is available to be used as a callback on that filter. It provides a more scalable approach to generating a
91
	 * post_name/slug that is probably unique. Because Action Scheduler never actually uses the post_name field, or an
92
	 * action's slug, being probably unique is good enough.
93
	 *
94
	 * For more backstory on this issue, see:
95
	 * - https://github.com/woocommerce/action-scheduler/issues/44 and
96
	 * - https://core.trac.wordpress.org/ticket/21112
97
	 *
98
	 * @param string $override_slug Short-circuit return value.
99
	 * @param string $slug          The desired slug (post_name).
100
	 * @param int    $post_ID       Post ID.
101
	 * @param string $post_status   The post status.
102
	 * @param string $post_type     Post type.
103
	 * @return string
104
	 */
105
	public function set_unique_post_slug( $override_slug, $slug, $post_ID, $post_status, $post_type ) {
106
		if ( self::POST_TYPE == $post_type ) {
107
			$override_slug = uniqid( self::POST_TYPE . '-', true ) . '-' . wp_generate_password( 32, false );
108
		}
109
		return $override_slug;
110
	}
111
112
	protected function save_post_schedule( $post_id, $schedule ) {
113
		update_post_meta( $post_id, self::SCHEDULE_META_KEY, $schedule );
114
	}
115
116
	protected function save_action_group( $post_id, $group ) {
117
		if ( empty($group) ) {
118
			wp_set_object_terms( $post_id, array(), self::GROUP_TAXONOMY, FALSE );
119
		} else {
120
			wp_set_object_terms( $post_id, array($group), self::GROUP_TAXONOMY, FALSE );
121
		}
122
	}
123
124
	public function fetch_action( $action_id ) {
125
		$post = $this->get_post( $action_id );
126
		if ( empty($post) || $post->post_type != self::POST_TYPE ) {
127
			return $this->get_null_action();
128
		}
129
130
		try {
131
			$action = $this->make_action_from_post( $post );
132
		} catch ( ActionScheduler_InvalidActionException $exception ) {
133
			do_action( 'action_scheduler_failed_fetch_action', $post->ID, $exception );
134
			return $this->get_null_action();
135
		}
136
137
		return $action;
138
	}
139
140
	protected function get_post( $action_id ) {
141
		if ( empty($action_id) ) {
142
			return NULL;
143
		}
144
		return get_post($action_id);
145
	}
146
147
	protected function get_null_action() {
148
		return new ActionScheduler_NullAction();
149
	}
150
151
	protected function make_action_from_post( $post ) {
152
		$hook = $post->post_title;
153
154
		$args = json_decode( $post->post_content, true );
155
		$this->validate_args( $args, $post->ID );
156
157
		$schedule = get_post_meta( $post->ID, self::SCHEDULE_META_KEY, true );
158
		$this->validate_schedule( $schedule, $post->ID );
159
160
		$group = wp_get_object_terms( $post->ID, self::GROUP_TAXONOMY, array('fields' => 'names') );
161
		$group = empty( $group ) ? '' : reset($group);
0 ignored issues
show
Bug introduced by
$group of type WP_Error is incompatible with the type array expected by parameter $array of reset(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

161
		$group = empty( $group ) ? '' : reset(/** @scrutinizer ignore-type */ $group);
Loading history...
162
163
		return ActionScheduler::factory()->get_stored_action( $this->get_action_status_by_post_status( $post->post_status ), $hook, $args, $schedule, $group );
164
	}
165
166
	/**
167
	 * @param string $post_status
168
	 *
169
	 * @throws InvalidArgumentException if $post_status not in known status fields returned by $this->get_status_labels()
170
	 * @return string
171
	 */
172
	protected function get_action_status_by_post_status( $post_status ) {
173
174
		switch ( $post_status ) {
175
			case 'publish' :
176
				$action_status = self::STATUS_COMPLETE;
177
				break;
178
			case 'trash' :
179
				$action_status = self::STATUS_CANCELED;
180
				break;
181
			default :
182
				if ( ! array_key_exists( $post_status, $this->get_status_labels() ) ) {
183
					throw new InvalidArgumentException( sprintf( 'Invalid post status: "%s". No matching action status available.', $post_status ) );
184
				}
185
				$action_status = $post_status;
186
				break;
187
		}
188
189
		return $action_status;
190
	}
191
192
	/**
193
	 * @param string $action_status
194
	 * @throws InvalidArgumentException if $post_status not in known status fields returned by $this->get_status_labels()
195
	 * @return string
196
	 */
197
	protected function get_post_status_by_action_status( $action_status ) {
198
199
		switch ( $action_status ) {
200
			case self::STATUS_COMPLETE :
201
				$post_status = 'publish';
202
				break;
203
			case self::STATUS_CANCELED :
204
				$post_status = 'trash';
205
				break;
206
			default :
207
				if ( ! array_key_exists( $action_status, $this->get_status_labels() ) ) {
208
					throw new InvalidArgumentException( sprintf( 'Invalid action status: "%s".', $action_status ) );
209
				}
210
				$post_status = $action_status;
211
				break;
212
		}
213
214
		return $post_status;
215
	}
216
217
	/**
218
	 * @param string $hook
219
	 * @param array $params
220
	 *
221
	 * @return string ID of the next action matching the criteria or NULL if not found
222
	 */
223
	public function find_action( $hook, $params = array() ) {
224
		$params = wp_parse_args( $params, array(
225
			'args' => NULL,
226
			'status' => ActionScheduler_Store::STATUS_PENDING,
227
			'group' => '',
228
		));
229
		/** @var wpdb $wpdb */
230
		global $wpdb;
231
		$query = "SELECT p.ID FROM {$wpdb->posts} p";
232
		$args = array();
233
		if ( !empty($params['group']) ) {
234
			$query .= " INNER JOIN {$wpdb->term_relationships} tr ON tr.object_id=p.ID";
235
			$query .= " INNER JOIN {$wpdb->term_taxonomy} tt ON tr.term_taxonomy_id=tt.term_taxonomy_id";
236
			$query .= " INNER JOIN {$wpdb->terms} t ON tt.term_id=t.term_id AND t.slug=%s";
237
			$args[] = $params['group'];
238
		}
239
		$query .= " WHERE p.post_title=%s";
240
		$args[] = $hook;
241
		$query .= " AND p.post_type=%s";
242
		$args[] = self::POST_TYPE;
243
		if ( !is_null($params['args']) ) {
244
			$query .= " AND p.post_content=%s";
245
			$args[] = json_encode($params['args']);
246
		}
247
248
		if ( ! empty( $params['status'] ) ) {
249
			$query .= " AND p.post_status=%s";
250
			$args[] = $this->get_post_status_by_action_status( $params['status'] );
251
		}
252
253
		switch ( $params['status'] ) {
254
			case self::STATUS_COMPLETE:
255
			case self::STATUS_RUNNING:
256
			case self::STATUS_FAILED:
257
				$order = 'DESC'; // Find the most recent action that matches
258
				break;
259
			case self::STATUS_PENDING:
260
			default:
261
				$order = 'ASC'; // Find the next action that matches
262
				break;
263
		}
264
		$query .= " ORDER BY post_date_gmt $order LIMIT 1";
265
266
		$query = $wpdb->prepare( $query, $args );
267
268
		$id = $wpdb->get_var($query);
269
		return $id;
270
	}
271
272
	/**
273
	 * Returns the SQL statement to query (or count) actions.
274
	 *
275
	 * @param array $query Filtering options
276
	 * @param string $select_or_count  Whether the SQL should select and return the IDs or just the row count
277
	 * @throws InvalidArgumentException if $select_or_count not count or select
278
	 * @return string SQL statement. The returned SQL is already properly escaped.
279
	 */
280
	protected function get_query_actions_sql( array $query, $select_or_count = 'select' ) {
281
282
		if ( ! in_array( $select_or_count, array( 'select', 'count' ) ) ) {
283
			throw new InvalidArgumentException( __( 'Invalid schedule. Cannot save action.', 'action-scheduler' ) );
284
		}
285
286
		$query = wp_parse_args( $query, array(
287
			'hook' => '',
288
			'args' => NULL,
289
			'date' => NULL,
290
			'date_compare' => '<=',
291
			'modified' => NULL,
292
			'modified_compare' => '<=',
293
			'group' => '',
294
			'status' => '',
295
			'claimed' => NULL,
296
			'per_page' => 5,
297
			'offset' => 0,
298
			'orderby' => 'date',
299
			'order' => 'ASC',
300
			'search' => '',
301
		) );
302
303
		/** @var wpdb $wpdb */
304
		global $wpdb;
305
		$sql  = ( 'count' === $select_or_count ) ? 'SELECT count(p.ID)' : 'SELECT p.ID ';
306
		$sql .= "FROM {$wpdb->posts} p";
307
		$sql_params = array();
308
		if ( empty( $query['group'] ) && 'group' === $query['orderby'] ) {
309
			$sql .= " LEFT JOIN {$wpdb->term_relationships} tr ON tr.object_id=p.ID";
310
			$sql .= " LEFT JOIN {$wpdb->term_taxonomy} tt ON tr.term_taxonomy_id=tt.term_taxonomy_id";
311
			$sql .= " LEFT JOIN {$wpdb->terms} t ON tt.term_id=t.term_id";
312
		} elseif ( ! empty( $query['group'] ) ) {
313
			$sql .= " INNER JOIN {$wpdb->term_relationships} tr ON tr.object_id=p.ID";
314
			$sql .= " INNER JOIN {$wpdb->term_taxonomy} tt ON tr.term_taxonomy_id=tt.term_taxonomy_id";
315
			$sql .= " INNER JOIN {$wpdb->terms} t ON tt.term_id=t.term_id";
316
			$sql .= " AND t.slug=%s";
317
			$sql_params[] = $query['group'];
318
		}
319
		$sql .= " WHERE post_type=%s";
320
		$sql_params[] = self::POST_TYPE;
321
		if ( $query['hook'] ) {
322
			$sql .= " AND p.post_title=%s";
323
			$sql_params[] = $query['hook'];
324
		}
325
		if ( !is_null($query['args']) ) {
326
			$sql .= " AND p.post_content=%s";
327
			$sql_params[] = json_encode($query['args']);
328
		}
329
330
		if ( ! empty( $query['status'] ) ) {
331
			$sql .= " AND p.post_status=%s";
332
			$sql_params[] = $this->get_post_status_by_action_status( $query['status'] );
333
		}
334
335
		if ( $query['date'] instanceof DateTime ) {
336
			$date = clone $query['date'];
337
			$date->setTimezone( new DateTimeZone('UTC') );
338
			$date_string = $date->format('Y-m-d H:i:s');
339
			$comparator = $this->validate_sql_comparator($query['date_compare']);
340
			$sql .= " AND p.post_date_gmt $comparator %s";
341
			$sql_params[] = $date_string;
342
		}
343
344
		if ( $query['modified'] instanceof DateTime ) {
345
			$modified = clone $query['modified'];
346
			$modified->setTimezone( new DateTimeZone('UTC') );
347
			$date_string = $modified->format('Y-m-d H:i:s');
348
			$comparator = $this->validate_sql_comparator($query['modified_compare']);
349
			$sql .= " AND p.post_modified_gmt $comparator %s";
350
			$sql_params[] = $date_string;
351
		}
352
353
		if ( $query['claimed'] === TRUE ) {
354
			$sql .= " AND p.post_password != ''";
355
		} elseif ( $query['claimed'] === FALSE ) {
356
			$sql .= " AND p.post_password = ''";
357
		} elseif ( !is_null($query['claimed']) ) {
358
			$sql .= " AND p.post_password = %s";
359
			$sql_params[] = $query['claimed'];
360
		}
361
362
		if ( ! empty( $query['search'] ) ) {
363
			$sql .= " AND (p.post_title LIKE %s OR p.post_content LIKE %s OR p.post_password LIKE %s)";
364
			for( $i = 0; $i < 3; $i++ ) {
365
				$sql_params[] = sprintf( '%%%s%%', $query['search'] );
366
			}
367
		}
368
369
		if ( 'select' === $select_or_count ) {
370
			switch ( $query['orderby'] ) {
371
				case 'hook':
372
					$orderby = 'p.post_title';
373
					break;
374
				case 'group':
375
					$orderby = 't.name';
376
					break;
377
				case 'status':
378
					$orderby = 'p.post_status';
379
					break;
380
				case 'modified':
381
					$orderby = 'p.post_modified';
382
					break;
383
				case 'claim_id':
384
					$orderby = 'p.post_password';
385
					break;
386
				case 'schedule':
387
				case 'date':
388
				default:
389
					$orderby = 'p.post_date_gmt';
390
					break;
391
			}
392
			if ( 'ASC' === strtoupper( $query['order'] ) ) {
393
				$order = 'ASC';
394
			} else {
395
				$order = 'DESC';
396
			}
397
			$sql .= " ORDER BY $orderby $order";
398
			if ( $query['per_page'] > 0 ) {
399
				$sql .= " LIMIT %d, %d";
400
				$sql_params[] = $query['offset'];
401
				$sql_params[] = $query['per_page'];
402
			}
403
		}
404
405
		return $wpdb->prepare( $sql, $sql_params );
406
	}
407
408
	/**
409
	 * @param array $query
410
	 * @param string $query_type Whether to select or count the results. Default, select.
411
	 * @return string|array The IDs of actions matching the query
412
	 */
413
	public function query_actions( $query = array(), $query_type = 'select' ) {
414
		/** @var wpdb $wpdb */
415
		global $wpdb;
416
417
		$sql = $this->get_query_actions_sql( $query, $query_type );
418
419
		return ( 'count' === $query_type ) ? $wpdb->get_var( $sql ) : $wpdb->get_col( $sql );
0 ignored issues
show
Bug Best Practice introduced by
The expression return 'count' === $quer... : $wpdb->get_col($sql) also could return the type string which is incompatible with the return type mandated by ActionScheduler_Store::query_actions() of array|integer.
Loading history...
420
	}
421
422
	/**
423
	 * Get a count of all actions in the store, grouped by status
424
	 *
425
	 * @return array
426
	 */
427
	public function action_counts() {
428
429
		$action_counts_by_status = array();
430
		$action_stati_and_labels = $this->get_status_labels();
431
		$posts_count_by_status   = (array) wp_count_posts( self::POST_TYPE, 'readable' );
432
433
		foreach ( $posts_count_by_status as $post_status_name => $count ) {
434
435
			try {
436
				$action_status_name = $this->get_action_status_by_post_status( $post_status_name );
437
			} catch ( Exception $e ) {
438
				// Ignore any post statuses that aren't for actions
439
				continue;
440
			}
441
			if ( array_key_exists( $action_status_name, $action_stati_and_labels ) ) {
442
				$action_counts_by_status[ $action_status_name ] = $count;
443
			}
444
		}
445
446
		return $action_counts_by_status;
447
	}
448
449
	/**
450
	 * @param string $action_id
451
	 *
452
	 * @throws InvalidArgumentException
453
	 */
454
	public function cancel_action( $action_id ) {
455
		$post = get_post( $action_id );
0 ignored issues
show
Bug introduced by
$action_id of type string is incompatible with the type WP_Post|integer|null expected by parameter $post of get_post(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

455
		$post = get_post( /** @scrutinizer ignore-type */ $action_id );
Loading history...
456
		if ( empty( $post ) || ( $post->post_type != self::POST_TYPE ) ) {
457
			throw new InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'action-scheduler' ), $action_id ) );
458
		}
459
		do_action( 'action_scheduler_canceled_action', $action_id );
460
		add_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10, 5 );
461
		wp_trash_post( $action_id );
0 ignored issues
show
Bug introduced by
$action_id of type string is incompatible with the type integer expected by parameter $post_id of wp_trash_post(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

461
		wp_trash_post( /** @scrutinizer ignore-type */ $action_id );
Loading history...
462
		remove_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10 );
463
	}
464
465
	public function delete_action( $action_id ) {
466
		$post = get_post( $action_id );
467
		if ( empty( $post ) || ( $post->post_type != self::POST_TYPE ) ) {
468
			throw new InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'action-scheduler' ), $action_id ) );
469
		}
470
		do_action( 'action_scheduler_deleted_action', $action_id );
471
472
		wp_delete_post( $action_id, TRUE );
473
	}
474
475
	/**
476
	 * @param string $action_id
477
	 *
478
	 * @throws InvalidArgumentException
479
	 * @return ActionScheduler_DateTime The date the action is schedule to run, or the date that it ran.
480
	 */
481
	public function get_date( $action_id ) {
482
		$next = $this->get_date_gmt( $action_id );
483
		return ActionScheduler_TimezoneHelper::set_local_timezone( $next );
484
	}
485
486
	/**
487
	 * @param string $action_id
488
	 *
489
	 * @throws InvalidArgumentException
490
	 * @return ActionScheduler_DateTime The date the action is schedule to run, or the date that it ran.
491
	 */
492
	public function get_date_gmt( $action_id ) {
493
		$post = get_post( $action_id );
0 ignored issues
show
Bug introduced by
$action_id of type string is incompatible with the type WP_Post|integer|null expected by parameter $post of get_post(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

493
		$post = get_post( /** @scrutinizer ignore-type */ $action_id );
Loading history...
494
		if ( empty( $post ) || ( $post->post_type != self::POST_TYPE ) ) {
495
			throw new InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'action-scheduler' ), $action_id ) );
496
		}
497
		if ( $post->post_status == 'publish' ) {
498
			return as_get_datetime_object( $post->post_modified_gmt );
499
		} else {
500
			return as_get_datetime_object( $post->post_date_gmt );
501
		}
502
	}
503
504
	/**
505
	 * @param int      $max_actions
506
	 * @param DateTime $before_date Jobs must be schedule before this date. Defaults to now.
507
	 * @param array    $hooks       Claim only actions with a hook or hooks.
508
	 * @param string   $group       Claim only actions in the given group.
509
	 *
510
	 * @return ActionScheduler_ActionClaim
511
	 * @throws RuntimeException When there is an error staking a claim.
512
	 * @throws InvalidArgumentException When the given group is not valid.
513
	 */
514
	public function stake_claim( $max_actions = 10, DateTime $before_date = null, $hooks = array(), $group = '' ) {
515
		$claim_id = $this->generate_claim_id();
516
		$this->claim_actions( $claim_id, $max_actions, $before_date, $hooks, $group );
517
		$action_ids = $this->find_actions_by_claim_id( $claim_id );
518
519
		return new ActionScheduler_ActionClaim( $claim_id, $action_ids );
520
	}
521
522
	/**
523
	 * @return int
524
	 */
525
	public function get_claim_count(){
526
		global $wpdb;
527
528
		$sql = "SELECT COUNT(DISTINCT post_password) FROM {$wpdb->posts} WHERE post_password != '' AND post_type = %s AND post_status IN ('in-progress','pending')";
529
		$sql = $wpdb->prepare( $sql, array( self::POST_TYPE ) );
530
531
		return $wpdb->get_var( $sql );
532
	}
533
534
	protected function generate_claim_id() {
535
		$claim_id = md5(microtime(true) . rand(0,1000));
536
		return substr($claim_id, 0, 20); // to fit in db field with 20 char limit
537
	}
538
539
	/**
540
	 * @param string   $claim_id
541
	 * @param int      $limit
542
	 * @param DateTime $before_date Should use UTC timezone.
543
	 * @param array    $hooks       Claim only actions with a hook or hooks.
544
	 * @param string   $group       Claim only actions in the given group.
545
	 *
546
	 * @return int The number of actions that were claimed
547
	 * @throws RuntimeException When there is a database error.
548
	 * @throws InvalidArgumentException When the group is invalid.
549
	 */
550
	protected function claim_actions( $claim_id, $limit, DateTime $before_date = null, $hooks = array(), $group = '' ) {
551
		// Set up initial variables.
552
		$date      = null === $before_date ? as_get_datetime_object() : clone $before_date;
553
		$limit_ids = ! empty( $group );
554
		$ids       = $limit_ids ? $this->get_actions_by_group( $group, $limit, $date ) : array();
555
556
		// If limiting by IDs and no posts found, then return early since we have nothing to update.
557
		if ( $limit_ids && 0 === count( $ids ) ) {
558
			return 0;
559
		}
560
561
		/** @var wpdb $wpdb */
562
		global $wpdb;
563
564
		/*
565
		 * Build up custom query to update the affected posts. Parameters are built as a separate array
566
		 * to make it easier to identify where they are in the query.
567
		 *
568
		 * We can't use $wpdb->update() here because of the "ID IN ..." clause.
569
		 */
570
		$update = "UPDATE {$wpdb->posts} SET post_password = %s, post_modified_gmt = %s, post_modified = %s";
571
		$params = array(
572
			$claim_id,
573
			current_time( 'mysql', true ),
574
			current_time( 'mysql' ),
575
		);
576
577
		// Build initial WHERE clause.
578
		$where    = "WHERE post_type = %s AND post_status = %s AND post_password = ''";
579
		$params[] = self::POST_TYPE;
580
		$params[] = ActionScheduler_Store::STATUS_PENDING;
581
582
		if ( ! empty( $hooks ) ) {
583
			$placeholders = array_fill( 0, count( $hooks ), '%s' );
584
			$where       .= ' AND post_title IN (' . join( ', ', $placeholders ) . ')';
585
			$params       = array_merge( $params, array_values( $hooks ) );
586
		}
587
588
		/*
589
		 * Add the IDs to the WHERE clause. IDs not escaped because they came directly from a prior DB query.
590
		 *
591
		 * If we're not limiting by IDs, then include the post_date_gmt clause.
592
		 */
593
		if ( $limit_ids ) {
594
			$where .= ' AND ID IN (' . join( ',', $ids ) . ')';
595
		} else {
596
			$where .= ' AND post_date_gmt <= %s';
597
			$params[] = $date->format( 'Y-m-d H:i:s' );
598
		}
599
600
		// Add the ORDER BY clause and,ms limit.
601
		$order    = 'ORDER BY menu_order ASC, post_date_gmt ASC, ID ASC LIMIT %d';
602
		$params[] = $limit;
603
604
		// Run the query and gather results.
605
		$rows_affected = $wpdb->query( $wpdb->prepare( "{$update} {$where} {$order}", $params ) );
606
		if ( $rows_affected === false ) {
607
			throw new RuntimeException( __( 'Unable to claim actions. Database error.', 'action-scheduler' ) );
608
		}
609
610
		return (int) $rows_affected;
611
	}
612
613
	/**
614
	 * Get IDs of actions within a certain group and up to a certain date/time.
615
	 *
616
	 * @param string   $group The group to use in finding actions.
617
	 * @param int      $limit The number of actions to retrieve.
618
	 * @param DateTime $date  DateTime object representing cutoff time for actions. Actions retrieved will be
619
	 *                        up to and including this DateTime.
620
	 *
621
	 * @return array IDs of actions in the appropriate group and before the appropriate time.
622
	 * @throws InvalidArgumentException When the group does not exist.
623
	 */
624
	protected function get_actions_by_group( $group, $limit, DateTime $date ) {
625
		// Ensure the group exists before continuing.
626
		if ( ! term_exists( $group, self::GROUP_TAXONOMY )) {
627
			throw new InvalidArgumentException( sprintf( __( 'The group "%s" does not exist.', 'action-scheduler' ), $group ) );
628
		}
629
630
		// Set up a query for post IDs to use later.
631
		$query      = new WP_Query();
632
		$query_args = array(
633
			'fields'           => 'ids',
634
			'post_type'        => self::POST_TYPE,
635
			'post_status'      => ActionScheduler_Store::STATUS_PENDING,
636
			'has_password'     => false,
637
			'posts_per_page'   => $limit * 3,
638
			'suppress_filters' => true,
639
			'no_found_rows'    => true,
640
			'orderby'          => array(
641
				'menu_order' => 'ASC',
642
				'date'       => 'ASC',
643
				'ID'         => 'ASC',
644
			),
645
			'date_query'       => array(
646
				'column' => 'post_date_gmt',
647
				'before' => $date->format( 'Y-m-d H:i' ),
648
				'inclusive' => true,
649
			),
650
			'tax_query' => array(
651
				array(
652
					'taxonomy'         => self::GROUP_TAXONOMY,
653
					'field'            => 'slug',
654
					'terms'            => $group,
655
					'include_children' => false,
656
				),
657
			),
658
		);
659
660
		return $query->query( $query_args );
661
	}
662
663
	/**
664
	 * @param string $claim_id
665
	 * @return array
666
	 */
667
	public function find_actions_by_claim_id( $claim_id ) {
668
		/** @var wpdb $wpdb */
669
		global $wpdb;
670
		$sql = "SELECT ID FROM {$wpdb->posts} WHERE post_type = %s AND post_password = %s";
671
		$sql = $wpdb->prepare( $sql, array( self::POST_TYPE, $claim_id ) );
672
		$action_ids = $wpdb->get_col( $sql );
673
		return $action_ids;
674
	}
675
676
	public function release_claim( ActionScheduler_ActionClaim $claim ) {
677
		$action_ids = $this->find_actions_by_claim_id( $claim->get_id() );
678
		if ( empty( $action_ids ) ) {
679
			return; // nothing to do
680
		}
681
		$action_id_string = implode( ',', array_map( 'intval', $action_ids ) );
682
		/** @var wpdb $wpdb */
683
		global $wpdb;
684
		$sql = "UPDATE {$wpdb->posts} SET post_password = '' WHERE ID IN ($action_id_string) AND post_password = %s";
685
		$sql = $wpdb->prepare( $sql, array( $claim->get_id() ) );
686
		$result = $wpdb->query( $sql );
687
		if ( $result === false ) {
688
			/* translators: %s: claim ID */
689
			throw new RuntimeException( sprintf( __( 'Unable to unlock claim %s. Database error.', 'action-scheduler' ), $claim->get_id() ) );
690
		}
691
	}
692
693
	/**
694
	 * @param string $action_id
695
	 */
696
	public function unclaim_action( $action_id ) {
697
		/** @var wpdb $wpdb */
698
		global $wpdb;
699
		$sql = "UPDATE {$wpdb->posts} SET post_password = '' WHERE ID = %d AND post_type = %s";
700
		$sql = $wpdb->prepare( $sql, $action_id, self::POST_TYPE );
701
		$result = $wpdb->query( $sql );
702
		if ( $result === false ) {
703
			/* translators: %s: action ID */
704
			throw new RuntimeException( sprintf( __( 'Unable to unlock claim on action %s. Database error.', 'action-scheduler' ), $action_id ) );
705
		}
706
	}
707
708
	public function mark_failure( $action_id ) {
709
		/** @var wpdb $wpdb */
710
		global $wpdb;
711
		$sql = "UPDATE {$wpdb->posts} SET post_status = %s WHERE ID = %d AND post_type = %s";
712
		$sql = $wpdb->prepare( $sql, self::STATUS_FAILED, $action_id, self::POST_TYPE );
713
		$result = $wpdb->query( $sql );
714
		if ( $result === false ) {
715
			/* translators: %s: action ID */
716
			throw new RuntimeException( sprintf( __( 'Unable to mark failure on action %s. Database error.', 'action-scheduler' ), $action_id ) );
717
		}
718
	}
719
720
	/**
721
	 * Return an action's claim ID, as stored in the post password column
722
	 *
723
	 * @param string $action_id
724
	 * @return mixed
725
	 */
726
	public function get_claim_id( $action_id ) {
727
		return $this->get_post_column( $action_id, 'post_password' );
728
	}
729
730
	/**
731
	 * Return an action's status, as stored in the post status column
732
	 *
733
	 * @param string $action_id
734
	 * @return mixed
735
	 */
736
	public function get_status( $action_id ) {
737
		$status = $this->get_post_column( $action_id, 'post_status' );
738
739
		if ( $status === null ) {
740
			throw new InvalidArgumentException( __( 'Invalid action ID. No status found.', 'action-scheduler' ) );
741
		}
742
743
		return $this->get_action_status_by_post_status( $status );
744
	}
745
746
	private function get_post_column( $action_id, $column_name ) {
747
		/** @var \wpdb $wpdb */
748
		global $wpdb;
749
		return $wpdb->get_var( $wpdb->prepare( "SELECT {$column_name} FROM {$wpdb->posts} WHERE ID=%d AND post_type=%s", $action_id, self::POST_TYPE ) );
750
	}
751
752
	/**
753
	 * @param string $action_id
754
	 */
755
	public function log_execution( $action_id ) {
756
		/** @var wpdb $wpdb */
757
		global $wpdb;
758
759
		$sql = "UPDATE {$wpdb->posts} SET menu_order = menu_order+1, post_status=%s, post_modified_gmt = %s, post_modified = %s WHERE ID = %d AND post_type = %s";
760
		$sql = $wpdb->prepare( $sql, self::STATUS_RUNNING, current_time('mysql', true), current_time('mysql'), $action_id, self::POST_TYPE );
761
		$wpdb->query($sql);
762
	}
763
764
	/**
765
	 * Record that an action was completed.
766
	 *
767
	 * @param int $action_id ID of the completed action.
768
	 * @throws InvalidArgumentException|RuntimeException
769
	 */
770
	public function mark_complete( $action_id ) {
771
		$post = get_post( $action_id );
772
		if ( empty( $post ) || ( $post->post_type != self::POST_TYPE ) ) {
773
			throw new InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'action-scheduler' ), $action_id ) );
774
		}
775
		add_filter( 'wp_insert_post_data', array( $this, 'filter_insert_post_data' ), 10, 1 );
776
		add_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10, 5 );
777
		$result = wp_update_post(array(
778
			'ID' => $action_id,
779
			'post_status' => 'publish',
780
		), TRUE);
781
		remove_filter( 'wp_insert_post_data', array( $this, 'filter_insert_post_data' ), 10 );
782
		remove_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10 );
783
		if ( is_wp_error( $result ) ) {
784
			throw new RuntimeException( $result->get_error_message() );
785
		}
786
	}
787
788
	/**
789
	 * Mark action as migrated when there is an error deleting the action.
790
	 *
791
	 * @param int $action_id Action ID.
792
	 */
793
	public function mark_migrated( $action_id ) {
794
		wp_update_post(
795
			array(
796
				'ID'          => $action_id,
797
				'post_status' => 'migrated'
798
			)
799
		);
800
	}
801
802
	/**
803
	 * Determine whether the post store can be migrated.
804
	 *
805
	 * @return bool
806
	 */
807
	public function migration_dependencies_met( $setting ) {
808
		global $wpdb;
809
810
		$dependencies_met = get_transient( self::DEPENDENCIES_MET );
811
		if ( empty( $dependencies_met ) ) {
812
			$maximum_args_length = apply_filters( 'action_scheduler_maximum_args_length', 191 );
813
			$found_action        = $wpdb->get_var(
814
				$wpdb->prepare(
815
					"SELECT ID FROM {$wpdb->posts} WHERE post_type = %s AND CHAR_LENGTH(post_content) > %d LIMIT 1",
816
					$maximum_args_length,
817
					self::POST_TYPE
818
				)
819
			);
820
			$dependencies_met = $found_action ? 'no' : 'yes';
821
			set_transient( self::DEPENDENCIES_MET, $dependencies_met, DAY_IN_SECONDS );
822
		}
823
824
		return 'yes' == $dependencies_met ? $setting : false;
825
	}
826
827
	/**
828
	 * InnoDB indexes have a maximum size of 767 bytes by default, which is only 191 characters with utf8mb4.
829
	 *
830
	 * Previously, AS wasn't concerned about args length, as we used the (unindex) post_content column. However,
831
	 * as we prepare to move to custom tables, and can use an indexed VARCHAR column instead, we want to warn
832
	 * developers of this impending requirement.
833
	 *
834
	 * @param ActionScheduler_Action $action
835
	 */
836
	protected function validate_action( ActionScheduler_Action $action ) {
837
		try {
838
			parent::validate_action( $action );
839
		} catch ( Exception $e ) {
840
			$message = sprintf( __( '%s Support for strings longer than this will be removed in a future version.', 'action-scheduler' ), $e->getMessage() );
841
			_doing_it_wrong( 'ActionScheduler_Action::$args', $message, '2.1.0' );
842
		}
843
	}
844
845
	/**
846
	 * @codeCoverageIgnore
847
	 */
848
	public function init() {
849
		add_filter( 'action_scheduler_migration_dependencies_met', array( $this, 'migration_dependencies_met' ) );
850
851
		$post_type_registrar = new ActionScheduler_wpPostStore_PostTypeRegistrar();
852
		$post_type_registrar->register();
853
854
		$post_status_registrar = new ActionScheduler_wpPostStore_PostStatusRegistrar();
855
		$post_status_registrar->register();
856
857
		$taxonomy_registrar = new ActionScheduler_wpPostStore_TaxonomyRegistrar();
858
		$taxonomy_registrar->register();
859
	}
860
}
861