| 1 |
<?php |
| 2 |
|
| 3 |
/** |
| 4 |
* Class ActionScheduler_LoggerSchema |
| 5 |
* |
| 6 |
* @codeCoverageIgnore |
| 7 |
* |
| 8 |
* Creates a custom table for storing action logs |
| 9 |
*/ |
| 10 |
class ActionScheduler_LoggerSchema extends ActionScheduler_Abstract_Schema { |
| 11 |
const LOG_TABLE = 'actionscheduler_logs'; |
| 12 |
|
| 13 |
/** |
| 14 |
* @var int Increment this value to trigger a schema update. |
| 15 |
*/ |
| 16 |
protected $schema_version = 3; |
| 17 |
|
| 18 |
public function __construct() { |
| 19 |
$this->tables = [ |
| 20 |
self::LOG_TABLE, |
| 21 |
]; |
| 22 |
} |
| 23 |
|
| 24 |
/** |
| 25 |
* Performs additional setup work required to support this schema. |
| 26 |
*/ |
| 27 |
public function init() { |
| 28 |
add_action( 'action_scheduler_before_schema_update', array( $this, 'update_schema_3_0' ), 10, 2 ); |
| 29 |
} |
| 30 |
|
| 31 |
protected function get_table_definition( $table ) { |
| 32 |
global $wpdb; |
| 33 |
$table_name = $wpdb->$table; |
| 34 |
$charset_collate = $wpdb->get_charset_collate(); |
| 35 |
switch ( $table ) { |
| 36 |
|
| 37 |
case self::LOG_TABLE: |
| 38 |
|
| 39 |
$default_date = ActionScheduler_StoreSchema::DEFAULT_DATE; |
| 40 |
return "CREATE TABLE $table_name ( |
| 41 |
log_id bigint(20) unsigned NOT NULL auto_increment, |
| 42 |
action_id bigint(20) unsigned NOT NULL, |
| 43 |
message text NOT NULL, |
| 44 |
log_date_gmt datetime NULL default '{$default_date}', |
| 45 |
log_date_local datetime NULL default '{$default_date}', |
| 46 |
PRIMARY KEY (log_id), |
| 47 |
KEY action_id (action_id), |
| 48 |
KEY log_date_gmt (log_date_gmt) |
| 49 |
) $charset_collate"; |
| 50 |
|
| 51 |
default: |
| 52 |
return ''; |
| 53 |
} |
| 54 |
} |
| 55 |
|
| 56 |
/** |
| 57 |
* Update the logs table schema, allowing datetime fields to be NULL. |
| 58 |
* |
| 59 |
* This is needed because the NOT NULL constraint causes a conflict with some versions of MySQL |
| 60 |
* configured with sql_mode=NO_ZERO_DATE, which can for instance lead to tables not being created. |
| 61 |
* |
| 62 |
* Most other schema updates happen via ActionScheduler_Abstract_Schema::update_table(), however |
| 63 |
* that method relies on dbDelta() and this change is not possible when using that function. |
| 64 |
* |
| 65 |
* @param string $table Name of table being updated. |
| 66 |
* @param string $db_version The existing schema version of the table. |
| 67 |
*/ |
| 68 |
public function update_schema_3_0( $table, $db_version ) { |
| 69 |
global $wpdb; |
| 70 |
|
| 71 |
if ( 'actionscheduler_logs' !== $table || version_compare( $db_version, '3', '>=' ) ) { |
| 72 |
return; |
| 73 |
} |
| 74 |
|
| 75 |
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared |
| 76 |
$table_name = $wpdb->prefix . 'actionscheduler_logs'; |
| 77 |
$table_list = $wpdb->get_col( "SHOW TABLES LIKE '{$table_name}'" ); |
| 78 |
$default_date = ActionScheduler_StoreSchema::DEFAULT_DATE; |
| 79 |
|
| 80 |
if ( ! empty( $table_list ) ) { |
| 81 |
$query = " |
| 82 |
ALTER TABLE {$table_name} |
| 83 |
MODIFY COLUMN log_date_gmt datetime NULL default '{$default_date}', |
| 84 |
MODIFY COLUMN log_date_local datetime NULL default '{$default_date}' |
| 85 |
"; |
| 86 |
$wpdb->query( $query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared |
| 87 |
} |
| 88 |
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared |
| 89 |
} |
| 90 |
} |
| 91 |
|
