notifier / libraries / action-scheduler / classes / schema / ActionScheduler_StoreSchema.php

ActionScheduler_StoreSchema.php in WANotifier for Forms and Actions 2.7.5, at libraries/action-scheduler/classes/schema/ActionScheduler_StoreSchema.php

130 lines 4.5 KB

Raw Download Zip

1	<?php
2
3	/**
4	* Class ActionScheduler_StoreSchema
5	*
6	* @codeCoverageIgnore
7	*
8	* Creates custom tables for storing scheduled actions
9	*/
10	class ActionScheduler_StoreSchema extends ActionScheduler_Abstract_Schema {
11	const ACTIONS_TABLE = 'actionscheduler_actions';
12	const CLAIMS_TABLE = 'actionscheduler_claims';
13	const GROUPS_TABLE = 'actionscheduler_groups';
14	const DEFAULT_DATE = '0000-00-00 00:00:00';
15
16	/**
17	* @var int Increment this value to trigger a schema update.
18	*/
19	protected $schema_version = 6;
20
21	public function __construct() {
22	$this->tables = [
23	self::ACTIONS_TABLE,
24	self::CLAIMS_TABLE,
25	self::GROUPS_TABLE,
26	];
27	}
28
29	/**
30	* Performs additional setup work required to support this schema.
31	*/
32	public function init() {
33	add_action( 'action_scheduler_before_schema_update', array( $this, 'update_schema_5_0' ), 10, 2 );
34	}
35
36	protected function get_table_definition( $table ) {
37	global $wpdb;
38	$table_name = $wpdb->$table;
39	$charset_collate = $wpdb->get_charset_collate();
40	$max_index_length = 191; // @see wp_get_db_schema()
41	$default_date = self::DEFAULT_DATE;
42	switch ( $table ) {
43
44	case self::ACTIONS_TABLE:
45
46	return "CREATE TABLE {$table_name} (
47	action_id bigint(20) unsigned NOT NULL auto_increment,
48	hook varchar(191) NOT NULL,
49	status varchar(20) NOT NULL,
50	scheduled_date_gmt datetime NULL default '{$default_date}',
51	scheduled_date_local datetime NULL default '{$default_date}',
52	args varchar($max_index_length),
53	schedule longtext,
54	group_id bigint(20) unsigned NOT NULL default '0',
55	attempts int(11) NOT NULL default '0',
56	last_attempt_gmt datetime NULL default '{$default_date}',
57	last_attempt_local datetime NULL default '{$default_date}',
58	claim_id bigint(20) unsigned NOT NULL default '0',
59	extended_args varchar(8000) DEFAULT NULL,
60	PRIMARY KEY (action_id),
61	KEY hook (hook($max_index_length)),
62	KEY status (status),
63	KEY scheduled_date_gmt (scheduled_date_gmt),
64	KEY args (args($max_index_length)),
65	KEY group_id (group_id),
66	KEY last_attempt_gmt (last_attempt_gmt),
67	KEY `claim_id_status_scheduled_date_gmt` (`claim_id`, `status`, `scheduled_date_gmt`)
68	) $charset_collate";
69
70	case self::CLAIMS_TABLE:
71
72	return "CREATE TABLE {$table_name} (
73	claim_id bigint(20) unsigned NOT NULL auto_increment,
74	date_created_gmt datetime NULL default '{$default_date}',
75	PRIMARY KEY (claim_id),
76	KEY date_created_gmt (date_created_gmt)
77	) $charset_collate";
78
79	case self::GROUPS_TABLE:
80
81	return "CREATE TABLE {$table_name} (
82	group_id bigint(20) unsigned NOT NULL auto_increment,
83	slug varchar(255) NOT NULL,
84	PRIMARY KEY (group_id),
85	KEY slug (slug($max_index_length))
86	) $charset_collate";
87
88	default:
89	return '';
90	}
91	}
92
93	/**
94	* Update the actions table schema, allowing datetime fields to be NULL.
95	*
96	* This is needed because the NOT NULL constraint causes a conflict with some versions of MySQL
97	* configured with sql_mode=NO_ZERO_DATE, which can for instance lead to tables not being created.
98	*
99	* Most other schema updates happen via ActionScheduler_Abstract_Schema::update_table(), however
100	* that method relies on dbDelta() and this change is not possible when using that function.
101	*
102	* @param string $table Name of table being updated.
103	* @param string $db_version The existing schema version of the table.
104	*/
105	public function update_schema_5_0( $table, $db_version ) {
106	global $wpdb;
107
108	if ( 'actionscheduler_actions' !== $table \|\| version_compare( $db_version, '5', '>=' ) ) {
109	return;
110	}
111
112	// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
113	$table_name = $wpdb->prefix . 'actionscheduler_actions';
114	$table_list = $wpdb->get_col( "SHOW TABLES LIKE '{$table_name}'" );
115	$default_date = self::DEFAULT_DATE;
116
117	if ( ! empty( $table_list ) ) {
118	$query = "
119	ALTER TABLE {$table_name}
120	MODIFY COLUMN scheduled_date_gmt datetime NULL default '{$default_date}',
121	MODIFY COLUMN scheduled_date_local datetime NULL default '{$default_date}',
122	MODIFY COLUMN last_attempt_gmt datetime NULL default '{$default_date}',
123	MODIFY COLUMN last_attempt_local datetime NULL default '{$default_date}'
124	";
125	$wpdb->query( $query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
126	}
127	// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
128	}
129	}
130