/
Migrator.php
334 lines (282 loc) · 9.22 KB
/
Migrator.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
<?php
/*
* This file is part of Flarum.
*
* For detailed copyright and license information, please view the
* LICENSE file that was distributed with this source code.
*/
namespace Flarum\Database;
use Flarum\Database\Exception\MigrationKeyMissing;
use Flarum\Extension\Extension;
use Illuminate\Database\ConnectionInterface;
use Illuminate\Database\MySqlConnection;
use Illuminate\Filesystem\Filesystem;
use InvalidArgumentException;
use Symfony\Component\Console\Output\OutputInterface;
/**
* @internal
*/
class Migrator
{
/**
* The migration repository implementation.
*
* @var \Flarum\Database\MigrationRepositoryInterface
*/
protected $repository;
/**
* The filesystem instance.
*
* @var \Illuminate\Filesystem\Filesystem
*/
protected $files;
/**
* The output interface implementation.
*
* @var OutputInterface|null
*/
protected $output;
/**
* @var ConnectionInterface
*/
protected $connection;
/**
* Create a new migrator instance.
*/
public function __construct(
MigrationRepositoryInterface $repository,
ConnectionInterface $connection,
Filesystem $files
) {
$this->files = $files;
$this->repository = $repository;
if (! ($connection instanceof MySqlConnection)) {
throw new InvalidArgumentException('Only MySQL connections are supported');
}
$this->connection = $connection;
// Workaround for https://github.com/laravel/framework/issues/1186
$connection->getDoctrineSchemaManager()->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
}
/**
* Run the outstanding migrations at a given path.
*
* @param string $path
* @param Extension|null $extension
* @return void
*/
public function run($path, Extension $extension = null)
{
$files = $this->getMigrationFiles($path);
$ran = $this->repository->getRan($extension ? $extension->getId() : null);
$migrations = array_diff($files, $ran);
$this->runMigrationList($path, $migrations, $extension);
}
/**
* Run an array of migrations.
*
* @param string $path
* @param array $migrations
* @param Extension|null $extension
* @return void
*/
public function runMigrationList($path, $migrations, Extension $extension = null)
{
// First we will just make sure that there are any migrations to run. If there
// aren't, we will just make a note of it to the developer so they're aware
// that all of the migrations have been run against this database system.
if (count($migrations) == 0) {
$this->note('<info>Nothing to migrate.</info>');
return;
}
// Once we have the array of migrations, we will spin through them and run the
// migrations "up" so the changes are made to the databases. We'll then log
// that the migration was run so we don't repeat it next time we execute.
foreach ($migrations as $file) {
$this->runUp($path, $file, $extension);
}
}
/**
* Run "up" a migration instance.
*
* @param string $path
* @param string $file
* @param Extension|null $extension
* @return void
*/
protected function runUp($path, $file, Extension $extension = null)
{
$this->resolveAndRunClosureMigration($path, $file);
// Once we have run a migrations class, we will log that it was run in this
// repository so that we don't try to run it next time we do a migration
// in the application. A migration repository keeps the migrate order.
$this->repository->log($file, $extension ? $extension->getId() : null);
$this->note("<info>Migrated:</info> $file");
}
/**
* Rolls all of the currently applied migrations back.
*
* @param string $path
* @param Extension|null $extension
* @return int
*/
public function reset($path, Extension $extension = null)
{
$migrations = array_reverse($this->repository->getRan(
$extension ? $extension->getId() : null
));
$count = count($migrations);
if ($count === 0) {
$this->note('<info>Nothing to rollback.</info>');
} else {
foreach ($migrations as $migration) {
$this->runDown($path, $migration, $extension);
}
}
return $count;
}
/**
* Run "down" a migration instance.
*
* @param string $path
* @param string $file
* @param string $path
* @param Extension $extension
* @return void
*/
protected function runDown($path, $file, Extension $extension = null)
{
$this->resolveAndRunClosureMigration($path, $file, 'down');
// Once we have successfully run the migration "down" we will remove it from
// the migration repository so it will be considered to have not been run
// by the application then will be able to fire by any later operation.
$this->repository->delete($file, $extension ? $extension->getId() : null);
$this->note("<info>Rolled back:</info> $file");
}
/**
* Runs a closure migration based on the migrate direction.
*
* @param $migration
* @param string $direction
* @throws MigrationKeyMissing
*/
protected function runClosureMigration($migration, $direction = 'up')
{
if (is_array($migration) && array_key_exists($direction, $migration)) {
call_user_func($migration[$direction], $this->connection->getSchemaBuilder());
} else {
throw new MigrationKeyMissing($direction);
}
}
/**
* Resolves and run a migration and assign the filename to the exception if needed.
*
* @param string $path
* @param string $file
* @param string $direction
* @throws MigrationKeyMissing
*/
protected function resolveAndRunClosureMigration(string $path, string $file, string $direction = 'up')
{
$migration = $this->resolve($path, $file);
try {
$this->runClosureMigration($migration, $direction);
} catch (MigrationKeyMissing $exception) {
throw $exception->withFile("$path/$file.php");
}
}
/**
* Get all of the migration files in a given path.
*
* @param string $path
* @return array
*/
public function getMigrationFiles($path)
{
$files = $this->files->glob($path.'/*_*.php');
if ($files === false) {
return [];
}
$files = array_map(function ($file) {
return str_replace('.php', '', basename($file));
}, $files);
// Once we have all of the formatted file names we will sort them and since
// they all start with a timestamp this should give us the migrations in
// the order they were actually created by the application developers.
sort($files);
return $files;
}
/**
* Resolve a migration instance from a file.
*
* @param string $path
* @param string $file
* @return array
*/
public function resolve($path, $file)
{
$migration = "$path/$file.php";
if ($this->files->exists($migration)) {
return $this->files->getRequire($migration);
}
return [];
}
/**
* Initialize the Flarum database from a schema dump.
*
* @param string $path to the directory containing the dump.
*/
public function installFromSchema(string $path)
{
$schemaPath = "$path/install.dump";
$startTime = microtime(true);
$dump = file_get_contents($schemaPath);
$this->connection->getSchemaBuilder()->disableForeignKeyConstraints();
foreach (explode(';', $dump) as $statement) {
$statement = trim($statement);
if (empty($statement) || substr($statement, 0, 2) === '/*') {
continue;
}
$statement = str_replace(
'db_prefix_',
$this->connection->getTablePrefix(),
$statement
);
$this->connection->statement($statement);
}
$this->connection->getSchemaBuilder()->enableForeignKeyConstraints();
$runTime = number_format((microtime(true) - $startTime) * 1000, 2);
$this->note('<info>Loaded stored database schema.</info> ('.$runTime.'ms)');
}
/**
* Set the output implementation that should be used by the console.
*
* @param OutputInterface $output
* @return $this
*/
public function setOutput(OutputInterface $output)
{
$this->output = $output;
return $this;
}
/**
* Write a note to the conosle's output.
*
* @param string $message
* @return void
*/
protected function note($message)
{
if ($this->output) {
$this->output->writeln($message);
}
}
/**
* Determine if the migration repository exists.
*
* @return bool
*/
public function repositoryExists()
{
return $this->repository->repositoryExists();
}
}