123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252 |
- <?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 Valdnet <47037905+Valdnet@users.noreply.github.com>
- * @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/>
- *
- */
- namespace OC\Core\Command;
- use OC\Console\TimestampFormatter;
- 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\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;
- 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
- ) {
- 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 = \OCP\Server::get(Updater::class);
- /** @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('<info>Repair step: ' . $event->getStepName() . '</info>');
- }
- } elseif ($event instanceof RepairInfoEvent) {
- if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) {
- $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(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('<info>Turned on maintenance mode</info>');
- });
- $updater->listen('\OC\Updater', 'maintenanceDisabled', function () use ($output) {
- $output->writeln('<info>Turned off maintenance mode</info>');
- });
- $updater->listen('\OC\Updater', 'maintenanceActive', function () use ($output) {
- $output->writeln('<info>Maintenance mode is kept active</info>');
- });
- $updater->listen('\OC\Updater', 'updateEnd',
- function ($success) use ($output, $self) {
- if ($success) {
- $message = "<info>Update successful</info>";
- } else {
- $message = "<error>Update failed</error>";
- }
- $output->writeln($message);
- });
- $updater->listen('\OC\Updater', 'dbUpgradeBefore', function () use ($output) {
- $output->writeln('<info>Updating database schema</info>');
- });
- $updater->listen('\OC\Updater', 'dbUpgrade', function () use ($output) {
- $output->writeln('<info>Updated database</info>');
- });
- $updater->listen('\OC\Updater', 'incompatibleAppDisabled', function ($app) use ($output) {
- $output->writeln('<comment>Disabled incompatible app: ' . $app . '</comment>');
- });
- $updater->listen('\OC\Updater', 'upgradeAppStoreApp', function ($app) use ($output) {
- $output->writeln('<info>Update app ' . $app . ' from App Store</info>');
- });
- $updater->listen('\OC\Updater', 'appSimulateUpdate', function ($app) use ($output) {
- $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', 'appUpgradeStarted', function ($app, $version) use ($output) {
- $output->writeln("<info>Updating <$app> ...</info>");
- });
- $updater->listen('\OC\Updater', 'appUpgrade', function ($app, $version) use ($output) {
- $output->writeln("<info>Updated <$app> to $version</info>");
- });
- $updater->listen('\OC\Updater', 'failure', function ($message) use ($output, $self) {
- $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', 'resetLogLevel', function ($logLevel, $logLevelName) use ($output) {
- $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', 'finishedCheckCodeIntegrity', function () use ($output) {
- $output->writeln("<info>Finished code integrity check</info>");
- });
- $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('<comment>Nextcloud is in maintenance mode</comment>');
- $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);
- return self::ERROR_MAINTENANCE_MODE;
- } else {
- $output->writeln('<info>Nextcloud is already latest version</info>');
- 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(
- '<warning>The setting "trusted_domains" could not be ' .
- 'set automatically by the upgrade script, ' .
- 'please set it manually</warning>'
- );
- }
- }
- }
|