Repository navigation
Expand file tree
/
Copy pathDatabaseTableModel.php
More file actions
415 lines (342 loc) · 13.3 KB
/
Copy pathDatabaseTableModel.php
File metadata and controls
415 lines (342 loc) · 13.3 KB
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
<?php namespace RainLab\Builder\Classes;
use Doctrine\DBAL\Types\Type;
use ApplicationException;
use ValidationException;
use SystemException;
use Exception;
use Validator;
use Lang;
use Schema;
use Str;
use Db;
/**
* Manages plugin database tables.
*
* @package rainlab\builder
* @author Alexey Bobkov, Samuel Georges
*/
class DatabaseTableModel extends BaseModel
{
public $columns = [];
/**
* @var string Specifies the database table model
*/
public $name;
protected static $fillable = [
'name',
'columns'
];
protected $validationRules = [
'name' => ['required', 'regex:/^[a-z]+[a-z0-9_]+$/', 'tablePrefix', 'uniqueTableName', 'max:64']
];
/**
* @var \Doctrine\DBAL\Schema\Table Table details loaded from the database.
*/
protected $tableInfo;
/**
* @var \Doctrine\DBAL\Schema\AbstractSchemaManager Contains the database schema
*/
protected static $schemaManager = null;
/**
* @var \Doctrine\DBAL\Schema\Schema Contains the database schema
*/
protected static $schema = null;
public static function listPluginTables($pluginCode)
{
$pluginCodeObj = new PluginCode($pluginCode);
$prefix = $pluginCodeObj->toDatabasePrefix();
$tables = self::getSchemaManager()->listTableNames();
return array_filter($tables, function ($item) use ($prefix) {
return Str::startsWith($item, $prefix);
});
}
public static function tableExists($name)
{
return self::getSchema()->hasTable($name);
}
/**
* Loads the table from the database.
* @param string $name Specifies the table name.
*/
public function load($name)
{
if (!self::tableExists($name)) {
throw new SystemException(sprintf('The table with name %s doesn\'t exist', $name));
}
$schema = self::getSchemaManager()->createSchema();
$this->name = $name;
$this->tableInfo = $schema->getTable($this->name);
$this->loadColumnsFromTableInfo();
$this->exists = true;
}
public function validate()
{
$pluginDbPrefix = $this->getPluginCodeObj()->toDatabasePrefix();
if (!strlen($pluginDbPrefix)) {
throw new SystemException('Error saving the table model - the plugin database prefix is not set for the object.');
}
$prefix = $pluginDbPrefix.'_';
$this->validationMessages = [
'name.table_prefix' => Lang::get('rainlab.builder::lang.database.error_table_name_invalid_prefix', [
'prefix' => $prefix
]),
'name.regex' => Lang::get('rainlab.builder::lang.database.error_table_name_invalid_characters'),
'name.unique_table_name' => Lang::get('rainlab.builder::lang.database.error_table_already_exists', ['name'=>$this->name]),
'name.max' => Lang::get('rainlab.builder::lang.database.error_table_name_too_long')
];
Validator::extend('tablePrefix', function ($attribute, $value, $parameters) use ($prefix) {
$value = trim($value);
if (!Str::startsWith($value, $prefix)) {
return false;
}
return true;
});
Validator::extend('uniqueTableName', function ($attribute, $value, $parameters) {
$value = trim($value);
$schema = $this->getSchema();
if ($this->isNewModel()) {
return !$schema->hasTable($value);
}
if ($value != $this->tableInfo->getName()) {
return !$schema->hasTable($value);
}
return true;
});
$this->validateColumns();
return parent::validate();
}
public function generateCreateOrUpdateMigration()
{
$schemaCreator = new DatabaseTableSchemaCreator();
$existingSchema = $this->tableInfo;
$newTableName = $this->name;
$tableName = $existingSchema ? $existingSchema->getName() : $this->name;
$newSchema = $schemaCreator->createTableSchema($tableName, $this->columns);
$codeGenerator = new TableMigrationCodeGenerator();
$migrationCode = $codeGenerator->createOrUpdateTable($newSchema, $existingSchema, $newTableName);
if ($migrationCode === false) {
return $migrationCode;
}
$description = $existingSchema ? 'Updated table %s' : 'Created table %s';
return $this->createMigrationObject($migrationCode, sprintf($description, $tableName));
}
public function generateDropMigration()
{
$existingSchema = $this->tableInfo;
$codeGenerator = new TableMigrationCodeGenerator();
$migrationCode = $codeGenerator->dropTable($existingSchema);
return $this->createMigrationObject($migrationCode, sprintf('Drop table %s', $this->name));
}
public static function getSchema()
{
if (!self::$schema) {
self::$schema = self::getSchemaManager()->createSchema();
}
return self::$schema;
}
protected function validateColumns()
{
$this->validateColumnNameLengths();
$this->validateDuplicateColumns();
$this->validateDuplicatePrimaryKeys();
$this->validateAutoIncrementColumns();
$this->validateColumnsLengthParameter();
$this->validateUnsignedColumns();
$this->validateDefaultValues();
}
protected function validateColumnNameLengths()
{
foreach ($this->columns as $column) {
$name = trim($column['name']);
if (Str::length($name) > 64) {
throw new ValidationException([
'columns' => Lang::get(
'rainlab.builder::lang.database.error_column_name_too_long',
['column' => $name]
)
]);
}
}
}
protected function validateDuplicateColumns()
{
foreach ($this->columns as $outerIndex => $outerColumn) {
foreach ($this->columns as $innerIndex => $innerColumn) {
if ($innerIndex != $outerIndex && $innerColumn['name'] == $outerColumn['name']) {
throw new ValidationException([
'columns' => Lang::get(
'rainlab.builder::lang.database.error_table_duplicate_column',
['column' => $outerColumn['name']]
)
]);
}
}
}
}
protected function validateDuplicatePrimaryKeys()
{
$keysFound = 0;
$autoIncrementsFound = 0;
foreach ($this->columns as $column) {
if ($column['primary_key']) {
$keysFound++;
}
if ($column['auto_increment']) {
$autoIncrementsFound++;
}
}
if ($keysFound > 1 && $autoIncrementsFound) {
throw new ValidationException([
'columns' => Lang::get('rainlab.builder::lang.database.error_table_auto_increment_in_compound_pk')
]);
}
}
protected function validateAutoIncrementColumns()
{
$autoIncrement = null;
foreach ($this->columns as $column) {
if (!$column['auto_increment']) {
continue;
}
if ($autoIncrement) {
throw new ValidationException([
'columns' => Lang::get('rainlab.builder::lang.database.error_table_mutliple_auto_increment')
]);
}
$autoIncrement = $column;
}
if (!$autoIncrement) {
return;
}
if (!in_array($autoIncrement['type'], MigrationColumnType::getIntegerTypes())) {
throw new ValidationException([
'columns' => Lang::get('rainlab.builder::lang.database.error_table_auto_increment_non_integer')
]);
}
}
protected function validateUnsignedColumns()
{
foreach ($this->columns as $column) {
if (!$column['unsigned']) {
continue;
}
if (!in_array($column['type'], MigrationColumnType::getIntegerTypes())) {
throw new ValidationException([
'columns' => Lang::get('rainlab.builder::lang.database.error_unsigned_type_not_int', ['column'=>$column['name']])
]);
}
}
}
protected function validateColumnsLengthParameter()
{
foreach ($this->columns as $column) {
try {
MigrationColumnType::validateLength($column['type'], $column['length']);
} catch (Exception $ex) {
throw new ValidationException([
'columns' => $ex->getMessage()
]);
}
}
}
protected function validateDefaultValues()
{
foreach ($this->columns as $column) {
if (!strlen($column['default'])) {
continue;
}
// Allow null value for all nullable columns
if (strtolower($column['default']) === 'null' && (bool) $column['allow_null'] === true) {
continue;
}
$default = trim($column['default']);
if (in_array($column['type'], MigrationColumnType::getIntegerTypes())) {
if (!preg_match('/^\-?[0-9]+$/', $default)) {
throw new ValidationException([
'columns' => Lang::get('rainlab.builder::lang.database.error_integer_default_value', ['column'=>$column['name']])
]);
}
if ($column['unsigned'] && $default < 0) {
throw new ValidationException([
'columns' => Lang::get('rainlab.builder::lang.database.error_unsigned_negative_value', ['column'=>$column['name']])
]);
}
continue;
}
if (in_array($column['type'], MigrationColumnType::getDecimalTypes())) {
if (!preg_match('/^\-?([0-9]+\.[0-9]+|[0-9]+)$/', $default)) {
throw new ValidationException([
'columns' => Lang::get('rainlab.builder::lang.database.error_decimal_default_value', ['column'=>$column['name']])
]);
}
continue;
}
if ($column['type'] == MigrationColumnType::TYPE_BOOLEAN) {
if (!preg_match('/^0|1|true|false$/i', $default)) {
throw new ValidationException([
'columns' => Lang::get('rainlab.builder::lang.database.error_boolean_default_value', ['column'=>$column['name']])
]);
}
}
}
}
protected static function getSchemaManager()
{
if (!self::$schemaManager) {
self::$schemaManager = Schema::getConnection()->getDoctrineSchemaManager();
Type::addType('enumdbtype', 'RainLab\Builder\Classes\EnumDbType');
// Fixes the problem with enum column type not supported
// by Doctrine (https://github.com/laravel/framework/issues/1346)
$platform = self::$schemaManager->getDatabasePlatform();
$platform->registerDoctrineTypeMapping('enum', 'enumdbtype');
$platform->registerDoctrineTypeMapping('json', 'text');
}
return self::$schemaManager;
}
protected function loadColumnsFromTableInfo()
{
$this->columns = [];
$columns = $this->tableInfo->getColumns();
$primaryKey = $this->tableInfo->getPrimaryKey();
$primaryKeyColumns =[];
if ($primaryKey) {
$primaryKeyColumns = $primaryKey->getColumns();
}
foreach ($columns as $column) {
$columnName = $column->getName();
$typeName = $column->getType()->getName();
if ($typeName == EnumDbType::TYPENAME) {
throw new ApplicationException(Lang::get('rainlab.builder::lang.database.error_enum_not_supported'));
}
$item = [
'name' => $columnName,
'type' => MigrationColumnType::toMigrationMethodName($typeName, $columnName),
'length' => MigrationColumnType::doctrineLengthToMigrationLength($column),
'unsigned' => $column->getUnsigned(),
'allow_null' => !$column->getNotnull(),
'auto_increment' => $column->getAutoincrement(),
'primary_key' => in_array($columnName, $primaryKeyColumns),
'default' => $column->getDefault(),
'id' => $columnName,
];
// Format quoted "null" values with quotes
if ($column->getNotnull() === false) {
if ($item['default'] === null) {
$item['default'] = 'null';
} elseif (strtolower($item['default']) === 'null') {
$item['default'] = "'null'";
}
}
$this->columns[] = $item;
}
}
protected function createMigrationObject($code, $description)
{
$migration = new MigrationModel();
$migration->setPluginCodeObj($this->getPluginCodeObj());
$migration->code = $code;
$migration->version = $migration->getNextVersion();
$migration->description = $description;
return $migration;
}
}