factory = $factory ?? new UpgradeWizardFactory();
$this->upgradeWizardsService = $upgradeWizardsService ?? GeneralUtility::makeInstance(UpgradeWizardsService::class);
}
public function executeWizard(string $identifier, array $arguments = [], bool $force = false): UpgradeWizardResult
{
$upgradeWizard = $this->factory->create($identifier);
$identifier = $upgradeWizard->getIdentifier();
$messages = [];
$hasPerformed = $userHasDecided = $requiresConfirmation = $succeeded = false;
$userWantsExecution = true;
$output = new BufferedOutput();
$isWizardDone = $this->upgradeWizardsService->isWizardDone($identifier);
if ($upgradeWizard instanceof ConfirmableInterface) {
$userHasDecided = isset($arguments['confirm']);
$requiresConfirmation = $upgradeWizard->getConfirmation()->isRequired();
$userWantsExecution = !empty($arguments['confirm']);
}
if ($upgradeWizard instanceof ChattyInterface) {
$upgradeWizard->setOutput($output);
}
$checkForUpdateNecessary = $userWantsExecution && (!$isWizardDone || $force);
if ($checkForUpdateNecessary && $upgradeWizard->updateNecessary()) {
$succeeded = $upgradeWizard->executeUpdate();
$hasPerformed = true;
}
$messages[] = $output->fetch();
if ($succeeded) {
$messages[] = sprintf('Successfully executed upgrade wizard "%s".', $identifier);
}
if ($hasPerformed && !$succeeded) {
$messages[] = sprintf('Upgrade wizard "%s" had errors during execution.', $identifier);
}
if ($hasPerformed && $force && $isWizardDone) {
$messages[] = sprintf('Upgrade wizard "%s" was executed (forced).', $identifier);
}
if (!$hasPerformed && !$force && $isWizardDone) {
$messages[] = sprintf('Upgrade wizard "%s" was skipped because it is marked as done.', $identifier);
}
if (!$hasPerformed && $checkForUpdateNecessary) {
$messages[] = sprintf('Upgrade wizard "%s" was skipped because no operation is needed.', $identifier);
}
if ($userHasDecided && !$hasPerformed) {
if ($requiresConfirmation && !$isWizardDone) {
$messages[] = sprintf('Skipped wizard "%s" but it needs confirmation!', $identifier);
} else {
$messages[] = sprintf('Skipped wizard "%s" and marked as executed.', $identifier);
}
}
if (!$isWizardDone && ($succeeded || ($checkForUpdateNecessary && !$hasPerformed)) && !$upgradeWizard instanceof RepeatableInterface) {
$this->upgradeWizardsService->markWizardAsDone($identifier);
}
if (!$isWizardDone && $userHasDecided && !$hasPerformed && !$requiresConfirmation) {
$this->upgradeWizardsService->markWizardAsDone($identifier);
}
return new UpgradeWizardResult($hasPerformed, $messages, $succeeded);
}
public function wizardNeedsExecution(string $identifier): bool
{
$upgradeWizard = $this->factory->create($identifier);
return $upgradeWizard->updateNecessary();
}
}