92e8c40c55
This adds a requirement for all definitions that have foreign keys to also require indices for all source (local) attributes mentioned in foreign keys. MariaDB/MySQL creates indices for source attributes automatically, so this serves as a way to get rid of those automatic indices and create clean explicit ones instead. In PostgreSQL, most of the time, indices on the source are necessary to decrease performance penalty of foreign keys (like in MariaDB), but they aren't created automatically, so this serves to remove that difference between PostgreSQL and MariaDB.
620 lines
20 KiB
PHP
620 lines
20 KiB
PHP
<?php
|
|
// This file is part of GNU social - https://www.gnu.org/software/social
|
|
//
|
|
// GNU social is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// GNU social is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Database schema for MariaDB
|
|
*
|
|
* @category Database
|
|
* @package GNUsocial
|
|
* @author Evan Prodromou <evan@status.net>
|
|
* @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
|
*/
|
|
|
|
defined('GNUSOCIAL') || die();
|
|
|
|
/**
|
|
* Class representing the database schema for MariaDB
|
|
*
|
|
* A class representing the database schema. Can be used to
|
|
* manipulate the schema -- especially for plugins and upgrade
|
|
* utilities.
|
|
*
|
|
* @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
|
*/
|
|
class MysqlSchema extends Schema
|
|
{
|
|
public static $_single = null;
|
|
|
|
/**
|
|
* Main public entry point. Use this to get
|
|
* the singleton object.
|
|
*
|
|
* @param object|null $conn
|
|
* @param string|null dummy param
|
|
* @return Schema the (single) Schema object
|
|
*/
|
|
public static function get($conn = null, $_ = 'mysql')
|
|
{
|
|
if (empty(self::$_single)) {
|
|
self::$_single = new Schema($conn, 'mysql');
|
|
}
|
|
return self::$_single;
|
|
}
|
|
|
|
/**
|
|
* Returns a TableDef object for the table
|
|
* in the schema with the given name.
|
|
*
|
|
* Throws an exception if the table is not found.
|
|
*
|
|
* @param string $table Name of the table to get
|
|
*
|
|
* @return array of tabledef for that table.
|
|
* @throws PEAR_Exception
|
|
* @throws SchemaTableMissingException
|
|
*/
|
|
public function getTableDef($table)
|
|
{
|
|
$def = [];
|
|
$hasKeys = false;
|
|
|
|
// Pull column data from INFORMATION_SCHEMA
|
|
$columns = $this->fetchMetaInfo($table, 'COLUMNS', 'ORDINAL_POSITION');
|
|
if (count($columns) == 0) {
|
|
throw new SchemaTableMissingException("No such table: $table");
|
|
}
|
|
|
|
foreach ($columns as $row) {
|
|
$name = $row['COLUMN_NAME'];
|
|
$field = [];
|
|
|
|
$type = $field['type'] = $row['DATA_TYPE'];
|
|
|
|
switch ($type) {
|
|
case 'char':
|
|
case 'varchar':
|
|
if (!is_null($row['CHARACTER_MAXIMUM_LENGTH'])) {
|
|
$field['length'] = (int) $row['CHARACTER_MAXIMUM_LENGTH'];
|
|
}
|
|
break;
|
|
case 'decimal':
|
|
// Other int types may report these values, but they're irrelevant.
|
|
// Just ignore them!
|
|
if (!is_null($row['NUMERIC_PRECISION'])) {
|
|
$field['precision'] = (int) $row['NUMERIC_PRECISION'];
|
|
}
|
|
if (!is_null($row['NUMERIC_SCALE'])) {
|
|
$field['scale'] = (int) $row['NUMERIC_SCALE'];
|
|
}
|
|
break;
|
|
case 'enum':
|
|
$enum = preg_replace("/^enum\('(.+)'\)$/", '\1', $row['COLUMN_TYPE']);
|
|
$field['enum'] = explode("','", $enum);
|
|
break;
|
|
}
|
|
|
|
|
|
if ($row['IS_NULLABLE'] == 'NO') {
|
|
$field['not null'] = true;
|
|
}
|
|
$col_default = $row['COLUMN_DEFAULT'];
|
|
if (!is_null($col_default) && $col_default !== 'NULL') {
|
|
if ($this->isNumericType($field)) {
|
|
$field['default'] = (int) $col_default;
|
|
} elseif ($col_default === 'CURRENT_TIMESTAMP'
|
|
|| $col_default === 'current_timestamp()') {
|
|
// A hack for "datetime" fields
|
|
// Skip "timestamp" as they get a CURRENT_TIMESTAMP default implicitly
|
|
if ($type !== 'timestamp') {
|
|
$field['default'] = 'CURRENT_TIMESTAMP';
|
|
}
|
|
} else {
|
|
$match = "/^'(.*)'$/";
|
|
if (preg_match($match, $col_default)) {
|
|
$field['default'] = preg_replace($match, '\1', $col_default);
|
|
} else {
|
|
$field['default'] = $col_default;
|
|
}
|
|
}
|
|
}
|
|
if ($row['COLUMN_KEY'] !== null) {
|
|
// We'll need to look up key info...
|
|
$hasKeys = true;
|
|
}
|
|
if ($row['COLUMN_COMMENT'] !== null && $row['COLUMN_COMMENT'] != '') {
|
|
$field['description'] = $row['COLUMN_COMMENT'];
|
|
}
|
|
|
|
$extra = $row['EXTRA'];
|
|
if ($extra) {
|
|
if (preg_match('/(^|\s)auto_increment(\s|$)/i', $extra)) {
|
|
$field['auto_increment'] = true;
|
|
}
|
|
}
|
|
|
|
$table_props = $this->getTableProperties($table, ['TABLE_COLLATION']);
|
|
$collate = $row['COLLATION_NAME'];
|
|
if (!empty($collate) && $collate !== $table_props['TABLE_COLLATION']) {
|
|
$field['collate'] = $collate;
|
|
}
|
|
|
|
$def['fields'][$name] = $field;
|
|
}
|
|
|
|
if ($hasKeys) {
|
|
// INFORMATION_SCHEMA's CONSTRAINTS and KEY_COLUMN_USAGE tables give
|
|
// good info on primary and unique keys but don't list ANY info on
|
|
// multi-value keys, which is lame-o. Sigh.
|
|
$keyColumns = $this->fetchMetaInfo($table, 'KEY_COLUMN_USAGE', 'CONSTRAINT_NAME, ORDINAL_POSITION');
|
|
$keys = [];
|
|
$fkeys = [];
|
|
|
|
foreach ($keyColumns as $row) {
|
|
$keyName = $row['CONSTRAINT_NAME'];
|
|
$keyCol = $row['COLUMN_NAME'];
|
|
if (!isset($keys[$keyName])) {
|
|
$keys[$keyName] = [];
|
|
}
|
|
$keys[$keyName][] = $keyCol;
|
|
if (!is_null($row['REFERENCED_TABLE_NAME'])) {
|
|
$fkeys[] = $keyName;
|
|
}
|
|
}
|
|
|
|
foreach ($keys as $keyName => $cols) {
|
|
if ($keyName === 'PRIMARY') {
|
|
$def['primary key'] = $cols;
|
|
} elseif (in_array($keyName, $fkeys)) {
|
|
$fkey = $this->fetchForeignKeyInfo($table, $keyName);
|
|
$colMap = array_combine($cols, $fkey['cols']);
|
|
$def['foreign keys'][$keyName] = [$fkey['table_name'], $colMap];
|
|
} else {
|
|
$def['unique keys'][$keyName] = $cols;
|
|
}
|
|
}
|
|
|
|
$indexInfo = $this->fetchIndexInfo($table);
|
|
|
|
foreach ($indexInfo as $row) {
|
|
$keyName = $row['key_name'];
|
|
$cols = $row['cols'];
|
|
|
|
if ($row['key_type'] === 'FULLTEXT') {
|
|
$def['fulltext indexes'][$keyName] = $cols;
|
|
} else {
|
|
$def['indexes'][$keyName] = $cols;
|
|
}
|
|
}
|
|
}
|
|
return $def;
|
|
}
|
|
|
|
/**
|
|
* Pull the given table properties from INFORMATION_SCHEMA.
|
|
* Most of the good stuff is MySQL extensions.
|
|
*
|
|
* @param $table
|
|
* @param $props
|
|
* @return array
|
|
* @throws PEAR_Exception
|
|
* @throws SchemaTableMissingException
|
|
*/
|
|
public function getTableProperties($table, $props)
|
|
{
|
|
$data = $this->fetchMetaInfo($table, 'TABLES');
|
|
if ($data) {
|
|
return $data[0];
|
|
} else {
|
|
throw new SchemaTableMissingException("No such table: $table");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Pull some INFORMATION.SCHEMA data for the given table.
|
|
*
|
|
* @param string $table
|
|
* @param $infoTable
|
|
* @param null $orderBy
|
|
* @return array of arrays
|
|
* @throws PEAR_Exception
|
|
*/
|
|
public function fetchMetaInfo($table, $infoTable, $orderBy = null)
|
|
{
|
|
$query = "SELECT * FROM INFORMATION_SCHEMA.%s " .
|
|
"WHERE TABLE_SCHEMA='%s' AND TABLE_NAME='%s'";
|
|
$schema = $this->conn->dsn['database'];
|
|
$sql = sprintf($query, $infoTable, $schema, $table);
|
|
if ($orderBy) {
|
|
$sql .= ' ORDER BY ' . $orderBy;
|
|
}
|
|
return $this->fetchQueryData($sql);
|
|
}
|
|
|
|
/**
|
|
* Pull index and keys information for the given table.
|
|
*
|
|
* @param string $table
|
|
* @return array of arrays
|
|
* @throws PEAR_Exception
|
|
*/
|
|
public function fetchIndexInfo(string $table): array
|
|
{
|
|
$schema = $this->conn->dsn['database'];
|
|
$data = $this->fetchQueryData(
|
|
<<<END
|
|
SELECT INDEX_NAME AS `key_name`, INDEX_TYPE AS `key_type`, COLUMN_NAME AS `col`
|
|
FROM INFORMATION_SCHEMA.STATISTICS
|
|
WHERE TABLE_SCHEMA = '{$schema}'
|
|
AND TABLE_NAME = '{$table}'
|
|
AND NON_UNIQUE IS TRUE
|
|
ORDER BY SEQ_IN_INDEX;
|
|
END
|
|
);
|
|
|
|
$rows = [];
|
|
foreach ($data as $row) {
|
|
$name = $row['key_name'];
|
|
if (isset($rows[$name])) {
|
|
$rows[$name]['cols'][] = $row['col'];
|
|
} else {
|
|
$row['cols'] = [$row['col']];
|
|
unset($row['col']);
|
|
$rows[$name] = $row;
|
|
}
|
|
}
|
|
return array_values($rows);
|
|
}
|
|
|
|
/**
|
|
* @param string $table
|
|
* @param string $constraint_name
|
|
* @return array array of rows with keys: table_name, cols (array of strings)
|
|
* @throws PEAR_Exception
|
|
*/
|
|
public function fetchForeignKeyInfo(string $table, string $constraint_name): array
|
|
{
|
|
$query = 'SELECT REFERENCED_TABLE_NAME AS `table_name`, REFERENCED_COLUMN_NAME AS `col` ' .
|
|
'FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE ' .
|
|
'WHERE TABLE_SCHEMA = \'%s\' AND TABLE_NAME = \'%s\' AND CONSTRAINT_NAME = \'%s\' ' .
|
|
'AND REFERENCED_TABLE_SCHEMA IS NOT NULL ' .
|
|
'ORDER BY POSITION_IN_UNIQUE_CONSTRAINT';
|
|
$schema = $this->conn->dsn['database'];
|
|
$sql = sprintf($query, $schema, $table, $constraint_name);
|
|
$data = $this->fetchQueryData($sql);
|
|
if (count($data) < 1) {
|
|
throw new Exception('Could not find foreign key ' . $constraint_name . ' on table ' . $table);
|
|
}
|
|
|
|
$info = [
|
|
'table_name' => $data[0]['table_name'],
|
|
'cols' => [],
|
|
];
|
|
foreach ($data as $row) {
|
|
$info['cols'][] = $row['col'];
|
|
}
|
|
return $info;
|
|
}
|
|
|
|
/**
|
|
* Append an SQL statement with an index definition for a full-text search
|
|
* index over one or more columns on a table.
|
|
*
|
|
* @param array $statements
|
|
* @param string $table
|
|
* @param string $name
|
|
* @param array $def
|
|
*/
|
|
public function appendCreateFulltextIndex(array &$statements, $table, $name, array $def)
|
|
{
|
|
$statements[] = "CREATE FULLTEXT INDEX $name ON $table " . $this->buildIndexList($def);
|
|
}
|
|
|
|
/**
|
|
* Append an SQL statement with an index definition for an advisory
|
|
* index over one or more columns on a table.
|
|
*
|
|
* @param array $statements
|
|
* @param string $table
|
|
* @param string $name
|
|
* @param array $def
|
|
*/
|
|
public function appendCreateIndex(array &$statements, $table, $name, array $def)
|
|
{
|
|
$statements[] = "ALTER TABLE {$this->quoteIdentifier($table)} "
|
|
. "ADD INDEX {$name} {$this->buildIndexList($def)}";
|
|
}
|
|
|
|
/**
|
|
* Close out a 'create table' SQL statement.
|
|
*
|
|
* @param string $name
|
|
* @param array $def
|
|
* @return string;
|
|
*
|
|
*/
|
|
public function endCreateTable($name, array $def)
|
|
{
|
|
$engine = $this->preferredEngine($def);
|
|
return ") ENGINE=$engine CHARACTER SET utf8mb4 COLLATE utf8mb4_bin";
|
|
}
|
|
|
|
public function preferredEngine($def)
|
|
{
|
|
/* MyISAM is no longer required for fulltext indexes, fortunately
|
|
if (!empty($def['fulltext indexes'])) {
|
|
return 'MyISAM';
|
|
}
|
|
*/
|
|
return 'InnoDB';
|
|
}
|
|
|
|
/**
|
|
* Get the unique index key name for a given column on this table
|
|
* @param $tableName
|
|
* @param $columnName
|
|
* @return string
|
|
*/
|
|
public function _uniqueKey($tableName, $columnName)
|
|
{
|
|
return $this->_key($tableName, $columnName);
|
|
}
|
|
|
|
/**
|
|
* Get the index key name for a given column on this table
|
|
* @param $tableName
|
|
* @param $columnName
|
|
* @return string
|
|
*/
|
|
public function _key($tableName, $columnName)
|
|
{
|
|
return "{$tableName}_{$columnName}_idx";
|
|
}
|
|
|
|
/**
|
|
* Append phrase(s) to an array of partial ALTER TABLE chunks in order
|
|
* to alter the given column from its old state to a new one.
|
|
*
|
|
* @param array $phrase
|
|
* @param string $columnName
|
|
* @param array $old previous column definition as found in DB
|
|
* @param array $cd current column definition
|
|
*/
|
|
public function appendAlterModifyColumn(
|
|
array &$phrase,
|
|
string $columnName,
|
|
array $old,
|
|
array $cd
|
|
): void {
|
|
$phrase[] = 'MODIFY COLUMN ' . $this->quoteIdentifier($columnName)
|
|
. ' ' . $this->columnSql($columnName, $cd);
|
|
}
|
|
|
|
/**
|
|
* MySQL doesn't take 'DROP CONSTRAINT', need to treat primary keys as
|
|
* if they were indexes here, but can use 'PRIMARY KEY' special name.
|
|
*
|
|
* @param array $phrase
|
|
*/
|
|
public function appendAlterDropPrimary(array &$phrase, string $tableName)
|
|
{
|
|
$phrase[] = 'DROP PRIMARY KEY';
|
|
}
|
|
|
|
/**
|
|
* MySQL doesn't take 'DROP CONSTRAINT', need to treat unique keys as
|
|
* if they were indexes here.
|
|
*
|
|
* @param array $phrase
|
|
* @param string $keyName MySQL
|
|
*/
|
|
public function appendAlterDropUnique(array &$phrase, $keyName)
|
|
{
|
|
$phrase[] = 'DROP INDEX ' . $keyName;
|
|
}
|
|
|
|
/**
|
|
* Throw some table metadata onto the ALTER TABLE if we have a mismatch
|
|
* in expected type, collation.
|
|
* @param array $phrase
|
|
* @param $tableName
|
|
* @param array $def
|
|
* @throws Exception
|
|
*/
|
|
public function appendAlterExtras(array &$phrase, $tableName, array $def)
|
|
{
|
|
// Check for table properties: make sure we're using a sane
|
|
// engine type and collation.
|
|
// @fixme make the default engine configurable?
|
|
$oldProps = $this->getTableProperties($tableName, ['ENGINE', 'TABLE_COLLATION']);
|
|
$engine = $this->preferredEngine($def);
|
|
if (strtolower($oldProps['ENGINE']) != strtolower($engine)) {
|
|
$phrase[] = "ENGINE=$engine";
|
|
}
|
|
if (strtolower($oldProps['TABLE_COLLATION']) != 'utf8mb4_bin') {
|
|
$phrase[] = 'CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_bin';
|
|
$phrase[] = 'DEFAULT CHARACTER SET = utf8mb4';
|
|
$phrase[] = 'DEFAULT COLLATE = utf8mb4_bin';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Append an SQL statement to drop an index from a table.
|
|
* Note that in MariaDB index names are relation-specific.
|
|
*
|
|
* @param array $statements
|
|
* @param string $table
|
|
* @param string $name
|
|
*/
|
|
public function appendDropIndex(array &$statements, $table, $name)
|
|
{
|
|
$statements[] = "ALTER TABLE {$this->quoteIdentifier($table)} "
|
|
. "DROP INDEX {$name}";
|
|
}
|
|
|
|
private function isNumericType(array $cd): bool
|
|
{
|
|
$ints = array_map(
|
|
function ($s) {
|
|
return $s . 'int';
|
|
},
|
|
['tiny', 'small', 'medium', 'big']
|
|
);
|
|
$ints = array_merge($ints, ['int', 'numeric', 'serial']);
|
|
return in_array(strtolower($cd['type']), $ints);
|
|
}
|
|
|
|
/**
|
|
* Is this column a string type?
|
|
* @param array $cd
|
|
* @return bool
|
|
*/
|
|
private function isStringType(array $cd): bool
|
|
{
|
|
$strings = ['char', 'varchar', 'text'];
|
|
return in_array(strtolower($cd['type']), $strings);
|
|
}
|
|
|
|
/**
|
|
* Return the proper SQL for creating or
|
|
* altering a column.
|
|
*
|
|
* Appropriate for use in CREATE TABLE or
|
|
* ALTER TABLE statements.
|
|
*
|
|
* @param string $name column name to create
|
|
* @param array $cd column to create
|
|
*
|
|
* @return string correct SQL for that column
|
|
*/
|
|
public function columnSql(string $name, array $cd)
|
|
{
|
|
$line = [];
|
|
$line[] = parent::columnSql($name, $cd);
|
|
|
|
// This'll have been added from our transform of "serial" type
|
|
if (!empty($cd['auto_increment'])) {
|
|
$line[] = 'AUTO_INCREMENT';
|
|
}
|
|
|
|
if (!empty($cd['description'])) {
|
|
$line[] = 'COMMENT';
|
|
$line[] = $this->quoteValue($cd['description']);
|
|
}
|
|
|
|
return implode(' ', $line);
|
|
}
|
|
|
|
public function mapType($column)
|
|
{
|
|
$map = [
|
|
'integer' => 'int',
|
|
'numeric' => 'decimal',
|
|
];
|
|
|
|
$type = $column['type'];
|
|
if (isset($map[$type])) {
|
|
$type = $map[$type];
|
|
}
|
|
|
|
if (!empty($column['size'])) {
|
|
$size = $column['size'];
|
|
if ($type == 'int' &&
|
|
in_array($size, ['tiny', 'small', 'medium', 'big'])) {
|
|
$type = $size . $type;
|
|
} elseif ($type == 'float' && $size == 'big') {
|
|
$type = 'double';
|
|
} elseif (in_array($type, ['blob', 'text']) &&
|
|
in_array($size, ['tiny', 'medium', 'long'])) {
|
|
$type = $size . $type;
|
|
}
|
|
}
|
|
|
|
return $type;
|
|
}
|
|
|
|
public function typeAndSize(string $name, array $column)
|
|
{
|
|
if ($column['type'] === 'enum') {
|
|
$vals = [];
|
|
foreach ($column['enum'] as &$val) {
|
|
$vals[] = "'{$val}'";
|
|
}
|
|
return 'enum(' . implode(',', $vals) . ')';
|
|
} elseif ($this->isStringType($column)) {
|
|
$col = parent::typeAndSize($name, $column);
|
|
if (!empty($column['collate'])) {
|
|
$col .= ' COLLATE ' . $column['collate'];
|
|
}
|
|
return $col;
|
|
} else {
|
|
return parent::typeAndSize($name, $column);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Filter the given table definition array to match features available
|
|
* in this database.
|
|
*
|
|
* This lets us strip out unsupported things like comments, foreign keys,
|
|
* or type variants that we wouldn't get back from getTableDef().
|
|
*
|
|
* @param string $tableName
|
|
* @param array $tableDef
|
|
* @return array
|
|
*/
|
|
public function filterDef(string $tableName, array $tableDef)
|
|
{
|
|
$tableDef = parent::filterDef($tableName, $tableDef);
|
|
|
|
// Get existing table collation if the table exists.
|
|
// To know if collation that's been set is unique for the table.
|
|
try {
|
|
$table_props = $this->getTableProperties($tableName, ['TABLE_COLLATION']);
|
|
$table_collate = $table_props['TABLE_COLLATION'];
|
|
} catch (SchemaTableMissingException $e) {
|
|
$table_collate = null;
|
|
}
|
|
|
|
foreach ($tableDef['fields'] as $name => &$col) {
|
|
switch ($col['type']) {
|
|
case 'serial':
|
|
$col['type'] = 'int';
|
|
$col['auto_increment'] = true;
|
|
break;
|
|
case 'bool':
|
|
$col['type'] = 'int';
|
|
$col['size'] = 'tiny';
|
|
$col['default'] = (int) $col['default'];
|
|
break;
|
|
}
|
|
|
|
if (!empty($col['collate'])
|
|
&& $col['collate'] === $table_collate) {
|
|
unset($col['collate']);
|
|
}
|
|
|
|
$col['type'] = $this->mapType($col);
|
|
unset($col['size']);
|
|
}
|
|
if (!common_config('db', 'mysql_foreign_keys')) {
|
|
unset($tableDef['foreign keys']);
|
|
}
|
|
return $tableDef;
|
|
}
|
|
}
|