-
Notifications
You must be signed in to change notification settings - Fork 68
/
Column.php
422 lines (358 loc) · 18.3 KB
/
Column.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
<?php
/* ==========================================================================================
* Class for managing table columns in the data warehouse. This is meant to be used as a
* component of Table.
*
* @author Steve Gallo <smgallo@buffalo.edu>
* @date 2017-04-28
*
* @see Table
* @see iEntity
* ==========================================================================================
*/
namespace ETL\DbModel;
use Psr\Log\LoggerInterface;
class Column extends NamedEntity implements iEntity
{
// Properties required by this class. These will be merged with other required
// properties up the call chain. See @Entity::$requiredProperties
private $localRequiredProperties = array(
'type'
);
// Properties provided by this class. These will be merged with other properties up
// the call chain. See @Entity::$properties
private $localProperties = array(
// Column type (free-form string)
'type' => null,
// The column character set
'charset' => null,
// The column collation
'collation' => null,
// TRUE if the column is nullable
'nullable' => null,
// Column default
'default' => null,
// Column extra (see http://dev.mysql.com/doc/refman/5.7/en/create-table.html)
'extra' => null,
// The column comment
'comment' => null,
// Column hints object used to control behavior such as renaming columns
'hints' => null
);
/* ------------------------------------------------------------------------------------------
* @see iEntity::__construct()
* ------------------------------------------------------------------------------------------
*/
public function __construct($config, $systemQuoteChar = null, LoggerInterface $logger = null)
{
// Property merging is performed first so the values can be used in the constructor
parent::mergeProperties($this->localRequiredProperties, $this->localProperties);
parent::__construct($config, $systemQuoteChar, $logger);
} // __construct()
/* ------------------------------------------------------------------------------------------
* @see Entity::filterAndVerifyValue()
* ------------------------------------------------------------------------------------------
*/
protected function filterAndVerifyValue($property, $value)
{
$value = parent::filterAndVerifyValue($property, $value);
if ( null === $value ) {
return $value;
}
switch ( $property ) {
case 'name':
// Normalize property values to lowercase to match MySQL behavior
$value = strtolower($value);
break;
case 'nullable':
$origValue = $value;
$value = \xd_utilities\filter_var($value, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
if ( null === $value ) {
$this->logAndThrowException(
sprintf("%s must be a boolean, '%s' given", $property, gettype($origValue))
);
}
break;
case 'extra':
case 'comment':
if ( ! is_string($value) ) {
$this->logAndThrowException(
sprintf("%s name must be a string, '%s' given", $property, gettype($value))
);
}
// Normalize property values to lowercase to match MySQL behavior
if ( 'extra' == $property ) {
$value = strtolower($value);
}
break;
case 'type':
case 'charset':
case 'collation':
if ( ! is_string($value) ) {
$this->logAndThrowException(
sprintf("%s name must be a string, '%s' given", $property, gettype($value))
);
}
// Normalize property values to lowercase to match MySQL behavior but handle enum
// properly by only lowercasing the "enum" itself and not the possible values.
if ( 0 === stripos($value, 'enum') ) {
$value = strtolower(substr($value, 0, 4)) . substr($value, 4);
} else {
$value = strtolower($value);
}
break;
default:
break;
} // switch ( $property )
return $value;
} // filterAndVerifyValue()
/* ------------------------------------------------------------------------------------------
* @see iEntity::compare()
* ------------------------------------------------------------------------------------------
*/
public function compare(iEntity $cmp)
{
if ( ! $cmp instanceof Column ) {
return 1;
}
if ( ($retval = parent::compare($cmp)) != 0 ) {
return $retval;
}
// Columns are considered equal if all non-null properties in both Columns are the same. The
// name and type are required but if other properties are set use those in the comparison as
// well.
//
// Note that the "enum" type will be handled in a special case below so only match types here
// that are different and are not both enumerated.
if ( $this->type != $cmp->type && ! (0 === strpos($this->type, 'enum') && 0 === strpos($cmp->type, 'enum')) ) {
$this->logCompareFailure('type', $this->type, $cmp->type, $this->name);
return -1;
}
// Timestamp fields have special handling for default and extra fields.
// See https://dev.mysql.com/doc/refman/5.5/en/timestamp-initialization.html
if ( "timestamp" == $this->type ) {
// In the mode where a config file is compared to an existing database, the source is
// considered the configuration while the destination is the database.
$srcDefault = $this->default;
$destDefault = $cmp->default;
$srcExtra = $this->extra;
$destExtra = $cmp->extra;
// MySQL considers the following equivalent to CURRENT_TIMESTAMP and will convert them
// automatically. Map them now so we don't get into an endless ALTER TABLE loop.
if ( null !== $srcExtra) {
$search = array(
"CURRENT_TIMESTAMP()",
"NOW()",
"LOCALTIME",
"LOCALTIME()"
);
$srcExtra = str_ireplace($search, "CURRENT_TIMESTAMP", $srcExtra);
} // if ( null !== $srcExtra)
// If no DEFAULT and no EXTRA is provided MySQL will use:
// DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
//
// If no DEFAULT is provided but an EXTRA is provided the default will be 0 unless
// the collumn is nullable, then it will be NULL.
//
// **WARNING**
//
// Having multiple TIMESTAMP columns in the same table may result in unexpected behavior
// for the 2nd or following columns.
//
// See:
// https://dev.mysql.com/doc/refman/5.5/en/timestamp-initialization.html
// http://jasonbos.co/two-timestamp-columns-in-mysql
//
// One TIMESTAMP column in a table can have the current timestamp as the default value
// for initializing the column, as the auto-update value, or both. It is not possible to
// have the current timestamp be the default value for one column and the auto-update
// value for another column. To specify automatic initialization or updating for a
// different TIMESTAMP column, you must suppress the automatic properties for the first
// one.
if (
(
(null === $srcDefault && null === $srcExtra)
|| ('current_timestamp' === strtolower($srcDefault) && 'on update current_timestamp' === strtolower($srcExtra))
)
&& ('current_timestamp' != strtolower($destDefault) || null === $destExtra)
) {
$this->logCompareFailure('timestamp', "$srcDefault $srcExtra", "$destDefault $destExtra", $this->name);
return -1;
}
// With a DEFAULT clause but no ON UPDATE CURRENT_TIMESTAMP clause, the column has the
// given default value and is not automatically updated to the current timestamp.
// Note that valid defaults are 0 or a datetime format and MySQL will translate 0 to
// '0000-00-00 00:00:00' and will add '00:00:00' to date strings.
if ( (null !== $srcDefault && null === $srcExtra) ) {
if ( null !== $destExtra ) {
// Extra has changed (destination has a value)
$this->logCompareFailure('timestamp extra', $srcExtra, $destExtra, $this->name);
return -1;
} elseif ( null === $destDefault ) {
// Default has changed from NULL to something
$this->logCompareFailure('timestamp default', $srcDefault, $destDefault, $this->name);
return -1;
} elseif ( strtolower($srcDefault) != strtolower($destDefault)
&& ( ("0" == "$srcDefault" && '0000-00-00 00:00:00' != $destDefault)
|| ("0" != "$srcDefault" && $srcDefault . ' 00:00:00' != $destDefault) ) )
{
// Note the casting of 0 to "0" above is necessary because php considers 0 == "0000-01-01" to be true.
// Default has changed
$this->logCompareFailure('timestamp default', $srcDefault, $destDefault, $this->name);
return -1;
}
}
// With an ON UPDATE CURRENT_TIMESTAMP clause and a constant DEFAULT clause, the column
// is automatically updated to the current timestamp and has the given constant default
// value.
if ( null !== $srcDefault && null !== $srcExtra ) {
if ( $srcExtra != $destExtra ) {
$this->logCompareFailure('timestamp extra', $srcExtra, $destExtra, $this->name);
return -1;
} elseif ( strtolower($srcDefault) != strtolower($destDefault)
&& ( ("0" == "$srcDefault" && '0000-00-00 00:00:00' != $destDefault)
|| ("0" != "$srcDefault" && $srcDefault . ' 00:00:00' != $destDefault)) )
{
// Note the casting of 0 to "0" above is necessary because php considers 0 == "0000-01-01" to be true.
$this->logCompareFailure('timestamp default', $srcDefault, $destDefault, $this->name);
return -1;
}
}
// With an ON UPDATE CURRENT_TIMESTAMP clause but no DEFAULT clause, the column is
// automatically updated to the current timestamp. The default is 0 unless the column is
// defined with the NULL attribute, in which case the default is NULL.
if ( null === $srcDefault && null !== $srcExtra ) {
if ( null === $destExtra
|| $srcExtra != $destExtra
|| (null !== $destDefault && '0000-00-00 00:00:00' != $destDefault) )
{
$this->logCompareFailure('timestamp', "$srcDefault $srcExtra", "$destDefault $destExtra", $this->name);
return -1;
}
}
} else {
// The following properties do not have defaults set by the database and should be considered if
// one of them is set.
if ( ( null !== $this->default || null !== $cmp->default ) && $this->default != $cmp->default ) {
$this->logCompareFailure('default', $this->default, $cmp->default, $this->name);
return -1;
}
if ( ( null !== $this->extra || null !== $cmp->extra ) && $this->extra != $cmp->extra ) {
$this->logCompareFailure('extra', $this->extra, $cmp->extra, $this->name);
return -1;
}
} // else ( "timestamp" == $this->type )
// The enum type may be formatted by the database to add/remove spaces between parameter
// values. Normalize the values before comparing.
if ( 0 === ($myStartPos = strpos($this->type, 'enum'))
&& 0 === ($cmpStartPos = strpos($cmp->type, 'enum')) ) {
// Extract the enum value list and normalize it to include no spaces between values
$myType = substr($this->type, 4);
$myType = implode(',', preg_split('/\s*,\s*/', trim($myType, "() \t\n\r\0\x0B")));
$cmpType = substr($cmp->type, 4);
$cmpType = implode(',', preg_split('/\s*,\s*/', trim($cmpType, "() \t\n\r\0\x0B")));
if ( $myType != $cmpType ) {
$this->logCompareFailure('type enum', $myType, $cmpType, $this->name);
return -1;
}
}
// The following properties have a default set by the database. If the property is not specified
// a value will be provided when the database information schema is queried.
if ( ( null !== $this->nullable && null !== $cmp->nullable ) && $this->nullable != $cmp->nullable ) {
$this->logCompareFailure(
'nullable',
($this->nullable ? 'true' : 'false'),
($cmp->nullable ? 'true' : 'false'),
$this->name
);
return -1;
}
// The following properties do not have defaults set by the database and should be considered if
// one of them is set.
if ( ( null !== $this->comment || null !== $cmp->comment ) && $this->comment != $cmp->comment ) {
$this->logCompareFailure('comment', $this->comment, $cmp->comment, $this->name);
return -1;
}
// Character set and collation have defaults that are set by the table, database or server.
// See https://dev.mysql.com/doc/refman/5.5/en/charset-syntax.html
if ( ( null !== $this->charset && null !== $cmp->charset ) && $this->charset != $cmp->charset ) {
$this->logCompareFailure('charset', $this->charset, $cmp->charset, $this->name);
return -1;
}
if ( ( null !== $this->collation && null !== $cmp->collation ) && $this->collation != $cmp->collation ) {
$this->logCompareFailure('collation', $this->collation, $cmp->collation, $this->name);
return -1;
}
return 0;
} // compare()
/* ------------------------------------------------------------------------------------------
* @see iEntity::getSql()
* ------------------------------------------------------------------------------------------
*/
public function getSql($includeSchema = false)
{
// Name and type are required. null values are treated as not provided/specified.
// Columns may be created or altered in different ways (CREATE TABLE vs. ALTER TABLE) so we only
// return the essentials of the definition and let the Table class figure out the appropriate
// way to put them together.
$parts = array();
$parts[] = $this->getName(true);
$parts[] = $this->type;
if ( null !== $this->charset ) {
$parts[] = 'CHARSET ' . $this->charset;
}
if ( null !== $this->collation ) {
$parts[] = 'COLLATE ' . $this->collation;
}
if ( null !== $this->nullable ) {
$parts[] = ( false === $this->nullable ? "NOT NULL" : "NULL" );
}
// Specifying defaults can get tricky. If the default is non-null:
// - If the field is nullable and default is the string "NULL" leave it as is ( "NULL" -> DEFAULT NULL)
// - If the field is a timestamp do not quote CURRENT_TIMESTAMP or 0
// - If a numeric value leave as is (5 -> DEFAULT 5)
// - If a boolean value use boolean constant (false -> DEFAULT FALSE)
// - If it is a mysql bit or hex literal leave it as is(b'1' -> DEFAULT b'1')
// - If a string value ensure it is quoted ("Bob", "'Bob'" -> DEFAULT 'Bob')
//
// - Note that in MySQL a nullable column with no default is considered a default of NULL.
// - Note that MySQL assigns TIMESTAMP columns a default of CURRENT_TIMESTAMP with an extra field of "on update CURRENT_TIMESTAMP"
$currentTimestampAliases = array(
'current_timestamp',
'current_timestamp()',
'now()',
'localtime',
'localtime()',
'localtimestamp',
'localtimestamp()'
);
if ( null !== $this->default ) {
if (
( $this->nullable && "NULL" == $this->default ) ||
( "timestamp" == $this->type && is_numeric($this->default) ) ||
( "timestamp" == $this->type && in_array(strtolower($this->default), $currentTimestampAliases) ) ||
is_numeric($this->default) ||
"b'" == substr($this->default, 0, 2) ||
"x'" == substr(strtolower($this->default), 0, 2)
) {
$parts[] = "DEFAULT " . $this->default;
} elseif ( ($this->nullable && null === $this->default) ) {
$parts[] = "DEFAULT NULL";
} elseif (is_bool($this->default)) {
$parts[] = "DEFAULT " . ($this->default ? "TRUE" : "FALSE");
} elseif ( "'" == substr($this->default, 0, 1) && "'" == substr($this->default, -1) ) {
$parts[] = "DEFAULT " . addslashes($this->default);
}
else {
$parts[] = "DEFAULT '" . addslashes($this->default) . "'";
}
} // if ( null !== $this->default )
if ( null !== $this->extra ) {
$parts[] = $this->extra;
}
if ( null !== $this->comment ) {
$parts[] = "COMMENT '" . addslashes($this->comment) . "'";
}
return implode(" ", $parts);
} // getSql()
} // class Column