<?php
/**
* Forminator Database Tables
*
* @package Forminator
*/
if ( ! defined( 'ABSPATH' ) ) {
die();
}
/**
* Class Forminator_Upgrade
*
* Handle any installation upgrade or install tasks
*/
class Forminator_Database_Tables {
/**
* Table name keys
*/
const FORM_ENTRY = 'form_entry';
const FORM_ENTRY_META = 'form_entry_meta';
const FORM_VIEWS = 'form_views';
const FORM_REPORTS = 'form_reports';
/**
* Current tables
*
* @var array
*/
private static $tables = array();
/**
* Get all the used table names
*
* @param bool $db DB.
*
* @return array
* @since 1.0
*/
private static function table_names( $db = false ) {
if ( ! $db ) {
global $wpdb;
$db = $wpdb;
}
return array(
self::FORM_ENTRY => $db->prefix . 'frmt_form_entry',
self::FORM_ENTRY_META => $db->prefix . 'frmt_form_entry_meta',
self::FORM_VIEWS => $db->prefix . 'frmt_form_views',
self::FORM_REPORTS => $db->prefix . 'frmt_form_reports',
);
}
/**
* Get Table Name
*
* @param string $name - the name of the table.
*
* @return string|bool
* @since 1.0
*/
public static function get_table_name( $name ) {
if ( empty( self::$tables ) ) {
self::$tables = self::table_names();
}
return isset( self::$tables[ $name ] ) ? self::$tables[ $name ] : false;
}
/**
* Set up custom database tables
*
* @since 1.0
*/
public static function install_database_tables() {
require_once ABSPATH . 'wp-admin/includes/upgrade.php';
global $wpdb;
$wpdb->hide_errors();
$max_index_length = 191;
$charset_collate = $wpdb->get_charset_collate();
// Form entry.
$table_name = self::get_table_name( self::FORM_ENTRY );
if ( $table_name ) {
$sql = "CREATE TABLE {$table_name} (
`entry_id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`entry_type` VARCHAR(191) NOT NULL,
`draft_id` VARCHAR(12) NULL,
`form_id` bigint(20) unsigned NOT NULL,
`custom_id` bigint(20) unsigned NOT NULL DEFAULT 0,
`custom_prefix` VARCHAR(191) NOT NULL DEFAULT '',
`is_spam` TINYINT(1) NOT NULL DEFAULT 0,
`date_created` datetime NOT NULL default '0000-00-00 00:00:00',
`status` ENUM('active','spam','draft','abandoned') NOT NULL DEFAULT 'active',
PRIMARY KEY (`entry_id`),
KEY `entry_is_spam` (`is_spam` ASC ),
KEY `entry_status` (`status`),
KEY `entry_form_status` (`form_id`, `status`),
KEY `entry_form_custom_id` (`form_id`, `custom_id`),
KEY `entry_type` (`entry_type`($max_index_length)),
KEY `entry_form_id` (`form_id`))
$charset_collate;";
dbDelta( $sql );
}
// Form entry meta.
// Each entry is unique to each form.
$table_name = self::get_table_name( self::FORM_ENTRY_META );
if ( $table_name ) {
$sql = "CREATE TABLE {$table_name} (
`meta_id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`entry_id` bigint(20) unsigned NOT NULL,
`meta_key` VARCHAR(191) default NULL,
`meta_value` LONGTEXT NULL,
`date_created` datetime NOT NULL default '0000-00-00 00:00:00',
`date_updated` datetime NOT NULL default '0000-00-00 00:00:00',
PRIMARY KEY (`meta_id`),
KEY `meta_key` (`meta_key`($max_index_length)),
KEY `meta_entry_id` (`entry_id` ASC ),
KEY `meta_key_object` (`entry_id` ASC, `meta_key` ASC))
$charset_collate;";
dbDelta( $sql );
}
// Views.
$table_name = self::get_table_name( self::FORM_VIEWS );
if ( $table_name ) {
$sql = "CREATE TABLE {$table_name} (
`view_id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`form_id` bigint(20) unsigned NOT NULL,
`page_id` bigint(20) unsigned NOT NULL,
`ip` VARCHAR(191) default NULL,
`count` mediumint(8) unsigned not null default 1,
`date_created` datetime NOT NULL default '0000-00-00 00:00:00',
`date_updated` datetime NOT NULL default '0000-00-00 00:00:00',
PRIMARY KEY (`view_id`),
KEY `view_form_id` (`form_id` ASC ),
KEY `view_ip` (`ip`($max_index_length)),
KEY `view_form_object` (`form_id` ASC, `view_id` ASC),
KEY `view_form_object_ip` (`form_id` ASC, `view_id` ASC, `ip` ASC))
$charset_collate;";
dbDelta( $sql );
}
// Reports table.
$table_name = self::get_table_name( self::FORM_REPORTS );
if ( $table_name ) {
$sql = "CREATE TABLE {$table_name} (
`report_id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`report_value` LONGTEXT NOT NULL,
`status` VARCHAR(200) NOT NULL,
`date_created` datetime NOT NULL default '0000-00-00 00:00:00',
`date_updated` datetime NOT NULL default '0000-00-00 00:00:00',
PRIMARY KEY (`report_id`) )
$charset_collate;";
dbDelta( $sql );
}
}
/**
* Migrate existing entries to the new `status` column.
*
* - spam -> status = 'spam'
* - drafts (draft_id not empty and not null) -> status = 'draft'
* - others remain 'active' (default)
*
* @param string|null $new_version The new plugin version being upgraded to.
* @param string|null $old_version The previously installed plugin version.
*
* @return void
*/
public static function maybe_migrate_entry_status( $new_version = null, $old_version = null ) {
global $wpdb;
$table_name = self::get_table_name( self::FORM_ENTRY );
if ( ! $table_name ) {
return;
}
// If called from versioned hook, ensure we only run for upgrades below the target version.
$target_version = '1.48.0';
if ( ! empty( $old_version ) && version_compare( $old_version, $target_version, '>' ) ) {
return;
}
// Check if status column exists.
$column = $wpdb->get_var( $wpdb->prepare( "SHOW COLUMNS FROM {$table_name} LIKE %s", 'status' ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.DirectDatabaseQuery.NoCaching
if ( empty( $column ) ) {
return;
}
// Only run once per installation/upgrade.
$option_key = 'forminator_status_migration_done';
if ( get_option( $option_key ) ) {
return;
}
// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.DirectDatabaseQuery.NoCaching
// Set drafts first without checking spam; spam update below will override when needed.
$wpdb->query( "UPDATE {$table_name} SET `status` = 'draft' WHERE (`draft_id` IS NOT NULL AND `draft_id` <> '') AND `status` <> 'draft'" );
// Mark spam second so it always wins over any previous state.
$wpdb->query( "UPDATE {$table_name} SET `status` = 'spam' WHERE `is_spam` = 1 AND `status` <> 'spam'" );
// Normalize any null/empty values to 'active' as safety.
$wpdb->query( "UPDATE {$table_name} SET `status` = 'active' WHERE (`status` IS NULL OR `status` = '')" );
// phpcs:enable WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.DirectDatabaseQuery.NoCaching
update_option( $option_key, time() );
}
/**
* Delete custom tables
*
* @deprecated on 1.1 use forminator_drop_custom_tables on uninstall.php
* @since 1.0
*/
public static function uninstall_database_tables() {
_deprecated_function( __METHOD__, '1.1', 'forminator_drop_custom_tables' );
global $wpdb;
$tables = self::table_names( $wpdb );
$wpdb->hide_errors();
foreach ( $tables as $table_name ) {
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Caching is not required while dropping the table.
if ( ( $wpdb->get_var( $wpdb->prepare( 'SHOW TABLES LIKE %s', $table_name ) ) === $table_name ) ) {
$wpdb->query( $wpdb->prepare( 'DROP TABLE %s', $table_name ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.SchemaChange
}
}
}
/**
* Insert default database entries
*
* @return void
*/
public static function insert_default_entries() {
Forminator_Form_Reports_Model::get_instance()->default_report_entry();
}
}