Skip to content

Commit 2426f8d

Browse files
kenjiskenjis
committed
fix!: spark db:table causes errors w/z table name including speciali chars
1 parent b550dc6 commit 2426f8d

File tree

11 files changed

+131
-38
lines changed

11 files changed

+131
-38
lines changed

‎phpstan-baseline.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2396,11 +2396,6 @@
23962396
'count' => 1,
23972397
'path' => __DIR__ . '/system/Database/BaseConnection.php',
23982398
];
2399-
$ignoreErrors[] = [
2400-
'message' => '#^Property CodeIgniter\\\\Database\\\\BaseConnection\\:\\:\\$aliasedTables type has no value type specified in iterable type array\\.$#',
2401-
'count' => 1,
2402-
'path' => __DIR__ . '/system/Database/BaseConnection.php',
2403-
];
24042399
$ignoreErrors[] = [
24052400
'message' => '#^Property CodeIgniter\\\\Database\\\\BaseConnection\\:\\:\\$dataCache type has no value type specified in iterable type array\\.$#',
24062401
'count' => 1,

‎system/Commands/Database/ShowTableInfo.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
use CodeIgniter\CLI\BaseCommand;
1717
use CodeIgniter\CLI\CLI;
1818
use CodeIgniter\Database\BaseConnection;
19+
use CodeIgniter\Database\TableName;
1920
use Config\Database;
2021
use InvalidArgumentException;
2122

@@ -194,7 +195,7 @@ private function showDataOfTable(string $tableName, int $limitRows, int $limitFi
194195
CLI::newLine();
195196

196197
$this->removeDBPrefix();
197-
$thead = $this->db->getFieldNames($tableName);
198+
$thead = $this->db->getFieldNames(TableName::fromActualName($this->db, $tableName));
198199
$this->restoreDBPrefix();
199200

200201
// If there is a field named `id`, sort by it.
@@ -253,7 +254,7 @@ private function makeTableRows(
253254
$this->tbody = [];
254255

255256
$this->removeDBPrefix();
256-
$builder = $this->db->table($tableName);
257+
$builder = $this->db->table(TableName::fromActualName($this->db, $tableName));
257258
$builder->limit($limitRows);
258259
if ($sortField !== null) {
259260
$builder->orderBy($sortField, $this->sortDesc ? 'DESC' : 'ASC');

‎system/Database/BaseBuilder.php

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ class BaseBuilder
298298
/**
299299
* Constructor
300300
*
301-
* @param array|string $tableName tablename or tablenames with or without aliases
301+
* @param array|string|TableName $tableName tablename or tablenames with or without aliases
302302
*
303303
* Examples of $tableName: `mytable`, `jobs j`, `jobs j, users u`, `['jobs j','users u']`
304304
*
@@ -315,15 +315,20 @@ public function __construct($tableName, ConnectionInterface $db, ?array $options
315315
*/
316316
$this->db = $db;
317317

318+
if ($tableName instanceof TableName) {
319+
$this->tableName = $tableName->getTableName();
320+
$this->QBFrom[] = $this->db->escapeIdentifier($tableName);
321+
$this->db->addTableAlias($tableName->getAlias());
322+
}
318323
// If it contains `,`, it has multiple tables
319-
if (is_string($tableName) && ! str_contains($tableName, ',')) {
324+
elseif (is_string($tableName) && ! str_contains($tableName, ',')) {
320325
$this->tableName = $tableName; // @TODO remove alias if exists
326+
$this->from($tableName);
321327
} else {
322328
$this->tableName = '';
329+
$this->from($tableName);
323330
}
324331

325-
$this->from($tableName);
326-
327332
if ($options !== null && $options !== []) {
328333
foreach ($options as $key => $value) {
329334
if (property_exists($this, $key)) {

‎system/Database/BaseConnection.php

Lines changed: 40 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -565,6 +565,10 @@ public function setAliasedTables(array $aliases)
565565
*/
566566
public function addTableAlias(string $alias)
567567
{
568+
if ($alias === '') {
569+
return $this;
570+
}
571+
568572
if (! in_array($alias, $this->aliasedTables, true)) {
569573
$this->aliasedTables[] = $alias;
570574
}
@@ -900,7 +904,7 @@ abstract protected function _transRollback(): bool;
900904
/**
901905
* Returns a non-shared new instance of the query builder for this connection.
902906
*
903-
* @param array|string $tableName
907+
* @param array|string|TableName $tableName
904908
*
905909
* @return BaseBuilder
906910
*
@@ -1029,10 +1033,10 @@ public function getConnectDuration(int $decimals = 6): string
10291033
* insert the table prefix (if it exists) in the proper position, and escape only
10301034
* the correct identifiers.
10311035
*
1032-
* @param array|int|string $item
1033-
* @param bool $prefixSingle Prefix a table name with no segments?
1034-
* @param bool $protectIdentifiers Protect table or column names?
1035-
* @param bool $fieldExists Supplied $item contains a column name?
1036+
* @param array|int|string|TableName $item
1037+
* @param bool $prefixSingle Prefix a table name with no segments?
1038+
* @param bool $protectIdentifiers Protect table or column names?
1039+
* @param bool $fieldExists Supplied $item contains a column name?
10361040
*
10371041
* @return array|string
10381042
* @phpstan-return ($item is array ? array : string)
@@ -1053,6 +1057,11 @@ public function protectIdentifiers($item, bool $prefixSingle = false, ?bool $pro
10531057
return $escapedArray;
10541058
}
10551059

1060+
if ($item instanceof TableName) {
1061+
/** @psalm-suppress NoValue I don't know why ERROR. */
1062+
return $this->escapeTableName($item);
1063+
}
1064+
10561065
// If you pass `['column1', 'column2']`, `$item` will be int because the array keys are int.
10571066
$item = (string) $item;
10581067

@@ -1195,14 +1204,18 @@ private function protectDotItem(string $item, string $alias, bool $protectIdenti
11951204
*
11961205
* This function escapes single identifier.
11971206
*
1198-
* @param non-empty-string $item
1207+
* @param non-empty-string|TableName $item
11991208
*/
1200-
public function escapeIdentifier(string $item): string
1209+
public function escapeIdentifier($item): string
12011210
{
12021211
if ($item === '') {
12031212
return '';
12041213
}
12051214

1215+
if ($item instanceof TableName) {
1216+
return $this->escapeTableName($item);
1217+
}
1218+
12061219
return $this->escapeChar
12071220
. str_replace(
12081221
$this->escapeChar,
@@ -1212,6 +1225,17 @@ public function escapeIdentifier(string $item): string
12121225
. $this->escapeChar;
12131226
}
12141227

1228+
/**
1229+
* Returns escaped table name with alias.
1230+
*/
1231+
private function escapeTableName(TableName $tableName): string
1232+
{
1233+
$alias = $tableName->getAlias();
1234+
1235+
return $this->escapeIdentifier($tableName->getActualTableName())
1236+
. (($alias !== '') ? ' ' . $this->escapeIdentifier($alias) : '');
1237+
}
1238+
12151239
/**
12161240
* Escape the SQL Identifiers
12171241
*
@@ -1513,12 +1537,16 @@ public function tableExists(string $tableName, bool $cached = true): bool
15131537
/**
15141538
* Fetch Field Names
15151539
*
1540+
* @param string|TableName $tableName
1541+
*
15161542
* @return array|false
15171543
*
15181544
* @throws DatabaseException
15191545
*/
1520-
public function getFieldNames(string $table)
1546+
public function getFieldNames($tableName)
15211547
{
1548+
$table = ($tableName instanceof TableName) ? $tableName->getTableName() : $tableName;
1549+
15221550
// Is there a cached result?
15231551
if (isset($this->dataCache['field_names'][$table])) {
15241552
return $this->dataCache['field_names'][$table];
@@ -1528,7 +1556,7 @@ public function getFieldNames(string $table)
15281556
$this->initialize();
15291557
}
15301558

1531-
if (false === ($sql = $this->_listColumns($table))) {
1559+
if (false === ($sql = $this->_listColumns($tableName))) {
15321560
if ($this->DBDebug) {
15331561
throw new DatabaseException('This feature is not available for the database you are using.');
15341562
}
@@ -1744,9 +1772,11 @@ abstract protected function _listTables(bool $constrainByPrefix = false, ?string
17441772
/**
17451773
* Generates a platform-specific query string so that the column names can be fetched.
17461774
*
1775+
* @param string|TableName $table
1776+
*
17471777
* @return false|string
17481778
*/
1749-
abstract protected function _listColumns(string $table = '');
1779+
abstract protected function _listColumns($table = '');
17501780

17511781
/**
17521782
* Platform-specific field data information.

‎system/Database/MySQLi/Connection.php

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
use CodeIgniter\Database\BaseConnection;
1717
use CodeIgniter\Database\Exceptions\DatabaseException;
18+
use CodeIgniter\Database\TableName;
1819
use LogicException;
1920
use mysqli;
2021
use mysqli_result;
@@ -404,10 +405,19 @@ protected function _listTables(bool $prefixLimit = false, ?string $tableName = n
404405

405406
/**
406407
* Generates a platform-specific query string so that the column names can be fetched.
408+
*
409+
* @param string|TableName $table
407410
*/
408-
protected function _listColumns(string $table = ''): string
411+
protected function _listColumns($table = ''): string
409412
{
410-
return 'SHOW COLUMNS FROM ' . $this->protectIdentifiers($table, true, null, false);
413+
$tableName = $this->protectIdentifiers(
414+
$table,
415+
true,
416+
null,
417+
false
418+
);
419+
420+
return 'SHOW COLUMNS FROM ' . $tableName;
411421
}
412422

413423
/**

‎system/Database/OCI8/Connection.php

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
use CodeIgniter\Database\BaseConnection;
1717
use CodeIgniter\Database\Exceptions\DatabaseException;
1818
use CodeIgniter\Database\Query;
19+
use CodeIgniter\Database\TableName;
1920
use ErrorException;
2021
use stdClass;
2122

@@ -266,18 +267,25 @@ protected function _listTables(bool $prefixLimit = false, ?string $tableName = n
266267

267268
/**
268269
* Generates a platform-specific query string so that the column names can be fetched.
270+
*
271+
* @param string|TableName $table
269272
*/
270-
protected function _listColumns(string $table = ''): string
273+
protected function _listColumns($table = ''): string
271274
{
272-
if (str_contains($table, '.')) {
273-
sscanf($table, '%[^.].%s', $owner, $table);
275+
if ($table instanceof TableName) {
276+
$tableName = $this->escape(strtoupper($table->getActualTableName()));
277+
$owner = $this->username;
278+
} elseif (str_contains($table, '.')) {
279+
sscanf($table, '%[^.].%s', $owner, $tableName);
280+
$tableName = $this->escape(strtoupper($this->DBPrefix . $tableName));
274281
} else {
275-
$owner = $this->username;
282+
$owner = $this->username;
283+
$tableName = $this->escape(strtoupper($this->DBPrefix . $table));
276284
}
277285

278286
return 'SELECT COLUMN_NAME FROM ALL_TAB_COLUMNS
279287
WHERE UPPER(OWNER) = ' . $this->escape(strtoupper($owner)) . '
280-
AND UPPER(TABLE_NAME) = ' . $this->escape(strtoupper($this->DBPrefix . $table));
288+
AND UPPER(TABLE_NAME) = ' . $tableName;
281289
}
282290

283291
/**

‎system/Database/Postgre/Connection.php

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
use CodeIgniter\Database\BaseConnection;
1717
use CodeIgniter\Database\Exceptions\DatabaseException;
1818
use CodeIgniter\Database\RawSql;
19+
use CodeIgniter\Database\TableName;
1920
use ErrorException;
2021
use PgSql\Connection as PgSqlConnection;
2122
use PgSql\Result as PgSqlResult;
@@ -286,13 +287,20 @@ protected function _listTables(bool $prefixLimit = false, ?string $tableName = n
286287

287288
/**
288289
* Generates a platform-specific query string so that the column names can be fetched.
290+
*
291+
* @param string|TableName $table
289292
*/
290-
protected function _listColumns(string $table = ''): string
293+
protected function _listColumns($table = ''): string
291294
{
295+
if ($table instanceof TableName) {
296+
$tableName = $this->escape($table->getActualTableName());
297+
} else {
298+
$tableName = $this->escape($this->DBPrefix . strtolower($table));
299+
}
300+
292301
return 'SELECT "column_name"
293302
FROM "information_schema"."columns"
294-
WHERE LOWER("table_name") = '
295-
. $this->escape($this->DBPrefix . strtolower($table))
303+
WHERE LOWER("table_name") = ' . $tableName
296304
. ' ORDER BY "ordinal_position"';
297305
}
298306

‎system/Database/SQLSRV/Connection.php

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
use CodeIgniter\Database\BaseConnection;
1717
use CodeIgniter\Database\Exceptions\DatabaseException;
18+
use CodeIgniter\Database\TableName;
1819
use stdClass;
1920

2021
/**
@@ -221,12 +222,20 @@ protected function _listTables(bool $prefixLimit = false, ?string $tableName = n
221222

222223
/**
223224
* Generates a platform-specific query string so that the column names can be fetched.
225+
*
226+
* @param string|TableName $table
224227
*/
225-
protected function _listColumns(string $table = ''): string
228+
protected function _listColumns($table = ''): string
226229
{
230+
if ($table instanceof TableName) {
231+
$tableName = $this->escape(strtolower($table->getActualTableName()));
232+
} else {
233+
$tableName = $this->escape($this->DBPrefix . strtolower($table));
234+
}
235+
227236
return 'SELECT [COLUMN_NAME] '
228237
. ' FROM [INFORMATION_SCHEMA].[COLUMNS]'
229-
. ' WHERE [TABLE_NAME] = ' . $this->escape($this->DBPrefix . $table)
238+
. ' WHERE [TABLE_NAME] = ' . $tableName
230239
. ' AND [TABLE_SCHEMA] = ' . $this->escape($this->schema);
231240
}
232241

‎system/Database/SQLite3/Connection.php

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
use CodeIgniter\Database\BaseConnection;
1717
use CodeIgniter\Database\Exceptions\DatabaseException;
18+
use CodeIgniter\Database\TableName;
1819
use Exception;
1920
use SQLite3;
2021
use SQLite3Result;
@@ -202,19 +203,31 @@ protected function _listTables(bool $prefixLimit = false, ?string $tableName = n
202203

203204
/**
204205
* Generates a platform-specific query string so that the column names can be fetched.
206+
*
207+
* @param string|TableName $table
205208
*/
206-
protected function _listColumns(string $table = ''): string
209+
protected function _listColumns($table = ''): string
207210
{
208-
return 'PRAGMA TABLE_INFO(' . $this->protectIdentifiers($table, true, null, false) . ')';
211+
if ($table instanceof TableName) {
212+
$tableName = $this->escapeIdentifier($table);
213+
} else {
214+
$tableName = $this->protectIdentifiers($table, true, null, false);
215+
}
216+
217+
return 'PRAGMA TABLE_INFO(' . $tableName . ')';
209218
}
210219

211220
/**
221+
* @param string|TableName $tableName
222+
*
212223
* @return array|false
213224
*
214225
* @throws DatabaseException
215226
*/
216-
public function getFieldNames(string $table)
227+
public function getFieldNames($tableName)
217228
{
229+
$table = ($tableName instanceof TableName) ? $tableName->getTableName() : $tableName;
230+
218231
// Is there a cached result?
219232
if (isset($this->dataCache['field_names'][$table])) {
220233
return $this->dataCache['field_names'][$table];
@@ -224,7 +237,7 @@ public function getFieldNames(string $table)
224237
$this->initialize();
225238
}
226239

227-
$sql = $this->_listColumns($table);
240+
$sql = $this->_listColumns($tableName);
228241

229242
$query = $this->query($sql);
230243
$this->dataCache['field_names'][$table] = [];

0 commit comments

Comments
 (0)