UpgradeWizardRunCommand.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Install\Command;
 
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;
use Symfony\Component\Console\Style\SymfonyStyle;
use ‪TYPO3\CMS\Core\Authentication\CommandLineUserAuthentication;
use ‪TYPO3\CMS\Core\Core\Bootstrap;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Install\Service\LateBootService;
use ‪TYPO3\CMS\Install\Service\UpgradeWizardsService;
use ‪TYPO3\CMS\Install\Updates\ChattyInterface;
use ‪TYPO3\CMS\Install\Updates\ConfirmableInterface;
use ‪TYPO3\CMS\Install\Updates\PrerequisiteCollection;
use ‪TYPO3\CMS\Install\Updates\RepeatableInterface;
use ‪TYPO3\CMS\Install\Updates\UpgradeWizardInterface;
 
class ‪UpgradeWizardRunCommand extends Command
{
    private ‪$lateBootService;
 
    private ‪$upgradeWizardsService;
 
    private ‪$output;
 
    private ‪$input;
 
    public function ‪__construct(
        string $name,
        ‪LateBootService ‪$lateBootService,
        ‪UpgradeWizardsService ‪$upgradeWizardsService
    ) {
        $this->lateBootService = ‪$lateBootService;
        $this->upgradeWizardsService = ‪$upgradeWizardsService;
        parent::__construct($name);
    }
 
    protected function ‪bootstrap(): void
    {
        $this->lateBootService->loadExtLocalconfDatabaseAndExtTables();
        ‪Bootstrap::initializeBackendUser(CommandLineUserAuthentication::class);
        ‪Bootstrap::initializeBackendAuthentication();
        $this->upgradeWizardsService->isDatabaseCharsetUtf8() ?: $this->upgradeWizardsService->setDatabaseCharsetUtf8();
    }
 
    protected function ‪configure()
    {
        $this->setDescription('Run upgrade wizard. Without arguments all available wizards will be run.')
            ->addArgument(
                'wizardName',
                InputArgument::OPTIONAL
            )->setHelp(
                'This command allows running upgrade wizards on CLI. To run a single wizard add the ' .
                'identifier of the wizard as argument. The identifier of the wizard is the name it is ' .
                'registered with in ext_localconf.'
            );
    }
 
    protected function ‪execute(InputInterface ‪$input, OutputInterface ‪$output)
    {
        $this->output = new SymfonyStyle(‪$input, ‪$output);
        $this->input = ‪$input;
        $this->‪bootstrap();
 
        $result = 0;
        if (‪$input->getArgument('wizardName')) {
            $wizardToExecute = ‪$input->getArgument('wizardName');
            $wizardToExecute = is_string($wizardToExecute) ? $wizardToExecute : '';
            if (isset(‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/install']['update'][$wizardToExecute])) {
                $className = ‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/install']['update'][$wizardToExecute];
                $upgradeWizard = $this->‪getWizard($className, $wizardToExecute);
                if ($upgradeWizard !== null) {
                    $prerequisitesFulfilled = $this->‪handlePrerequisites([$upgradeWizard]);
                    if ($prerequisitesFulfilled === true) {
                        $result = $this->‪runSingleWizard($upgradeWizard);
                    } else {
                        $result = 1;
                    }
                }
            } else {
                $this->output->error('No such wizard: ' . $wizardToExecute);
                $result = 1;
            }
        } else {
            $result = $this->‪runAllWizards();
        }
        return $result;
    }
 
    protected function ‪getWizard(string $className, string $identifier): ?UpgradeWizardInterface
    {
        // already done
        if ($this->upgradeWizardsService->isWizardDone($identifier)) {
            return null;
        }
 
        $wizardInstance = GeneralUtility::makeInstance($className);
        if ($wizardInstance instanceof ChattyInterface) {
            $wizardInstance->setOutput($this->output);
        }
 
        if (!($wizardInstance instanceof UpgradeWizardInterface)) {
            $this->output->writeln(
                'Wizard ' .
                $identifier .
                ' needs to be manually run from the install tool, as it does not implement ' .
                UpgradeWizardInterface::class
            );
            return null;
        }
 
        if ($wizardInstance->updateNecessary()) {
            return $wizardInstance;
        }
        if ($wizardInstance instanceof RepeatableInterface) {
            $this->output->note('Wizard ' . $identifier . ' does not need to make changes.');
        } else {
            $this->output->note('Wizard ' . $identifier . ' does not need to make changes. Marking wizard as done.');
            $this->upgradeWizardsService->markWizardAsDone($identifier);
        }
        return null;
    }
 
    protected function ‪handlePrerequisites(array $instances): bool
    {
        $prerequisites = GeneralUtility::makeInstance(PrerequisiteCollection::class);
        foreach ($instances as $instance) {
            foreach ($instance->getPrerequisites() as $prerequisite) {
                $prerequisites->add($prerequisite);
            }
        }
        $result = true;
        foreach ($prerequisites as $prerequisite) {
            if ($prerequisite instanceof ChattyInterface) {
                $prerequisite->setOutput($this->output);
            }
            if (!$prerequisite->isFulfilled()) {
                $this->output->writeln('Prerequisite "' . $prerequisite->getTitle() . '" not fulfilled, will ensure.');
                $result = $prerequisite->ensure();
                if ($result === false) {
                    $this->output->error(
                        '<error>Error running ' .
                        $prerequisite->getTitle() .
                        '. Please ensure this prerequisite manually and try again.</error>'
                    );
                    break;
                }
            } else {
                $this->output->writeln('Prerequisite "' . $prerequisite->getTitle() . '" fulfilled.');
            }
        }
        return $result;
    }
 
    protected function ‪runSingleWizard(
        UpgradeWizardInterface $instance
    ): int {
        $this->output->title('Running Wizard ' . $instance->getTitle());
        if ($instance instanceof ConfirmableInterface) {
            $confirmation = $instance->getConfirmation();
            $defaultString = $confirmation->getDefaultValue() ? 'Y/n' : 'y/N';
            $question = new ConfirmationQuestion(
                sprintf(
                    '<info>%s</info>' . LF . '%s' . LF . '%s %s (%s)',
                    $confirmation->getTitle(),
                    $confirmation->getMessage(),
                    $confirmation->getConfirm(),
                    $confirmation->getDeny(),
                    $defaultString
                ),
                $confirmation->getDefaultValue()
            );
            $helper = $this->getHelper('question');
            if (!$helper->ask($this->input, $this->output, $question)) {
                if ($confirmation->isRequired()) {
                    $this->output->error('You have to acknowledge this wizard to continue');
                    return 1;
                }
                if ($instance instanceof RepeatableInterface) {
                    $this->output->note('No changes applied.');
                } else {
                    $this->upgradeWizardsService->markWizardAsDone($instance->getIdentifier());
                    $this->output->note('No changes applied, marking wizard as done.');
                }
                return 0;
            }
        }
        if ($instance->executeUpdate()) {
            $this->output->success('Successfully ran wizard ' . $instance->getTitle());
            if (!$instance instanceof RepeatableInterface) {
                $this->upgradeWizardsService->markWizardAsDone($instance->getIdentifier());
            }
            return 0;
        }
        $this->output->error('<error>Something went wrong while running ' . $instance->getTitle() . '</error>');
        return 1;
    }
 
    public function ‪runAllWizards(): int
    {
        $returnCode = 0;
        $wizardInstances = [];
        foreach (‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/install']['update'] as $identifier => $class) {
            $wizardInstances[] = $this->‪getWizard($class, $identifier);
        }
        $wizardInstances = array_filter($wizardInstances);
        if (count($wizardInstances) > 0) {
            $prerequisitesResult = $this->‪handlePrerequisites($wizardInstances);
            if ($prerequisitesResult === false) {
                $returnCode = 1;
                $this->output->error('Error handling prerequisites, aborting.');
            } else {
                $this->output->title('Found ' . count($wizardInstances) . ' wizard(s) to run.');
                foreach ($wizardInstances as $wizardInstance) {
                    $result = $this->‪runSingleWizard($wizardInstance);
                    if ($result > 0) {
                        $returnCode = 1;
                    }
                }
            }
        } else {
            $this->output->success('No wizards left to run.');
        }
        return $returnCode;
    }
}