<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Tasks;

[2] Fix | Delete

[3] Fix | Delete

use WPForms_DB;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Class Meta helps to manage the tasks meta information

[7] Fix | Delete

* between Action Scheduler and WPForms hooks arguments.

[8] Fix | Delete

* We can't pass arguments longer than >191 chars in JSON to AS,

[9] Fix | Delete

* so we need to store them somewhere (and clean from time to time).

[10] Fix | Delete

*

[11] Fix | Delete

* @since 1.5.9

[12] Fix | Delete

*/

[13] Fix | Delete

class Meta extends WPForms_DB {

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* Primary key (unique field) for the database table.

[17] Fix | Delete

*

[18] Fix | Delete

* @since 1.5.9

[19] Fix | Delete

*

[20] Fix | Delete

* @var string

[21] Fix | Delete

*/

[22] Fix | Delete

public $primary_key = 'id';

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Database type identifier.

[26] Fix | Delete

*

[27] Fix | Delete

* @since 1.5.9

[28] Fix | Delete

*

[29] Fix | Delete

* @var string

[30] Fix | Delete

*/

[31] Fix | Delete

public $type = 'tasks_meta';

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* Primary class constructor.

[35] Fix | Delete

*

[36] Fix | Delete

* @since 1.5.9

[37] Fix | Delete

*/

[38] Fix | Delete

public function __construct() {

[39] Fix | Delete

[40] Fix | Delete

parent::__construct();

[41] Fix | Delete

[42] Fix | Delete

$this->table_name = self::get_table_name();

[43] Fix | Delete

}

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* Get the DB table name.

[47] Fix | Delete

*

[48] Fix | Delete

* @since 1.5.9

[49] Fix | Delete

*

[50] Fix | Delete

* @return string

[51] Fix | Delete

*/

[52] Fix | Delete

public static function get_table_name() {

[53] Fix | Delete

[54] Fix | Delete

global $wpdb;

[55] Fix | Delete

[56] Fix | Delete

return $wpdb->prefix . 'wpforms_tasks_meta';

[57] Fix | Delete

}

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* Get table columns.

[61] Fix | Delete

*

[62] Fix | Delete

* @since 1.5.9

[63] Fix | Delete

*/

[64] Fix | Delete

public function get_columns() {

[65] Fix | Delete

[66] Fix | Delete

return [

[67] Fix | Delete

'id' => '%d',

[68] Fix | Delete

'action' => '%s',

[69] Fix | Delete

'data' => '%s',

[70] Fix | Delete

'date' => '%s',

[71] Fix | Delete

];

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* Default column values.

[76] Fix | Delete

*

[77] Fix | Delete

* @since 1.5.9

[78] Fix | Delete

*

[79] Fix | Delete

* @return array

[80] Fix | Delete

*/

[81] Fix | Delete

public function get_column_defaults() {

[82] Fix | Delete

[83] Fix | Delete

return [

[84] Fix | Delete

'action' => '',

[85] Fix | Delete

'data' => '',

[86] Fix | Delete

'date' => gmdate( 'Y-m-d H:i:s' ),

[87] Fix | Delete

];

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

/**

[91] Fix | Delete

* Create custom entry meta database table.

[92] Fix | Delete

* Used in migration and on plugin activation.

[93] Fix | Delete

*

[94] Fix | Delete

* @since 1.5.9

[95] Fix | Delete

*

[96] Fix | Delete

* @noinspection UnusedFunctionResultInspection

[97] Fix | Delete

*/

[98] Fix | Delete

public function create_table() {

[99] Fix | Delete

[100] Fix | Delete

global $wpdb;

[101] Fix | Delete

[102] Fix | Delete

require_once ABSPATH . 'wp-admin/includes/upgrade.php';

[103] Fix | Delete

[104] Fix | Delete

$charset_collate = $wpdb->get_charset_collate();

[105] Fix | Delete

[106] Fix | Delete

$sql = "CREATE TABLE $this->table_name (

[107] Fix | Delete

id bigint(20) NOT NULL AUTO_INCREMENT,

[108] Fix | Delete

action varchar(255) NOT NULL,

[109] Fix | Delete

data longtext NOT NULL,

[110] Fix | Delete

date datetime NOT NULL,

[111] Fix | Delete

PRIMARY KEY (id)

[112] Fix | Delete

) $charset_collate;";

[113] Fix | Delete

[114] Fix | Delete

dbDelta( $sql );

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

/**

[118] Fix | Delete

* Remove queue records for a defined period of time in the past.

[119] Fix | Delete

* Calling this method will remove queue records that are older than $period seconds.

[120] Fix | Delete

*

[121] Fix | Delete

* @since 1.5.9

[122] Fix | Delete

*

[123] Fix | Delete

* @param string $action Action that should be cleaned up.

[124] Fix | Delete

* @param int $interval Number of seconds from now.

[125] Fix | Delete

*

[126] Fix | Delete

* @return int Number of removed tasks meta records.

[127] Fix | Delete

*/

[128] Fix | Delete

public function clean_by( $action, $interval ) {

[129] Fix | Delete

[130] Fix | Delete

global $wpdb;

[131] Fix | Delete

[132] Fix | Delete

if ( empty( $action ) || empty( $interval ) ) {

[133] Fix | Delete

return 0;

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

$table = self::get_table_name();

[137] Fix | Delete

$action = sanitize_key( $action );

[138] Fix | Delete

$date = gmdate( 'Y-m-d H:i:s', time() - (int) $interval );

[139] Fix | Delete

[140] Fix | Delete

// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching

[141] Fix | Delete

return (int) $wpdb->query(

[142] Fix | Delete

$wpdb->prepare(

[143] Fix | Delete

"DELETE FROM $table WHERE action = %s AND date < %s", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared

[144] Fix | Delete

$action,

[145] Fix | Delete

$date

[146] Fix | Delete

)

[147] Fix | Delete

);

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

/**

[151] Fix | Delete

* Inserts a new record into the database.

[152] Fix | Delete

*

[153] Fix | Delete

* @since 1.5.9

[154] Fix | Delete

*

[155] Fix | Delete

* @param array $data Column data.

[156] Fix | Delete

* @param string $type Optional. Data type context.

[157] Fix | Delete

*

[158] Fix | Delete

* @return int ID for the newly inserted record. Zero otherwise.

[159] Fix | Delete

*/

[160] Fix | Delete

public function add( $data, $type = '' ) {

[161] Fix | Delete

[162] Fix | Delete

if ( empty( $data['action'] ) || ! is_string( $data['action'] ) ) {

[163] Fix | Delete

return 0;

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

$data['action'] = sanitize_key( $data['action'] );

[167] Fix | Delete

[168] Fix | Delete

if ( isset( $data['data'] ) ) {

[169] Fix | Delete

$data['data'] = $this->prepare_data( $data['data'] );

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete

if ( empty( $type ) ) {

[173] Fix | Delete

$type = $this->type;

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

return parent::add( $data, $type );

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

/**

[180] Fix | Delete

* Prepare data.

[181] Fix | Delete

*

[182] Fix | Delete

* @since 1.7.0

[183] Fix | Delete

*

[184] Fix | Delete

* @param array $data Meta data.

[185] Fix | Delete

*

[186] Fix | Delete

* @return string

[187] Fix | Delete

*/

[188] Fix | Delete

private function prepare_data( $data ) {

[189] Fix | Delete

[190] Fix | Delete

$string = wp_json_encode( $data );

[191] Fix | Delete

[192] Fix | Delete

if ( $string === false ) {

[193] Fix | Delete

$string = '';

[194] Fix | Delete

}

[195] Fix | Delete

[196] Fix | Delete

/*

[197] Fix | Delete

* We are encoding the string representation of all the data to make sure that nothing can harm the database.

[198] Fix | Delete

* This is not an encryption, and we need this data later "as is",

[199] Fix | Delete

* so we are using one of the fastest ways to do that.

[200] Fix | Delete

* This data is removed from DB daily.

[201] Fix | Delete

*/

[202] Fix | Delete

// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode

[203] Fix | Delete

return base64_encode( $string );

[204] Fix | Delete

}

[205] Fix | Delete

[206] Fix | Delete

/**

[207] Fix | Delete

* Retrieve a row from the database based on a given row ID.

[208] Fix | Delete

*

[209] Fix | Delete

* @since 1.5.9

[210] Fix | Delete

*

[211] Fix | Delete

* @param int $meta_id Meta ID.

[212] Fix | Delete

*

[213] Fix | Delete

* @return null|object

[214] Fix | Delete

* @noinspection PhpParameterNameChangedDuringInheritanceInspection

[215] Fix | Delete

*/

[216] Fix | Delete

public function get( $meta_id ) {

[217] Fix | Delete

[218] Fix | Delete

$meta = parent::get( $meta_id );

[219] Fix | Delete

[220] Fix | Delete

if ( empty( $meta ) || empty( $meta->data ) ) {

[221] Fix | Delete

return $meta;

[222] Fix | Delete

}

[223] Fix | Delete

[224] Fix | Delete

// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode

[225] Fix | Delete

$decoded = base64_decode( $meta->data );

[226] Fix | Delete

[227] Fix | Delete

if ( $decoded === false || ! is_string( $decoded ) ) {

[228] Fix | Delete

$meta->data = '';

[229] Fix | Delete

} else {

[230] Fix | Delete

$meta->data = json_decode( $decoded, true );

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

return $meta;

[234] Fix | Delete

}

[235] Fix | Delete

[236] Fix | Delete

/**

[237] Fix | Delete

* Get meta ID by action name and params.

[238] Fix | Delete

*

[239] Fix | Delete

* @since 1.7.0

[240] Fix | Delete

*

[241] Fix | Delete

* @param string $action Action name.

[242] Fix | Delete

* @param array $params Action params.

[243] Fix | Delete

*

[244] Fix | Delete

* @return int

[245] Fix | Delete

*/

[246] Fix | Delete

public function get_meta_id( $action, $params ) {

[247] Fix | Delete

[248] Fix | Delete

global $wpdb;

[249] Fix | Delete

[250] Fix | Delete

$table = self::get_table_name();

[251] Fix | Delete

$action = sanitize_key( $action );

[252] Fix | Delete

$data = $this->prepare_data( array_values( $params ) );

[253] Fix | Delete

[254] Fix | Delete

return absint(

[255] Fix | Delete

// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching

[256] Fix | Delete

$wpdb->get_var(

[257] Fix | Delete

$wpdb->prepare(

[258] Fix | Delete

"SELECT id FROM $table WHERE action = %s AND data = %s LIMIT 1", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared

[259] Fix | Delete

$action,

[260] Fix | Delete

$data

[261] Fix | Delete

)

[262] Fix | Delete

)

[263] Fix | Delete

);

[264] Fix | Delete

}

[265] Fix | Delete

}

[266] Fix | Delete

[267] Fix | Delete