<?php

[0] Fix | Delete

[1] Fix | Delete

// phpcs:ignore Generic.Commenting.DocComment.MissingShort

[2] Fix | Delete

/** @noinspection PhpIllegalPsrClassPathInspection */

[3] Fix | Delete

[4] Fix | Delete

namespace WPForms\Helpers;

[5] Fix | Delete

[6] Fix | Delete

// phpcs:ignore WPForms.PHP.UseStatement.UnusedUseStatement

[7] Fix | Delete

use WPForms_DB;

[8] Fix | Delete

use WPForms_Lite;

[9] Fix | Delete

use WPForms_Pro;

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* DB helpers.

[13] Fix | Delete

*

[14] Fix | Delete

* @since 1.8.7

[15] Fix | Delete

*/

[16] Fix | Delete

class DB {

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Existing tables transient name.

[20] Fix | Delete

*

[21] Fix | Delete

* @since 1.8.7

[22] Fix | Delete

* @since 1.9.0 Changed from 'wpforms_existing_tables' to 'existing_tables'

[23] Fix | Delete

*

[24] Fix | Delete

* @var string

[25] Fix | Delete

*/

[26] Fix | Delete

const EXISTING_TABLES_TRANSIENT_NAME = 'existing_tables';

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Existing tables transient expiration, sec.

[30] Fix | Delete

*

[31] Fix | Delete

* @since 1.8.7

[32] Fix | Delete

*

[33] Fix | Delete

* @var int

[34] Fix | Delete

* @noinspection SummerTimeUnsafeTimeManipulationInspection

[35] Fix | Delete

*/

[36] Fix | Delete

const EXISTING_TABLES_TRANSIENT_EXPIRATION = WEEK_IN_SECONDS; // A week.

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Existing tables.

[40] Fix | Delete

*

[41] Fix | Delete

* @since 1.8.7

[42] Fix | Delete

*

[43] Fix | Delete

* @var array

[44] Fix | Delete

*/

[45] Fix | Delete

private static $existing_tables = [];

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* Get the list of existing tables and cache the result.

[49] Fix | Delete

*

[50] Fix | Delete

* @since 1.8.7

[51] Fix | Delete

*

[52] Fix | Delete

* @param string $table_name Table name. Can have SQL wildcard.

[53] Fix | Delete

*

[54] Fix | Delete

* @return array List of table names.

[55] Fix | Delete

*/

[56] Fix | Delete

public static function get_existing_tables( string $table_name ): array {

[57] Fix | Delete

[58] Fix | Delete

global $wpdb;

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* Filters existence of a table before a request to the database is executed.

[62] Fix | Delete

*

[63] Fix | Delete

* @since 1.8.7

[64] Fix | Delete

*

[65] Fix | Delete

* @param array $tables Existing tables with given table name.

[66] Fix | Delete

* @param string $table_name Table name.

[67] Fix | Delete

*/

[68] Fix | Delete

$tables = (array) apply_filters( 'wpforms_helpers_db_pre_get_existing_tables', [], $table_name );

[69] Fix | Delete

[70] Fix | Delete

if ( $tables ) {

[71] Fix | Delete

return $tables;

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

$tables = self::get_existing_tables_cache( $table_name );

[75] Fix | Delete

[76] Fix | Delete

if ( $tables ) {

[77] Fix | Delete

return $tables;

[78] Fix | Delete

}

[79] Fix | Delete

[80] Fix | Delete

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

[81] Fix | Delete

$tables = $wpdb->get_results(

[82] Fix | Delete

$wpdb->prepare( 'SHOW TABLES LIKE %s', $table_name ),

[83] Fix | Delete

'ARRAY_N'

[84] Fix | Delete

);

[85] Fix | Delete

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

[86] Fix | Delete

[87] Fix | Delete

$tables = ! empty( $tables ) ? wp_list_pluck( $tables, 0 ) : [];

[88] Fix | Delete

[89] Fix | Delete

self::set_existing_tables_cache( $tables, $table_name );

[90] Fix | Delete

[91] Fix | Delete

return self::$existing_tables[ $table_name ] ?? [];

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

/**

[95] Fix | Delete

* Get the list of all existing custom tables starting with `wpforms_*` and cache the result.

[96] Fix | Delete

*

[97] Fix | Delete

* @since 1.8.7

[98] Fix | Delete

*

[99] Fix | Delete

* @return array List of table names.

[100] Fix | Delete

*/

[101] Fix | Delete

public static function get_existing_custom_tables(): array {

[102] Fix | Delete

[103] Fix | Delete

global $wpdb;

[104] Fix | Delete

[105] Fix | Delete

return self::get_existing_tables( "{$wpdb->prefix}wpforms_%" );

[106] Fix | Delete

}

[107] Fix | Delete

[108] Fix | Delete

/**

[109] Fix | Delete

* Check if the database table exists and cache the result.

[110] Fix | Delete

*

[111] Fix | Delete

* @since 1.8.7

[112] Fix | Delete

*

[113] Fix | Delete

* @param string $table_name Table name. Can have SQL wildcard.

[114] Fix | Delete

*

[115] Fix | Delete

* @return bool

[116] Fix | Delete

*/

[117] Fix | Delete

public static function table_exists( string $table_name ): bool {

[118] Fix | Delete

[119] Fix | Delete

/**

[120] Fix | Delete

* Filters existence of a table before a request to the database is executed.

[121] Fix | Delete

*

[122] Fix | Delete

* @since 1.8.7

[123] Fix | Delete

*

[124] Fix | Delete

* @param integer $exists Table exists.

[125] Fix | Delete

* @param string $table_name Table name.

[126] Fix | Delete

*/

[127] Fix | Delete

if ( apply_filters( 'wpforms_helpers_db_pre_table_exists', false, $table_name ) ) {

[128] Fix | Delete

return true;

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

foreach ( self::get_existing_tables( $table_name ) as $existing_table ) {

[132] Fix | Delete

if ( self::wildcard_match( $table_name, $existing_table ) ) {

[133] Fix | Delete

return true;

[134] Fix | Delete

}

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

return false;

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete

/**

[141] Fix | Delete

* Get the list of existing tables from cache.

[142] Fix | Delete

*

[143] Fix | Delete

* @since 1.8.7

[144] Fix | Delete

*

[145] Fix | Delete

* @param string $table_name Table name. Can have SQL wildcard.

[146] Fix | Delete

*

[147] Fix | Delete

* @return array List of table names.

[148] Fix | Delete

*/

[149] Fix | Delete

private static function get_existing_tables_cache( string $table_name ): array {

[150] Fix | Delete

[151] Fix | Delete

$tables = Transient::get( self::EXISTING_TABLES_TRANSIENT_NAME );

[152] Fix | Delete

self::$existing_tables = $tables ? $tables : [];

[153] Fix | Delete

[154] Fix | Delete

return self::$existing_tables[ $table_name ] ?? [];

[155] Fix | Delete

}

[156] Fix | Delete

[157] Fix | Delete

/**

[158] Fix | Delete

* Set existing tables cache.

[159] Fix | Delete

*

[160] Fix | Delete

* @since 1.8.7

[161] Fix | Delete

*

[162] Fix | Delete

* @param array $tables Existing tables with given table name.

[163] Fix | Delete

* @param string $table_name Table name.

[164] Fix | Delete

*

[165] Fix | Delete

* @return void

[166] Fix | Delete

*/

[167] Fix | Delete

private static function set_existing_tables_cache( array $tables, string $table_name ) {

[168] Fix | Delete

[169] Fix | Delete

if ( empty( $tables ) ) {

[170] Fix | Delete

return;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

self::$existing_tables[ $table_name ] = $tables;

[174] Fix | Delete

[175] Fix | Delete

/**

[176] Fix | Delete

* Filters existing tables transient expiration time.

[177] Fix | Delete

*

[178] Fix | Delete

* @since 1.8.7

[179] Fix | Delete

*

[180] Fix | Delete

* @param integer $expiration Expiration time.

[181] Fix | Delete

*/

[182] Fix | Delete

$expiration = apply_filters( 'wpforms_helpers_db_existing_tables_transient_expiration', self::EXISTING_TABLES_TRANSIENT_EXPIRATION );

[183] Fix | Delete

[184] Fix | Delete

Transient::set( self::EXISTING_TABLES_TRANSIENT_NAME, self::$existing_tables, $expiration );

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

/**

[188] Fix | Delete

* Flush existing tables cache.

[189] Fix | Delete

*

[190] Fix | Delete

* @since 1.9.0

[191] Fix | Delete

*

[192] Fix | Delete

* @return void

[193] Fix | Delete

*/

[194] Fix | Delete

public static function flush_existing_tables_cache() {

[195] Fix | Delete

[196] Fix | Delete

self::$existing_tables = [];

[197] Fix | Delete

[198] Fix | Delete

Transient::delete( self::EXISTING_TABLES_TRANSIENT_NAME );

[199] Fix | Delete

}

[200] Fix | Delete

[201] Fix | Delete

/**

[202] Fix | Delete

* Wildcard match.

[203] Fix | Delete

* Works as MySQL LIKE match.

[204] Fix | Delete

*

[205] Fix | Delete

* @since 1.8.7

[206] Fix | Delete

*

[207] Fix | Delete

* @param string $pattern Pattern.

[208] Fix | Delete

* @param string $subject String to search into.

[209] Fix | Delete

*

[210] Fix | Delete

* @return false|int

[211] Fix | Delete

*/

[212] Fix | Delete

private static function wildcard_match( string $pattern, string $subject ) {

[213] Fix | Delete

[214] Fix | Delete

$regex = str_replace(

[215] Fix | Delete

[ '%', '_' ], // MySQL wildcard chars.

[216] Fix | Delete

[ '.*', '.' ], // Regexp chars.

[217] Fix | Delete

preg_quote( $pattern, '/' )

[218] Fix | Delete

);

[219] Fix | Delete

[220] Fix | Delete

return preg_match( '/^' . $regex . '$/is', $subject );

[221] Fix | Delete

}

[222] Fix | Delete

[223] Fix | Delete

/**

[224] Fix | Delete

* Check if all custom tables exist.

[225] Fix | Delete

*

[226] Fix | Delete

* @since 1.9.0

[227] Fix | Delete

*

[228] Fix | Delete

* @return bool True if all custom tables exist. False if any is missing.

[229] Fix | Delete

*/

[230] Fix | Delete

public static function custom_tables_exist(): bool {

[231] Fix | Delete

[232] Fix | Delete

global $wpdb;

[233] Fix | Delete

[234] Fix | Delete

$existing_tables = self::get_existing_custom_tables();

[235] Fix | Delete

$custom_tables = wpforms()->is_pro() ? WPForms_Pro::CUSTOM_TABLES : WPForms_Lite::CUSTOM_TABLES;

[236] Fix | Delete

[237] Fix | Delete

foreach ( $custom_tables as $table_name => $handler_class ) {

[238] Fix | Delete

if ( ! in_array( $wpdb->prefix . $table_name, $existing_tables, true ) ) {

[239] Fix | Delete

return false;

[240] Fix | Delete

}

[241] Fix | Delete

}

[242] Fix | Delete

[243] Fix | Delete

return true;

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

/**

[247] Fix | Delete

* Create all custom DB tables.

[248] Fix | Delete

*

[249] Fix | Delete

* @since 1.9.0

[250] Fix | Delete

*

[251] Fix | Delete

* @param bool $flush_cache Clear existing custom tables cache.

[252] Fix | Delete

*

[253] Fix | Delete

* @noinspection PhpPossiblePolymorphicInvocationInspection

[254] Fix | Delete

*/

[255] Fix | Delete

public static function create_custom_tables( bool $flush_cache = false ) {

[256] Fix | Delete

[257] Fix | Delete

global $wpdb;

[258] Fix | Delete

[259] Fix | Delete

if ( $flush_cache ) {

[260] Fix | Delete

self::flush_existing_tables_cache();

[261] Fix | Delete

}

[262] Fix | Delete

[263] Fix | Delete

$existing_tables = self::get_existing_custom_tables();

[264] Fix | Delete

$custom_tables = wpforms()->is_pro() ? WPForms_Pro::CUSTOM_TABLES : WPForms_Lite::CUSTOM_TABLES;

[265] Fix | Delete

$created = false;

[266] Fix | Delete

[267] Fix | Delete

foreach ( $custom_tables as $table_name => $handler_class ) {

[268] Fix | Delete

if ( in_array( $wpdb->prefix . $table_name, $existing_tables, true ) ) {

[269] Fix | Delete

continue;

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

/**

[273] Fix | Delete

* Child class of WPForms_DB.

[274] Fix | Delete

*

[275] Fix | Delete

* @var $handler WPForms_DB

[276] Fix | Delete

*/

[277] Fix | Delete

$handler = new $handler_class();

[278] Fix | Delete

[279] Fix | Delete

// Create a table.

[280] Fix | Delete

$handler->create_table();

[281] Fix | Delete

[282] Fix | Delete

$created = true;

[283] Fix | Delete

}

[284] Fix | Delete

[285] Fix | Delete

if ( $created ) {

[286] Fix | Delete

Transient::delete( self::EXISTING_TABLES_TRANSIENT_NAME );

[287] Fix | Delete

}

[288] Fix | Delete

}

[289] Fix | Delete

}

[290] Fix | Delete

[291] Fix | Delete