* @author Christoph Wurst * @author Joas Schilling * @author Lukas Reschke * @author Morris Jobke * @author Nils Wittenbrink * @author Owen Winkler * @author Robin Appelman * @author Sander Ruitenbeek * @author Thomas Müller * @author Thomas Pulzer * @author Valdnet <47037905+Valdnet@users.noreply.github.com> * @author Vincent Petry * * @license AGPL-3.0 * * This code is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License, version 3, * as published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License, version 3, * along with this program. If not, see * */ namespace OC\Core\Command; use OC\Console\TimestampFormatter; use OC\DB\MigratorExecuteSqlEvent; use OC\Installer; use OC\Repair\Events\RepairAdvanceEvent; use OC\Repair\Events\RepairErrorEvent; use OC\Repair\Events\RepairFinishEvent; use OC\Repair\Events\RepairInfoEvent; use OC\Repair\Events\RepairStartEvent; use OC\Repair\Events\RepairStepEvent; use OC\Repair\Events\RepairWarningEvent; use OC\Updater; use OCP\EventDispatcher\Event; use OCP\EventDispatcher\IEventDispatcher; use OCP\IConfig; use OCP\Util; use Psr\Log\LoggerInterface; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Helper\ProgressBar; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; class Upgrade extends Command { public const ERROR_SUCCESS = 0; public const ERROR_NOT_INSTALLED = 1; public const ERROR_MAINTENANCE_MODE = 2; public const ERROR_UP_TO_DATE = 0; public const ERROR_INVALID_ARGUMENTS = 4; public const ERROR_FAILURE = 5; public function __construct( private IConfig $config, private LoggerInterface $logger, private Installer $installer, ) { parent::__construct(); } protected function configure() { $this ->setName('upgrade') ->setDescription('run upgrade routines after installation of a new release. The release has to be installed before.'); } /** * Execute the upgrade command * * @param InputInterface $input input interface * @param OutputInterface $output output interface */ protected function execute(InputInterface $input, OutputInterface $output): int { if (Util::needUpgrade()) { if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) { // Prepend each line with a little timestamp $timestampFormatter = new TimestampFormatter($this->config, $output->getFormatter()); $output->setFormatter($timestampFormatter); } $self = $this; $updater = new Updater( $this->config, \OC::$server->getIntegrityCodeChecker(), $this->logger, $this->installer ); /** @var IEventDispatcher $dispatcher */ $dispatcher = \OC::$server->get(IEventDispatcher::class); $progress = new ProgressBar($output); $progress->setFormat(" %message%\n %current%/%max% [%bar%] %percent:3s%%"); $listener = function (MigratorExecuteSqlEvent $event) use ($progress, $output): void { $message = $event->getSql(); if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) { $output->writeln(' Executing SQL ' . $message); } else { if (strlen($message) > 60) { $message = substr($message, 0, 57) . '...'; } $progress->setMessage($message); if ($event->getCurrentStep() === 1) { $output->writeln(''); $progress->start($event->getMaxStep()); } $progress->setProgress($event->getCurrentStep()); if ($event->getCurrentStep() === $event->getMaxStep()) { $progress->setMessage('Done'); $progress->finish(); $output->writeln(''); } } }; $repairListener = function (Event $event) use ($progress, $output): void { if ($event instanceof RepairStartEvent) { $progress->setMessage('Starting ...'); $output->writeln($event->getCurrentStepName()); $output->writeln(''); $progress->start($event->getMaxStep()); } elseif ($event instanceof RepairAdvanceEvent) { $desc = $event->getDescription(); if (!empty($desc)) { $progress->setMessage($desc); } $progress->advance($event->getIncrement()); } elseif ($event instanceof RepairFinishEvent) { $progress->setMessage('Done'); $progress->finish(); $output->writeln(''); } elseif ($event instanceof RepairStepEvent) { if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) { $output->writeln('Repair step: ' . $event->getStepName() . ''); } } elseif ($event instanceof RepairInfoEvent) { if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) { $output->writeln('Repair info: ' . $event->getMessage() . ''); } } elseif ($event instanceof RepairWarningEvent) { $output->writeln('Repair warning: ' . $event->getMessage() . ''); } elseif ($event instanceof RepairErrorEvent) { $output->writeln('Repair error: ' . $event->getMessage() . ''); } }; $dispatcher->addListener(MigratorExecuteSqlEvent::class, $listener); $dispatcher->addListener(RepairStartEvent::class, $repairListener); $dispatcher->addListener(RepairAdvanceEvent::class, $repairListener); $dispatcher->addListener(RepairFinishEvent::class, $repairListener); $dispatcher->addListener(RepairStepEvent::class, $repairListener); $dispatcher->addListener(RepairInfoEvent::class, $repairListener); $dispatcher->addListener(RepairWarningEvent::class, $repairListener); $dispatcher->addListener(RepairErrorEvent::class, $repairListener); $updater->listen('\OC\Updater', 'maintenanceEnabled', function () use ($output) { $output->writeln('Turned on maintenance mode'); }); $updater->listen('\OC\Updater', 'maintenanceDisabled', function () use ($output) { $output->writeln('Turned off maintenance mode'); }); $updater->listen('\OC\Updater', 'maintenanceActive', function () use ($output) { $output->writeln('Maintenance mode is kept active'); }); $updater->listen('\OC\Updater', 'updateEnd', function ($success) use ($output, $self) { if ($success) { $message = "Update successful"; } else { $message = "Update failed"; } $output->writeln($message); }); $updater->listen('\OC\Updater', 'dbUpgradeBefore', function () use ($output) { $output->writeln('Updating database schema'); }); $updater->listen('\OC\Updater', 'dbUpgrade', function () use ($output) { $output->writeln('Updated database'); }); $updater->listen('\OC\Updater', 'incompatibleAppDisabled', function ($app) use ($output) { $output->writeln('Disabled incompatible app: ' . $app . ''); }); $updater->listen('\OC\Updater', 'upgradeAppStoreApp', function ($app) use ($output) { $output->writeln('Update app ' . $app . ' from App Store'); }); $updater->listen('\OC\Updater', 'appSimulateUpdate', function ($app) use ($output) { $output->writeln("Checking whether the database schema for <$app> can be updated (this can take a long time depending on the database size)"); }); $updater->listen('\OC\Updater', 'appUpgradeStarted', function ($app, $version) use ($output) { $output->writeln("Updating <$app> ..."); }); $updater->listen('\OC\Updater', 'appUpgrade', function ($app, $version) use ($output) { $output->writeln("Updated <$app> to $version"); }); $updater->listen('\OC\Updater', 'failure', function ($message) use ($output, $self) { $output->writeln("$message"); }); $updater->listen('\OC\Updater', 'setDebugLogLevel', function ($logLevel, $logLevelName) use ($output) { $output->writeln("Setting log level to debug"); }); $updater->listen('\OC\Updater', 'resetLogLevel', function ($logLevel, $logLevelName) use ($output) { $output->writeln("Resetting log level"); }); $updater->listen('\OC\Updater', 'startCheckCodeIntegrity', function () use ($output) { $output->writeln("Starting code integrity check..."); }); $updater->listen('\OC\Updater', 'finishedCheckCodeIntegrity', function () use ($output) { $output->writeln("Finished code integrity check"); }); $success = $updater->upgrade(); $this->postUpgradeCheck($input, $output); if (!$success) { return self::ERROR_FAILURE; } return self::ERROR_SUCCESS; } elseif ($this->config->getSystemValueBool('maintenance')) { //Possible scenario: Nextcloud core is updated but an app failed $output->writeln('Nextcloud is in maintenance mode'); $output->write('Maybe an upgrade is already in process. Please check the ' . 'logfile (data/nextcloud.log). If you want to re-run the ' . 'upgrade procedure, remove the "maintenance mode" from ' . 'config.php and call this script again.', true); return self::ERROR_MAINTENANCE_MODE; } else { $output->writeln('Nextcloud is already latest version'); return self::ERROR_UP_TO_DATE; } } /** * Perform a post upgrade check (specific to the command line tool) * * @param InputInterface $input input interface * @param OutputInterface $output output interface */ protected function postUpgradeCheck(InputInterface $input, OutputInterface $output) { $trustedDomains = $this->config->getSystemValue('trusted_domains', []); if (empty($trustedDomains)) { $output->write( 'The setting "trusted_domains" could not be ' . 'set automatically by the upgrade script, ' . 'please set it manually' ); } } }