From b7be1aa89a3486d2f80456e83d090e5ce273ec17 Mon Sep 17 00:00:00 2001 From: Matthew Bucci Date: Tue, 27 Feb 2024 00:53:05 -0800 Subject: [PATCH 1/2] add rewriting for protected column names --- pg4wp/rewriters/AlterTableSQLRewriter.php | 25 +++++++++ pg4wp/rewriters/CreateTableSQLRewriter.php | 25 +++++++++ tests/rewriteTest.php | 63 ++++++++++++++++++++++ 3 files changed, 113 insertions(+) diff --git a/pg4wp/rewriters/AlterTableSQLRewriter.php b/pg4wp/rewriters/AlterTableSQLRewriter.php index db819e7..27a0c95 100644 --- a/pg4wp/rewriters/AlterTableSQLRewriter.php +++ b/pg4wp/rewriters/AlterTableSQLRewriter.php @@ -30,6 +30,7 @@ class AlterTableSQLRewriter extends AbstractSQLRewriter $sql = $this->original(); $sql = $this->rewrite_numeric_type($sql); + $sql = $this->rewrite_columns_with_protected_names($sql); if (str_contains($sql, 'ADD INDEX') || str_contains($sql, 'ADD UNIQUE INDEX')) { $sql = $this->rewriteAddIndex($sql); @@ -262,4 +263,28 @@ class AlterTableSQLRewriter extends AbstractSQLRewriter return $sql; } + + private function rewrite_columns_with_protected_names($sql) + { + // Splitting the SQL statement into parts before "(", inside "(", and after ")" + if (preg_match('/^(CREATE TABLE IF NOT EXISTS|CREATE TABLE|ALTER TABLE)\s+([^\s]+)\s*\((.*)\)(.*)$/is', $sql, $matches)) { + $prefix = $matches[1] . ' ' . $matches[2] . ' ('; + $columnsAndKeys = $matches[3]; + $suffix = ')' . $matches[4]; + + $regex = '/(?:^|\s*,\s*)(\b(?:timestamp|date|time|default)\b)\s*(?=\s+\w+)/i'; + + // Callback function to add quotes around protected column names + $callback = function($matches) { + $whitespace = str_replace($matches[1], "", $matches[0]); + return $whitespace . '"' . $matches[1] . '"'; + }; + + // Replace protected column names with quoted versions within columns and keys part + $columnsAndKeys = preg_replace_callback($regex, $callback, $columnsAndKeys, 1); + return $prefix . $columnsAndKeys . $suffix; + } + + return $sql; + } } diff --git a/pg4wp/rewriters/CreateTableSQLRewriter.php b/pg4wp/rewriters/CreateTableSQLRewriter.php index 8bd2b4f..eb4be6e 100644 --- a/pg4wp/rewriters/CreateTableSQLRewriter.php +++ b/pg4wp/rewriters/CreateTableSQLRewriter.php @@ -55,6 +55,7 @@ class CreateTableSQLRewriter extends AbstractSQLRewriter ); $sql = $this->rewrite_numeric_type($sql); + $sql = $this->rewrite_columns_with_protected_names($sql); // Support for UNIQUE INDEX creation $pattern = '/,\s*(UNIQUE |)KEY\s+(`[^`]+`|\w+)\s+\(((?:[^()]|\([^)]*\))*)\)/'; @@ -133,4 +134,28 @@ class CreateTableSQLRewriter extends AbstractSQLRewriter return $sql; } + + private function rewrite_columns_with_protected_names($sql) + { + // Splitting the SQL statement into parts before "(", inside "(", and after ")" + if (preg_match('/^(CREATE TABLE IF NOT EXISTS|CREATE TABLE|ALTER TABLE)\s+([^\s]+)\s*\((.*)\)(.*)$/is', $sql, $matches)) { + $prefix = $matches[1] . ' ' . $matches[2] . ' ('; + $columnsAndKeys = $matches[3]; + $suffix = ')' . $matches[4]; + + $regex = '/(?:^|\s*,\s*)(\b(?:timestamp|date|time|default)\b)\s*(?=\s+\w+)/i'; + + // Callback function to add quotes around protected column names + $callback = function($matches) { + $whitespace = str_replace($matches[1], "", $matches[0]); + return $whitespace . '"' . $matches[1] . '"'; + }; + + // Replace protected column names with quoted versions within columns and keys part + $columnsAndKeys = preg_replace_callback($regex, $callback, $columnsAndKeys, 1); + return $prefix . $columnsAndKeys . $suffix; + } + + return $sql; + } } diff --git a/tests/rewriteTest.php b/tests/rewriteTest.php index 118ade0..b2de577 100644 --- a/tests/rewriteTest.php +++ b/tests/rewriteTest.php @@ -530,6 +530,69 @@ final class rewriteTest extends TestCase $this->assertSame(trim($expected), trim($postgresql)); } + public function test_it_rewrites_protected_column_names() + { + $sql = <<assertSame(trim($expected), trim($postgresql)); + } + + public function test_it_rewrites_advanced_protected_column_names() + { + $sql = <<assertSame(trim($expected), trim($postgresql)); + } + + public function test_it_doesnt_remove_single_quotes() { $sql = << Date: Tue, 27 Feb 2024 00:58:58 -0800 Subject: [PATCH 2/2] update expected results for create table tests with protected names --- pg4wp/rewriters/AlterTableSQLRewriter.php | 2 +- pg4wp/rewriters/CreateTableSQLRewriter.php | 2 +- tests/rewriteTest.php | 10 +++++----- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/pg4wp/rewriters/AlterTableSQLRewriter.php b/pg4wp/rewriters/AlterTableSQLRewriter.php index 27a0c95..ac3d639 100644 --- a/pg4wp/rewriters/AlterTableSQLRewriter.php +++ b/pg4wp/rewriters/AlterTableSQLRewriter.php @@ -281,7 +281,7 @@ class AlterTableSQLRewriter extends AbstractSQLRewriter }; // Replace protected column names with quoted versions within columns and keys part - $columnsAndKeys = preg_replace_callback($regex, $callback, $columnsAndKeys, 1); + $columnsAndKeys = preg_replace_callback($regex, $callback, $columnsAndKeys); return $prefix . $columnsAndKeys . $suffix; } diff --git a/pg4wp/rewriters/CreateTableSQLRewriter.php b/pg4wp/rewriters/CreateTableSQLRewriter.php index eb4be6e..948c9ce 100644 --- a/pg4wp/rewriters/CreateTableSQLRewriter.php +++ b/pg4wp/rewriters/CreateTableSQLRewriter.php @@ -152,7 +152,7 @@ class CreateTableSQLRewriter extends AbstractSQLRewriter }; // Replace protected column names with quoted versions within columns and keys part - $columnsAndKeys = preg_replace_callback($regex, $callback, $columnsAndKeys, 1); + $columnsAndKeys = preg_replace_callback($regex, $callback, $columnsAndKeys); return $prefix . $columnsAndKeys . $suffix; } diff --git a/tests/rewriteTest.php b/tests/rewriteTest.php index b2de577..d9172f2 100644 --- a/tests/rewriteTest.php +++ b/tests/rewriteTest.php @@ -114,7 +114,7 @@ final class rewriteTest extends TestCase CREATE TABLE IF NOT EXISTS wp_itsec_dashboard_lockouts ( id serial, ip varchar(40), - time timestamp NOT NULL, + "time" timestamp NOT NULL, count int NOT NULL, PRIMARY KEY (id) ); @@ -184,7 +184,7 @@ final class rewriteTest extends TestCase CREATE TABLE IF NOT EXISTS wp_itsec_dashboard_lockouts ( id serial, ip varchar(40), - time timestamp NOT NULL, + "time" timestamp NOT NULL, count int NOT NULL, PRIMARY KEY (id) ); @@ -222,8 +222,8 @@ final class rewriteTest extends TestCase "ID" bigserial, ip varchar(60) NOT NULL, created int, - timestamp int NOT NULL, - date timestamp NOT NULL, + "timestamp" int NOT NULL, + "date" timestamp NOT NULL, referred text NOT NULL, agent varchar(255) NOT NULL, platform varchar(255), @@ -264,7 +264,7 @@ final class rewriteTest extends TestCase page_id bigserial, uri varchar(190) NOT NULL, type varchar(180) NOT NULL, - date date NOT NULL, + "date" date NOT NULL, count int NOT NULL, id int NOT NULL, PRIMARY KEY (page_id)