forked from CakeDC/migrations
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMigrationShell.php
1346 lines (1206 loc) · 40.5 KB
/
MigrationShell.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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* Copyright 2009 - 2014, Cake Development Corporation (http://cakedc.com)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright 2009 - 2014, Cake Development Corporation (http://cakedc.com)
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
App::uses('Shell', 'Console');
App::uses('AppShell', 'Console/Command');
App::uses('CakeSchema', 'Model');
App::uses('MigrationVersion', 'Migrations.Lib');
App::uses('CakeText', 'Utility');
App::uses('ClassRegistry', 'Utility');
App::uses('ConnectionManager', 'Model');
App::uses('Folder', 'Utility');
App::uses('File', 'Utility');
App::uses('CakeTime', 'Utility');
/**
* Migration shell.
*/
class MigrationShell extends AppShell {
/**
* Connection used for the migration_schema table of the migration versions
*
* @var null|string
*/
public $connection = null;
/**
* Connection used for the migration
*
* This can be used to override the connection of migration file
*
* @var null|string
*/
public $migrationConnection = null;
/**
* Current path to load and save migrations
*
* @var string
*/
public $path;
/**
* The migration script name
*
* @var string
*/
public $migrationName = '';
/**
* Type of migration, can be 'app' or a plugin name
*
* @var string
*/
public $type = 'app';
/**
* MigrationVersion instance
*
* @var MigrationVersion
*/
public $Version;
/**
* Skip a version or it can skip many version using comma as separate.
*
* @var array
*/
public $skip = array();
/**
* Messages used to display action being performed
*
* @var array
*/
protected $_messages = array();
/**
* Override startup
*
* @return void
*/
public function startup() {
$this->out(__d('migrations', 'Cake Migration Shell'));
$this->hr();
if (!empty($this->params['connection'])) {
$this->connection = $this->params['connection'];
}
$this->migrationConnection = $this->_startMigrationConnection();
if (!empty($this->params['name'])) {
$this->migrationName = $this->params['name'];
}
if (!empty($this->params['plugin'])) {
$this->type = $this->params['plugin'];
}
if (!empty($this->params['skip'])) {
$this->skip = $this->params['skip'];
}
$this->path = $this->_getPath() . 'Config' . DS . 'Migration' . DS;
$options = array(
'precheck' => $this->params['precheck'],
'autoinit' => !$this->params['no-auto-init'],
'dry' => $this->params['dry'],
'skip' => isset($this->params['skip']) ? $this->params['skip'] : null,
'jumpTo' => isset($this->params['jump-to']) ? $this->params['jump-to'] : null);
if (!empty($this->connection)) {
$options['connection'] = $this->connection;
}
if (!empty($this->migrationConnection)) {
$options['migrationConnection'] = $this->migrationConnection;
}
$this->Version = new MigrationVersion($options);
$this->_messages = array(
'create_table' => __d('migrations', 'Creating table ":table".'),
'drop_table' => __d('migrations', 'Dropping table ":table".'),
'rename_table' => __d('migrations', 'Renaming table ":old_name" to ":new_name".'),
'add_field' => __d('migrations', 'Adding field ":field" to table ":table".'),
'drop_field' => __d('migrations', 'Dropping field ":field" from table ":table".'),
'change_field' => __d('migrations', 'Changing field ":field" from table ":table".'),
'rename_field' => __d('migrations', 'Renaming field ":old_name" to ":new_name" on table ":table".'),
'add_index' => __d('migrations', 'Adding index ":index" to table ":table".'),
'drop_index' => __d('migrations', 'Dropping index ":index" from table ":table".'),
);
}
/**
* Get a list of connection names.
*
* @return array The list of connection names
*/
protected function _connectionNamesEnum() {
return array_keys(ConnectionManager::enumConnectionObjects());
}
/**
* Set a migration connection
*
* @return string The name of the migration connection.
*/
protected function _startMigrationConnection() {
if (!empty($this->params['connection']) && empty($this->params['migrationConnection'])) {
return $this->in(
"You did not set a migration connection (-i), which connection do you want to use?",
$this->_connectionNamesEnum(),
$this->params['connection']
);
}
if (!empty($this->params['migrationConnection'])) {
return $this->params['migrationConnection'];
}
}
/**
* Get the option parser.
*
* @return string
*/
public function getOptionParser() {
$parser = parent::getOptionParser();
return $parser->description(
'The Migration shell.' .
'')
->addOption('name', array(
'help' => __d('migrations', 'The migration script name.')))
->addOption('plugin', array(
'short' => 'p',
'help' => __d('migrations', 'Plugin name to be used.')))
->addOption('precheck', array(
'short' => 'm',
'default' => 'Migrations.PrecheckException',
'help' => __d('migrations', 'Precheck migrations')))
->addOption('force', array(
'short' => 'f',
'boolean' => true,
'help' => __d('migrations', 'Force \'generate\' to compare all tables.')))
->addOption('skip', array(
'help' => __d('migrations', 'Skip certain migration.')))
->addOption('jump-to', array(
'short' => 'j',
'help' => __d('migrations', 'Jump to a certain migration and mark the preceding migrations as executed.')))
->addOption('compare', array(
'short' => 'm',
'boolean' => true,
'help' => __d('migrations', 'Force the comparison between schema file and database')))
->addOption('overwrite', array(
'short' => 'o',
'boolean' => true,
'help' => __d('migrations', 'Overwrite the schema.php file after generated a migration.')))
->addOption('connection', array(
'short' => 'c',
'default' => null,
'help' => __d('migrations', 'Overrides the \'default\' connection of the MigrationVersion')))
->addOption('migrationConnection', array(
'short' => 'i',
'default' => null,
'help' => __d('migrations', 'Overrides the \'default\' connection of the CakeMigrations that are applied')))
->addOption('dry', array(
'short' => 'd',
'boolean' => true,
'default' => false,
'help' => __d('migrations', 'Output the raw SQL queries rather than applying them to the database.')))
->addOption('no-auto-init', array(
'short' => 'n',
'boolean' => true,
'default' => false,
'help' => __d('migrations', 'Disables automatic creation of migrations table and running any internal plugin migrations')))
->addOption('schema-class', array(
'short' => 's',
'boolean' => false,
'default' => false,
'help' => __d('migrations', 'CamelCased Classname without the `Schema` suffix to use when reading or generating schema files. See `Console/cake schema generate --help`.')))
->addOption('preview', array(
'boolean' => true,
'help' => __d('migrations', 'Enables the migration file preview.')))
->addOption('no-preview', array(
'boolean' => true,
'help' => __d('migrations', 'Disables the migration file preview.')))
->addSubcommand('status', array(
'help' => __d('migrations', 'Displays a status of all plugin and app migrations.')))
->addSubcommand('run', array(
'help' => __d('migrations', 'Run a migration to given direction or version.')))
->addSubcommand('generate', array(
'help' => __d('migrations', 'Generates a migration file.')));
}
/**
* Override main
*
* @return void
*/
public function main() {
$this->out($this->getOptionParser()->help());
}
/**
* Run the migrations
*
* @return bool True if success
*/
public function run() {
try {
$mapping = $this->Version->getMapping($this->type);
} catch (MigrationVersionException $e) {
$this->err($e->getMessage());
return false;
}
if ($mapping === false) {
$this->out(__d('migrations', 'No migrations available.'));
return $this->_stop();
}
$latestVersion = $this->Version->getVersion($this->type);
if (!isset($this->params['dry'])) {
$this->params['dry'] = false;
}
$options = array(
'precheck' => isset($this->params['precheck']) ? $this->params['precheck'] : null,
'type' => $this->type,
'dry' => $this->params['dry'],
'callback' => &$this,
'skip' => $this->skip);
$once = false; //In case of exception run shell again (all, reset, migration number)
if (isset($this->args[0]) && in_array($this->args[0], array('up', 'down'))) {
$once = true;
$options = $this->_singleStepOptions($mapping, $latestVersion, $options);
} elseif (isset($this->args[0]) && $this->args[0] === 'all') {
end($mapping);
$options['version'] = key($mapping);
$options['direction'] = 'up';
} elseif (isset($this->args[0]) && $this->args[0] === 'reset') {
$options['version'] = 0;
$options['direction'] = 'down';
} else {
$options = $this->_promptVersionOptions($mapping, $latestVersion);
}
$this->out(__d('migrations', 'Running migrations:'));
if ($options === false) {
return false;
}
$options += array(
'type' => $this->type,
'callback' => &$this,
'dry' => $this->params['dry']
);
if ($options['dry']) {
$this->out('');
$this->out(__d('migrations', 'Migration will run dry, no database changes will be made'));
$this->out('');
}
$result = $this->_execute($options, $once);
if ($result !== true) {
$this->out($result);
}
$this->out(__d('migrations', 'All migrations have completed.'));
$this->out('');
Configure::write('Cache.disable', false);
Cache::clear(false, '_cake_model_');
return true;
}
/**
* Execute migration
*
* @param array $options Options for migration
* @param bool $once True to only run once, false to retry
* @return bool True if success
*/
protected function _execute($options, $once) {
$result = true;
try {
$result = $this->Version->run($options);
$this->_outputLog($this->Version->log);
} catch (MigrationException $e) {
$this->out(__d('migrations', 'An error occurred when processing the migration:'));
$this->out(' ' . sprintf(__d('migrations', 'Migration: %s'), $e->Migration->info['name']));
$this->out(' ' . sprintf(__d('migrations', 'Error: %s'), $e->getMessage()));
$this->hr();
$response = $this->in(__d('migrations', 'Do you want to mark the migration as successful?. [y]es or [a]bort.'), array('y', 'a'));
if (strtolower($response) === 'y') {
$this->Version->setVersion($e->Migration->info['version'], $this->type, $options['direction'] === 'up');
if (!$once) {
return $this->run();
}
} elseif (strtolower($response) === 'a') {
return $this->_stop();
}
$this->hr();
}
return $result;
}
/**
* Output the SQL log in dry mode
*
* @param array $log List of queries per migration
* @return void
*/
protected function _outputLog($log) {
foreach ($log as $migrationName => $queries) {
if (empty($queries)) {
continue;
}
$this->hr();
$this->out(sprintf('SQL for migration %s:', $migrationName));
$this->hr();
foreach ($queries as $query) {
$this->out(str_replace(array("\n", "\t"), '', $query));
}
}
$this->hr();
}
/**
* Single step options for up/down migrations
*
* @param array $mapping Migration version mappings
* @param string $latestVersion Latest migration version
* @param array $default Default options for migration
* @return array Modified options for migration
*/
protected function _singleStepOptions($mapping, $latestVersion, $default = array()) {
$options = $default;
$versions = array_keys($mapping);
$flipped = array_flip($versions);
$versionNumber = isset($flipped[$latestVersion]) ? $flipped[$latestVersion] : -1;
$options['direction'] = $this->args[0];
if ($options['direction'] === 'up') {
$latestVersion = isset($versions[$versionNumber + 1]) ? $versions[$versionNumber + 1] : -1;
}
if (!isset($mapping[$latestVersion])) {
$this->out(__d('migrations', 'Not a valid migration version.'));
return $this->_stop(2);
}
$options['version'] = $mapping[$latestVersion]['version'];
return $options;
}
/**
* Output prompt with different migration versions to choose from
*
* @param array $mapping Migration version mappings
* @param string $latestVersion Latest migration version
* @return array User-chosen options for migration
*/
protected function _promptVersionOptions($mapping, $latestVersion) {
if (isset($this->args[0]) && is_numeric($this->args[0])) {
$options['version'] = (int)$this->args[0];
$valid = isset($mapping[$options['version']]) || ($options['version'] === 0 && $latestVersion > 0);
if (!$valid) {
$this->out(__d('migrations', 'Not a valid migration version.'));
return $this->_stop();
}
} else {
$this->_showInfo($mapping, $this->type);
$this->hr();
while (true) {
$response = $this->in(__d('migrations', 'Please choose which version you want to migrate to. [q]uit or [c]lean.'));
if (strtolower($response) === 'q') {
return $this->_stop();
} elseif (strtolower($response) === 'c') {
$this->clear();
continue;
}
$valid = is_numeric($response) && isset($mapping[(int)$response]);
if ($valid) {
$options['version'] = (int)$response;
$direction = 'up';
if (empty($mapping[(int)$response]['migrated'])) {
$direction = 'up';
} elseif ((int)$response <= $latestVersion) {
$direction = 'down';
}
break;
} else {
$this->out(__d('migrations', 'Not a valid migration version.'));
}
}
$this->hr();
}
return compact('direction') + $options;
}
/**
* Generate a new migration file
*
* @return void
*/
public function generate() {
Configure::write('Cache.disable', true);
$fromSchema = false;
$this->Schema = $this->_getSchema();
$migration = array('up' => array(), 'down' => array());
$migrationName = $this->migrationName;
$comparison = array();
if (!empty($this->args)) {
// If args are passed in from the command line, we just want to
// generate a migration based on them - don't offer to compare to database
$this->_generateFromCliArgs($migration, $migrationName, $comparison);
} else {
$oldSchema = $this->_getSchema($this->type);
if ($oldSchema !== false) {
$response = isset($this->params['compare']) && $this->params['compare'] === true ? 'y' : false;
if ($response === false) {
$response = $this->in(__d('migrations', 'Do you want to compare the schema.php file to the database?'), array('y', 'n'), 'y');
}
if (strtolower($response) === 'y') {
$this->_generateFromComparison($migration, $oldSchema, $comparison);
$this->_migrationChanges($migration);
$fromSchema = true;
} else {
$response = $this->in(__d('migrations', 'Do you want to compare the database to the schema.php file?'), array('y', 'n'), 'y');
if (strtolower($response) === 'y') {
$this->_generateFromInverseComparison($migration, $oldSchema, $comparison);
$this->_migrationChanges($migration);
$fromSchema = false;
}
}
} else {
$response = $this->in(__d('migrations', 'Do you want to generate a dump from the current database?'), array('y', 'n'), 'y');
if (strtolower($response) === 'y') {
$this->_generateDump($migration);
$fromSchema = true;
}
}
}
$this->_finalizeGeneratedMigration($migration, $migrationName, $fromSchema);
if ($this->params['overwrite'] === true) {
$this->_overwriteSchema();
}
if ($fromSchema && isset($comparison)) {
$response = $this->in(__d('migrations', 'Do you want to update the schema.php file?'), array('y', 'n'), 'y');
if (strtolower($response) === 'y') {
$this->_updateSchema();
}
}
}
/**
* _migrationsChanges method
*
* @param array $migration list of migrations
* @return bool
*/
protected function _migrationChanges($migration) {
if (empty($migration)) {
$this->hr();
$this->out(__d('migrations', 'No database changes detected.'));
return $this->_stop();
}
}
/**
* Generate a migration by comparing schema.php with the database.
*
* @param array &$migration Reference to variable of the same name in generate() method
* @param array &$oldSchema Reference to variable of the same name in generate() method
* @param array &$comparison Reference to variable of the same name in generate() method
* @return void (The variables passed by reference are changed; nothing is returned)
*/
protected function _generateFromComparison(&$migration, &$oldSchema, &$comparison) {
$this->hr();
$this->out(__d('migrations', 'Comparing schema.php to the database...'));
if ($this->type !== 'migrations') {
unset($oldSchema->tables['schema_migrations']);
}
$newSchema = $this->_readSchema();
$comparison = $this->Schema->compare($oldSchema, $newSchema);
$migration = $this->_fromComparison($migration, $comparison, $oldSchema->tables, $newSchema['tables']);
}
/**
* Generate a migration by comparing the database with schema.php.
*
* @param array &$migration Reference to variable of the same name in generate() method
* @param array &$oldSchema Reference to variable of the same name in generate() method
* @param array &$comparison Reference to variable of the same name in generate() method
* @return void (The variables passed by reference are changed; nothing is returned)
*/
protected function _generateFromInverseComparison(&$migration, &$oldSchema, &$comparison) {
$this->hr();
$this->out(__d('migrations', 'Comparing database to the schema.php...'));
if ($this->type !== 'migrations') {
unset($oldSchema->tables['schema_migrations']);
}
$database = $this->_readSchema();
$comparison = $this->Schema->compare($database, $oldSchema);
$migration = $this->_fromComparison($migration, $comparison, $oldSchema->tables, $database['tables']);
}
/**
* Generate a migration from arguments passed in at the command line
*
* @param array &$migration Reference to variable of the same name in generate() method
* @param array &$migrationName Reference to variable of the same name in generate() method
* @param array &$comparison Reference to variable of the same name in generate() method
* @return void (The variables passed by reference are changed; nothing is returned)
*/
protected function _generateFromCliArgs(&$migration, &$migrationName, &$comparison) {
$this->hr();
$this->out(__d('migrations', 'Generating migration from commandline arguments...'));
$migrationName = array_shift($this->args);
if (empty($migrationName)) {
$this->error('Missing argument', "Missing required argument 'name' for migration");
}
$cli = $this->_parseCommandLineFields($migrationName);
$action = $cli['action'];
$table = $cli['table'];
$tables = $cli['tables'];
$fields = $cli['fields'];
if ($action == 'create_table') {
$migration['up']['create_table'][$table] = $fields;
$migration['down']['drop_table'] = array($table);
} elseif ($action == 'drop_table') {
$migration['up']['drop_table'] = array($table);
// We don't have a down case as the migration is irreversible
} elseif ($action == 'create_field') {
$migration['up']['create_field'][$table] = $fields;
$migration['down']['drop_field'][$table] = $this->_fieldNamesArray($fields);
} elseif ($action == 'drop_field') {
$fieldsToDrop = array();
$migration['up']['drop_field'][$table] = $this->_fieldNamesArray($fields);
// We don't have a down case as the migration is irreversible
} else {
$this->error(__d('migrations', 'Invalid argument'), __d('migrations', "Migration name (%s) is invalid. It cannot be used to generate a migration from the CLI."));
}
}
/**
* Return list of field names from array of field/index definitions
*
* @param array $fields Field/index definitions
* @return array List of field names
*/
protected function _fieldNamesArray($fields) {
$fieldNames = array();
foreach ($fields as $name => $value) {
if ($name !== 'indexes') {
$fieldNames[] = $name;
}
}
return $fieldNames;
}
/**
* Generate a dump of the current database.
*
* @param array &$migration Reference to variable of the same name in generate() method
* @return void (The variables passed by reference are changed; nothing is returned)
*/
protected function _generateDump(&$migration) {
$this->hr();
$this->out(__d('migrations', 'Generating dump from the current database...'));
$dump = $this->_readSchema();
$dump = $dump['tables'];
unset($dump['missing']);
if (!empty($dump)) {
$migration['up']['create_table'] = $dump;
$migration['down']['drop_table'] = array_keys($dump);
}
}
/**
* Finalizes the generated migration - offers to preview it,
* prompts for a name, writes the file, and updates db version if needed.
*
* @param array &$migration Reference to variable of the same name in generate() method
* @param array &$migrationName Reference to variable of the same name in generate() method
* @param bool &$fromSchema Reference to variable of the same name in generate() method
* @return void
*/
protected function _finalizeGeneratedMigration(&$migration, &$migrationName, &$fromSchema) {
if (!empty($this->params['preview'])) {
$preview = 'y';
} elseif (!empty($this->params['no-preview'])) {
$preview = 'n';
} else {
$preview = $this->in(__d('migrations', 'Do you want to preview the file before generation?'), array('y', 'n'), 'y');
}
if (strtolower($preview) === 'y') {
$this->out($this->_generateMigration('Preview of migration', 'PreviewMigration', $migration));
}
$name = $migrationName;
if (empty($name)) {
$name = $this->_promptForMigrationName();
} else {
$validMigrationName = $this->_validateMigrationName($name);
if ($validMigrationName === true) {
$name = $this->_buildMigrationName($name);
}
}
$this->out(__d('migrations', 'Generating Migration...'));
$time = gmdate('U');
$this->_writeMigration($name, $time, $migration);
if ($fromSchema) {
$this->Version->setVersion($time, $this->type);
}
$this->out('');
$this->out(__d('migrations', 'Done.'));
}
/**
* Prompt the user for a name for their new migration.
*
* @return string
*/
protected function _promptForMigrationName() {
while (true) {
$name = $this->in(__d('migrations', 'Please enter the descriptive name of the migration to generate:'));
$validMigrationName = $this->_validateMigrationName($name);
if ($validMigrationName === true) {
$name = $this->_buildMigrationName($name);
break;
}
}
return $name;
}
/**
* Validates the presented migration name.
*
* @param string $name
* @return bool
*/
protected function _validateMigrationName($name) {
if (!preg_match('/^([A-Za-z0-9_]+|\s)+$/', $name) || is_numeric($name[0])) {
$this->out('');
$this->err(__d('migrations', 'Migration name (%s) is invalid. It must only contain alphanumeric characters and start with a letter.', $name));
return false;
} elseif (strlen($name) > 255) {
$this->out('');
$this->err(__d('migrations', 'Migration name (%s) is invalid. It cannot be longer than 255 characters.', $name));
return false;
}
return true;
}
/**
* Build the migration name.
*
* @param string $name
* @return mixed
*/
protected function _buildMigrationName($name) {
return str_replace(' ', '_', trim($name));
}
/**
* Displays a status of all plugin and app migrations
*
* @return void
*/
public function status() {
$types = CakePlugin::loaded();
ksort($types);
array_unshift($types, 'App');
$outdated = (isset($this->args[0]) && $this->args[0] === 'outdated');
foreach ($types as $name) {
try {
$type = Inflector::underscore($name);
$mapping = $this->Version->getMapping($type);
if ($mapping === false) {
continue;
}
$version = $this->Version->getVersion($type);
$latest = end($mapping);
if ($outdated && $latest['version'] == $version) {
continue;
}
$this->out(($type === 'app') ? 'Application' : $name . ' Plugin');
$this->out('');
$this->out(__d('migrations', 'Current version:'));
if ($version != 0) {
$info = $mapping[$version];
$this->out(' #' . sprintf("%'.03d", $info['version']) . ' ' . $info['name']);
} else {
$this->out(' ' . __d('migrations', 'None applied.'));
}
$this->out(__d('migrations', 'Latest version:'));
$this->out(' #' . sprintf("%'.03d", $latest['version']) . ' ' . $latest['name']);
$this->hr();
} catch (MigrationVersionException $e) {
continue;
}
}
}
/**
* Shows a list of available migrations
*
* @param array $mapping Migration mapping
* @param string $type Can be 'app' or a plugin name
* @return void
*/
protected function _showInfo($mapping, $type = null) {
if ($type === null) {
$type = $this->type;
}
$version = $this->Version->getVersion($type);
if ($version != 0) {
$info = $mapping[$version];
$this->out(__d('migrations', 'Current migration version:'));
$this->out(' #' . sprintf("%'.03d", $version) . ' ' . $info['name']);
$this->hr();
}
$this->out(__d('migrations', 'Available migrations:'));
foreach ($mapping as $version => $info) {
$this->out(' [' . sprintf("%'.03d", $version) . '] ' . $info['name']);
$this->out(' ', false);
if ($info['migrated'] !== null) {
$this->out(__d('migrations', 'applied') . ' ' . CakeTime::nice(strtotime($info['migrated'])));
} else {
$this->out(__d('migrations', 'not applied'));
}
}
}
/**
* Generate a migration string using comparison
*
* @param array $migration Migration instructions array
* @param array $comparison Result from CakeSchema::compare()
* @param array $oldTables List of tables on schema.php file
* @param array $currentTables List of current tables on database
* @return array
*/
protected function _fromComparison($migration, $comparison, $oldTables, $currentTables) {
foreach ($comparison as $table => $actions) {
if (!isset($oldTables[$table])) {
if (isset($actions['add'])) {
$migration['up']['create_table'][$table] = $actions['add'];
} elseif (isset($actions['create'])) {
$migration['up']['create_table'][$table] = $actions['create'];
}
$migration['down']['drop_table'][] = $table;
continue;
}
foreach ($actions as $type => $fields) {
$indexes = array();
if (!empty($fields['indexes'])) {
$indexes = array('indexes' => $fields['indexes']);
unset($fields['indexes']);
}
if ($type === 'add') {
$migration['up']['create_field'][$table] = array_merge($fields, $indexes);
$migration['down']['drop_field'][$table] = array_keys($fields);
if (!empty($indexes['indexes'])) {
$migration['down']['drop_field'][$table]['indexes'] = array_keys($indexes['indexes']);
}
} elseif ($type === 'change') {
foreach ($fields as $name => $col) {
if (!empty($oldTables[$table][$name]['length']) && substr($col['type'], 0, 4) === 'date') {
$fields[$name]['length'] = null;
}
}
$migration['up']['alter_field'][$table] = $fields;
$migration['down']['alter_field'][$table] = array_intersect_key($oldTables[$table], $fields);
} else {
$migration['up']['drop_field'][$table] = array_keys($fields);
if (!empty($indexes['indexes'])) {
$migration['up']['drop_field'][$table]['indexes'] = array_keys($indexes['indexes']);
}
$migration['down']['create_field'][$table] = array_merge($fields, $indexes);
}
}
}
foreach ($oldTables as $table => $fields) {
if (!isset($currentTables[$table])) {
$migration['up']['drop_table'][] = $table;
$migration['down']['create_table'][$table] = $fields;
}
}
return $migration;
}
/**
* Gets the schema class name
*
* @param string $name Can be 'app' or a plugin name
* @param bool $suffix Return the class name with or without the "Schema" suffix, default is true
* @return string Returns the schema class name
*/
protected function _getSchemaClassName($name = null, $suffix = true) {
if (empty($name)) {
$name = $this->type;
}
if (!empty($this->params['schema-class'])) {
$name = $this->params['schema-class'];
}
$name = preg_replace('/[^a-zA-Z0-9]/', '', $name);
$name = Inflector::camelize($name);
if ($suffix === true && (substr($name, -6) !== 'Schema')) {
$name .= 'Schema';
} elseif ($suffix === false && (substr($name, -6) === 'Schema')) {
$name = substr($name, 0, -6);
}
return $name;
}
/**
* Load and construct the schema class if exists
*
* @param string $type Can be 'app' or a plugin name
* @return mixed False in case of no file found, schema object
*/
protected function _getSchema($type = null) {
if ($type === null) {
$plugin = ($this->type === 'app') ? null : $this->type;
return new CakeSchema(array('connection' => $this->connection, 'plugin' => $plugin));
}
$folder = new Folder($this->_getPath($type) . 'Config' . DS . 'Schema');
$schemaFiles = $folder->find('.*schema.*.php');
if (count($schemaFiles) === 0) {
return false;
}
$name = $this->_getSchemaClassName($type);
$file = $this->_findSchemaFile($folder, $schemaFiles, $name);
if ($type === 'app' && empty($file)) {
$appDir = preg_replace('/[^a-zA-Z0-9]/', '', APP_DIR);
$name = Inflector::camelize($appDir) . 'Schema';
$file = $this->_getPath($type) . 'Config' . DS . 'Schema' . DS . 'schema.php';
}
require_once $file;
$plugin = ($type === 'app') ? null : $type;
$schema = new $name(array('connection' => $this->connection, 'plugin' => $plugin));
return $schema;
}
/**
* Finds schema file
*
* @param Folder $folder Folder object with schema folder path.
* @param array $schemaFiles Schema files inside schema folder.
* @param string $name Schema-class name.
* @return mixed null in case of no file found, schema file.
*/
protected function _findSchemaFile($folder, $schemaFiles, $name) {
foreach ($schemaFiles as $schemaFile) {
$file = new File($folder->pwd() . DS . $schemaFile);
$content = $file->read();
if (strpos($content, $name) !== false) {
return $file->path;
}
}
return null;
}
/**
* Reads the schema data
*
* @return array
*/
protected function _readSchema() {
$read = $this->Schema->read(array('models' => !$this->params['force']));
if ($this->type !== 'migrations') {
unset($read['tables']['schema_migrations']);
}
return $read;
}
/**
* Update the schema, making a call to schema shell
*
* @return void
*/
protected function _updateSchema() {
$command = 'schema generate --connection ' . $this->connection;
if (!empty($this->params['plugin'])) {
$command .= ' --plugin ' . $this->params['plugin'];
}
if ($this->params['force']) {
$command .= ' --force';
}
$command .= ' --file schema.php --name ' . $this->_getSchemaClassName($this->type, false);
$this->dispatchShell($command);
}
/**
* Overwrite the schema.php file
*
* @return void
*/
protected function _overwriteSchema() {
$options = array();
if ($this->params['force']) {
$options['models'] = false;
} elseif (!empty($this->params['models'])) {