← All changes | includes/Core/Database/DB.php +216 -48 2.0 → 3.3.1 View file →

		@@ -8,19 +8,137 @@
8	8	*/
9	9
10	10	namespace BitCode\BitForm\Core\Database;
11	11
	12	+use BitCode\BitForm\Core\Util\Log;
	13	+
12	14	/**
13	15	* Database Migration
14	16	*/
15		-final class DB {
	17	+final class DB
	18	+{
16	19	/**
17	20	* Undocumented function
18	21	*
19	22	* @return void
20	23	*/
21		- public static function migrate() {
	24	+
	25	+ /**
	26	+ * Idempotently add the email-template status/config columns.
	27	+ *
	28	+ * @return void
	29	+ */
	30	+ public static function ensureEmailTemplateStatusColumn()
	31	+ {
22	32	global $wpdb;
	33	+ $emailTable = $wpdb->prefix . 'bitforms_email_template';
	34	+ if (null === $wpdb->get_var("SHOW COLUMNS FROM `{$emailTable}` LIKE 'status'")) {
	35	+ // Schema migration: table name interpolation only (no user input). $wpdb->prepare() cannot parameterize DDL.
	36	+ $wpdb->query(
	37	+ "ALTER TABLE `{$emailTable}`
	38	+ ADD COLUMN `status` TINYINT(1) DEFAULT 1 AFTER `body`,
	39	+ ADD COLUMN `config` LONGTEXT NULL AFTER `status`"
	40	+ );
	41	+ }
	42	+ }
	43	+
	44	+ /**
	45	+ * Idempotently add the workflows `workflow_info` column.
	46	+ *
	47	+ * @return void
	48	+ */
	49	+ public static function ensureWorkflowInfoColumn()
	50	+ {
	51	+ global $wpdb;
	52	+ $table = $wpdb->prefix . 'bitforms_workflows';
	53	+ if (null === $wpdb->get_var("SHOW COLUMNS FROM `{$table}` LIKE 'workflow_info'")) {
	54	+ // Schema migration: table name interpolation only (no user input). $wpdb->prepare() cannot parameterize DDL.
	55	+ $wpdb->query(
	56	+ "ALTER TABLE `{$table}`
	57	+ ADD COLUMN `workflow_info` LONGTEXT NULL AFTER `workflow_condition`"
	58	+ );
	59	+ }
	60	+ }
	61	+
	62	+ /**
	63	+ * Idempotently add the workflows `workflow_category` column (conditional-logic classic/basic split).
	64	+ *
	65	+ * @return void
	66	+ */
	67	+ public static function ensureWorkflowCategoryColumn()
	68	+ {
	69	+ self::ensureWorkflowInfoColumn();
	70	+ global $wpdb;
	71	+ $table = $wpdb->prefix . 'bitforms_workflows';
	72	+ if (null === $wpdb->get_var("SHOW COLUMNS FROM `{$table}` LIKE 'workflow_category'")) {
	73	+ // Schema migration: table name interpolation only (no user input). $wpdb->prepare() cannot parameterize DDL.
	74	+ $wpdb->query(
	75	+ "ALTER TABLE `{$table}`
	76	+ ADD COLUMN `workflow_category` VARCHAR(20) DEFAULT 'classic' AFTER `workflow_info`,
	77	+ ADD KEY `workflow_category` (`workflow_category`)"
	78	+ );
	79	+ }
	80	+ }
	81	+
	82	+ /**
	83	+ * Idempotently add the workflows `workflow_order` column.
	84	+ *
	85	+ * @return void
	86	+ */
	87	+ public static function ensureWorkflowOrderColumn()
	88	+ {
	89	+ global $wpdb;
	90	+ $table = $wpdb->prefix . 'bitforms_workflows';
	91	+ if (null === $wpdb->get_var("SHOW COLUMNS FROM `{$table}` LIKE 'workflow_order'")) {
	92	+ $wpdb->query(
	93	+ "ALTER TABLE `{$table}`
	94	+ ADD COLUMN `workflow_order` INT(11) DEFAULT NULL AFTER `workflow_condition`"
	95	+ );
	96	+ }
	97	+ }
	98	+
	99	+ /**
	100	+ * Idempotently add the workflows `workflow_status` column.
	101	+ *
	102	+ * @return void
	103	+ */
	104	+ public static function ensureWorkflowStatusColumn()
	105	+ {
	106	+ self::ensureWorkflowOrderColumn();
	107	+ global $wpdb;
	108	+ $table = $wpdb->prefix . 'bitforms_workflows';
	109	+ if (null === $wpdb->get_var("SHOW COLUMNS FROM `{$table}` LIKE 'workflow_status'")) {
	110	+ $wpdb->query(
	111	+ "ALTER TABLE `{$table}`
	112	+ ADD COLUMN `workflow_status` TINYINT(1) DEFAULT 1 NOT NULL AFTER `workflow_order`"
	113	+ );
	114	+ }
	115	+ }
	116	+
	117	+ /**
	118	+ * Idempotently add every workflows column the queries reference, for installs whose
	119	+ * `bitforms_db_version` ran ahead of their real schema (a version-gated ALTER failed once).
	120	+ *
	121	+ * @return bool true when all four columns exist afterwards
	122	+ */
	123	+ public static function ensureWorkflowSchema()
	124	+ {
	125	+ global $wpdb;
	126	+ self::ensureWorkflowStatusColumn();
	127	+ self::ensureWorkflowCategoryColumn();
	128	+
	129	+ $table = $wpdb->prefix . 'bitforms_workflows';
	130	+ foreach (['workflow_order', 'workflow_info', 'workflow_category', 'workflow_status'] as $column) {
	131	+ if (null === $wpdb->get_var("SHOW COLUMNS FROM `{$table}` LIKE '{$column}'")) {
	132	+ return false;
	133	+ }
	134	+ }
	135	+ return true;
	136	+ }
	137	+
	138	+ public static function migrate()
	139	+ {
	140	+ global $wpdb;
23	141	global $bitforms_db_version;
24	142	$collate = '';
25	143
26	144	if ($wpdb->has_cap('collation')) {
		@@ -75,9 +193,12 @@
75	193	`workflow_type` varchar(50) NOT NULL,
76	194	`workflow_run` varchar(50) NOT NULL,
77	195	`workflow_behaviour` varchar(25) NOT NULL,
78	196	`workflow_condition` longtext DEFAULT NULL,
	197	+ `workflow_info` longtext DEFAULT NULL,
	198	+ `workflow_category` varchar(20) DEFAULT 'classic',/* classic = legacy, basic = field show/hide, advanced = multi-condition routing */
79	199	`workflow_order` int(11) unsigned DEFAULT NULL,
	200	+ `workflow_status` tinyint(1) DEFAULT 1,/* 0 disable, 1 enable, 2 enable in field settings */
80	201	`form_id` bigint(20) unsigned DEFAULT NULL,
81	202	`user_id` bigint(20) unsigned DEFAULT NULL,
82	203	`user_ip` int(11) unsigned DEFAULT NULL,
83	204	`user_location` text DEFAULT NULL,
		@@ -84,9 +205,10 @@
84	205	`user_device` varchar(50) DEFAULT NULL,
85	206	`created_at` datetime DEFAULT NULL,
86	207	`updated_at` datetime DEFAULT NULL,
87	208	PRIMARY KEY (`id`),
88		- KEY `form_id` (`form_id`)
	209	+ KEY `form_id` (`form_id`),
	210	+ KEY `workflow_category` (`workflow_category`)
89	211	) $collate;",
90	212
91	213	"CREATE TABLE IF NOT EXISTS `{$wpdb->prefix}bitforms_success_messages` (
92	214	`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
		@@ -105,8 +227,10 @@
105	227	`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
106	228	`title` text DEFAULT NULL,
107	229	`sub` text DEFAULT NULL,
108	230	`body` longtext DEFAULT NULL,
	231	+ `status` tinyint(1) DEFAULT 1,/* 0 disabled, 1 enabled */
	232	+ `config` longtext DEFAULT NULL,/* SendTo / From / From Name / CC / BCC / Reply-To / attachments JSON */
109	233	`form_id` bigint(20) unsigned DEFAULT NULL,
110	234	`user_id` bigint(20) unsigned DEFAULT NULL,
111	235	`user_ip` int(11) unsigned DEFAULT NULL,
112	236	`created_at` datetime DEFAULT NULL,
		@@ -135,9 +259,9 @@
135	259	`user_id` bigint(20) unsigned DEFAULT NULL,
136	260	`user_ip` varchar(255) DEFAULT NULL,
137	261	`user_location` text DEFAULT NULL,
138	262	`user_device` varchar(50) DEFAULT NULL,
139		- `referer` varchar(255) DEFAULT NULL,
	263	+ `referer` TEXT DEFAULT NULL,
140	264	`status` tinyint(1) DEFAULT 0,/* 0 not viewed, 1 viewed, 2 trashed */
141	265	`created_at` datetime DEFAULT NULL,
142	266	`updated_at` datetime DEFAULT NULL,
143	267	PRIMARY KEY (`id`),
		@@ -194,57 +318,101 @@
194	318	`updated_at` DATETIME NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP,
195	319	PRIMARY KEY (`id`),
196	320	KEY `form_id` (`form_id`),
197	321	KEY `entry_id` (`entry_id`)
198		- ) $collate;",
	322	+ ) $collate;"
199	323	];
200	324
201		- $table_schema_update = [
202		- "ALTER TABLE `{$wpdb->prefix}bitforms_form_entry_log`
203		- CHANGE COLUMN `log_type` `log_type` VARCHAR(50) NULL DEFAULT NULL,
	325	+ try {
	326	+ include_once ABSPATH . 'wp-admin/includes/upgrade.php';
	327	+ foreach ($table_schema as $table) {
	328	+ dbDelta($table);
	329	+ }
	330	+ $installed_db_version = get_option('bitforms_db_version');
	331	+ if ($installed_db_version && version_compare('1.1', $installed_db_version, '>=')) {
	332	+ // if new db version is equal or higher than 1.1
	333	+ // Schema migration: table name interpolation only (no user input). $wpdb->prepare() cannot parameterize DDL statements.
	334	+ try {
	335	+ $wpdb->query("ALTER TABLE `{$wpdb->prefix}bitforms_form_entry_log`
	336	+ MODIFY `log_type` VARCHAR(50) NULL DEFAULT NULL,
	337	+ MODIFY `created_at` DATETIME NOT NULL,
	338	+ CHANGE COLUMN `meta_key` `content` LONGTEXT NULL,
204	339	ADD COLUMN `action_type` VARCHAR(50) NULL DEFAULT NULL,
205		- CHANGE COLUMN `meta_key` `content` LONGTEXT NULL,
206		- CHANGE COLUMN `created_at` `created_at` DATETIME NOT NULL",
207		- "ALTER TABLE `{$wpdb->prefix}bitforms_form_log_details`
208		- CHANGE COLUMN `api_type` `api_type` VARCHAR(255) NULL DEFAULT NULL,
209		- CHANGE COLUMN `response_obj` `response_obj` LONGTEXT NULL,
210		- CHANGE COLUMN `created_at` `created_at` DATETIME NOT NULL",
211		- ];
	340	+ ADD COLUMN `content` LONGTEXT NULL AFTER `action_type`");
	341	+ } catch (\Exception $e) {
	342	+ Log::debug_log("Update failed: {$e->getMessage()} in query: ALTER TABLE `{$wpdb->prefix}bitforms_form_entry_log`...");
	343	+ }
	344	+ try {
	345	+ $wpdb->query("ALTER TABLE `{$wpdb->prefix}bitforms_form_log_details`
	346	+ MODIFY `api_type` VARCHAR(255) NULL DEFAULT NULL,
	347	+ MODIFY `response_obj` LONGTEXT NULL,
	348	+ MODIFY `created_at` DATETIME NOT NULL");
	349	+ } catch (\Exception $e) {
	350	+ Log::debug_log("Update failed: {$e->getMessage()} in query: ALTER TABLE `{$wpdb->prefix}bitforms_form_log_details`...");
	351	+ }
	352	+ }
	353	+ if ($installed_db_version && version_compare('1.3', $installed_db_version, '>=')) {
	354	+ // if new db version is equal or higher than 1.3
	355	+ $wpdb->query("ALTER TABLE `{$wpdb->prefix}bitforms_form_entries` MODIFY `user_ip` VARCHAR(255) NULL DEFAULT NULL");
	356	+ }
212	357
213		- include_once ABSPATH . 'wp-admin/includes/upgrade.php';
214		- foreach ($table_schema as $table) {
215		- dbDelta($table);
216		- }
217		- $installed_db_version = get_site_option('bitforms_db_version');
218		- if ($installed_db_version && version_compare('1.1', $installed_db_version, '>=')) {
219		- // if new db version is equal or higher than 1.1
220		- foreach ($table_schema_update as $table) {
221		- $wpdb->query($table);
	358	+ if ($installed_db_version && version_compare('2.0', $installed_db_version, '>=')) {
	359	+ if (null === $wpdb->get_var("SHOW COLUMNS FROM `{$wpdb->prefix}bitforms_success_messages` LIKE 'message_config'")) {
	360	+ $wpdb->query(
	361	+ "ALTER TABLE `{$wpdb->prefix}bitforms_success_messages`
	362	+ ADD COLUMN `message_config` LONGTEXT NULL AFTER `message_content`"
	363	+ );
	364	+ }
	365	+ if (null === $wpdb->get_var("SHOW COLUMNS FROM `{$wpdb->prefix}bitforms_form` LIKE 'builder_helper_state'")) {
	366	+ $wpdb->query(
	367	+ "ALTER TABLE `{$wpdb->prefix}bitforms_form`
	368	+ ADD COLUMN `builder_helper_state` LONGTEXT NULL AFTER `form_content`,
	369	+ ADD COLUMN `atomic_class_map` LONGTEXT NULL AFTER `builder_helper_state`,
	370	+ ADD COLUMN `generated_script_page_ids` LONGTEXT NULL AFTER `atomic_class_map`"
	371	+ );
	372	+ }
	373	+ if (null === $wpdb->get_var("SHOW COLUMNS FROM `{$wpdb->prefix}bitforms_workflows` LIKE 'workflow_order'")) {
	374	+ $wpdb->query(
	375	+ "ALTER TABLE `{$wpdb->prefix}bitforms_workflows`
	376	+ ADD COLUMN `workflow_order` INT(11) DEFAULT NULL AFTER `workflow_condition`"
	377	+ );
	378	+ }
222	379	}
223		- }
224		- if ($installed_db_version && version_compare('1.3', $installed_db_version, '>=')) {
225		- // if new db version is equal or higher than 1.3
226		- $wpdb->query("ALTER TABLE `{$wpdb->prefix}bitforms_form_entries` CHANGE `user_ip` `user_ip` VARCHAR(255) NULL DEFAULT NULL");
227		- }
228	380
229		- if ($installed_db_version && version_compare('2.0', $installed_db_version, '>=')) {
230		- $wpdb->query(
231		- "ALTER TABLE `{$wpdb->prefix}bitforms_success_messages`
232		- ADD `message_config` LONGTEXT NULL AFTER `message_content`"
233		- );
234		- $wpdb->query(
235		- "ALTER TABLE `{$wpdb->prefix}bitforms_form`
236		- ADD `builder_helper_state` LONGTEXT NULL AFTER `form_content`,
237		- ADD `atomic_class_map` LONGTEXT NULL AFTER `builder_helper_state`,
238		- ADD `generated_script_page_ids` LONGTEXT NULL AFTER `atomic_class_map`"
239		- );
240		- $wpdb->query(
241		- "ALTER TABLE `{$wpdb->prefix}bitforms_workflows`
242		- ADD `workflow_order` INT(11) DEFAULT NULL AFTER `workflow_condition`"
243		- );
	381	+ if ($installed_db_version && version_compare('2.2', $installed_db_version, '>=')) {
	382	+ if (null === $wpdb->get_var("SHOW COLUMNS FROM `{$wpdb->prefix}bitforms_form_entries` LIKE 'referer'")) {
	383	+ $wpdb->query(
	384	+ "ALTER TABLE `{$wpdb->prefix}bitforms_form_entries`
	385	+ ADD COLUMN `referer` TEXT NULL DEFAULT NULL"
	386	+ );
	387	+ }
	388	+ }
	389	+
	390	+ if ($installed_db_version && version_compare('2.4', $installed_db_version, '>=')) {
	391	+ if (null === $wpdb->get_var("SHOW COLUMNS FROM `{$wpdb->prefix}bitforms_workflows` LIKE 'workflow_status'")) {
	392	+ $wpdb->query(
	393	+ "ALTER TABLE `{$wpdb->prefix}bitforms_workflows`
	394	+ ADD COLUMN `workflow_status` TINYINT(1) DEFAULT 1 NOT NULL AFTER `workflow_order`"
	395	+ );
	396	+ }
	397	+ }
	398	+
	399	+ // add workflow_info column if not exists
	400	+ if ($installed_db_version && version_compare('3.0', $installed_db_version, '>=')) {
	401	+ self::ensureWorkflowInfoColumn();
	402	+ }
	403	+
	404	+ // add workflow_category column if not exists (conditional logic separation)
	405	+ // existing rows default to 'classic' so Free keeps executing them unchanged; data normalization in Fallback WorkFlow@normalizeCategory
	406	+ if ($installed_db_version && version_compare('3.2', $installed_db_version, '>=')) {
	407	+ self::ensureWorkflowCategoryColumn();
	408	+ // email template enable/disable + per-template config (SendTo/From/CC/BCC/Reply-To/attachments)
	409	+ self::ensureEmailTemplateStatusColumn();
	410	+ }
	411	+
	412	+ update_option('bitforms_db_version', $bitforms_db_version, true);
	413	+ } catch (\Exception $e) {
	414	+ // Log the error to a file or the database
	415	+ Log::debug_log('Error during DB migration: ' . $e->getMessage());
244	416	}
245		- update_site_option(
246		- 'bitforms_db_version',
247		- $bitforms_db_version
248		- );
249	417	}
250	418	}