Add console command to mark upgrade wizards as undone

readme.md

This is an backport from TYPO3 v13 to TYPO3 v12.

A new CLI command :bash:typo3 upgrade:mark:undone has been introduced. It allows to mark a previously executed upgrade wizard as "undone", so it can be run again.

This makes the existing functionality from the install tool also available on CLI.

Sources:

• https://forge.typo3.org/issues/104655
• https://git.typo3.org/typo3/typo3/-/commit/b99439613cc2ca553c3be17eedd690b981ca9233
• https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/13.3/Feature-104655-AddConsoleCommandToMarkUpgradeWizardsAsUndone.html

backport_undone_upgrade_wizard_v13_forge_104655.patch

Index: Classes/Command/UpgradeWizardMarkUndoneCommand.php
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/Classes/Command/UpgradeWizardMarkUndoneCommand.php b/Classes/Command/UpgradeWizardMarkUndoneCommand.php
new file mode 100644
--- /dev/null	(date 1738945026210)
+++ b/Classes/Command/UpgradeWizardMarkUndoneCommand.php	(date 1738945026210)
@@ -0,0 +1,87 @@
+<?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\Style\SymfonyStyle;
+use TYPO3\CMS\Core\Authentication\CommandLineUserAuthentication;
+use TYPO3\CMS\Core\Core\Bootstrap;
+use TYPO3\CMS\Install\Service\LateBootService;
+use TYPO3\CMS\Install\Service\UpgradeWizardsService;
+
+/**
+ * Upgrade wizard command for marking wizards as undone
+ *
+ * @internal
+ */
+class UpgradeWizardMarkUndoneCommand extends Command
+{
+    private UpgradeWizardsService $upgradeWizardsService;
+
+    public function __construct(
+        string $name,
+        private readonly LateBootService $lateBootService
+    ) {
+        parent::__construct($name);
+    }
+
+    /**
+     * Bootstrap running of upgradeWizards
+     */
+    protected function bootstrap(): void
+    {
+        $this->upgradeWizardsService = $this->lateBootService
+            ->loadExtLocalconfDatabaseAndExtTables(false)
+            ->get(UpgradeWizardsService::class);
+        Bootstrap::initializeBackendUser(CommandLineUserAuthentication::class);
+        Bootstrap::initializeBackendAuthentication();
+    }
+
+    /**
+     * Configure the command by defining the name, options and arguments
+     */
+    protected function configure(): void
+    {
+        $this->setDescription('Mark upgrade wizard as undone.')
+            ->addArgument(
+                'wizardIdentifier',
+                InputArgument::REQUIRED
+            );
+    }
+
+    /**
+     * Mark an upgrade wizard as undone
+     */
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+        $this->bootstrap();
+        $wizardIdentifier = (string)$input->getArgument('wizardIdentifier');
+        $wizardInformation = $this->upgradeWizardsService->getWizardInformationByIdentifier($wizardIdentifier);
+        $hasBeenMarkedUndone = $this->upgradeWizardsService->markWizardUndone($wizardIdentifier);
+        if ($hasBeenMarkedUndone) {
+            $io->success('The wizard "' . $wizardInformation['title'] . '" has been marked as undone.');
+            return Command::SUCCESS;
+        }
+        $io->error('The wizard "' . $wizardInformation['title'] . '" could not be marked undone, because it was most likely not yet run.');
+        return Command::FAILURE;
+    }
+}
Index: Classes/ServiceProvider.php
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/Classes/ServiceProvider.php b/Classes/ServiceProvider.php
--- a/Classes/ServiceProvider.php
+++ b/Classes/ServiceProvider.php	(date 1738945932279)
@@ -96,6 +96,7 @@
             Command\LanguagePackCommand::class => self::getLanguagePackCommand(...),
             Command\UpgradeWizardRunCommand::class => self::getUpgradeWizardRunCommand(...),
             Command\UpgradeWizardListCommand::class => self::getUpgradeWizardListCommand(...),
+            Command\UpgradeWizardMarkUndoneCommand::class => self::getUpgradeWizardMarkUndoneCommand(...),
             Command\SetupCommand::class => self::getSetupCommand(...),
             Database\PermissionsCheck::class => self::getPermissionsCheck(...),
             Mailer::class => self::getMailer(...),
@@ -351,6 +352,14 @@
             $container->get(Service\LateBootService::class),
         );
     }
+
+    public static function getUpgradeWizardMarkUndoneCommand(ContainerInterface $container): Command\UpgradeWizardMarkUndoneCommand
+    {
+        return new Command\UpgradeWizardMarkUndoneCommand(
+            'upgrade:mark:undone',
+            $container->get(Service\LateBootService::class),
+        );
+    }

     public static function getSetupCommand(ContainerInterface $container): Command\SetupCommand
     {
@@ -395,6 +404,11 @@
             Command\UpgradeWizardListCommand::class,
             'List available upgrade wizards.'
         );
+        $commandRegistry->addLazyCommand(
+            'upgrade:mark:undone',
+            Command\UpgradeWizardMarkUndoneCommand::class,
+            'Mark upgrade wizard as undone.'
+        );
         $commandRegistry->addLazyCommand(
             'setup',
             Command\SetupCommand::class,