ActionScheduler_StoreSchema.php — WP Mail SMTP by WPForms – The Most Popular SMTP and Email Log Plugin 3.11.0

wp-mail-smtp / vendor / woocommerce / action-scheduler / classes / schema / ActionScheduler_StoreSchema.php

wp-mail-smtp / vendor / woocommerce / action-scheduler / classes / schema Last commit date

ActionScheduler_LoggerSchema.php 2 years ago ActionScheduler_StoreSchema.php 2 years ago

ActionScheduler_StoreSchema.php

131 lines

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 = 7;
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	priority tinyint unsigned NOT NULL default '10',
53	args varchar($max_index_length),
54	schedule longtext,
55	group_id bigint(20) unsigned NOT NULL default '0',
56	attempts int(11) NOT NULL default '0',
57	last_attempt_gmt datetime NULL default '{$default_date}',
58	last_attempt_local datetime NULL default '{$default_date}',
59	claim_id bigint(20) unsigned NOT NULL default '0',
60	extended_args varchar(8000) DEFAULT NULL,
61	PRIMARY KEY (action_id),
62	KEY hook (hook($max_index_length)),
63	KEY status (status),
64	KEY scheduled_date_gmt (scheduled_date_gmt),
65	KEY args (args($max_index_length)),
66	KEY group_id (group_id),
67	KEY last_attempt_gmt (last_attempt_gmt),
68	KEY `claim_id_status_scheduled_date_gmt` (`claim_id`, `status`, `scheduled_date_gmt`)
69	) $charset_collate";
70
71	case self::CLAIMS_TABLE:
72
73	return "CREATE TABLE {$table_name} (
74	claim_id bigint(20) unsigned NOT NULL auto_increment,
75	date_created_gmt datetime NULL default '{$default_date}',
76	PRIMARY KEY (claim_id),
77	KEY date_created_gmt (date_created_gmt)
78	) $charset_collate";
79
80	case self::GROUPS_TABLE:
81
82	return "CREATE TABLE {$table_name} (
83	group_id bigint(20) unsigned NOT NULL auto_increment,
84	slug varchar(255) NOT NULL,
85	PRIMARY KEY (group_id),
86	KEY slug (slug($max_index_length))
87	) $charset_collate";
88
89	default:
90	return '';
91	}
92	}
93
94	/**
95	* Update the actions table schema, allowing datetime fields to be NULL.
96	*
97	* This is needed because the NOT NULL constraint causes a conflict with some versions of MySQL
98	* configured with sql_mode=NO_ZERO_DATE, which can for instance lead to tables not being created.
99	*
100	* Most other schema updates happen via ActionScheduler_Abstract_Schema::update_table(), however
101	* that method relies on dbDelta() and this change is not possible when using that function.
102	*
103	* @param string $table Name of table being updated.
104	* @param string $db_version The existing schema version of the table.
105	*/
106	public function update_schema_5_0( $table, $db_version ) {
107	global $wpdb;
108
109	if ( 'actionscheduler_actions' !== $table \|\| version_compare( $db_version, '5', '>=' ) ) {
110	return;
111	}
112
113	// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
114	$table_name = $wpdb->prefix . 'actionscheduler_actions';
115	$table_list = $wpdb->get_col( "SHOW TABLES LIKE '{$table_name}'" );
116	$default_date = self::DEFAULT_DATE;
117
118	if ( ! empty( $table_list ) ) {
119	$query = "
120	ALTER TABLE {$table_name}
121	MODIFY COLUMN scheduled_date_gmt datetime NULL default '{$default_date}',
122	MODIFY COLUMN scheduled_date_local datetime NULL default '{$default_date}',
123	MODIFY COLUMN last_attempt_gmt datetime NULL default '{$default_date}',
124	MODIFY COLUMN last_attempt_local datetime NULL default '{$default_date}'
125	";
126	$wpdb->query( $query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
127	}
128	// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
129	}
130	}
131