aboutsummaryrefslogtreecommitdiffstats
path: root/core/Command/Upgrade.php
diff options
context:
space:
mode:
Diffstat (limited to 'core/Command/Upgrade.php')
-rw-r--r--core/Command/Upgrade.php283
1 files changed, 112 insertions, 171 deletions
diff --git a/core/Command/Upgrade.php b/core/Command/Upgrade.php
index 7ab5fe8e5fd..c3d6aacc714 100644
--- a/core/Command/Upgrade.php
+++ b/core/Command/Upgrade.php
@@ -1,49 +1,32 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Andreas Fischer <bantu@owncloud.com>
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Nils Wittenbrink <nilswittenbrink@web.de>
- * @author Owen Winkler <a_github@midnightcircus.com>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Sander Ruitenbeek <sander@grids.be>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- * @author Thomas Pulzer <t.pulzer@kniel.de>
- * @author Vincent Petry <vincent@nextcloud.com>
- *
- * @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 <http://www.gnu.org/licenses/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
-
namespace OC\Core\Command;
use OC\Console\TimestampFormatter;
-use OC\Installer;
+use OC\DB\MigratorExecuteSqlEvent;
+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\ILogger;
+use OCP\IURLGenerator;
+use OCP\Server;
use OCP\Util;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\EventDispatcher\GenericEvent;
class Upgrade extends Command {
public const ERROR_SUCCESS = 0;
@@ -53,22 +36,11 @@ class Upgrade extends Command {
public const ERROR_INVALID_ARGUMENTS = 4;
public const ERROR_FAILURE = 5;
- /** @var IConfig */
- private $config;
-
- /** @var ILogger */
- private $logger;
-
- /**
- * @param IConfig $config
- * @param ILogger $logger
- * @param Installer $installer
- */
- public function __construct(IConfig $config, ILogger $logger, Installer $installer) {
+ public function __construct(
+ private IConfig $config,
+ private IURLGenerator $urlGenerator,
+ ) {
parent::__construct();
- $this->config = $config;
- $this->logger = $logger;
- $this->installer = $installer;
}
protected function configure() {
@@ -85,171 +57,137 @@ class Upgrade extends Command {
*/
protected function execute(InputInterface $input, OutputInterface $output): int {
if (Util::needUpgrade()) {
- if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) {
+ if ($output->getVerbosity() > OutputInterface::VERBOSITY_NORMAL) {
// 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
- );
+ $updater = Server::get(Updater::class);
+ $incompatibleOverwrites = $this->config->getSystemValue('app_install_overwrite', []);
- $dispatcher = \OC::$server->getEventDispatcher();
+ /** @var IEventDispatcher $dispatcher */
+ $dispatcher = Server::get(IEventDispatcher::class);
$progress = new ProgressBar($output);
$progress->setFormat(" %message%\n %current%/%max% [%bar%] %percent:3s%%");
- $listener = function ($event) use ($progress, $output) {
- if ($event instanceof GenericEvent) {
- $message = $event->getSubject();
- if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) {
- $output->writeln(' Checking table ' . $message);
- } else {
- if (strlen($message) > 60) {
- $message = substr($message, 0, 57) . '...';
- }
- $progress->setMessage($message);
- if ($event[0] === 1) {
- $output->writeln('');
- $progress->start($event[1]);
- }
- $progress->setProgress($event[0]);
- if ($event[0] === $event[1]) {
- $progress->setMessage('Done');
- $progress->finish();
- $output->writeln('');
- }
+ $listener = function (MigratorExecuteSqlEvent $event) use ($progress, $output): void {
+ $message = $event->getSql();
+ if ($output->getVerbosity() > OutputInterface::VERBOSITY_NORMAL) {
+ $output->writeln(' Executing SQL ' . $message);
+ } else {
+ if (strlen($message) > 60) {
+ $message = substr($message, 0, 57) . '...';
}
- }
- };
- $repairListener = function ($event) use ($progress, $output) {
- if (!$event instanceof GenericEvent) {
- return;
- }
- switch ($event->getSubject()) {
- case '\OC\Repair::startProgress':
- $progress->setMessage('Starting ...');
- $output->writeln($event->getArgument(1));
+ $progress->setMessage($message);
+ if ($event->getCurrentStep() === 1) {
$output->writeln('');
- $progress->start($event->getArgument(0));
- break;
- case '\OC\Repair::advance':
- $desc = $event->getArgument(1);
- if (!empty($desc)) {
- $progress->setMessage($desc);
- }
- $progress->advance($event->getArgument(0));
-
- break;
- case '\OC\Repair::finishProgress':
+ $progress->start($event->getMaxStep());
+ }
+ $progress->setProgress($event->getCurrentStep());
+ if ($event->getCurrentStep() === $event->getMaxStep()) {
$progress->setMessage('Done');
$progress->finish();
$output->writeln('');
- break;
- case '\OC\Repair::step':
- if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) {
- $output->writeln('<info>Repair step: ' . $event->getArgument(0) . '</info>');
- }
- break;
- case '\OC\Repair::info':
- if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) {
- $output->writeln('<info>Repair info: ' . $event->getArgument(0) . '</info>');
- }
- break;
- case '\OC\Repair::warning':
- $output->writeln('<error>Repair warning: ' . $event->getArgument(0) . '</error>');
- break;
- case '\OC\Repair::error':
- $output->writeln('<error>Repair error: ' . $event->getArgument(0) . '</error>');
- break;
+ }
+ }
+ };
+ $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 ($output->getVerbosity() > OutputInterface::VERBOSITY_NORMAL) {
+ $output->writeln('<info>Repair step: ' . $event->getStepName() . '</info>');
+ }
+ } elseif ($event instanceof RepairInfoEvent) {
+ if ($output->getVerbosity() > OutputInterface::VERBOSITY_NORMAL) {
+ $output->writeln('<info>Repair info: ' . $event->getMessage() . '</info>');
+ }
+ } elseif ($event instanceof RepairWarningEvent) {
+ $output->writeln('<error>Repair warning: ' . $event->getMessage() . '</error>');
+ } elseif ($event instanceof RepairErrorEvent) {
+ $output->writeln('<error>Repair error: ' . $event->getMessage() . '</error>');
}
};
- $dispatcher->addListener('\OC\DB\Migrator::executeSql', $listener);
- $dispatcher->addListener('\OC\DB\Migrator::checkTable', $listener);
- $dispatcher->addListener('\OC\Repair::startProgress', $repairListener);
- $dispatcher->addListener('\OC\Repair::advance', $repairListener);
- $dispatcher->addListener('\OC\Repair::finishProgress', $repairListener);
- $dispatcher->addListener('\OC\Repair::step', $repairListener);
- $dispatcher->addListener('\OC\Repair::info', $repairListener);
- $dispatcher->addListener('\OC\Repair::warning', $repairListener);
- $dispatcher->addListener('\OC\Repair::error', $repairListener);
+ $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) {
+ $updater->listen('\OC\Updater', 'maintenanceEnabled', function () use ($output): void {
$output->writeln('<info>Turned on maintenance mode</info>');
});
- $updater->listen('\OC\Updater', 'maintenanceDisabled', function () use ($output) {
+ $updater->listen('\OC\Updater', 'maintenanceDisabled', function () use ($output): void {
$output->writeln('<info>Turned off maintenance mode</info>');
});
- $updater->listen('\OC\Updater', 'maintenanceActive', function () use ($output) {
+ $updater->listen('\OC\Updater', 'maintenanceActive', function () use ($output): void {
$output->writeln('<info>Maintenance mode is kept active</info>');
});
$updater->listen('\OC\Updater', 'updateEnd',
- function ($success) use ($output, $self) {
+ function ($success) use ($output, $self): void {
if ($success) {
- $message = "<info>Update successful</info>";
+ $message = '<info>Update successful</info>';
} else {
- $message = "<error>Update failed</error>";
+ $message = '<error>Update failed</error>';
}
$output->writeln($message);
});
- $updater->listen('\OC\Updater', 'dbUpgradeBefore', function () use ($output) {
+ $updater->listen('\OC\Updater', 'dbUpgradeBefore', function () use ($output): void {
$output->writeln('<info>Updating database schema</info>');
});
- $updater->listen('\OC\Updater', 'dbUpgrade', function () use ($output) {
+ $updater->listen('\OC\Updater', 'dbUpgrade', function () use ($output): void {
$output->writeln('<info>Updated database</info>');
});
- $updater->listen('\OC\Updater', 'dbSimulateUpgradeBefore', function () use ($output) {
- $output->writeln('<info>Checking whether the database schema can be updated (this can take a long time depending on the database size)</info>');
- });
- $updater->listen('\OC\Updater', 'dbSimulateUpgrade', function () use ($output) {
- $output->writeln('<info>Checked database schema update</info>');
- });
- $updater->listen('\OC\Updater', 'incompatibleAppDisabled', function ($app) use ($output) {
- $output->writeln('<comment>Disabled incompatible app: ' . $app . '</comment>');
- });
- $updater->listen('\OC\Updater', 'checkAppStoreAppBefore', function ($app) use ($output) {
- $output->writeln('<info>Checking for update of app ' . $app . ' in appstore</info>');
- });
- $updater->listen('\OC\Updater', 'upgradeAppStoreApp', function ($app) use ($output) {
- $output->writeln('<info>Update app ' . $app . ' from appstore</info>');
- });
- $updater->listen('\OC\Updater', 'checkAppStoreApp', function ($app) use ($output) {
- $output->writeln('<info>Checked for update of app "' . $app . '" in appstore </info>');
+ $updater->listen('\OC\Updater', 'incompatibleAppDisabled', function ($app) use ($output, &$incompatibleOverwrites): void {
+ if (!in_array($app, $incompatibleOverwrites)) {
+ $output->writeln('<comment>Disabled incompatible app: ' . $app . '</comment>');
+ }
});
- $updater->listen('\OC\Updater', 'appUpgradeCheckBefore', function () use ($output) {
- $output->writeln('<info>Checking updates of apps</info>');
+ $updater->listen('\OC\Updater', 'upgradeAppStoreApp', function ($app) use ($output): void {
+ $output->writeln('<info>Update app ' . $app . ' from App Store</info>');
});
- $updater->listen('\OC\Updater', 'appSimulateUpdate', function ($app) use ($output) {
+ $updater->listen('\OC\Updater', 'appSimulateUpdate', function ($app) use ($output): void {
$output->writeln("<info>Checking whether the database schema for <$app> can be updated (this can take a long time depending on the database size)</info>");
});
- $updater->listen('\OC\Updater', 'appUpgradeCheck', function () use ($output) {
- $output->writeln('<info>Checked database schema update for apps</info>');
- });
- $updater->listen('\OC\Updater', 'appUpgradeStarted', function ($app, $version) use ($output) {
+ $updater->listen('\OC\Updater', 'appUpgradeStarted', function ($app, $version) use ($output): void {
$output->writeln("<info>Updating <$app> ...</info>");
});
- $updater->listen('\OC\Updater', 'appUpgrade', function ($app, $version) use ($output) {
+ $updater->listen('\OC\Updater', 'appUpgrade', function ($app, $version) use ($output): void {
$output->writeln("<info>Updated <$app> to $version</info>");
});
- $updater->listen('\OC\Updater', 'failure', function ($message) use ($output, $self) {
+ $updater->listen('\OC\Updater', 'failure', function ($message) use ($output, $self): void {
$output->writeln("<error>$message</error>");
});
- $updater->listen('\OC\Updater', 'setDebugLogLevel', function ($logLevel, $logLevelName) use ($output) {
- $output->writeln("<info>Setting log level to debug</info>");
+ $updater->listen('\OC\Updater', 'setDebugLogLevel', function ($logLevel, $logLevelName) use ($output): void {
+ $output->writeln('<info>Setting log level to debug</info>');
});
- $updater->listen('\OC\Updater', 'resetLogLevel', function ($logLevel, $logLevelName) use ($output) {
- $output->writeln("<info>Resetting log level</info>");
+ $updater->listen('\OC\Updater', 'resetLogLevel', function ($logLevel, $logLevelName) use ($output): void {
+ $output->writeln('<info>Resetting log level</info>');
});
- $updater->listen('\OC\Updater', 'startCheckCodeIntegrity', function () use ($output) {
- $output->writeln("<info>Starting code integrity check...</info>");
+ $updater->listen('\OC\Updater', 'startCheckCodeIntegrity', function () use ($output): void {
+ $output->writeln('<info>Starting code integrity check...</info>');
});
- $updater->listen('\OC\Updater', 'finishedCheckCodeIntegrity', function () use ($output) {
- $output->writeln("<info>Finished code integrity check</info>");
+ $updater->listen('\OC\Updater', 'finishedCheckCodeIntegrity', function () use ($output): void {
+ $output->writeln('<info>Finished code integrity check</info>');
});
$success = $updater->upgrade();
@@ -267,11 +205,14 @@ class Upgrade extends Command {
$output->write('<comment>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.</comment>'
- , true);
+ . 'config.php and call this script again.</comment>', true);
return self::ERROR_MAINTENANCE_MODE;
} else {
- $output->writeln('<info>Nextcloud is already latest version</info>');
+ $output->writeln('<info>No upgrade required.</info>');
+ $output->writeln('');
+ $output->writeln('Note: This command triggers the upgrade actions associated with a new version. The new version\'s updated source files must be deployed in advance.');
+ $doc = $this->urlGenerator->linkToDocs('admin-update');
+ $output->writeln('See the upgrade documentation: ' . $doc . ' for more information.');
return self::ERROR_UP_TO_DATE;
}
}
@@ -286,9 +227,9 @@ class Upgrade extends Command {
$trustedDomains = $this->config->getSystemValue('trusted_domains', []);
if (empty($trustedDomains)) {
$output->write(
- '<warning>The setting "trusted_domains" could not be ' .
- 'set automatically by the upgrade script, ' .
- 'please set it manually</warning>'
+ '<warning>The setting "trusted_domains" could not be '
+ . 'set automatically by the upgrade script, '
+ . 'please set it manually</warning>'
);
}
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-16 07:21:15 +0000