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
|
<?php
declare(strict_types=1);
namespace Drupal\Core\Recipe;
use Drupal\Component\Render\PlainTextOutput;
use Drupal\Core\Command\BootableCommandTrait;
use Drupal\Core\Config\Checkpoint\Checkpoint;
use Drupal\Core\Config\ConfigImporter;
use Drupal\Core\Config\ConfigImporterException;
use Drupal\Core\Config\StorageComparer;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LogLevel;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Logger\ConsoleLogger;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
/**
* Applies recipe.
*
* @internal
* This API is experimental.
*/
final class RecipeCommand extends Command {
use BootableCommandTrait;
use StringTranslationTrait;
/**
* Constructs a new RecipeCommand command.
*
* @param object $class_loader
* The class loader.
*/
public function __construct($class_loader) {
parent::__construct('recipe');
$this->classLoader = $class_loader;
}
/**
* {@inheritdoc}
*/
protected function configure(): void {
$this
->setDescription('Applies a recipe to a site.')
->addArgument('path', InputArgument::REQUIRED, 'The path to the recipe\'s folder to apply');
ConsoleInputCollector::configureCommand($this);
}
/**
* {@inheritdoc}
*/
protected function execute(InputInterface $input, OutputInterface $output): int {
$io = new SymfonyStyle($input, $output);
$recipe_path = $input->getArgument('path');
if (!is_string($recipe_path) || !is_dir($recipe_path)) {
$io->error(sprintf('The supplied path %s is not a directory', $recipe_path));
return 1;
}
// Recipes can only be applied to an already-installed site.
$container = $this->boot()->getContainer();
/** @var \Drupal\Core\Config\Checkpoint\CheckpointStorageInterface $checkpoint_storage */
$checkpoint_storage = $container->get('config.storage.checkpoint');
$recipe = Recipe::createFromDirectory($recipe_path);
// Collect input for this recipe and all the recipes it directly and
// indirectly applies.
$recipe->input->collectAll(new ConsoleInputCollector($input, $io));
if ($checkpoint_storage instanceof LoggerAwareInterface) {
$logger = new ConsoleLogger($output, [
// The checkpoint storage logs a notice if it decides to not create a
// checkpoint, and we want to be sure those notices are seen even
// without additional verbosity.
LogLevel::NOTICE => OutputInterface::VERBOSITY_NORMAL,
]);
$checkpoint_storage->setLogger($logger);
}
$backup_checkpoint = $checkpoint_storage
->checkpoint("Backup before the '$recipe->name' recipe.");
try {
$steps = RecipeRunner::toBatchOperations($recipe);
$progress_bar = $io->createProgressBar();
$progress_bar->setFormat("%current%/%max% [%bar%]\n%message%\n");
$progress_bar->setMessage($this->toPlainString($this->t('Applying recipe')));
$progress_bar->start(count($steps));
/** @var array{message?: \Stringable|string, results: array{module?: string[], theme?: string[], content?: string[], recipe?: string[]}} $context */
$context = ['results' => []];
foreach ($steps as $step) {
call_user_func_array($step[0], array_merge($step[1], [&$context]));
if (isset($context['message'])) {
$progress_bar->setMessage($this->toPlainString($context['message']));
}
unset($context['message']);
$progress_bar->advance();
}
if ($io->isVerbose()) {
if (!empty($context['results']['module'])) {
$io->section($this->toPlainString($this->t('Modules installed')));
$modules = array_map(fn ($module) => \Drupal::service('extension.list.module')->getName($module), $context['results']['module']);
sort($modules, SORT_NATURAL);
$io->listing($modules);
}
if (!empty($context['results']['theme'])) {
$io->section($this->toPlainString($this->t('Themes installed')));
$themes = array_map(fn ($theme) => \Drupal::service('extension.list.theme')->getName($theme), $context['results']['theme']);
sort($themes, SORT_NATURAL);
$io->listing($themes);
}
if (!empty($context['results']['content'])) {
$io->section($this->toPlainString($this->t('Content created for recipes')));
$io->listing($context['results']['content']);
}
if (!empty($context['results']['recipe'])) {
$io->section($this->toPlainString($this->t('Recipes applied')));
$io->listing($context['results']['recipe']);
}
}
$io->success($this->toPlainString($this->t('%recipe applied successfully', ['%recipe' => $recipe->name])));
return 0;
}
catch (\Throwable $e) {
try {
$this->rollBackToCheckpoint($backup_checkpoint);
}
catch (ConfigImporterException $importer_exception) {
$io->error($importer_exception->getMessage());
}
throw $e;
}
}
/**
* Converts a stringable like TranslatableMarkup to a plain text string.
*
* @param \Stringable|string $text
* The string to convert.
*
* @return string
* The plain text string.
*/
private function toPlainString(\Stringable|string $text): string {
return PlainTextOutput::renderFromHtml((string) $text);
}
/**
* Rolls config back to a particular checkpoint.
*
* @param \Drupal\Core\Config\Checkpoint\Checkpoint $checkpoint
* The checkpoint to roll back to.
*/
private function rollBackToCheckpoint(Checkpoint $checkpoint): void {
$container = \Drupal::getContainer();
/** @var \Drupal\Core\Config\Checkpoint\CheckpointStorageInterface $checkpoint_storage */
$checkpoint_storage = $container->get('config.storage.checkpoint');
$checkpoint_storage->setCheckpointToReadFrom($checkpoint);
$storage_comparer = new StorageComparer($checkpoint_storage, $container->get('config.storage'));
$storage_comparer->reset();
$config_importer = new ConfigImporter(
$storage_comparer,
$container->get('event_dispatcher'),
$container->get('config.manager'),
$container->get('lock'),
$container->get('config.typed'),
$container->get('module_handler'),
$container->get('module_installer'),
$container->get('theme_handler'),
$container->get('string_translation'),
$container->get('extension.list.module'),
$container->get('extension.list.theme'),
);
$config_importer->import();
}
}
|
