[ticket/17530] Use Doctrine driver middleware instead of 'platform' parameter

PHPBB-17530

phpBB/phpbb/db/middleware/postgresql/phpbb_postgresql_driver.php

@@ -0,0 +1,31 @@
+<?php
+/**
+ *
+ * This file is part of the phpBB Forum Software package.
+ *
+ * @copyright (c) phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ * For full copyright and license information, please see
+ * the docs/CREDITS.txt file.
+ *
+ */
+
+namespace phpbb\db\middleware\postgresql;
+
+use Doctrine\DBAL\Driver\Middleware\AbstractDriverMiddleware;
+
+/**
+ * PostgreSQL Doctrine driver middleware.
+ * Makes use of phpBB's PostgreSQL specific platform.
+ */
+class phpbb_postgresql_driver extends AbstractDriverMiddleware
+{
+	/**
+	 * {@inheritDoc}
+	 */
+	public function createDatabasePlatformForVersion($version)
+	{
+		return new phpbb_postgresql_platform();
+	}
+}

phpBB/phpbb/db/middleware/postgresql/phpbb_postgresql_middleware.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ *
+ * This file is part of the phpBB Forum Software package.
+ *
+ * @copyright (c) phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ * For full copyright and license information, please see
+ * the docs/CREDITS.txt file.
+ *
+ */
+
+namespace phpbb\db\middleware\postgresql;
+
+use Doctrine\DBAL\Driver;
+
+/**
+ * PostgreSQL Doctrine middleware.
+ * Makes use of phpBB's PostgreSQL specific platform.
+ */
+class phpbb_postgresql_middleware implements Driver\Middleware
+{
+	public function wrap(Driver $driver): Driver
+	{
+		return new phpbb_postgresql_driver($driver);
+	}
+}

phpBB/phpbb/db/middleware/postgresql/phpbb_postgresql_platform.php

@@ -0,0 +1,205 @@
+<?php
+/**
+ *
+ * This file is part of the phpBB Forum Software package.
+ *
+ * @copyright (c) phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ * For full copyright and license information, please see
+ * the docs/CREDITS.txt file.
+ *
+ */
+
+namespace phpbb\db\middleware\postgresql;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
+use Doctrine\DBAL\Schema\Sequence;
+use Doctrine\DBAL\Schema\Table;
+use Doctrine\DBAL\Schema\TableDiff;
+use Doctrine\DBAL\Types\BigIntType;
+use Doctrine\DBAL\Types\IntegerType;
+use Doctrine\DBAL\Types\SmallIntType;
+use Doctrine\DBAL\Types\Type;
+
+/**
+ * PostgreSQL specific schema restrictions for BC.
+ *
+ * Doctrine is using SERIAL which auto creates the sequences with
+ * a name different from the one our driver is using. So in order
+ * to stay compatible with the existing DB we have to change its
+ * naming and not ours.
+ */
+class phpbb_postgresql_platform extends PostgreSQLPlatform
+{
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getIdentitySequenceName($tableName, $columnName): string
+	{
+		return $tableName . '_seq';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public function getIntegerTypeDeclarationSQL(array $column): string
+	{
+		return 'INT';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public function getBigIntTypeDeclarationSQL(array $column): string
+	{
+		return 'BIGINT';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public function getSmallIntTypeDeclarationSQL(array $column): string
+	{
+		return 'SMALLINT';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public function getDefaultValueDeclarationSQL($column): string
+	{
+		if ($this->isSerialColumn($column))
+		{
+			return ' DEFAULT {{placeholder_sequence}}';
+		}
+
+		return AbstractPlatform::getDefaultValueDeclarationSQL($column);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public function getAlterTableSQL(TableDiff $diff)
+	{
+		$sql = parent::getAlterTableSQL($diff);
+		$table_name = $diff->getOldTable()->getName();
+		$columns = $diff->getAddedColumns();
+		$post_sql = $sequence_sql = [];
+
+		foreach ($columns as $column)
+		{
+			$column_name = $column->getName();
+			if (!empty($column->getAutoincrement()))
+			{
+				$sequence = new Sequence($this->getIdentitySequenceName($table_name, $column_name));
+				$sequence_sql[] = $this->getCreateSequenceSQL($sequence);
+				$post_sql[] = 'ALTER SEQUENCE ' . $sequence->getName() . ' OWNED BY ' . $table_name . '.' . $column_name;
+			}
+		}
+		$sql = array_merge($sequence_sql, $sql, $post_sql);
+
+		foreach ($sql as $i => $query)
+		{
+			$sql[$i] = str_replace('{{placeholder_sequence}}', "nextval('{$table_name}_seq')", $query);
+		}
+
+		return $sql;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public function supportsIdentityColumns(): bool
+	{
+		return false;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	protected function _getCreateTableSQL($name, array $columns, array $options = []): array
+	{
+		$sql = [];
+		$post_sql = [];
+		foreach ($columns as $column_name => $column)
+		{
+			if (!empty($column['autoincrement']))
+			{
+				$sequence = new Sequence($this->getIdentitySequenceName($name, $column_name));
+				$sql[] = $this->getCreateSequenceSQL($sequence);
+				$post_sql[] = 'ALTER SEQUENCE '.$sequence->getName().' OWNED BY '.$name.'.'.$column_name;
+			}
+		}
+		$sql = array_merge($sql, parent::_getCreateTableSQL($name, $columns, $options), $post_sql);
+
+		foreach ($sql as $i => $query)
+		{
+			$sql[$i] = str_replace('{{placeholder_sequence}}', "nextval('{$name}_seq')", $query);
+		}
+
+		return $sql;
+	}
+
+	/**
+	 * Return if column is a "serial" column, i.e. type supporting auto-increment
+	 *
+	 * @param array $column Column data
+	 * @return bool
+	 */
+	private function isSerialColumn(array $column): bool
+	{
+		return isset($column['type'], $column['autoincrement'])
+			&& $column['autoincrement'] === true
+			&& $this->isNumericType($column['type']);
+	}
+
+	/**
+	 * Return if supplied type is of numeric type
+	 *
+	 * @param Type $type
+	 * @return bool
+	 */
+	private function isNumericType(Type $type): bool
+	{
+		return $type instanceof IntegerType || $type instanceof BigIntType || $type instanceof SmallIntType;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public function getListSequencesSQL($database): string
+	{
+		return "SELECT sequence_name AS relname,
+				sequence_schema AS schemaname,
+				1 AS min_value,
+				1 AS increment_by
+			FROM information_schema.sequences
+			WHERE sequence_schema NOT LIKE 'pg\_%'
+				AND sequence_schema <> 'information_schema'";
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public function getDropIndexSQL($index, $table = null): string
+	{
+		// If we have a primary or a unique index, we need to drop the constraint
+		// instead of the index itself or postgreSQL will reject the query.
+		if (is_string($index) && $table !== null && $index === $this->tableName($table) . '_pkey')
+		{
+			return $this->getDropConstraintSQL($index, $this->tableName($table));
+		}
+
+		return parent::getDropIndexSQL($index, $table);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	private function tableName($table)
+	{
+		return $table instanceof Table ? $table->getName() : (string) $table;
+	}
+}