ActionScheduler_StoreSchema.php
129 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 | $hook_status_scheduled_date_gmt_max_index_length = $max_index_length - 20 - 8; // - status, - scheduled_date_gmt |
| 42 | $default_date = self::DEFAULT_DATE; |
| 43 | switch ( $table ) { |
| 44 | |
| 45 | case self::ACTIONS_TABLE: |
| 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_status_scheduled_date_gmt (hook($hook_status_scheduled_date_gmt_max_index_length), status, scheduled_date_gmt), |
| 63 | KEY status_scheduled_date_gmt (status, scheduled_date_gmt), |
| 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 | 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 | return "CREATE TABLE {$table_name} ( |
| 81 | group_id bigint(20) unsigned NOT NULL auto_increment, |
| 82 | slug varchar(255) NOT NULL, |
| 83 | PRIMARY KEY (group_id), |
| 84 | KEY slug (slug($max_index_length)) |
| 85 | ) $charset_collate"; |
| 86 | |
| 87 | default: |
| 88 | return ''; |
| 89 | } |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Update the actions table schema, allowing datetime fields to be NULL. |
| 94 | * |
| 95 | * This is needed because the NOT NULL constraint causes a conflict with some versions of MySQL |
| 96 | * configured with sql_mode=NO_ZERO_DATE, which can for instance lead to tables not being created. |
| 97 | * |
| 98 | * Most other schema updates happen via ActionScheduler_Abstract_Schema::update_table(), however |
| 99 | * that method relies on dbDelta() and this change is not possible when using that function. |
| 100 | * |
| 101 | * @param string $table Name of table being updated. |
| 102 | * @param string $db_version The existing schema version of the table. |
| 103 | */ |
| 104 | public function update_schema_5_0( $table, $db_version ) { |
| 105 | global $wpdb; |
| 106 | |
| 107 | if ( 'actionscheduler_actions' !== $table || version_compare( $db_version, '5', '>=' ) ) { |
| 108 | return; |
| 109 | } |
| 110 | |
| 111 | // phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared |
| 112 | $table_name = $wpdb->prefix . 'actionscheduler_actions'; |
| 113 | $table_list = $wpdb->get_col( "SHOW TABLES LIKE '{$table_name}'" ); |
| 114 | $default_date = self::DEFAULT_DATE; |
| 115 | |
| 116 | if ( ! empty( $table_list ) ) { |
| 117 | $query = " |
| 118 | ALTER TABLE {$table_name} |
| 119 | MODIFY COLUMN scheduled_date_gmt datetime NULL default '{$default_date}', |
| 120 | MODIFY COLUMN scheduled_date_local datetime NULL default '{$default_date}', |
| 121 | MODIFY COLUMN last_attempt_gmt datetime NULL default '{$default_date}', |
| 122 | MODIFY COLUMN last_attempt_local datetime NULL default '{$default_date}' |
| 123 | "; |
| 124 | $wpdb->query( $query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared |
| 125 | } |
| 126 | // phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared |
| 127 | } |
| 128 | } |
| 129 |