-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
ConfigImportCommands.php
351 lines (305 loc) · 12.1 KB
/
ConfigImportCommands.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
<?php
namespace Drush\Drupal\Commands\config;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Drupal\Core\Config\ImportStorageTransformer;
use Drupal\Core\Config\StorageTransformerException;
use Consolidation\AnnotatedCommand\CommandData;
use Consolidation\AnnotatedCommand\CommandError;
use Drupal\config\StorageReplaceDataWrapper;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Config\ConfigException;
use Drupal\Core\Config\ConfigImporter;
use Drupal\Core\Config\ConfigManagerInterface;
use Drupal\Core\Config\FileStorage;
use Drupal\Core\Config\StorageComparer;
use Drupal\Core\Config\StorageInterface;
use Drupal\Core\Config\TypedConfigManagerInterface;
use Drupal\Core\Extension\ModuleExtensionList;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Extension\ModuleInstallerInterface;
use Drupal\Core\Extension\ThemeHandlerInterface;
use Drupal\Core\Lock\LockBackendInterface;
use Drupal\Core\Site\Settings;
use Drupal\Core\StringTranslation\TranslationInterface;
use Drush\Commands\DrushCommands;
use Drush\Exceptions\UserAbortException;
use Webmozart\PathUtil\Path;
class ConfigImportCommands extends DrushCommands
{
/**
* @var ConfigManagerInterface
*/
protected $configManager;
protected $configStorage;
protected $configStorageSync;
protected $configCache;
protected $eventDispatcher;
protected $lock;
protected $configTyped;
protected $moduleInstaller;
protected $themeHandler;
protected $stringTranslation;
protected $importStorageTransformer;
/**
* @var ModuleHandlerInterface
*/
protected $moduleHandler;
/**
* The module extension list.
*
* @var ModuleExtensionList
*/
protected $moduleExtensionList;
public function getConfigManager(): ConfigManagerInterface
{
return $this->configManager;
}
public function getConfigStorage(): StorageInterface
{
return $this->configStorage;
}
public function getConfigStorageSync(): StorageInterface
{
return $this->configStorageSync;
}
public function setConfigStorageSync(StorageInterface|null $syncStorage): void
{
$this->configStorageSync = $syncStorage;
}
public function getConfigCache(): CacheBackendInterface
{
return $this->configCache;
}
public function getModuleHandler(): ModuleHandlerInterface
{
return $this->moduleHandler;
}
/**
* Note that type hint is changing https://www.drupal.org/project/drupal/issues/3161983
*/
public function getEventDispatcher(): EventDispatcherInterface
{
return $this->eventDispatcher;
}
public function getLock(): LockBackendInterface
{
return $this->lock;
}
public function getConfigTyped(): TypedConfigManagerInterface
{
return $this->configTyped;
}
public function getModuleInstaller(): ModuleInstallerInterface
{
return $this->moduleInstaller;
}
public function getThemeHandler(): ThemeHandlerInterface
{
return $this->themeHandler;
}
public function getStringTranslation(): TranslationInterface
{
return $this->stringTranslation;
}
public function setImportTransformer(ImportStorageTransformer $importStorageTransformer): void
{
$this->importStorageTransformer = $importStorageTransformer;
}
public function hasImportTransformer(): bool
{
return isset($this->importStorageTransformer);
}
public function getImportTransformer(): ?ImportStorageTransformer
{
return $this->importStorageTransformer;
}
/**
* @return ModuleExtensionList
*/
public function getModuleExtensionList(): ModuleExtensionList
{
return $this->moduleExtensionList;
}
/**
* @param ConfigManagerInterface $configManager
* @param StorageInterface $configStorage
* @param StorageInterface $configStorageSync
* @param CacheBackendInterface $configCache
* @param ModuleHandlerInterface $moduleHandler
* @param $eventDispatcher
* @param LockBackendInterface $lock
* @param TypedConfigManagerInterface $configTyped
* @param ModuleInstallerInterface $moduleInstaller
* @param ThemeHandlerInterface $themeHandler
* @param TranslationInterface $stringTranslation
* @param ModuleExtensionList $moduleExtensionList
*/
public function __construct(
ConfigManagerInterface $configManager,
StorageInterface $configStorage,
CacheBackendInterface $configCache,
ModuleHandlerInterface $moduleHandler,
// Omit type hint as it changed in https://www.drupal.org/project/drupal/issues/3161983
$eventDispatcher,
LockBackendInterface $lock,
TypedConfigManagerInterface $configTyped,
ModuleInstallerInterface $moduleInstaller,
ThemeHandlerInterface $themeHandler,
TranslationInterface $stringTranslation,
ModuleExtensionList $moduleExtensionList
) {
parent::__construct();
$this->configManager = $configManager;
$this->configStorage = $configStorage;
$this->configCache = $configCache;
$this->moduleHandler = $moduleHandler;
$this->eventDispatcher = $eventDispatcher;
$this->lock = $lock;
$this->configTyped = $configTyped;
$this->moduleInstaller = $moduleInstaller;
$this->themeHandler = $themeHandler;
$this->stringTranslation = $stringTranslation;
$this->moduleExtensionList = $moduleExtensionList;
}
/**
* Import config from a config directory.
*
* @command config:import
*
*
* @return bool|void
* @option diff Show preview as a diff.
* @option source An arbitrary directory that holds the configuration files.
* @option partial Allows for partial config imports from the source directory. Only updates and new configs will be processed with this flag (missing configs will not be deleted). No config transformation happens.
* @aliases cim,config-import
* @topics docs:deploy
* @bootstrap full
*
* @throws StorageTransformerException
* @throws UserAbortException
*/
public function import(array $options = ['source' => self::REQ, 'partial' => false, 'diff' => false])
{
// Determine source directory.
$source_storage_dir = ConfigCommands::getDirectory($options['source']);
// Prepare the configuration storage for the import.
if ($source_storage_dir == Path::canonicalize(Settings::get('config_sync_directory'))) {
$source_storage = $this->getConfigStorageSync();
} else {
$source_storage = new FileStorage($source_storage_dir);
}
// Determine $source_storage in partial case.
$active_storage = $this->getConfigStorage();
if ($options['partial']) {
$replacement_storage = new StorageReplaceDataWrapper($active_storage);
foreach ($source_storage->listAll() as $name) {
$data = $source_storage->read($name);
$replacement_storage->replaceData($name, $data);
}
$source_storage = $replacement_storage;
} elseif ($this->hasImportTransformer()) {
// Use the import transformer if it is available. (Drupal ^8.8)
// Drupal core does not apply transformations for single imports.
// And in addition the StorageReplaceDataWrapper is not compatible
// with StorageCopyTrait::replaceStorageContents.
$source_storage = $this->getImportTransformer()->transform($source_storage);
}
$config_manager = $this->getConfigManager();
$storage_comparer = new StorageComparer($source_storage, $active_storage, $config_manager);
if (!$storage_comparer->createChangelist()->hasChanges()) {
$this->logger()->notice(('There are no changes to import.'));
return;
}
if (!$options['diff']) {
$change_list = [];
foreach ($storage_comparer->getAllCollectionNames() as $collection) {
$change_list[$collection] = $storage_comparer->getChangelist(null, $collection);
}
$table = ConfigCommands::configChangesTable($change_list, $this->output());
$table->render();
} else {
$output = ConfigCommands::getDiff($active_storage, $source_storage, $this->output());
$this->output()->writeln($output);
}
if (!$this->io()->confirm(dt('Import the listed configuration changes?'))) {
throw new UserAbortException();
}
return drush_op([$this, 'doImport'], $storage_comparer);
}
// Copied from submitForm() at /core/modules/config/src/Form/ConfigSync.php
public function doImport($storage_comparer): void
{
$config_importer = new ConfigImporter(
$storage_comparer,
$this->getEventDispatcher(),
$this->getConfigManager(),
$this->getLock(),
$this->getConfigTyped(),
$this->getModuleHandler(),
$this->getModuleInstaller(),
$this->getThemeHandler(),
$this->getStringTranslation(),
$this->getModuleExtensionList()
);
if ($config_importer->alreadyImporting()) {
$this->logger()->warning('Another request may be synchronizing configuration already.');
} else {
try {
// This is the contents of \Drupal\Core\Config\ConfigImporter::import.
// Copied here so we can log progress.
if ($config_importer->hasUnprocessedConfigurationChanges()) {
$sync_steps = $config_importer->initialize();
foreach ($sync_steps as $step) {
$context = [];
do {
$config_importer->doSyncStep($step, $context);
if (isset($context['message'])) {
$this->logger()->notice(str_replace('Synchronizing', 'Synchronized', (string)$context['message']));
}
} while ($context['finished'] < 1);
}
// Clear the cache of the active config storage.
$this->getConfigCache()->deleteAll();
}
if ($config_importer->getErrors()) {
throw new ConfigException('Errors occurred during import');
} else {
$this->logger()->success('The configuration was imported successfully.');
}
} catch (ConfigException $e) {
// Return a negative result for UI purposes. We do not differentiate
// between an actual synchronization error and a failed lock, because
// concurrent synchronizations are an edge-case happening only when
// multiple developers or site builders attempt to do it without
// coordinating.
$message = 'The import failed due to the following reasons:' . "\n";
$message .= implode("\n", $config_importer->getErrors());
watchdog_exception('config_import', $e);
throw new \Exception($message);
}
}
}
/**
* @hook validate config:import
* @param CommandData $commandData
* @return CommandError|null
*/
public function validate(CommandData $commandData)
{
$msgs = [];
if ($commandData->input()->getOption('partial') && !\Drupal::moduleHandler()->moduleExists('config')) {
$msgs[] = 'Enable the config module in order to use the --partial option.';
}
if ($source = $commandData->input()->getOption('source')) {
if (!file_exists($source)) {
$msgs[] = 'The source directory does not exist.';
}
if (!is_dir($source)) {
$msgs[] = 'The source is not a directory.';
}
}
if ($msgs) {
return new CommandError(implode(' ', $msgs));
}
}
}