Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[9.x] Fix postgres reference parsing #35530

Merged
merged 4 commits into from
Dec 10, 2020
Merged

[9.x] Fix postgres reference parsing #35530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
20fc31c
"Normalize" the search_path parsing behavior
cbj4074 Dec 8, 2020
76933a3
Fix PostgreSQL object reference parsing
cbj4074 Dec 8, 2020
c630b8e
Apply Style-CI fixes
cbj4074 Dec 8, 2020
7128e69
Add tests to cover any added or modified code
cbj4074 Dec 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 25 additions & 8 deletions src/Illuminate/Database/Connectors/PostgresConnector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,35 @@ protected function configureTimezone($connection, array $config)
protected function configureSearchPath($connection, $config)
{
if (isset($config['search_path'])) {
$searchPath = $this->formatSearchPath($config['search_path']);
$searchPath = $this->formatSearchPath(
$this->parseSearchPath($config['search_path'])
);

$connection->prepare("set search_path to {$searchPath}")->execute();
}
}

/**
* Parse the search_path.
*
* @param string|array $searchPath
* @return array
*/
protected function parseSearchPath($searchPath)
{
if (is_string($searchPath)) {
preg_match_all('/[a-zA-z0-9$]{1,}/i', $searchPath, $matches);

$searchPath = $matches[0];
}

array_walk($searchPath, function (&$schema) {
$schema = trim($schema, '\'"');
});

return $searchPath;
}

/**
* Format the search path for the DSN.
*
Expand All @@ -108,13 +131,7 @@ protected function configureSearchPath($connection, $config)
*/
protected function formatSearchPath($searchPath)
{
if (is_array($searchPath)) {
$searchPath = '"'.implode('", "', $searchPath).'"';
}

preg_match_all('/[a-zA-z0-9$]{1,}/i', $searchPath, $matches);

return '"'.implode('", "', $matches[0]).'"';
return count($searchPath) === 1 ? '"'.$searchPath[0].'"' : '"'.implode('", "', $searchPath).'"';
}

/**
Expand Down
4 changes: 2 additions & 2 deletions src/Illuminate/Database/Schema/Grammars/PostgresGrammar.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ class PostgresGrammar extends Grammar
*/
public function compileTableExists()
{
return "select * from information_schema.tables where table_schema = ? and table_name = ? and table_type = 'BASE TABLE'";
return "select * from information_schema.tables where table_catalog = ? and table_schema = ? and table_name = ? and table_type = 'BASE TABLE'";
}

/**
Expand All @@ -52,7 +52,7 @@ public function compileTableExists()
*/
public function compileColumnListing()
{
return 'select column_name from information_schema.columns where table_schema = ? and table_name = ?';
return 'select column_name from information_schema.columns where table_catalog = ? and table_schema = ? and table_name = ?';
}

/**
Expand Down
70 changes: 56 additions & 14 deletions src/Illuminate/Database/Schema/PostgresBuilder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ class PostgresBuilder extends Builder
*/
public function hasTable($table)
{
[$schema, $table] = $this->parseSchemaAndTable($table);
[$database, $schema, $table] = $this->parseSchemaAndTable($table);

$table = $this->connection->getTablePrefix().$table;

return count($this->connection->select(
$this->grammar->compileTableExists(), [$schema, $table]
$this->grammar->compileTableExists(), [$database, $schema, $table]
)) > 0;
}

Expand Down Expand Up @@ -143,35 +143,77 @@ public function getAllTypes()
*/
public function getColumnListing($table)
{
[$schema, $table] = $this->parseSchemaAndTable($table);
[$database, $schema, $table] = $this->parseSchemaAndTable($table);

$table = $this->connection->getTablePrefix().$table;

$results = $this->connection->select(
$this->grammar->compileColumnListing(), [$schema, $table]
$this->grammar->compileColumnListing(), [$database, $schema, $table]
);

return $this->connection->getPostProcessor()->processColumnListing($results);
}

/**
* Parse the table name and extract the schema and table.
* Parse the search_path.
*
* @param string $table
* @param string|array $searchPath
* @return array
*/
protected function parseSchemaAndTable($table)
protected function parseSearchPath($searchPath)
{
$table = explode('.', $table);
if (is_string($searchPath)) {
preg_match_all('/[a-zA-z0-9$]{1,}/i', $searchPath, $matches);

if (is_array($searchPath = $this->connection->getConfig('search_path'))) {
if (in_array($table[0], $searchPath)) {
return [array_shift($table), implode('.', $table)];
}
$searchPath = $matches[0];
}

array_walk($searchPath, function (&$schema) {
$schema = trim($schema, '\'"');
});

return $searchPath;
}

/**
* Parse the database object reference and extract the database, schema, and
* table.
*
* @param string $reference
* @return array
*/
protected function parseSchemaAndTable($reference)
{
$searchPath = $this->parseSearchPath(
$this->connection->getConfig('search_path') ?: 'public'
);

$parts = explode('.', $reference);

// Use the connection's configured database by default.

$database = $this->connection->getConfig('database');

// If the reference contains a database name, use that instead.

if (count($parts) === 3) {
$database = $parts[0];

array_shift($parts);
}

// Use the first schema in the search_path by default.

$schema = $searchPath[0];

// If the reference contains a schema, use that instead.

if (count($parts) === 2) {
$schema = $parts[0];

$schema = head($searchPath);
array_shift($parts);
}

return [$schema ?: 'public', implode('.', $table)];
return [$database, $schema, $parts[0]];
}
}
209 changes: 209 additions & 0 deletions tests/Database/DatabasePostgresBuilderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,209 @@
<?php

namespace Illuminate\Tests\Database;

use Illuminate\Database\Connection;
use Illuminate\Database\Query\Processors\PostgresProcessor;
use Illuminate\Database\Schema\Grammars\PostgresGrammar;
use Illuminate\Database\Schema\PostgresBuilder;
use Mockery as m;
use PHPUnit\Framework\TestCase;

class DatabasePostgresBuilderTest extends TestCase
{
protected function tearDown(): void
{
m::close();
}

/**
* Ensure that when the reference is unqualified (i.e., does not contain a
* database name or a schema), and the search_path is empty, the database
* specified on the connection is used, and the default schema ('public')
* is used.
*/
public function testWhenSearchPathEmptyHasTableWithUnqualifiedReferenceIsCorrect()
{
$connection = $this->getConnection();
$connection->shouldReceive('getConfig')->with('search_path')->andReturn(null);
$grammar = m::mock(PostgresGrammar::class);
$connection->shouldReceive('getSchemaGrammar')->once()->andReturn($grammar);
$grammar->shouldReceive('compileTableExists')->andReturn("select * from information_schema.tables where table_catalog = ? and table_schema = ? and table_name = ? and table_type = 'BASE TABLE'");
$connection->shouldReceive('select')->with("select * from information_schema.tables where table_catalog = ? and table_schema = ? and table_name = ? and table_type = 'BASE TABLE'", ['laravel', 'public', 'foo'])->andReturn(['countable_result']);
$connection->shouldReceive('getTablePrefix');
$connection->shouldReceive('getConfig')->with('database')->andReturn('laravel');
$builder = $this->getBuilder($connection);

$builder->hasTable('foo');
}

/**
* Ensure that when the reference is unqualified (i.e., does not contain a
* database name or a schema), and the first schema in the search_path is
* NOT the default ('public'), the database specified on the connection is
* used, and the first schema in the search_path is used.
*/
public function testWhenSearchPathNotEmptyHasTableWithUnqualifiedSchemaReferenceIsCorrect()
{
$connection = $this->getConnection();
$connection->shouldReceive('getConfig')->with('search_path')->andReturn('myapp,public');
$grammar = m::mock(PostgresGrammar::class);
$connection->shouldReceive('getSchemaGrammar')->once()->andReturn($grammar);
$grammar->shouldReceive('compileTableExists')->andReturn("select * from information_schema.tables where table_catalog = ? and table_schema = ? and table_name = ? and table_type = 'BASE TABLE'");
$connection->shouldReceive('select')->with("select * from information_schema.tables where table_catalog = ? and table_schema = ? and table_name = ? and table_type = 'BASE TABLE'", ['laravel', 'myapp', 'foo'])->andReturn(['countable_result']);
$connection->shouldReceive('getTablePrefix');
$connection->shouldReceive('getConfig')->with('database')->andReturn('laravel');
$builder = $this->getBuilder($connection);

$builder->hasTable('foo');
}

/**
* Ensure that when the reference is qualified only with a schema, that
* the database specified on the connection is used, and the specified
* schema is used, even if it is not within the search_path.
*/
public function testWhenSchemaNotInSearchPathHasTableWithQualifiedSchemaReferenceIsCorrect()
{
$connection = $this->getConnection();
$connection->shouldReceive('getConfig')->with('search_path')->andReturn('public');
$grammar = m::mock(PostgresGrammar::class);
$connection->shouldReceive('getSchemaGrammar')->once()->andReturn($grammar);
$grammar->shouldReceive('compileTableExists')->andReturn("select * from information_schema.tables where table_catalog = ? and table_schema = ? and table_name = ? and table_type = 'BASE TABLE'");
$connection->shouldReceive('select')->with("select * from information_schema.tables where table_catalog = ? and table_schema = ? and table_name = ? and table_type = 'BASE TABLE'", ['laravel', 'myapp', 'foo'])->andReturn(['countable_result']);
$connection->shouldReceive('getTablePrefix');
$connection->shouldReceive('getConfig')->with('database')->andReturn('laravel');
$builder = $this->getBuilder($connection);

$builder->hasTable('myapp.foo');
}

/**
* Ensure that when the reference is qualified with a database AND a schema,
* and the database is NOT the database configured for the connection, the
* specified database is used instead.
*/
public function testWhenDatabaseNotDefaultHasTableWithFullyQualifiedReferenceIsCorrect()
{
$connection = $this->getConnection();
$connection->shouldReceive('getConfig')->with('search_path')->andReturn('public');
$grammar = m::mock(PostgresGrammar::class);
$connection->shouldReceive('getSchemaGrammar')->once()->andReturn($grammar);
$grammar->shouldReceive('compileTableExists')->andReturn("select * from information_schema.tables where table_catalog = ? and table_schema = ? and table_name = ? and table_type = 'BASE TABLE'");
$connection->shouldReceive('select')->with("select * from information_schema.tables where table_catalog = ? and table_schema = ? and table_name = ? and table_type = 'BASE TABLE'", ['mydatabase', 'myapp', 'foo'])->andReturn(['countable_result']);
$connection->shouldReceive('getTablePrefix');
$connection->shouldReceive('getConfig')->with('database')->andReturn('laravel');
$builder = $this->getBuilder($connection);

$builder->hasTable('mydatabase.myapp.foo');
}

/**
* Ensure that when the reference is unqualified (i.e., does not contain a
* database name or a schema), and the search_path is empty, the database
* specified on the connection is used, and the default schema ('public')
* is used.
*/
public function testWhenSearchPathEmptyGetColumnListingWithUnqualifiedReferenceIsCorrect()
{
$connection = $this->getConnection();
$connection->shouldReceive('getConfig')->with('search_path')->andReturn(null);
$grammar = m::mock(PostgresGrammar::class);
$connection->shouldReceive('getSchemaGrammar')->once()->andReturn($grammar);
$grammar->shouldReceive('compileColumnListing')->andReturn('select column_name from information_schema.columns where table_catalog = ? and table_schema = ? and table_name = ?');
$connection->shouldReceive('select')->with('select column_name from information_schema.columns where table_catalog = ? and table_schema = ? and table_name = ?', ['laravel', 'public', 'foo'])->andReturn(['countable_result']);
$connection->shouldReceive('getTablePrefix');
$connection->shouldReceive('getConfig')->with('database')->andReturn('laravel');
$processor = m::mock(PostgresProcessor::class);
$connection->shouldReceive('getPostProcessor')->andReturn($processor);
$processor->shouldReceive('processColumnListing')->andReturn(['some_column']);
$builder = $this->getBuilder($connection);

$builder->getColumnListing('foo');
}

/**
* Ensure that when the reference is unqualified (i.e., does not contain a
* database name or a schema), and the first schema in the search_path is
* NOT the default ('public'), the database specified on the connection is
* used, and the first schema in the search_path is used.
*/
public function testWhenSearchPathNotEmptyGetColumnListingWithUnqualifiedSchemaReferenceIsCorrect()
{
$connection = $this->getConnection();
$connection->shouldReceive('getConfig')->with('search_path')->andReturn('myapp,public');
$grammar = m::mock(PostgresGrammar::class);
$connection->shouldReceive('getSchemaGrammar')->once()->andReturn($grammar);
$grammar->shouldReceive('compileColumnListing')->andReturn('select column_name from information_schema.columns where table_catalog = ? and table_schema = ? and table_name = ?');
$connection->shouldReceive('select')->with('select column_name from information_schema.columns where table_catalog = ? and table_schema = ? and table_name = ?', ['laravel', 'myapp', 'foo'])->andReturn(['countable_result']);
$connection->shouldReceive('getTablePrefix');
$connection->shouldReceive('getConfig')->with('database')->andReturn('laravel');
$processor = m::mock(PostgresProcessor::class);
$connection->shouldReceive('getPostProcessor')->andReturn($processor);
$processor->shouldReceive('processColumnListing')->andReturn(['some_column']);
$builder = $this->getBuilder($connection);

$builder->getColumnListing('foo');
}

/**
* Ensure that when the reference is qualified only with a schema, that
* the database specified on the connection is used, and the specified
* schema is used, even if it is not within the search_path.
*/
public function testWhenSchemaNotInSearchPathGetColumnListingWithQualifiedSchemaReferenceIsCorrect()
{
$connection = $this->getConnection();
$connection->shouldReceive('getConfig')->with('search_path')->andReturn('public');
$grammar = m::mock(PostgresGrammar::class);
$connection->shouldReceive('getSchemaGrammar')->once()->andReturn($grammar);
$grammar->shouldReceive('compileColumnListing')->andReturn('select column_name from information_schema.columns where table_catalog = ? and table_schema = ? and table_name = ?');
$connection->shouldReceive('select')->with('select column_name from information_schema.columns where table_catalog = ? and table_schema = ? and table_name = ?', ['laravel', 'myapp', 'foo'])->andReturn(['countable_result']);
$connection->shouldReceive('getTablePrefix');
$connection->shouldReceive('getConfig')->with('database')->andReturn('laravel');
$processor = m::mock(PostgresProcessor::class);
$connection->shouldReceive('getPostProcessor')->andReturn($processor);
$processor->shouldReceive('processColumnListing')->andReturn(['some_column']);
$builder = $this->getBuilder($connection);

$builder->getColumnListing('myapp.foo');
}

/**
* Ensure that when the reference is qualified with a database AND a schema,
* and the database is NOT the database configured for the connection, the
* specified database is used instead.
*/
public function testWhenDatabaseNotDefaultGetColumnListingWithFullyQualifiedReferenceIsCorrect()
{
$connection = $this->getConnection();
$connection->shouldReceive('getConfig')->with('search_path')->andReturn('public');
$grammar = m::mock(PostgresGrammar::class);
$connection->shouldReceive('getSchemaGrammar')->once()->andReturn($grammar);
$grammar->shouldReceive('compileColumnListing')->andReturn('select column_name from information_schema.columns where table_catalog = ? and table_schema = ? and table_name = ?');
$connection->shouldReceive('select')->with('select column_name from information_schema.columns where table_catalog = ? and table_schema = ? and table_name = ?', ['mydatabase', 'myapp', 'foo'])->andReturn(['countable_result']);
$connection->shouldReceive('getTablePrefix');
$connection->shouldReceive('getConfig')->with('database')->andReturn('laravel');
$processor = m::mock(PostgresProcessor::class);
$connection->shouldReceive('getPostProcessor')->andReturn($processor);
$processor->shouldReceive('processColumnListing')->andReturn(['some_column']);
$builder = $this->getBuilder($connection);

$builder->getColumnListing('mydatabase.myapp.foo');
}

protected function getConnection()
{
return m::mock(Connection::class);
}

protected function getBuilder($connection)
{
return new PostgresBuilder($connection);
}

protected function getGrammar()
{
return new PostgresGrammar;
}
}
Loading