image-optimization / vendor / woocommerce / action-scheduler / classes / schema / ActionScheduler_StoreSchema.php

ActionScheduler_StoreSchema.php in Image Optimizer – Compress Images and Convert to WebP or AVIF 1.7.7, at vendor/woocommerce/action-scheduler/classes/schema/ActionScheduler_StoreSchema.php

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