Exception
2 years ago
Visitor
9 months ago
AbstractAsset.php
2 years ago
AbstractSchemaManager.php
9 months ago
Column.php
2 years ago
ColumnDiff.php
2 years ago
Comparator.php
2 years ago
Constraint.php
2 years ago
DB2SchemaManager.php
2 years ago
DefaultSchemaManagerFactory.php
2 years ago
ForeignKeyConstraint.php
9 months ago
Identifier.php
2 years ago
Index.php
2 years ago
LegacySchemaManagerFactory.php
2 years ago
MySQLSchemaManager.php
9 months ago
OracleSchemaManager.php
2 years ago
PostgreSQLSchemaManager.php
9 months ago
SQLServerSchemaManager.php
9 months ago
Schema.php
2 years ago
SchemaConfig.php
2 years ago
SchemaDiff.php
2 years ago
SchemaException.php
2 years ago
SchemaManagerFactory.php
2 years ago
Sequence.php
2 years ago
SqliteSchemaManager.php
8 months ago
Table.php
2 years ago
TableDiff.php
2 years ago
UniqueConstraint.php
2 years ago
View.php
2 years ago
MySQLSchemaManager.php
368 lines
| 1 | <?php |
| 2 | namespace MailPoetVendor\Doctrine\DBAL\Schema; |
| 3 | if (!defined('ABSPATH')) exit; |
| 4 | use MailPoetVendor\Doctrine\DBAL\Platforms\AbstractMySQLPlatform; |
| 5 | use MailPoetVendor\Doctrine\DBAL\Platforms\MariaDb1027Platform; |
| 6 | use MailPoetVendor\Doctrine\DBAL\Platforms\MySQL; |
| 7 | use MailPoetVendor\Doctrine\DBAL\Platforms\MySQL\CollationMetadataProvider\CachingCollationMetadataProvider; |
| 8 | use MailPoetVendor\Doctrine\DBAL\Platforms\MySQL\CollationMetadataProvider\ConnectionCollationMetadataProvider; |
| 9 | use MailPoetVendor\Doctrine\DBAL\Result; |
| 10 | use MailPoetVendor\Doctrine\DBAL\Types\Type; |
| 11 | use MailPoetVendor\Doctrine\Deprecations\Deprecation; |
| 12 | use function array_change_key_case; |
| 13 | use function array_shift; |
| 14 | use function assert; |
| 15 | use function explode; |
| 16 | use function implode; |
| 17 | use function is_string; |
| 18 | use function preg_match; |
| 19 | use function strpos; |
| 20 | use function strtok; |
| 21 | use function strtolower; |
| 22 | use function strtr; |
| 23 | use const CASE_LOWER; |
| 24 | class MySQLSchemaManager extends AbstractSchemaManager |
| 25 | { |
| 26 | private const MARIADB_ESCAPE_SEQUENCES = [ |
| 27 | '\\0' => "\x00", |
| 28 | "\\'" => "'", |
| 29 | '\\"' => '"', |
| 30 | '\\b' => "\\b", |
| 31 | '\\n' => "\n", |
| 32 | '\\r' => "\r", |
| 33 | '\\t' => "\t", |
| 34 | '\\Z' => "\x1a", |
| 35 | '\\\\' => '\\', |
| 36 | '\\%' => '%', |
| 37 | '\\_' => '_', |
| 38 | // Internally, MariaDB escapes single quotes using the standard syntax |
| 39 | "''" => "'", |
| 40 | ]; |
| 41 | public function listTableNames() |
| 42 | { |
| 43 | return $this->doListTableNames(); |
| 44 | } |
| 45 | public function listTables() |
| 46 | { |
| 47 | return $this->doListTables(); |
| 48 | } |
| 49 | public function listTableDetails($name) |
| 50 | { |
| 51 | Deprecation::triggerIfCalledFromOutside('doctrine/dbal', 'https://github.com/doctrine/dbal/pull/5595', '%s is deprecated. Use introspectTable() instead.', __METHOD__); |
| 52 | return $this->doListTableDetails($name); |
| 53 | } |
| 54 | public function listTableColumns($table, $database = null) |
| 55 | { |
| 56 | return $this->doListTableColumns($table, $database); |
| 57 | } |
| 58 | public function listTableIndexes($table) |
| 59 | { |
| 60 | return $this->doListTableIndexes($table); |
| 61 | } |
| 62 | public function listTableForeignKeys($table, $database = null) |
| 63 | { |
| 64 | return $this->doListTableForeignKeys($table, $database); |
| 65 | } |
| 66 | protected function _getPortableViewDefinition($view) |
| 67 | { |
| 68 | return new View($view['TABLE_NAME'], $view['VIEW_DEFINITION']); |
| 69 | } |
| 70 | protected function _getPortableTableDefinition($table) |
| 71 | { |
| 72 | return array_shift($table); |
| 73 | } |
| 74 | protected function _getPortableTableIndexesList($tableIndexes, $tableName = null) |
| 75 | { |
| 76 | foreach ($tableIndexes as $k => $v) { |
| 77 | $v = array_change_key_case($v, CASE_LOWER); |
| 78 | if ($v['key_name'] === 'PRIMARY') { |
| 79 | $v['primary'] = \true; |
| 80 | } else { |
| 81 | $v['primary'] = \false; |
| 82 | } |
| 83 | if (strpos($v['index_type'], 'FULLTEXT') !== \false) { |
| 84 | $v['flags'] = ['FULLTEXT']; |
| 85 | } elseif (strpos($v['index_type'], 'SPATIAL') !== \false) { |
| 86 | $v['flags'] = ['SPATIAL']; |
| 87 | } |
| 88 | // Ignore prohibited prefix `length` for spatial index |
| 89 | if (strpos($v['index_type'], 'SPATIAL') === \false) { |
| 90 | $v['length'] = isset($v['sub_part']) ? (int) $v['sub_part'] : null; |
| 91 | } |
| 92 | $tableIndexes[$k] = $v; |
| 93 | } |
| 94 | return parent::_getPortableTableIndexesList($tableIndexes, $tableName); |
| 95 | } |
| 96 | protected function _getPortableDatabaseDefinition($database) |
| 97 | { |
| 98 | return $database['Database']; |
| 99 | } |
| 100 | protected function _getPortableTableColumnDefinition($tableColumn) |
| 101 | { |
| 102 | $tableColumn = array_change_key_case($tableColumn, CASE_LOWER); |
| 103 | $dbType = strtolower($tableColumn['type']); |
| 104 | $dbType = strtok($dbType, '(), '); |
| 105 | assert(is_string($dbType)); |
| 106 | $length = $tableColumn['length'] ?? strtok('(), '); |
| 107 | $fixed = null; |
| 108 | if (!isset($tableColumn['name'])) { |
| 109 | $tableColumn['name'] = ''; |
| 110 | } |
| 111 | $scale = null; |
| 112 | $precision = null; |
| 113 | $type = $origType = $this->_platform->getDoctrineTypeMapping($dbType); |
| 114 | // In cases where not connected to a database DESCRIBE $table does not return 'Comment' |
| 115 | if (isset($tableColumn['comment'])) { |
| 116 | $type = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type); |
| 117 | $tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $type); |
| 118 | } |
| 119 | switch ($dbType) { |
| 120 | case 'char': |
| 121 | case 'binary': |
| 122 | $fixed = \true; |
| 123 | break; |
| 124 | case 'float': |
| 125 | case 'double': |
| 126 | case 'real': |
| 127 | case 'numeric': |
| 128 | case 'decimal': |
| 129 | if (preg_match('([A-Za-z]+\\(([0-9]+),([0-9]+)\\))', $tableColumn['type'], $match) === 1) { |
| 130 | $precision = $match[1]; |
| 131 | $scale = $match[2]; |
| 132 | $length = null; |
| 133 | } |
| 134 | break; |
| 135 | case 'tinytext': |
| 136 | $length = AbstractMySQLPlatform::LENGTH_LIMIT_TINYTEXT; |
| 137 | break; |
| 138 | case 'text': |
| 139 | $length = AbstractMySQLPlatform::LENGTH_LIMIT_TEXT; |
| 140 | break; |
| 141 | case 'mediumtext': |
| 142 | $length = AbstractMySQLPlatform::LENGTH_LIMIT_MEDIUMTEXT; |
| 143 | break; |
| 144 | case 'tinyblob': |
| 145 | $length = AbstractMySQLPlatform::LENGTH_LIMIT_TINYBLOB; |
| 146 | break; |
| 147 | case 'blob': |
| 148 | $length = AbstractMySQLPlatform::LENGTH_LIMIT_BLOB; |
| 149 | break; |
| 150 | case 'mediumblob': |
| 151 | $length = AbstractMySQLPlatform::LENGTH_LIMIT_MEDIUMBLOB; |
| 152 | break; |
| 153 | case 'tinyint': |
| 154 | case 'smallint': |
| 155 | case 'mediumint': |
| 156 | case 'int': |
| 157 | case 'integer': |
| 158 | case 'bigint': |
| 159 | case 'year': |
| 160 | $length = null; |
| 161 | break; |
| 162 | } |
| 163 | if ($this->_platform instanceof MariaDb1027Platform) { |
| 164 | $columnDefault = $this->getMariaDb1027ColumnDefault($this->_platform, $tableColumn['default']); |
| 165 | } else { |
| 166 | $columnDefault = $tableColumn['default']; |
| 167 | } |
| 168 | $options = ['length' => $length !== null ? (int) $length : null, 'unsigned' => strpos($tableColumn['type'], 'unsigned') !== \false, 'fixed' => (bool) $fixed, 'default' => $columnDefault, 'notnull' => $tableColumn['null'] !== 'YES', 'scale' => null, 'precision' => null, 'autoincrement' => strpos($tableColumn['extra'], 'auto_increment') !== \false, 'comment' => isset($tableColumn['comment']) && $tableColumn['comment'] !== '' ? $tableColumn['comment'] : null]; |
| 169 | if ($scale !== null && $precision !== null) { |
| 170 | $options['scale'] = (int) $scale; |
| 171 | $options['precision'] = (int) $precision; |
| 172 | } |
| 173 | $column = new Column($tableColumn['field'], Type::getType($type), $options); |
| 174 | if (isset($tableColumn['characterset'])) { |
| 175 | $column->setPlatformOption('charset', $tableColumn['characterset']); |
| 176 | } |
| 177 | if (isset($tableColumn['collation'])) { |
| 178 | $column->setPlatformOption('collation', $tableColumn['collation']); |
| 179 | } |
| 180 | if (isset($tableColumn['declarationMismatch'])) { |
| 181 | $column->setPlatformOption('declarationMismatch', $tableColumn['declarationMismatch']); |
| 182 | } |
| 183 | // Check underlying database type where doctrine type is inferred from DC2Type comment |
| 184 | // and set a flag if it is not as expected. |
| 185 | if ($type === 'json' && $origType !== $type && $this->expectedDbType($type, $options) !== $dbType) { |
| 186 | $column->setPlatformOption('declarationMismatch', \true); |
| 187 | } |
| 188 | return $column; |
| 189 | } |
| 190 | private function expectedDbType(string $type, array $tableColumn) : string |
| 191 | { |
| 192 | $_type = Type::getType($type); |
| 193 | $expectedDbType = strtolower($_type->getSQLDeclaration($tableColumn, $this->_platform)); |
| 194 | $expectedDbType = strtok($expectedDbType, '(), '); |
| 195 | return $expectedDbType === \false ? '' : $expectedDbType; |
| 196 | } |
| 197 | private function getMariaDb1027ColumnDefault(MariaDb1027Platform $platform, ?string $columnDefault) : ?string |
| 198 | { |
| 199 | if ($columnDefault === 'NULL' || $columnDefault === null) { |
| 200 | return null; |
| 201 | } |
| 202 | if (preg_match('/^\'(.*)\'$/', $columnDefault, $matches) === 1) { |
| 203 | return strtr($matches[1], self::MARIADB_ESCAPE_SEQUENCES); |
| 204 | } |
| 205 | switch ($columnDefault) { |
| 206 | case 'current_timestamp()': |
| 207 | return $platform->getCurrentTimestampSQL(); |
| 208 | case 'curdate()': |
| 209 | return $platform->getCurrentDateSQL(); |
| 210 | case 'curtime()': |
| 211 | return $platform->getCurrentTimeSQL(); |
| 212 | } |
| 213 | return $columnDefault; |
| 214 | } |
| 215 | protected function _getPortableTableForeignKeysList($tableForeignKeys) |
| 216 | { |
| 217 | $list = []; |
| 218 | foreach ($tableForeignKeys as $value) { |
| 219 | $value = array_change_key_case($value, CASE_LOWER); |
| 220 | if (!isset($list[$value['constraint_name']])) { |
| 221 | if (!isset($value['delete_rule']) || $value['delete_rule'] === 'RESTRICT') { |
| 222 | $value['delete_rule'] = null; |
| 223 | } |
| 224 | if (!isset($value['update_rule']) || $value['update_rule'] === 'RESTRICT') { |
| 225 | $value['update_rule'] = null; |
| 226 | } |
| 227 | $list[$value['constraint_name']] = ['name' => $value['constraint_name'], 'local' => [], 'foreign' => [], 'foreignTable' => $value['referenced_table_name'], 'onDelete' => $value['delete_rule'], 'onUpdate' => $value['update_rule']]; |
| 228 | } |
| 229 | $list[$value['constraint_name']]['local'][] = $value['column_name']; |
| 230 | $list[$value['constraint_name']]['foreign'][] = $value['referenced_column_name']; |
| 231 | } |
| 232 | return parent::_getPortableTableForeignKeysList($list); |
| 233 | } |
| 234 | protected function _getPortableTableForeignKeyDefinition($tableForeignKey) : ForeignKeyConstraint |
| 235 | { |
| 236 | return new ForeignKeyConstraint($tableForeignKey['local'], $tableForeignKey['foreignTable'], $tableForeignKey['foreign'], $tableForeignKey['name'], ['onDelete' => $tableForeignKey['onDelete'], 'onUpdate' => $tableForeignKey['onUpdate']]); |
| 237 | } |
| 238 | public function createComparator() : Comparator |
| 239 | { |
| 240 | return new MySQL\Comparator($this->_platform, new CachingCollationMetadataProvider(new ConnectionCollationMetadataProvider($this->_conn))); |
| 241 | } |
| 242 | protected function selectTableNames(string $databaseName) : Result |
| 243 | { |
| 244 | $sql = <<<'SQL' |
| 245 | SELECT TABLE_NAME |
| 246 | FROM information_schema.TABLES |
| 247 | WHERE TABLE_SCHEMA = ? |
| 248 | AND TABLE_TYPE = 'BASE TABLE' |
| 249 | ORDER BY TABLE_NAME |
| 250 | SQL; |
| 251 | return $this->_conn->executeQuery($sql, [$databaseName]); |
| 252 | } |
| 253 | protected function selectTableColumns(string $databaseName, ?string $tableName = null) : Result |
| 254 | { |
| 255 | // @todo 4.0 - call getColumnTypeSQLSnippet() instead |
| 256 | [$columnTypeSQL, $joinCheckConstraintSQL] = $this->_platform->getColumnTypeSQLSnippets('c', $databaseName); |
| 257 | $sql = 'SELECT'; |
| 258 | if ($tableName === null) { |
| 259 | $sql .= ' c.TABLE_NAME,'; |
| 260 | } |
| 261 | $sql .= <<<SQL |
| 262 | c.COLUMN_NAME AS field, |
| 263 | {$columnTypeSQL} AS type, |
| 264 | c.IS_NULLABLE AS `null`, |
| 265 | c.COLUMN_KEY AS `key`, |
| 266 | c.COLUMN_DEFAULT AS `default`, |
| 267 | c.EXTRA, |
| 268 | c.COLUMN_COMMENT AS comment, |
| 269 | c.CHARACTER_SET_NAME AS characterset, |
| 270 | c.COLLATION_NAME AS collation |
| 271 | FROM information_schema.COLUMNS c |
| 272 | INNER JOIN information_schema.TABLES t |
| 273 | ON t.TABLE_NAME = c.TABLE_NAME |
| 274 | {$joinCheckConstraintSQL} |
| 275 | SQL; |
| 276 | // The schema name is passed multiple times as a literal in the WHERE clause instead of using a JOIN condition |
| 277 | // in order to avoid performance issues on MySQL older than 8.0 and the corresponding MariaDB versions |
| 278 | // caused by https://bugs.mysql.com/bug.php?id=81347 |
| 279 | $conditions = ['c.TABLE_SCHEMA = ?', 't.TABLE_SCHEMA = ?', "t.TABLE_TYPE = 'BASE TABLE'"]; |
| 280 | $params = [$databaseName, $databaseName]; |
| 281 | if ($tableName !== null) { |
| 282 | $conditions[] = 't.TABLE_NAME = ?'; |
| 283 | $params[] = $tableName; |
| 284 | } |
| 285 | $sql .= ' WHERE ' . implode(' AND ', $conditions) . ' ORDER BY ORDINAL_POSITION'; |
| 286 | return $this->_conn->executeQuery($sql, $params); |
| 287 | } |
| 288 | protected function selectIndexColumns(string $databaseName, ?string $tableName = null) : Result |
| 289 | { |
| 290 | $sql = 'SELECT'; |
| 291 | if ($tableName === null) { |
| 292 | $sql .= ' TABLE_NAME,'; |
| 293 | } |
| 294 | $sql .= <<<'SQL' |
| 295 | NON_UNIQUE AS Non_Unique, |
| 296 | INDEX_NAME AS Key_name, |
| 297 | COLUMN_NAME AS Column_Name, |
| 298 | SUB_PART AS Sub_Part, |
| 299 | INDEX_TYPE AS Index_Type |
| 300 | FROM information_schema.STATISTICS |
| 301 | SQL; |
| 302 | $conditions = ['TABLE_SCHEMA = ?']; |
| 303 | $params = [$databaseName]; |
| 304 | if ($tableName !== null) { |
| 305 | $conditions[] = 'TABLE_NAME = ?'; |
| 306 | $params[] = $tableName; |
| 307 | } |
| 308 | $sql .= ' WHERE ' . implode(' AND ', $conditions) . ' ORDER BY SEQ_IN_INDEX'; |
| 309 | return $this->_conn->executeQuery($sql, $params); |
| 310 | } |
| 311 | protected function selectForeignKeyColumns(string $databaseName, ?string $tableName = null) : Result |
| 312 | { |
| 313 | $sql = 'SELECT DISTINCT'; |
| 314 | if ($tableName === null) { |
| 315 | $sql .= ' k.TABLE_NAME,'; |
| 316 | } |
| 317 | $sql .= <<<'SQL' |
| 318 | k.CONSTRAINT_NAME, |
| 319 | k.COLUMN_NAME, |
| 320 | k.REFERENCED_TABLE_NAME, |
| 321 | k.REFERENCED_COLUMN_NAME, |
| 322 | k.ORDINAL_POSITION /*!50116, |
| 323 | c.UPDATE_RULE, |
| 324 | c.DELETE_RULE */ |
| 325 | FROM information_schema.key_column_usage k /*!50116 |
| 326 | INNER JOIN information_schema.referential_constraints c |
| 327 | ON c.CONSTRAINT_NAME = k.CONSTRAINT_NAME |
| 328 | AND c.TABLE_NAME = k.TABLE_NAME */ |
| 329 | SQL; |
| 330 | $conditions = ['k.TABLE_SCHEMA = ?']; |
| 331 | $params = [$databaseName]; |
| 332 | if ($tableName !== null) { |
| 333 | $conditions[] = 'k.TABLE_NAME = ?'; |
| 334 | $params[] = $tableName; |
| 335 | } |
| 336 | $conditions[] = 'k.REFERENCED_COLUMN_NAME IS NOT NULL'; |
| 337 | $sql .= ' WHERE ' . implode(' AND ', $conditions) . ' /*!50116 AND c.CONSTRAINT_SCHEMA = ' . $this->_conn->quote($databaseName) . ' */' . ' ORDER BY k.ORDINAL_POSITION'; |
| 338 | return $this->_conn->executeQuery($sql, $params); |
| 339 | } |
| 340 | protected function fetchTableOptionsByTable(string $databaseName, ?string $tableName = null) : array |
| 341 | { |
| 342 | $sql = $this->_platform->fetchTableOptionsByTable($tableName !== null); |
| 343 | $params = [$databaseName]; |
| 344 | if ($tableName !== null) { |
| 345 | $params[] = $tableName; |
| 346 | } |
| 347 | $metadata = $this->_conn->executeQuery($sql, $params)->fetchAllAssociativeIndexed(); |
| 348 | $tableOptions = []; |
| 349 | foreach ($metadata as $table => $data) { |
| 350 | $data = array_change_key_case($data, CASE_LOWER); |
| 351 | $tableOptions[$table] = ['engine' => $data['engine'], 'collation' => $data['table_collation'], 'charset' => $data['character_set_name'], 'autoincrement' => $data['auto_increment'], 'comment' => $data['table_comment'], 'create_options' => $this->parseCreateOptions($data['create_options'])]; |
| 352 | } |
| 353 | return $tableOptions; |
| 354 | } |
| 355 | private function parseCreateOptions(?string $string) : array |
| 356 | { |
| 357 | $options = []; |
| 358 | if ($string === null || $string === '') { |
| 359 | return $options; |
| 360 | } |
| 361 | foreach (explode(' ', $string) as $pair) { |
| 362 | $parts = explode('=', $pair, 2); |
| 363 | $options[$parts[0]] = $parts[1] ?? \true; |
| 364 | } |
| 365 | return $options; |
| 366 | } |
| 367 | } |
| 368 |