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
|
<?php
/**
* SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2017 ownCloud GmbH
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OC\Core\Command\Db\Migrations;
use OC\DB\Connection;
use OC\DB\MigrationService;
use OC\Migration\ConsoleOutput;
use OCP\App\IAppManager;
use OCP\Util;
use Stecman\Component\Symfony\Console\BashCompletion\Completion\CompletionAwareInterface;
use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Exception\RuntimeException;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;
class GenerateCommand extends Command implements CompletionAwareInterface {
protected static $_templateSimple =
'<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: {{year}} Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace {{namespace}};
use Closure;
use OCP\DB\ISchemaWrapper;
use OCP\Migration\IOutput;
use OCP\Migration\SimpleMigrationStep;
/**
* FIXME Auto-generated migration step: Please modify to your needs!
*/
class {{classname}} extends SimpleMigrationStep {
/**
* @param IOutput $output
* @param Closure(): ISchemaWrapper $schemaClosure
* @param array $options
*/
public function preSchemaChange(IOutput $output, Closure $schemaClosure, array $options): void {
}
/**
* @param IOutput $output
* @param Closure(): ISchemaWrapper $schemaClosure
* @param array $options
* @return null|ISchemaWrapper
*/
public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
{{schemabody}}
}
/**
* @param IOutput $output
* @param Closure(): ISchemaWrapper $schemaClosure
* @param array $options
*/
public function postSchemaChange(IOutput $output, Closure $schemaClosure, array $options): void {
}
}
';
public function __construct(
protected Connection $connection,
protected IAppManager $appManager,
) {
parent::__construct();
}
protected function configure() {
$this
->setName('migrations:generate')
->addArgument('app', InputArgument::REQUIRED, 'Name of the app this migration command shall work on')
->addArgument('version', InputArgument::REQUIRED, 'Major version of this app, to allow versions on parallel development branches')
;
parent::configure();
}
public function execute(InputInterface $input, OutputInterface $output): int {
$appName = $input->getArgument('app');
$version = $input->getArgument('version');
if (!preg_match('/^\d{1,16}$/', $version)) {
$output->writeln('<error>The given version is invalid. Only 0-9 are allowed (max. 16 digits)</error>');
return 1;
}
if ($appName === 'core') {
$fullVersion = implode('.', Util::getVersion());
} else {
try {
$fullVersion = $this->appManager->getAppVersion($appName, false);
} catch (\Throwable $e) {
$fullVersion = '';
}
}
if ($fullVersion) {
[$major, $minor] = explode('.', $fullVersion);
$shouldVersion = (string)((int)$major * 1000 + (int)$minor);
if ($version !== $shouldVersion) {
$output->writeln('<comment>Unexpected migration version for current version: ' . $fullVersion . '</comment>');
$output->writeln('<comment> - Pattern: XYYY </comment>');
$output->writeln('<comment> - Expected: ' . $shouldVersion . '</comment>');
$output->writeln('<comment> - Actual: ' . $version . '</comment>');
if ($input->isInteractive()) {
$helper = $this->getHelper('question');
$question = new ConfirmationQuestion('Continue with your given version? (y/n) [n] ', false);
if (!$helper->ask($input, $output, $question)) {
return 1;
}
}
}
}
$ms = new MigrationService($appName, $this->connection, new ConsoleOutput($output));
$date = date('YmdHis');
$path = $this->generateMigration($ms, 'Version' . $version . 'Date' . $date);
$output->writeln("New migration class has been generated to <info>$path</info>");
return 0;
}
/**
* @param string $optionName
* @param CompletionContext $context
* @return string[]
*/
public function completeOptionValues($optionName, CompletionContext $context) {
return [];
}
/**
* @param string $argumentName
* @param CompletionContext $context
* @return string[]
*/
public function completeArgumentValues($argumentName, CompletionContext $context) {
if ($argumentName === 'app') {
$allApps = $this->appManager->getAllAppsInAppsFolders();
return array_diff($allApps, \OC_App::getEnabledApps(true, true));
}
if ($argumentName === 'version') {
$appName = $context->getWordAtIndex($context->getWordIndex() - 1);
$version = explode('.', $this->appManager->getAppVersion($appName));
return [$version[0] . sprintf('%1$03d', $version[1])];
}
return [];
}
/**
* @param MigrationService $ms
* @param string $className
* @param string $schemaBody
* @return string
*/
protected function generateMigration(MigrationService $ms, $className, $schemaBody = '') {
if ($schemaBody === '') {
$schemaBody = "\t\t" . 'return null;';
}
$placeHolders = [
'{{namespace}}',
'{{classname}}',
'{{schemabody}}',
'{{year}}',
];
$replacements = [
$ms->getMigrationsNamespace(),
$className,
$schemaBody,
date('Y')
];
$code = str_replace($placeHolders, $replacements, self::$_templateSimple);
$dir = $ms->getMigrationsDirectory();
$this->ensureMigrationDirExists($dir);
$path = $dir . '/' . $className . '.php';
if (file_put_contents($path, $code) === false) {
throw new RuntimeException('Failed to generate new migration step. Could not write to ' . $path);
}
return $path;
}
protected function ensureMigrationDirExists($directory) {
if (file_exists($directory) && is_dir($directory)) {
return;
}
if (file_exists($directory)) {
throw new \RuntimeException("Could not create folder \"$directory\"");
}
$this->ensureMigrationDirExists(dirname($directory));
if (!@mkdir($directory) && !is_dir($directory)) {
throw new \RuntimeException("Could not create folder \"$directory\"");
}
}
}
|
