1
|
|
|
<?php |
2
|
|
|
/* |
3
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
4
|
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
5
|
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
6
|
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
7
|
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
8
|
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
9
|
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
10
|
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
11
|
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
12
|
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
13
|
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
14
|
|
|
* |
15
|
|
|
* This software consists of voluntary contributions made by many individuals |
16
|
|
|
* and is licensed under the MIT license. For more information, see |
17
|
|
|
* <http://www.doctrine-project.org>. |
18
|
|
|
*/ |
19
|
|
|
|
20
|
|
|
namespace Doctrine\DBAL\Schema; |
21
|
|
|
|
22
|
|
|
use Doctrine\DBAL\Platforms\MariaDb1027Platform; |
23
|
|
|
use Doctrine\DBAL\Platforms\MySqlPlatform; |
24
|
|
|
use Doctrine\DBAL\Types\Type; |
25
|
|
|
|
26
|
|
|
/** |
27
|
|
|
* Schema manager for the MySql RDBMS. |
28
|
|
|
* |
29
|
|
|
* @author Konsta Vesterinen <[email protected]> |
30
|
|
|
* @author Lukas Smith <[email protected]> (PEAR MDB2 library) |
31
|
|
|
* @author Roman Borschel <[email protected]> |
32
|
|
|
* @author Benjamin Eberlei <[email protected]> |
33
|
|
|
* @since 2.0 |
34
|
|
|
*/ |
35
|
|
|
class MySqlSchemaManager extends AbstractSchemaManager |
36
|
|
|
{ |
37
|
|
|
/** |
38
|
|
|
* {@inheritdoc} |
39
|
|
|
*/ |
40
|
|
|
protected function _getPortableViewDefinition($view) |
41
|
|
|
{ |
42
|
|
|
return new View($view['TABLE_NAME'], $view['VIEW_DEFINITION']); |
43
|
|
|
} |
44
|
|
|
|
45
|
|
|
/** |
46
|
|
|
* {@inheritdoc} |
47
|
|
|
*/ |
48
|
|
|
protected function _getPortableTableDefinition($table) |
49
|
|
|
{ |
50
|
|
|
return array_shift($table); |
51
|
|
|
} |
52
|
|
|
|
53
|
|
|
/** |
54
|
|
|
* {@inheritdoc} |
55
|
|
|
*/ |
56
|
|
|
protected function _getPortableUserDefinition($user) |
57
|
|
|
{ |
58
|
|
|
return [ |
59
|
|
|
'user' => $user['User'], |
60
|
|
|
'password' => $user['Password'], |
61
|
|
|
]; |
62
|
|
|
} |
63
|
|
|
|
64
|
|
|
/** |
65
|
|
|
* {@inheritdoc} |
66
|
|
|
*/ |
67
|
|
|
protected function _getPortableTableIndexesList($tableIndexes, $tableName = null) |
68
|
|
|
{ |
69
|
|
|
foreach ($tableIndexes as $k => $v) { |
70
|
|
|
$v = array_change_key_case($v, CASE_LOWER); |
71
|
|
|
if ($v['key_name'] === 'PRIMARY') { |
72
|
|
|
$v['primary'] = true; |
73
|
|
|
} else { |
74
|
|
|
$v['primary'] = false; |
75
|
|
|
} |
76
|
|
|
if (strpos($v['index_type'], 'FULLTEXT') !== false) { |
77
|
|
|
$v['flags'] = ['FULLTEXT']; |
78
|
|
|
} elseif (strpos($v['index_type'], 'SPATIAL') !== false) { |
79
|
|
|
$v['flags'] = ['SPATIAL']; |
80
|
|
|
} |
81
|
|
|
$tableIndexes[$k] = $v; |
82
|
|
|
} |
83
|
|
|
|
84
|
|
|
return parent::_getPortableTableIndexesList($tableIndexes, $tableName); |
85
|
|
|
} |
86
|
|
|
|
87
|
|
|
/** |
88
|
|
|
* {@inheritdoc} |
89
|
|
|
*/ |
90
|
|
|
protected function _getPortableSequenceDefinition($sequence) |
91
|
|
|
{ |
92
|
|
|
return end($sequence); |
93
|
|
|
} |
94
|
|
|
|
95
|
|
|
/** |
96
|
|
|
* {@inheritdoc} |
97
|
|
|
*/ |
98
|
|
|
protected function _getPortableDatabaseDefinition($database) |
99
|
|
|
{ |
100
|
|
|
return $database['Database']; |
101
|
|
|
} |
102
|
|
|
|
103
|
|
|
/** |
104
|
|
|
* {@inheritdoc} |
105
|
|
|
*/ |
106
|
|
|
protected function _getPortableTableColumnDefinition($tableColumn) |
107
|
|
|
{ |
108
|
|
|
$tableColumn = array_change_key_case($tableColumn, CASE_LOWER); |
109
|
|
|
|
110
|
|
|
$dbType = strtolower($tableColumn['type']); |
111
|
|
|
$dbType = strtok($dbType, '(), '); |
112
|
|
|
if (isset($tableColumn['length'])) { |
113
|
|
|
$length = $tableColumn['length']; |
114
|
|
|
} else { |
115
|
|
|
$length = strtok('(), '); |
|
|
|
|
116
|
|
|
} |
117
|
|
|
|
118
|
|
|
$fixed = null; |
119
|
|
|
|
120
|
|
|
if ( ! isset($tableColumn['name'])) { |
121
|
|
|
$tableColumn['name'] = ''; |
122
|
|
|
} |
123
|
|
|
|
124
|
|
|
$scale = null; |
125
|
|
|
$precision = null; |
126
|
|
|
|
127
|
|
|
$type = $this->_platform->getDoctrineTypeMapping($dbType); |
128
|
|
|
|
129
|
|
|
// In cases where not connected to a database DESCRIBE $table does not return 'Comment' |
130
|
|
|
if (isset($tableColumn['comment'])) { |
131
|
|
|
$type = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type); |
132
|
|
|
$tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $type); |
133
|
|
|
} |
134
|
|
|
|
135
|
|
|
switch ($dbType) { |
136
|
|
|
case 'char': |
137
|
|
|
case 'binary': |
138
|
|
|
$fixed = true; |
139
|
|
|
break; |
140
|
|
|
case 'float': |
141
|
|
|
case 'double': |
142
|
|
|
case 'real': |
143
|
|
|
case 'numeric': |
144
|
|
|
case 'decimal': |
145
|
|
|
if (preg_match('([A-Za-z]+\(([0-9]+)\,([0-9]+)\))', $tableColumn['type'], $match)) { |
146
|
|
|
$precision = $match[1]; |
147
|
|
|
$scale = $match[2]; |
148
|
|
|
$length = null; |
149
|
|
|
} |
150
|
|
|
break; |
151
|
|
|
case 'tinytext': |
152
|
|
|
$length = MySqlPlatform::LENGTH_LIMIT_TINYTEXT; |
153
|
|
|
break; |
154
|
|
|
case 'text': |
155
|
|
|
$length = MySqlPlatform::LENGTH_LIMIT_TEXT; |
156
|
|
|
break; |
157
|
|
|
case 'mediumtext': |
158
|
|
|
$length = MySqlPlatform::LENGTH_LIMIT_MEDIUMTEXT; |
159
|
|
|
break; |
160
|
|
|
case 'tinyblob': |
161
|
|
|
$length = MySqlPlatform::LENGTH_LIMIT_TINYBLOB; |
162
|
|
|
break; |
163
|
|
|
case 'blob': |
164
|
|
|
$length = MySqlPlatform::LENGTH_LIMIT_BLOB; |
165
|
|
|
break; |
166
|
|
|
case 'mediumblob': |
167
|
|
|
$length = MySqlPlatform::LENGTH_LIMIT_MEDIUMBLOB; |
168
|
|
|
break; |
169
|
|
|
case 'tinyint': |
170
|
|
|
case 'smallint': |
171
|
|
|
case 'mediumint': |
172
|
|
|
case 'int': |
173
|
|
|
case 'integer': |
174
|
|
|
case 'bigint': |
175
|
|
|
case 'year': |
176
|
|
|
$length = null; |
177
|
|
|
break; |
178
|
|
|
} |
179
|
|
|
|
180
|
|
|
if ($this->_platform instanceof MariaDb1027Platform) { |
181
|
|
|
$columnDefault = $this->getMariaDb1027ColumnDefault($this->_platform, $tableColumn['default']); |
182
|
|
|
} else { |
183
|
|
|
$columnDefault = $tableColumn['default']; |
184
|
|
|
} |
185
|
|
|
|
186
|
|
|
$options = [ |
187
|
|
|
'length' => $length !== null ? (int) $length : null, |
188
|
|
|
'unsigned' => strpos($tableColumn['type'], 'unsigned') !== false, |
189
|
|
|
'fixed' => (bool) $fixed, |
190
|
|
|
'default' => $columnDefault, |
191
|
|
|
'notnull' => $tableColumn['null'] !== 'YES', |
192
|
|
|
'scale' => null, |
193
|
|
|
'precision' => null, |
194
|
|
|
'autoincrement' => strpos($tableColumn['extra'], 'auto_increment') !== false, |
195
|
|
|
'comment' => isset($tableColumn['comment']) && $tableColumn['comment'] !== '' |
196
|
|
|
? $tableColumn['comment'] |
197
|
|
|
: null, |
198
|
|
|
]; |
199
|
|
|
|
200
|
|
|
if ($scale !== null && $precision !== null) { |
201
|
|
|
$options['scale'] = (int) $scale; |
202
|
|
|
$options['precision'] = (int) $precision; |
203
|
|
|
} |
204
|
|
|
|
205
|
|
|
$column = new Column($tableColumn['field'], Type::getType($type), $options); |
206
|
|
|
|
207
|
|
|
if (isset($tableColumn['collation'])) { |
208
|
|
|
$column->setPlatformOption('collation', $tableColumn['collation']); |
209
|
|
|
} |
210
|
|
|
|
211
|
|
|
return $column; |
212
|
|
|
} |
213
|
|
|
|
214
|
|
|
/** |
215
|
|
|
* Return Doctrine/Mysql-compatible column default values for MariaDB 10.2.7+ servers. |
216
|
|
|
* |
217
|
|
|
* - Since MariaDb 10.2.7 column defaults stored in information_schema are now quoted |
218
|
|
|
* to distinguish them from expressions (see MDEV-10134). |
219
|
|
|
* - CURRENT_TIMESTAMP, CURRENT_TIME, CURRENT_DATE are stored in information_schema |
220
|
|
|
* as current_timestamp(), currdate(), currtime() |
221
|
|
|
* - Quoted 'NULL' is not enforced by Maria, it is technically possible to have |
222
|
|
|
* null in some circumstances (see https://jira.mariadb.org/browse/MDEV-14053) |
223
|
|
|
* - \' is always stored as '' in information_schema (normalized) |
224
|
|
|
* |
225
|
|
|
* @link https://mariadb.com/kb/en/library/information-schema-columns-table/ |
226
|
|
|
* @link https://jira.mariadb.org/browse/MDEV-13132 |
227
|
|
|
* |
228
|
|
|
* @param null|string $columnDefault default value as stored in information_schema for MariaDB >= 10.2.7 |
229
|
|
|
*/ |
230
|
|
|
private function getMariaDb1027ColumnDefault(MariaDb1027Platform $platform, ?string $columnDefault) : ?string |
231
|
|
|
{ |
232
|
|
|
if ($columnDefault === 'NULL' || $columnDefault === null) { |
233
|
|
|
return null; |
234
|
|
|
} |
235
|
|
|
if ($columnDefault[0] === "'") { |
236
|
|
|
return stripslashes( |
237
|
|
|
str_replace("''", "'", |
238
|
|
|
preg_replace('/^\'(.*)\'$/', '$1', $columnDefault) |
239
|
|
|
) |
240
|
|
|
); |
241
|
|
|
} |
242
|
|
|
switch ($columnDefault) { |
243
|
|
|
case 'current_timestamp()': |
|
|
|
|
244
|
|
|
return $platform->getCurrentTimestampSQL(); |
245
|
|
|
case 'curdate()': |
246
|
|
|
return $platform->getCurrentDateSQL(); |
247
|
|
|
case 'curtime()': |
248
|
|
|
return $platform->getCurrentTimeSQL(); |
249
|
|
|
} |
250
|
|
|
return $columnDefault; |
251
|
|
|
} |
252
|
|
|
|
253
|
|
|
/** |
254
|
|
|
* {@inheritdoc} |
255
|
|
|
*/ |
256
|
1 |
|
protected function _getPortableTableForeignKeysList($tableForeignKeys) |
257
|
|
|
{ |
258
|
1 |
|
$list = []; |
259
|
1 |
|
foreach ($tableForeignKeys as $value) { |
260
|
1 |
|
$value = array_change_key_case($value, CASE_LOWER); |
261
|
1 |
|
if ( ! isset($list[$value['constraint_name']])) { |
262
|
1 |
|
if ( ! isset($value['delete_rule']) || $value['delete_rule'] === "RESTRICT") { |
263
|
1 |
|
$value['delete_rule'] = null; |
264
|
|
|
} |
265
|
1 |
|
if ( ! isset($value['update_rule']) || $value['update_rule'] === "RESTRICT") { |
266
|
1 |
|
$value['update_rule'] = null; |
267
|
|
|
} |
268
|
|
|
|
269
|
1 |
|
$list[$value['constraint_name']] = [ |
270
|
1 |
|
'name' => $value['constraint_name'], |
271
|
|
|
'local' => [], |
272
|
|
|
'foreign' => [], |
273
|
1 |
|
'foreignTable' => $value['referenced_table_name'], |
274
|
1 |
|
'onDelete' => $value['delete_rule'], |
275
|
1 |
|
'onUpdate' => $value['update_rule'], |
276
|
|
|
]; |
277
|
|
|
} |
278
|
1 |
|
$list[$value['constraint_name']]['local'][] = $value['column_name']; |
279
|
1 |
|
$list[$value['constraint_name']]['foreign'][] = $value['referenced_column_name']; |
280
|
|
|
} |
281
|
|
|
|
282
|
1 |
|
$result = []; |
283
|
1 |
|
foreach ($list as $constraint) { |
284
|
1 |
|
$result[] = new ForeignKeyConstraint( |
285
|
1 |
|
array_values($constraint['local']), |
286
|
1 |
|
$constraint['foreignTable'], |
287
|
1 |
|
array_values($constraint['foreign']), |
288
|
1 |
|
$constraint['name'], |
289
|
|
|
[ |
290
|
1 |
|
'onDelete' => $constraint['onDelete'], |
291
|
1 |
|
'onUpdate' => $constraint['onUpdate'], |
292
|
|
|
] |
293
|
|
|
); |
294
|
|
|
} |
295
|
|
|
|
296
|
1 |
|
return $result; |
297
|
|
|
} |
298
|
|
|
} |
299
|
|
|
|
This check compares calls to functions or methods with their respective definitions. If the call has less arguments than are defined, it raises an issue.
If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. Please note the @ignore annotation hint above.