nextcloud / server

lib/private/Updater.php

Indentation +561 added lines, -561 removed lines

@@ -55,567 +55,567 @@
  */
 class Updater extends BasicEmitter {
 
-	/** @var ILogger $log */
-	private $log;
-
-	/** @var IConfig */
-	private $config;
-
-	/** @var Checker */
-	private $checker;
-
-	/** @var Installer */
-	private $installer;
-
-	/** @var IJobList */
-	private $jobList;
-
-	private $logLevelNames = [
-		0 => 'Debug',
-		1 => 'Info',
-		2 => 'Warning',
-		3 => 'Error',
-		4 => 'Fatal',
-	];
-
-	public function __construct(IConfig $config,
-								Checker $checker,
-								ILogger $log,
-								Installer $installer,
-								IJobList $jobList) {
-		$this->log = $log;
-		$this->config = $config;
-		$this->checker = $checker;
-		$this->installer = $installer;
-		$this->jobList = $jobList;
-	}
-
-	/**
-	 * runs the update actions in maintenance mode, does not upgrade the source files
-	 * except the main .htaccess file
-	 *
-	 * @return bool true if the operation succeeded, false otherwise
-	 */
-	public function upgrade() {
-		$this->emitRepairEvents();
-		$this->logAllEvents();
-
-		$logLevel = $this->config->getSystemValue('loglevel', ILogger::WARN);
-		$this->emit('\OC\Updater', 'setDebugLogLevel', [ $logLevel, $this->logLevelNames[$logLevel] ]);
-		$this->config->setSystemValue('loglevel', ILogger::DEBUG);
-
-		$wasMaintenanceModeEnabled = $this->config->getSystemValue('maintenance', false);
-
-		if(!$wasMaintenanceModeEnabled) {
-			$this->config->setSystemValue('maintenance', true);
-			$this->emit('\OC\Updater', 'maintenanceEnabled');
-		}
-
-		$installedVersion = $this->config->getSystemValue('version', '0.0.0');
-		$currentVersion = implode('.', \OCP\Util::getVersion());
-
-		// see https://github.com/nextcloud/server/issues/9992 for potential problem
-		if (version_compare($installedVersion, '14.0.0.9', '>=')) {
-			$this->waitForCronToFinish();
-		}
-
-		$this->log->debug('starting upgrade from ' . $installedVersion . ' to ' . $currentVersion, array('app' => 'core'));
-
-		$success = true;
-		try {
-			$this->doUpgrade($currentVersion, $installedVersion);
-		} catch (HintException $exception) {
-			$this->log->logException($exception, ['app' => 'core']);
-			$this->emit('\OC\Updater', 'failure', array($exception->getMessage() . ': ' .$exception->getHint()));
-			$success = false;
-		} catch (\Exception $exception) {
-			$this->log->logException($exception, ['app' => 'core']);
-			$this->emit('\OC\Updater', 'failure', array(get_class($exception) . ': ' .$exception->getMessage()));
-			$success = false;
-		}
-
-		$this->emit('\OC\Updater', 'updateEnd', array($success));
-
-		if(!$wasMaintenanceModeEnabled && $success) {
-			$this->config->setSystemValue('maintenance', false);
-			$this->emit('\OC\Updater', 'maintenanceDisabled');
-		} else {
-			$this->emit('\OC\Updater', 'maintenanceActive');
-		}
-
-		$this->emit('\OC\Updater', 'resetLogLevel', [ $logLevel, $this->logLevelNames[$logLevel] ]);
-		$this->config->setSystemValue('loglevel', $logLevel);
-		$this->config->setSystemValue('installed', true);
-
-		return $success;
-	}
-
-	/**
-	 * Return version from which this version is allowed to upgrade from
-	 *
-	 * @return array allowed previous versions per vendor
-	 */
-	private function getAllowedPreviousVersions() {
-		// this should really be a JSON file
-		require \OC::$SERVERROOT . '/version.php';
-		/** @var array $OC_VersionCanBeUpgradedFrom */
-		return $OC_VersionCanBeUpgradedFrom;
-	}
-
-	/**
-	 * Return vendor from which this version was published
-	 *
-	 * @return string Get the vendor
-	 */
-	private function getVendor() {
-		// this should really be a JSON file
-		require \OC::$SERVERROOT . '/version.php';
-		/** @var string $vendor */
-		return (string) $vendor;
-	}
-
-	/**
-	 * Whether an upgrade to a specified version is possible
-	 * @param string $oldVersion
-	 * @param string $newVersion
-	 * @param array $allowedPreviousVersions
-	 * @return bool
-	 */
-	public function isUpgradePossible($oldVersion, $newVersion, array $allowedPreviousVersions) {
-		$version = explode('.', $oldVersion);
-		$majorMinor = $version[0] . '.' . $version[1];
-
-		$currentVendor = $this->config->getAppValue('core', 'vendor', '');
-
-		// Vendor was not set correctly on install, so we have to white-list known versions
-		if ($currentVendor === '' && isset($allowedPreviousVersions['owncloud'][$oldVersion])) {
-			$currentVendor = 'owncloud';
-		}
-
-		if ($currentVendor === 'nextcloud') {
-			return isset($allowedPreviousVersions[$currentVendor][$majorMinor])
-				&& (version_compare($oldVersion, $newVersion, '<=') ||
-					$this->config->getSystemValue('debug', false));
-		}
-
-		// Check if the instance can be migrated
-		return isset($allowedPreviousVersions[$currentVendor][$majorMinor]) ||
-			isset($allowedPreviousVersions[$currentVendor][$oldVersion]);
-	}
-
-	/**
-	 * runs the update actions in maintenance mode, does not upgrade the source files
-	 * except the main .htaccess file
-	 *
-	 * @param string $currentVersion current version to upgrade to
-	 * @param string $installedVersion previous version from which to upgrade from
-	 *
-	 * @throws \Exception
-	 */
-	private function doUpgrade($currentVersion, $installedVersion) {
-		// Stop update if the update is over several major versions
-		$allowedPreviousVersions = $this->getAllowedPreviousVersions();
-		if (!$this->isUpgradePossible($installedVersion, $currentVersion, $allowedPreviousVersions)) {
-			throw new \Exception('Updates between multiple major versions and downgrades are unsupported.');
-		}
-
-		// Update .htaccess files
-		try {
-			Setup::updateHtaccess();
-			Setup::protectDataDirectory();
-		} catch (\Exception $e) {
-			throw new \Exception($e->getMessage());
-		}
-
-		// create empty file in data dir, so we can later find
-		// out that this is indeed an ownCloud data directory
-		// (in case it didn't exist before)
-		file_put_contents($this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/.ocdata', '');
-
-		// pre-upgrade repairs
-		$repair = new Repair(Repair::getBeforeUpgradeRepairSteps(), \OC::$server->getEventDispatcher());
-		$repair->run();
-
-		$this->doCoreUpgrade();
-
-		try {
-			// TODO: replace with the new repair step mechanism https://github.com/owncloud/core/pull/24378
-			Setup::installBackgroundJobs();
-		} catch (\Exception $e) {
-			throw new \Exception($e->getMessage());
-		}
-
-		// update all shipped apps
-		$this->checkAppsRequirements();
-		$this->doAppUpgrade();
-
-		// Update the appfetchers version so it downloads the correct list from the appstore
-		\OC::$server->getAppFetcher()->setVersion($currentVersion);
-
-		// upgrade appstore apps
-		$this->upgradeAppStoreApps(\OC::$server->getAppManager()->getInstalledApps());
-
-		// install new shipped apps on upgrade
-		OC_App::loadApps(['authentication']);
-		$errors = Installer::installShippedApps(true);
-		foreach ($errors as $appId => $exception) {
-			/** @var \Exception $exception */
-			$this->log->logException($exception, ['app' => $appId]);
-			$this->emit('\OC\Updater', 'failure', [$appId . ': ' . $exception->getMessage()]);
-		}
-
-		// post-upgrade repairs
-		$repair = new Repair(Repair::getRepairSteps(), \OC::$server->getEventDispatcher());
-		$repair->run();
-
-		//Invalidate update feed
-		$this->config->setAppValue('core', 'lastupdatedat', 0);
-
-		// Check for code integrity if not disabled
-		if(\OC::$server->getIntegrityCodeChecker()->isCodeCheckEnforced()) {
-			$this->emit('\OC\Updater', 'startCheckCodeIntegrity');
-			$this->checker->runInstanceVerification();
-			$this->emit('\OC\Updater', 'finishedCheckCodeIntegrity');
-		}
-
-		// only set the final version if everything went well
-		$this->config->setSystemValue('version', implode('.', Util::getVersion()));
-		$this->config->setAppValue('core', 'vendor', $this->getVendor());
-	}
-
-	protected function doCoreUpgrade() {
-		$this->emit('\OC\Updater', 'dbUpgradeBefore');
-
-		// execute core migrations
-		$ms = new MigrationService('core', \OC::$server->getDatabaseConnection());
-		$ms->migrate();
-
-		$this->emit('\OC\Updater', 'dbUpgrade');
-	}
-
-	/**
-	 * @param string $version the oc version to check app compatibility with
-	 */
-	protected function checkAppUpgrade($version) {
-		$apps = \OC_App::getEnabledApps();
-		$this->emit('\OC\Updater', 'appUpgradeCheckBefore');
-
-		$appManager = \OC::$server->getAppManager();
-		foreach ($apps as $appId) {
-			$info = \OC_App::getAppInfo($appId);
-			$compatible = \OC_App::isAppCompatible($version, $info);
-			$isShipped = $appManager->isShipped($appId);
-
-			if ($compatible && $isShipped && \OC_App::shouldUpgrade($appId)) {
-				/**
-				 * FIXME: The preupdate check is performed before the database migration, otherwise database changes
-				 * are not possible anymore within it. - Consider this when touching the code.
-				 * @link https://github.com/owncloud/core/issues/10980
-				 * @see \OC_App::updateApp
-				 */
-				if (file_exists(\OC_App::getAppPath($appId) . '/appinfo/preupdate.php')) {
-					$this->includePreUpdate($appId);
-				}
-				if (file_exists(\OC_App::getAppPath($appId) . '/appinfo/database.xml')) {
-					$this->emit('\OC\Updater', 'appSimulateUpdate', array($appId));
-					\OC_DB::simulateUpdateDbFromStructure(\OC_App::getAppPath($appId) . '/appinfo/database.xml');
-				}
-			}
-		}
-
-		$this->emit('\OC\Updater', 'appUpgradeCheck');
-	}
-
-	/**
-	 * Includes the pre-update file. Done here to prevent namespace mixups.
-	 * @param string $appId
-	 */
-	private function includePreUpdate($appId) {
-		include \OC_App::getAppPath($appId) . '/appinfo/preupdate.php';
-	}
-
-	/**
-	 * upgrades all apps within a major ownCloud upgrade. Also loads "priority"
-	 * (types authentication, filesystem, logging, in that order) afterwards.
-	 *
-	 * @throws NeedsUpdateException
-	 */
-	protected function doAppUpgrade() {
-		$apps = \OC_App::getEnabledApps();
-		$priorityTypes = array('authentication', 'filesystem', 'logging');
-		$pseudoOtherType = 'other';
-		$stacks = array($pseudoOtherType => array());
-
-		foreach ($apps as $appId) {
-			$priorityType = false;
-			foreach ($priorityTypes as $type) {
-				if(!isset($stacks[$type])) {
-					$stacks[$type] = array();
-				}
-				if (\OC_App::isType($appId, [$type])) {
-					$stacks[$type][] = $appId;
-					$priorityType = true;
-					break;
-				}
-			}
-			if (!$priorityType) {
-				$stacks[$pseudoOtherType][] = $appId;
-			}
-		}
-		foreach ($stacks as $type => $stack) {
-			foreach ($stack as $appId) {
-				if (\OC_App::shouldUpgrade($appId)) {
-					$this->emit('\OC\Updater', 'appUpgradeStarted', [$appId, \OC_App::getAppVersion($appId)]);
-					\OC_App::updateApp($appId);
-					$this->emit('\OC\Updater', 'appUpgrade', [$appId, \OC_App::getAppVersion($appId)]);
-				}
-				if($type !== $pseudoOtherType) {
-					// load authentication, filesystem and logging apps after
-					// upgrading them. Other apps my need to rely on modifying
-					// user and/or filesystem aspects.
-					\OC_App::loadApp($appId);
-				}
-			}
-		}
-	}
-
-	/**
-	 * check if the current enabled apps are compatible with the current
-	 * ownCloud version. disable them if not.
-	 * This is important if you upgrade ownCloud and have non ported 3rd
-	 * party apps installed.
-	 *
-	 * @return array
-	 * @throws \Exception
-	 */
-	private function checkAppsRequirements() {
-		$isCoreUpgrade = $this->isCodeUpgrade();
-		$apps = OC_App::getEnabledApps();
-		$version = implode('.', Util::getVersion());
-		$disabledApps = [];
-		$appManager = \OC::$server->getAppManager();
-		foreach ($apps as $app) {
-			// check if the app is compatible with this version of ownCloud
-			$info = OC_App::getAppInfo($app);
-			if($info === null || !OC_App::isAppCompatible($version, $info)) {
-				if ($appManager->isShipped($app)) {
-					throw new \UnexpectedValueException('The files of the app "' . $app . '" were not correctly replaced before running the update');
-				}
-				\OC::$server->getAppManager()->disableApp($app);
-				$this->emit('\OC\Updater', 'incompatibleAppDisabled', array($app));
-			}
-			// no need to disable any app in case this is a non-core upgrade
-			if (!$isCoreUpgrade) {
-				continue;
-			}
-			// shipped apps will remain enabled
-			if ($appManager->isShipped($app)) {
-				continue;
-			}
-			// authentication and session apps will remain enabled as well
-			if (OC_App::isType($app, ['session', 'authentication'])) {
-				continue;
-			}
-		}
-		return $disabledApps;
-	}
-
-	/**
-	 * @return bool
-	 */
-	private function isCodeUpgrade() {
-		$installedVersion = $this->config->getSystemValue('version', '0.0.0');
-		$currentVersion = implode('.', Util::getVersion());
-		if (version_compare($currentVersion, $installedVersion, '>')) {
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * @param array $disabledApps
-	 * @throws \Exception
-	 */
-	private function upgradeAppStoreApps(array $disabledApps) {
-		foreach($disabledApps as $app) {
-			try {
-				$this->emit('\OC\Updater', 'checkAppStoreAppBefore', [$app]);
-				if ($this->installer->isUpdateAvailable($app)) {
-					$this->emit('\OC\Updater', 'upgradeAppStoreApp', [$app]);
-					$this->installer->updateAppstoreApp($app);
-				}
-				$this->emit('\OC\Updater', 'checkAppStoreApp', [$app]);
-			} catch (\Exception $ex) {
-				$this->log->logException($ex, ['app' => 'core']);
-			}
-		}
-	}
-
-	/**
-	 * Forward messages emitted by the repair routine
-	 */
-	private function emitRepairEvents() {
-		$dispatcher = \OC::$server->getEventDispatcher();
-		$dispatcher->addListener('\OC\Repair::warning', function ($event) {
-			if ($event instanceof GenericEvent) {
-				$this->emit('\OC\Updater', 'repairWarning', $event->getArguments());
-			}
-		});
-		$dispatcher->addListener('\OC\Repair::error', function ($event) {
-			if ($event instanceof GenericEvent) {
-				$this->emit('\OC\Updater', 'repairError', $event->getArguments());
-			}
-		});
-		$dispatcher->addListener('\OC\Repair::info', function ($event) {
-			if ($event instanceof GenericEvent) {
-				$this->emit('\OC\Updater', 'repairInfo', $event->getArguments());
-			}
-		});
-		$dispatcher->addListener('\OC\Repair::step', function ($event) {
-			if ($event instanceof GenericEvent) {
-				$this->emit('\OC\Updater', 'repairStep', $event->getArguments());
-			}
-		});
-	}
-
-	private function logAllEvents() {
-		$log = $this->log;
-
-		$dispatcher = \OC::$server->getEventDispatcher();
-		$dispatcher->addListener('\OC\DB\Migrator::executeSql', function($event) use ($log) {
-			if (!$event instanceof GenericEvent) {
-				return;
-			}
-			$log->info('\OC\DB\Migrator::executeSql: ' . $event->getSubject() . ' (' . $event->getArgument(0) . ' of ' . $event->getArgument(1) . ')', ['app' => 'updater']);
-		});
-		$dispatcher->addListener('\OC\DB\Migrator::checkTable', function($event) use ($log) {
-			if (!$event instanceof GenericEvent) {
-				return;
-			}
-			$log->info('\OC\DB\Migrator::checkTable: ' . $event->getSubject() . ' (' . $event->getArgument(0) . ' of ' . $event->getArgument(1) . ')', ['app' => 'updater']);
-		});
-
-		$repairListener = function($event) use ($log) {
-			if (!$event instanceof GenericEvent) {
-				return;
-			}
-			switch ($event->getSubject()) {
-				case '\OC\Repair::startProgress':
-					$log->info('\OC\Repair::startProgress: Starting ... ' . $event->getArgument(1) .  ' (' . $event->getArgument(0) . ')', ['app' => 'updater']);
-					break;
-				case '\OC\Repair::advance':
-					$desc = $event->getArgument(1);
-					if (empty($desc)) {
-						$desc = '';
-					}
-					$log->info('\OC\Repair::advance: ' . $desc . ' (' . $event->getArgument(0) . ')', ['app' => 'updater']);
-
-					break;
-				case '\OC\Repair::finishProgress':
-					$log->info('\OC\Repair::finishProgress', ['app' => 'updater']);
-					break;
-				case '\OC\Repair::step':
-					$log->info('\OC\Repair::step: Repair step: ' . $event->getArgument(0), ['app' => 'updater']);
-					break;
-				case '\OC\Repair::info':
-					$log->info('\OC\Repair::info: Repair info: ' . $event->getArgument(0), ['app' => 'updater']);
-					break;
-				case '\OC\Repair::warning':
-					$log->warning('\OC\Repair::warning: Repair warning: ' . $event->getArgument(0), ['app' => 'updater']);
-					break;
-				case '\OC\Repair::error':
-					$log->error('\OC\Repair::error: Repair error: ' . $event->getArgument(0), ['app' => 'updater']);
-					break;
-			}
-		};
-
-		$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);
-
-
-		$this->listen('\OC\Updater', 'maintenanceEnabled', function () use($log) {
-			$log->info('\OC\Updater::maintenanceEnabled: Turned on maintenance mode', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'maintenanceDisabled', function () use($log) {
-			$log->info('\OC\Updater::maintenanceDisabled: Turned off maintenance mode', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'maintenanceActive', function () use($log) {
-			$log->info('\OC\Updater::maintenanceActive: Maintenance mode is kept active', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'updateEnd', function ($success) use($log) {
-			if ($success) {
-				$log->info('\OC\Updater::updateEnd: Update successful', ['app' => 'updater']);
-			} else {
-				$log->error('\OC\Updater::updateEnd: Update failed', ['app' => 'updater']);
-			}
-		});
-		$this->listen('\OC\Updater', 'dbUpgradeBefore', function () use($log) {
-			$log->info('\OC\Updater::dbUpgradeBefore: Updating database schema', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'dbUpgrade', function () use($log) {
-			$log->info('\OC\Updater::dbUpgrade: Updated database', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'dbSimulateUpgradeBefore', function () use($log) {
-			$log->info('\OC\Updater::dbSimulateUpgradeBefore: Checking whether the database schema can be updated (this can take a long time depending on the database size)', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'dbSimulateUpgrade', function () use($log) {
-			$log->info('\OC\Updater::dbSimulateUpgrade: Checked database schema update', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'incompatibleAppDisabled', function ($app) use($log) {
-			$log->info('\OC\Updater::incompatibleAppDisabled: Disabled incompatible app: ' . $app, ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'checkAppStoreAppBefore', function ($app) use($log) {
-			$log->info('\OC\Updater::checkAppStoreAppBefore: Checking for update of app "' . $app . '" in appstore', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'upgradeAppStoreApp', function ($app) use($log) {
-			$log->info('\OC\Updater::upgradeAppStoreApp: Update app "' . $app . '" from appstore', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'checkAppStoreApp', function ($app) use($log) {
-			$log->info('\OC\Updater::checkAppStoreApp: Checked for update of app "' . $app . '" in appstore', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'appUpgradeCheckBefore', function () use ($log) {
-			$log->info('\OC\Updater::appUpgradeCheckBefore: Checking updates of apps', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'appSimulateUpdate', function ($app) use ($log) {
-			$log->info('\OC\Updater::appSimulateUpdate: Checking whether the database schema for <' . $app . '> can be updated (this can take a long time depending on the database size)', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'appUpgradeCheck', function () use ($log) {
-			$log->info('\OC\Updater::appUpgradeCheck: Checked database schema update for apps', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'appUpgradeStarted', function ($app) use ($log) {
-			$log->info('\OC\Updater::appUpgradeStarted: Updating <' . $app . '> ...', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'appUpgrade', function ($app, $version) use ($log) {
-			$log->info('\OC\Updater::appUpgrade: Updated <' . $app . '> to ' . $version, ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'failure', function ($message) use($log) {
-			$log->error('\OC\Updater::failure: ' . $message, ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'setDebugLogLevel', function () use($log) {
-			$log->info('\OC\Updater::setDebugLogLevel: Set log level to debug', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'resetLogLevel', function ($logLevel, $logLevelName) use($log) {
-			$log->info('\OC\Updater::resetLogLevel: Reset log level to ' . $logLevelName . '(' . $logLevel . ')', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'startCheckCodeIntegrity', function () use($log) {
-			$log->info('\OC\Updater::startCheckCodeIntegrity: Starting code integrity check...', ['app' => 'updater']);
-		});
-		$this->listen('\OC\Updater', 'finishedCheckCodeIntegrity', function () use($log) {
-			$log->info('\OC\Updater::finishedCheckCodeIntegrity: Finished code integrity check', ['app' => 'updater']);
-		});
-
-	}
-	private function waitForCronToFinish() {
-		while ($this->jobList->isAnyJobRunning()) {
-			$this->emit('\OC\Updater', 'waitForCronToFinish');
-			sleep(5);
-		}
-	}
+    /** @var ILogger $log */
+    private $log;
+
+    /** @var IConfig */
+    private $config;
+
+    /** @var Checker */
+    private $checker;
+
+    /** @var Installer */
+    private $installer;
+
+    /** @var IJobList */
+    private $jobList;
+
+    private $logLevelNames = [
+        0 => 'Debug',
+        1 => 'Info',
+        2 => 'Warning',
+        3 => 'Error',
+        4 => 'Fatal',
+    ];
+
+    public function __construct(IConfig $config,
+                                Checker $checker,
+                                ILogger $log,
+                                Installer $installer,
+                                IJobList $jobList) {
+        $this->log = $log;
+        $this->config = $config;
+        $this->checker = $checker;
+        $this->installer = $installer;
+        $this->jobList = $jobList;
+    }
+
+    /**
+     * runs the update actions in maintenance mode, does not upgrade the source files
+     * except the main .htaccess file
+     *
+     * @return bool true if the operation succeeded, false otherwise
+     */
+    public function upgrade() {
+        $this->emitRepairEvents();
+        $this->logAllEvents();
+
+        $logLevel = $this->config->getSystemValue('loglevel', ILogger::WARN);
+        $this->emit('\OC\Updater', 'setDebugLogLevel', [ $logLevel, $this->logLevelNames[$logLevel] ]);
+        $this->config->setSystemValue('loglevel', ILogger::DEBUG);
+
+        $wasMaintenanceModeEnabled = $this->config->getSystemValue('maintenance', false);
+
+        if(!$wasMaintenanceModeEnabled) {
+            $this->config->setSystemValue('maintenance', true);
+            $this->emit('\OC\Updater', 'maintenanceEnabled');
+        }
+
+        $installedVersion = $this->config->getSystemValue('version', '0.0.0');
+        $currentVersion = implode('.', \OCP\Util::getVersion());
+
+        // see https://github.com/nextcloud/server/issues/9992 for potential problem
+        if (version_compare($installedVersion, '14.0.0.9', '>=')) {
+            $this->waitForCronToFinish();
+        }
+
+        $this->log->debug('starting upgrade from ' . $installedVersion . ' to ' . $currentVersion, array('app' => 'core'));
+
+        $success = true;
+        try {
+            $this->doUpgrade($currentVersion, $installedVersion);
+        } catch (HintException $exception) {
+            $this->log->logException($exception, ['app' => 'core']);
+            $this->emit('\OC\Updater', 'failure', array($exception->getMessage() . ': ' .$exception->getHint()));
+            $success = false;
+        } catch (\Exception $exception) {
+            $this->log->logException($exception, ['app' => 'core']);
+            $this->emit('\OC\Updater', 'failure', array(get_class($exception) . ': ' .$exception->getMessage()));
+            $success = false;
+        }
+
+        $this->emit('\OC\Updater', 'updateEnd', array($success));
+
+        if(!$wasMaintenanceModeEnabled && $success) {
+            $this->config->setSystemValue('maintenance', false);
+            $this->emit('\OC\Updater', 'maintenanceDisabled');
+        } else {
+            $this->emit('\OC\Updater', 'maintenanceActive');
+        }
+
+        $this->emit('\OC\Updater', 'resetLogLevel', [ $logLevel, $this->logLevelNames[$logLevel] ]);
+        $this->config->setSystemValue('loglevel', $logLevel);
+        $this->config->setSystemValue('installed', true);
+
+        return $success;
+    }
+
+    /**
+     * Return version from which this version is allowed to upgrade from
+     *
+     * @return array allowed previous versions per vendor
+     */
+    private function getAllowedPreviousVersions() {
+        // this should really be a JSON file
+        require \OC::$SERVERROOT . '/version.php';
+        /** @var array $OC_VersionCanBeUpgradedFrom */
+        return $OC_VersionCanBeUpgradedFrom;
+    }
+
+    /**
+     * Return vendor from which this version was published
+     *
+     * @return string Get the vendor
+     */
+    private function getVendor() {
+        // this should really be a JSON file
+        require \OC::$SERVERROOT . '/version.php';
+        /** @var string $vendor */
+        return (string) $vendor;
+    }
+
+    /**
+     * Whether an upgrade to a specified version is possible
+     * @param string $oldVersion
+     * @param string $newVersion
+     * @param array $allowedPreviousVersions
+     * @return bool
+     */
+    public function isUpgradePossible($oldVersion, $newVersion, array $allowedPreviousVersions) {
+        $version = explode('.', $oldVersion);
+        $majorMinor = $version[0] . '.' . $version[1];
+
+        $currentVendor = $this->config->getAppValue('core', 'vendor', '');
+
+        // Vendor was not set correctly on install, so we have to white-list known versions
+        if ($currentVendor === '' && isset($allowedPreviousVersions['owncloud'][$oldVersion])) {
+            $currentVendor = 'owncloud';
+        }
+
+        if ($currentVendor === 'nextcloud') {
+            return isset($allowedPreviousVersions[$currentVendor][$majorMinor])
+                && (version_compare($oldVersion, $newVersion, '<=') ||
+                    $this->config->getSystemValue('debug', false));
+        }
+
+        // Check if the instance can be migrated
+        return isset($allowedPreviousVersions[$currentVendor][$majorMinor]) ||
+            isset($allowedPreviousVersions[$currentVendor][$oldVersion]);
+    }
+
+    /**
+     * runs the update actions in maintenance mode, does not upgrade the source files
+     * except the main .htaccess file
+     *
+     * @param string $currentVersion current version to upgrade to
+     * @param string $installedVersion previous version from which to upgrade from
+     *
+     * @throws \Exception
+     */
+    private function doUpgrade($currentVersion, $installedVersion) {
+        // Stop update if the update is over several major versions
+        $allowedPreviousVersions = $this->getAllowedPreviousVersions();
+        if (!$this->isUpgradePossible($installedVersion, $currentVersion, $allowedPreviousVersions)) {
+            throw new \Exception('Updates between multiple major versions and downgrades are unsupported.');
+        }
+
+        // Update .htaccess files
+        try {
+            Setup::updateHtaccess();
+            Setup::protectDataDirectory();
+        } catch (\Exception $e) {
+            throw new \Exception($e->getMessage());
+        }
+
+        // create empty file in data dir, so we can later find
+        // out that this is indeed an ownCloud data directory
+        // (in case it didn't exist before)
+        file_put_contents($this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/.ocdata', '');
+
+        // pre-upgrade repairs
+        $repair = new Repair(Repair::getBeforeUpgradeRepairSteps(), \OC::$server->getEventDispatcher());
+        $repair->run();
+
+        $this->doCoreUpgrade();
+
+        try {
+            // TODO: replace with the new repair step mechanism https://github.com/owncloud/core/pull/24378
+            Setup::installBackgroundJobs();
+        } catch (\Exception $e) {
+            throw new \Exception($e->getMessage());
+        }
+
+        // update all shipped apps
+        $this->checkAppsRequirements();
+        $this->doAppUpgrade();
+
+        // Update the appfetchers version so it downloads the correct list from the appstore
+        \OC::$server->getAppFetcher()->setVersion($currentVersion);
+
+        // upgrade appstore apps
+        $this->upgradeAppStoreApps(\OC::$server->getAppManager()->getInstalledApps());
+
+        // install new shipped apps on upgrade
+        OC_App::loadApps(['authentication']);
+        $errors = Installer::installShippedApps(true);
+        foreach ($errors as $appId => $exception) {
+            /** @var \Exception $exception */
+            $this->log->logException($exception, ['app' => $appId]);
+            $this->emit('\OC\Updater', 'failure', [$appId . ': ' . $exception->getMessage()]);
+        }
+
+        // post-upgrade repairs
+        $repair = new Repair(Repair::getRepairSteps(), \OC::$server->getEventDispatcher());
+        $repair->run();
+
+        //Invalidate update feed
+        $this->config->setAppValue('core', 'lastupdatedat', 0);
+
+        // Check for code integrity if not disabled
+        if(\OC::$server->getIntegrityCodeChecker()->isCodeCheckEnforced()) {
+            $this->emit('\OC\Updater', 'startCheckCodeIntegrity');
+            $this->checker->runInstanceVerification();
+            $this->emit('\OC\Updater', 'finishedCheckCodeIntegrity');
+        }
+
+        // only set the final version if everything went well
+        $this->config->setSystemValue('version', implode('.', Util::getVersion()));
+        $this->config->setAppValue('core', 'vendor', $this->getVendor());
+    }
+
+    protected function doCoreUpgrade() {
+        $this->emit('\OC\Updater', 'dbUpgradeBefore');
+
+        // execute core migrations
+        $ms = new MigrationService('core', \OC::$server->getDatabaseConnection());
+        $ms->migrate();
+
+        $this->emit('\OC\Updater', 'dbUpgrade');
+    }
+
+    /**
+     * @param string $version the oc version to check app compatibility with
+     */
+    protected function checkAppUpgrade($version) {
+        $apps = \OC_App::getEnabledApps();
+        $this->emit('\OC\Updater', 'appUpgradeCheckBefore');
+
+        $appManager = \OC::$server->getAppManager();
+        foreach ($apps as $appId) {
+            $info = \OC_App::getAppInfo($appId);
+            $compatible = \OC_App::isAppCompatible($version, $info);
+            $isShipped = $appManager->isShipped($appId);
+
+            if ($compatible && $isShipped && \OC_App::shouldUpgrade($appId)) {
+                /**
+                 * FIXME: The preupdate check is performed before the database migration, otherwise database changes
+                 * are not possible anymore within it. - Consider this when touching the code.
+                 * @link https://github.com/owncloud/core/issues/10980
+                 * @see \OC_App::updateApp
+                 */
+                if (file_exists(\OC_App::getAppPath($appId) . '/appinfo/preupdate.php')) {
+                    $this->includePreUpdate($appId);
+                }
+                if (file_exists(\OC_App::getAppPath($appId) . '/appinfo/database.xml')) {
+                    $this->emit('\OC\Updater', 'appSimulateUpdate', array($appId));
+                    \OC_DB::simulateUpdateDbFromStructure(\OC_App::getAppPath($appId) . '/appinfo/database.xml');
+                }
+            }
+        }
+
+        $this->emit('\OC\Updater', 'appUpgradeCheck');
+    }
+
+    /**
+     * Includes the pre-update file. Done here to prevent namespace mixups.
+     * @param string $appId
+     */
+    private function includePreUpdate($appId) {
+        include \OC_App::getAppPath($appId) . '/appinfo/preupdate.php';
+    }
+
+    /**
+     * upgrades all apps within a major ownCloud upgrade. Also loads "priority"
+     * (types authentication, filesystem, logging, in that order) afterwards.
+     *
+     * @throws NeedsUpdateException
+     */
+    protected function doAppUpgrade() {
+        $apps = \OC_App::getEnabledApps();
+        $priorityTypes = array('authentication', 'filesystem', 'logging');
+        $pseudoOtherType = 'other';
+        $stacks = array($pseudoOtherType => array());
+
+        foreach ($apps as $appId) {
+            $priorityType = false;
+            foreach ($priorityTypes as $type) {
+                if(!isset($stacks[$type])) {
+                    $stacks[$type] = array();
+                }
+                if (\OC_App::isType($appId, [$type])) {
+                    $stacks[$type][] = $appId;
+                    $priorityType = true;
+                    break;
+                }
+            }
+            if (!$priorityType) {
+                $stacks[$pseudoOtherType][] = $appId;
+            }
+        }
+        foreach ($stacks as $type => $stack) {
+            foreach ($stack as $appId) {
+                if (\OC_App::shouldUpgrade($appId)) {
+                    $this->emit('\OC\Updater', 'appUpgradeStarted', [$appId, \OC_App::getAppVersion($appId)]);
+                    \OC_App::updateApp($appId);
+                    $this->emit('\OC\Updater', 'appUpgrade', [$appId, \OC_App::getAppVersion($appId)]);
+                }
+                if($type !== $pseudoOtherType) {
+                    // load authentication, filesystem and logging apps after
+                    // upgrading them. Other apps my need to rely on modifying
+                    // user and/or filesystem aspects.
+                    \OC_App::loadApp($appId);
+                }
+            }
+        }
+    }
+
+    /**
+     * check if the current enabled apps are compatible with the current
+     * ownCloud version. disable them if not.
+     * This is important if you upgrade ownCloud and have non ported 3rd
+     * party apps installed.
+     *
+     * @return array
+     * @throws \Exception
+     */
+    private function checkAppsRequirements() {
+        $isCoreUpgrade = $this->isCodeUpgrade();
+        $apps = OC_App::getEnabledApps();
+        $version = implode('.', Util::getVersion());
+        $disabledApps = [];
+        $appManager = \OC::$server->getAppManager();
+        foreach ($apps as $app) {
+            // check if the app is compatible with this version of ownCloud
+            $info = OC_App::getAppInfo($app);
+            if($info === null || !OC_App::isAppCompatible($version, $info)) {
+                if ($appManager->isShipped($app)) {
+                    throw new \UnexpectedValueException('The files of the app "' . $app . '" were not correctly replaced before running the update');
+                }
+                \OC::$server->getAppManager()->disableApp($app);
+                $this->emit('\OC\Updater', 'incompatibleAppDisabled', array($app));
+            }
+            // no need to disable any app in case this is a non-core upgrade
+            if (!$isCoreUpgrade) {
+                continue;
+            }
+            // shipped apps will remain enabled
+            if ($appManager->isShipped($app)) {
+                continue;
+            }
+            // authentication and session apps will remain enabled as well
+            if (OC_App::isType($app, ['session', 'authentication'])) {
+                continue;
+            }
+        }
+        return $disabledApps;
+    }
+
+    /**
+     * @return bool
+     */
+    private function isCodeUpgrade() {
+        $installedVersion = $this->config->getSystemValue('version', '0.0.0');
+        $currentVersion = implode('.', Util::getVersion());
+        if (version_compare($currentVersion, $installedVersion, '>')) {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * @param array $disabledApps
+     * @throws \Exception
+     */
+    private function upgradeAppStoreApps(array $disabledApps) {
+        foreach($disabledApps as $app) {
+            try {
+                $this->emit('\OC\Updater', 'checkAppStoreAppBefore', [$app]);
+                if ($this->installer->isUpdateAvailable($app)) {
+                    $this->emit('\OC\Updater', 'upgradeAppStoreApp', [$app]);
+                    $this->installer->updateAppstoreApp($app);
+                }
+                $this->emit('\OC\Updater', 'checkAppStoreApp', [$app]);
+            } catch (\Exception $ex) {
+                $this->log->logException($ex, ['app' => 'core']);
+            }
+        }
+    }
+
+    /**
+     * Forward messages emitted by the repair routine
+     */
+    private function emitRepairEvents() {
+        $dispatcher = \OC::$server->getEventDispatcher();
+        $dispatcher->addListener('\OC\Repair::warning', function ($event) {
+            if ($event instanceof GenericEvent) {
+                $this->emit('\OC\Updater', 'repairWarning', $event->getArguments());
+            }
+        });
+        $dispatcher->addListener('\OC\Repair::error', function ($event) {
+            if ($event instanceof GenericEvent) {
+                $this->emit('\OC\Updater', 'repairError', $event->getArguments());
+            }
+        });
+        $dispatcher->addListener('\OC\Repair::info', function ($event) {
+            if ($event instanceof GenericEvent) {
+                $this->emit('\OC\Updater', 'repairInfo', $event->getArguments());
+            }
+        });
+        $dispatcher->addListener('\OC\Repair::step', function ($event) {
+            if ($event instanceof GenericEvent) {
+                $this->emit('\OC\Updater', 'repairStep', $event->getArguments());
+            }
+        });
+    }
+
+    private function logAllEvents() {
+        $log = $this->log;
+
+        $dispatcher = \OC::$server->getEventDispatcher();
+        $dispatcher->addListener('\OC\DB\Migrator::executeSql', function($event) use ($log) {
+            if (!$event instanceof GenericEvent) {
+                return;
+            }
+            $log->info('\OC\DB\Migrator::executeSql: ' . $event->getSubject() . ' (' . $event->getArgument(0) . ' of ' . $event->getArgument(1) . ')', ['app' => 'updater']);
+        });
+        $dispatcher->addListener('\OC\DB\Migrator::checkTable', function($event) use ($log) {
+            if (!$event instanceof GenericEvent) {
+                return;
+            }
+            $log->info('\OC\DB\Migrator::checkTable: ' . $event->getSubject() . ' (' . $event->getArgument(0) . ' of ' . $event->getArgument(1) . ')', ['app' => 'updater']);
+        });
+
+        $repairListener = function($event) use ($log) {
+            if (!$event instanceof GenericEvent) {
+                return;
+            }
+            switch ($event->getSubject()) {
+                case '\OC\Repair::startProgress':
+                    $log->info('\OC\Repair::startProgress: Starting ... ' . $event->getArgument(1) .  ' (' . $event->getArgument(0) . ')', ['app' => 'updater']);
+                    break;
+                case '\OC\Repair::advance':
+                    $desc = $event->getArgument(1);
+                    if (empty($desc)) {
+                        $desc = '';
+                    }
+                    $log->info('\OC\Repair::advance: ' . $desc . ' (' . $event->getArgument(0) . ')', ['app' => 'updater']);
+
+                    break;
+                case '\OC\Repair::finishProgress':
+                    $log->info('\OC\Repair::finishProgress', ['app' => 'updater']);
+                    break;
+                case '\OC\Repair::step':
+                    $log->info('\OC\Repair::step: Repair step: ' . $event->getArgument(0), ['app' => 'updater']);
+                    break;
+                case '\OC\Repair::info':
+                    $log->info('\OC\Repair::info: Repair info: ' . $event->getArgument(0), ['app' => 'updater']);
+                    break;
+                case '\OC\Repair::warning':
+                    $log->warning('\OC\Repair::warning: Repair warning: ' . $event->getArgument(0), ['app' => 'updater']);
+                    break;
+                case '\OC\Repair::error':
+                    $log->error('\OC\Repair::error: Repair error: ' . $event->getArgument(0), ['app' => 'updater']);
+                    break;
+            }
+        };
+
+        $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);
+
+
+        $this->listen('\OC\Updater', 'maintenanceEnabled', function () use($log) {
+            $log->info('\OC\Updater::maintenanceEnabled: Turned on maintenance mode', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'maintenanceDisabled', function () use($log) {
+            $log->info('\OC\Updater::maintenanceDisabled: Turned off maintenance mode', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'maintenanceActive', function () use($log) {
+            $log->info('\OC\Updater::maintenanceActive: Maintenance mode is kept active', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'updateEnd', function ($success) use($log) {
+            if ($success) {
+                $log->info('\OC\Updater::updateEnd: Update successful', ['app' => 'updater']);
+            } else {
+                $log->error('\OC\Updater::updateEnd: Update failed', ['app' => 'updater']);
+            }
+        });
+        $this->listen('\OC\Updater', 'dbUpgradeBefore', function () use($log) {
+            $log->info('\OC\Updater::dbUpgradeBefore: Updating database schema', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'dbUpgrade', function () use($log) {
+            $log->info('\OC\Updater::dbUpgrade: Updated database', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'dbSimulateUpgradeBefore', function () use($log) {
+            $log->info('\OC\Updater::dbSimulateUpgradeBefore: Checking whether the database schema can be updated (this can take a long time depending on the database size)', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'dbSimulateUpgrade', function () use($log) {
+            $log->info('\OC\Updater::dbSimulateUpgrade: Checked database schema update', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'incompatibleAppDisabled', function ($app) use($log) {
+            $log->info('\OC\Updater::incompatibleAppDisabled: Disabled incompatible app: ' . $app, ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'checkAppStoreAppBefore', function ($app) use($log) {
+            $log->info('\OC\Updater::checkAppStoreAppBefore: Checking for update of app "' . $app . '" in appstore', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'upgradeAppStoreApp', function ($app) use($log) {
+            $log->info('\OC\Updater::upgradeAppStoreApp: Update app "' . $app . '" from appstore', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'checkAppStoreApp', function ($app) use($log) {
+            $log->info('\OC\Updater::checkAppStoreApp: Checked for update of app "' . $app . '" in appstore', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'appUpgradeCheckBefore', function () use ($log) {
+            $log->info('\OC\Updater::appUpgradeCheckBefore: Checking updates of apps', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'appSimulateUpdate', function ($app) use ($log) {
+            $log->info('\OC\Updater::appSimulateUpdate: Checking whether the database schema for <' . $app . '> can be updated (this can take a long time depending on the database size)', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'appUpgradeCheck', function () use ($log) {
+            $log->info('\OC\Updater::appUpgradeCheck: Checked database schema update for apps', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'appUpgradeStarted', function ($app) use ($log) {
+            $log->info('\OC\Updater::appUpgradeStarted: Updating <' . $app . '> ...', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'appUpgrade', function ($app, $version) use ($log) {
+            $log->info('\OC\Updater::appUpgrade: Updated <' . $app . '> to ' . $version, ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'failure', function ($message) use($log) {
+            $log->error('\OC\Updater::failure: ' . $message, ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'setDebugLogLevel', function () use($log) {
+            $log->info('\OC\Updater::setDebugLogLevel: Set log level to debug', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'resetLogLevel', function ($logLevel, $logLevelName) use($log) {
+            $log->info('\OC\Updater::resetLogLevel: Reset log level to ' . $logLevelName . '(' . $logLevel . ')', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'startCheckCodeIntegrity', function () use($log) {
+            $log->info('\OC\Updater::startCheckCodeIntegrity: Starting code integrity check...', ['app' => 'updater']);
+        });
+        $this->listen('\OC\Updater', 'finishedCheckCodeIntegrity', function () use($log) {
+            $log->info('\OC\Updater::finishedCheckCodeIntegrity: Finished code integrity check', ['app' => 'updater']);
+        });
+
+    }
+    private function waitForCronToFinish() {
+        while ($this->jobList->isAnyJobRunning()) {
+            $this->emit('\OC\Updater', 'waitForCronToFinish');
+            sleep(5);
+        }
+    }
 
 }
 

lib/private/Repair.php

Indentation +166 added lines, -166 removed lines

@@ -56,170 +56,170 @@
 use Symfony\Component\EventDispatcher\GenericEvent;
 
 class Repair implements IOutput{
-	/* @var IRepairStep[] */
-	private $repairSteps;
-	/** @var EventDispatcher */
-	private $dispatcher;
-	/** @var string */
-	private $currentStep;
-
-	/**
-	 * Creates a new repair step runner
-	 *
-	 * @param IRepairStep[] $repairSteps array of RepairStep instances
-	 * @param EventDispatcher $dispatcher
-	 */
-	public function __construct($repairSteps = [], EventDispatcher $dispatcher = null) {
-		$this->repairSteps = $repairSteps;
-		$this->dispatcher = $dispatcher;
-	}
-
-	/**
-	 * Run a series of repair steps for common problems
-	 */
-	public function run() {
-		if (count($this->repairSteps) === 0) {
-			$this->emit('\OC\Repair', 'info', array('No repair steps available'));
-			return;
-		}
-		// run each repair step
-		foreach ($this->repairSteps as $step) {
-			$this->currentStep = $step->getName();
-			$this->emit('\OC\Repair', 'step', [$this->currentStep]);
-			$step->run($this);
-		}
-	}
-
-	/**
-	 * Add repair step
-	 *
-	 * @param IRepairStep|string $repairStep repair step
-	 * @throws \Exception
-	 */
-	public function addStep($repairStep) {
-		if (is_string($repairStep)) {
-			try {
-				$s = \OC::$server->query($repairStep);
-			} catch (QueryException $e) {
-				if (class_exists($repairStep)) {
-					$s = new $repairStep();
-				} else {
-					throw new \Exception("Repair step '$repairStep' is unknown");
-				}
-			}
-
-			if ($s instanceof IRepairStep) {
-				$this->repairSteps[] = $s;
-			} else {
-				throw new \Exception("Repair step '$repairStep' is not of type \\OCP\\Migration\\IRepairStep");
-			}
-		} else {
-			$this->repairSteps[] = $repairStep;
-		}
-	}
-
-	/**
-	 * Returns the default repair steps to be run on the
-	 * command line or after an upgrade.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getRepairSteps() {
-		return [
-			new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), \OC::$server->getDatabaseConnection(), false),
-			new RepairMimeTypes(\OC::$server->getConfig()),
-			new CleanTags(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager()),
-			new RepairInvalidShares(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()),
-			new RemoveRootShares(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager(), \OC::$server->getLazyRootFolder()),
-			new MoveUpdaterStepFile(\OC::$server->getConfig()),
-			new FixMountStorages(\OC::$server->getDatabaseConnection()),
-			new RepairInvalidPaths(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
-			new AddLogRotateJob(\OC::$server->getJobList()),
-			new ClearFrontendCaches(\OC::$server->getMemCacheFactory(), \OC::$server->query(SCSSCacher::class), \OC::$server->query(JSCombiner::class)),
-			new AddPreviewBackgroundCleanupJob(\OC::$server->getJobList()),
-			new AddCleanupUpdaterBackupsJob(\OC::$server->getJobList()),
-			new RepairPendingCronJobs(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
-		];
-	}
-
-	/**
-	 * Returns expensive repair steps to be run on the
-	 * command line with a special option.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getExpensiveRepairSteps() {
-		return [
-			new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager()),
-		];
-	}
-
-	/**
-	 * Returns the repair steps to be run before an
-	 * upgrade.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getBeforeUpgradeRepairSteps() {
-		$connection = \OC::$server->getDatabaseConnection();
-		$config = \OC::$server->getConfig();
-		$steps = [
-			new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), $connection, true),
-			new SqliteAutoincrement($connection),
-			new SaveAccountsTableData($connection, $config),
-			new DropAccountTermsTable($connection),
-		];
-
-		return $steps;
-	}
-
-	/**
-	 * @param string $scope
-	 * @param string $method
-	 * @param array $arguments
-	 */
-	public function emit($scope, $method, array $arguments = []) {
-		if (!is_null($this->dispatcher)) {
-			$this->dispatcher->dispatch("$scope::$method",
-				new GenericEvent("$scope::$method", $arguments));
-		}
-	}
-
-	public function info($string) {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'info', array($string));
-	}
-
-	/**
-	 * @param string $message
-	 */
-	public function warning($message) {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'warning', [$message]);
-	}
-
-	/**
-	 * @param int $max
-	 */
-	public function startProgress($max = 0) {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'startProgress', [$max, $this->currentStep]);
-	}
-
-	/**
-	 * @param int $step
-	 * @param string $description
-	 */
-	public function advance($step = 1, $description = '') {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'advance', [$step, $description]);
-	}
-
-	/**
-	 * @param int $max
-	 */
-	public function finishProgress() {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'finishProgress', []);
-	}
+    /* @var IRepairStep[] */
+    private $repairSteps;
+    /** @var EventDispatcher */
+    private $dispatcher;
+    /** @var string */
+    private $currentStep;
+
+    /**
+     * Creates a new repair step runner
+     *
+     * @param IRepairStep[] $repairSteps array of RepairStep instances
+     * @param EventDispatcher $dispatcher
+     */
+    public function __construct($repairSteps = [], EventDispatcher $dispatcher = null) {
+        $this->repairSteps = $repairSteps;
+        $this->dispatcher = $dispatcher;
+    }
+
+    /**
+     * Run a series of repair steps for common problems
+     */
+    public function run() {
+        if (count($this->repairSteps) === 0) {
+            $this->emit('\OC\Repair', 'info', array('No repair steps available'));
+            return;
+        }
+        // run each repair step
+        foreach ($this->repairSteps as $step) {
+            $this->currentStep = $step->getName();
+            $this->emit('\OC\Repair', 'step', [$this->currentStep]);
+            $step->run($this);
+        }
+    }
+
+    /**
+     * Add repair step
+     *
+     * @param IRepairStep|string $repairStep repair step
+     * @throws \Exception
+     */
+    public function addStep($repairStep) {
+        if (is_string($repairStep)) {
+            try {
+                $s = \OC::$server->query($repairStep);
+            } catch (QueryException $e) {
+                if (class_exists($repairStep)) {
+                    $s = new $repairStep();
+                } else {
+                    throw new \Exception("Repair step '$repairStep' is unknown");
+                }
+            }
+
+            if ($s instanceof IRepairStep) {
+                $this->repairSteps[] = $s;
+            } else {
+                throw new \Exception("Repair step '$repairStep' is not of type \\OCP\\Migration\\IRepairStep");
+            }
+        } else {
+            $this->repairSteps[] = $repairStep;
+        }
+    }
+
+    /**
+     * Returns the default repair steps to be run on the
+     * command line or after an upgrade.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getRepairSteps() {
+        return [
+            new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), \OC::$server->getDatabaseConnection(), false),
+            new RepairMimeTypes(\OC::$server->getConfig()),
+            new CleanTags(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager()),
+            new RepairInvalidShares(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()),
+            new RemoveRootShares(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager(), \OC::$server->getLazyRootFolder()),
+            new MoveUpdaterStepFile(\OC::$server->getConfig()),
+            new FixMountStorages(\OC::$server->getDatabaseConnection()),
+            new RepairInvalidPaths(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
+            new AddLogRotateJob(\OC::$server->getJobList()),
+            new ClearFrontendCaches(\OC::$server->getMemCacheFactory(), \OC::$server->query(SCSSCacher::class), \OC::$server->query(JSCombiner::class)),
+            new AddPreviewBackgroundCleanupJob(\OC::$server->getJobList()),
+            new AddCleanupUpdaterBackupsJob(\OC::$server->getJobList()),
+            new RepairPendingCronJobs(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
+        ];
+    }
+
+    /**
+     * Returns expensive repair steps to be run on the
+     * command line with a special option.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getExpensiveRepairSteps() {
+        return [
+            new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager()),
+        ];
+    }
+
+    /**
+     * Returns the repair steps to be run before an
+     * upgrade.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getBeforeUpgradeRepairSteps() {
+        $connection = \OC::$server->getDatabaseConnection();
+        $config = \OC::$server->getConfig();
+        $steps = [
+            new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), $connection, true),
+            new SqliteAutoincrement($connection),
+            new SaveAccountsTableData($connection, $config),
+            new DropAccountTermsTable($connection),
+        ];
+
+        return $steps;
+    }
+
+    /**
+     * @param string $scope
+     * @param string $method
+     * @param array $arguments
+     */
+    public function emit($scope, $method, array $arguments = []) {
+        if (!is_null($this->dispatcher)) {
+            $this->dispatcher->dispatch("$scope::$method",
+                new GenericEvent("$scope::$method", $arguments));
+        }
+    }
+
+    public function info($string) {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'info', array($string));
+    }
+
+    /**
+     * @param string $message
+     */
+    public function warning($message) {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'warning', [$message]);
+    }
+
+    /**
+     * @param int $max
+     */
+    public function startProgress($max = 0) {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'startProgress', [$max, $this->currentStep]);
+    }
+
+    /**
+     * @param int $step
+     * @param string $description
+     */
+    public function advance($step = 1, $description = '') {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'advance', [$step, $description]);
+    }
+
+    /**
+     * @param int $max
+     */
+    public function finishProgress() {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'finishProgress', []);
+    }
 }

lib/private/Repair/NC14/RepairPendingCronJobs.php

Indentation +34 added lines, -34 removed lines

@@ -30,48 +30,48 @@
 use OCP\Migration\IRepairStep;
 
 class RepairPendingCronJobs implements IRepairStep {
-	const MAX_ROWS = 1000;
+    const MAX_ROWS = 1000;
 
-	/** @var IDBConnection */
-	private $connection;
-	/** @var IConfig */
-	private $config;
+    /** @var IDBConnection */
+    private $connection;
+    /** @var IConfig */
+    private $config;
 
-	public function __construct(IDBConnection $connection, IConfig $config) {
-		$this->connection = $connection;
-		$this->config = $config;
-	}
+    public function __construct(IDBConnection $connection, IConfig $config) {
+        $this->connection = $connection;
+        $this->config = $config;
+    }
 
 
-	public function getName() {
-		return 'Repair pending cron jobs';
-	}
+    public function getName() {
+        return 'Repair pending cron jobs';
+    }
 
-	private function shouldRun() {
-		$versionFromBeforeUpdate = $this->config->getSystemValue('version', '0.0.0');
+    private function shouldRun() {
+        $versionFromBeforeUpdate = $this->config->getSystemValue('version', '0.0.0');
 
-		return version_compare($versionFromBeforeUpdate, '14.0.0.9', '<');
-	}
+        return version_compare($versionFromBeforeUpdate, '14.0.0.9', '<');
+    }
 
-	/**
-	 * @suppress SqlInjectionChecker
-	 */
-	private function repair() {
-		$reset = $this->connection->getQueryBuilder();
-		$reset->update('jobs')
-			->set('reserved_at', $reset->expr()->literal(0, IQueryBuilder::PARAM_INT))
-			->where($reset->expr()->neq('reserved_at', $reset->expr()->literal(0, IQueryBuilder::PARAM_INT)));
+    /**
+     * @suppress SqlInjectionChecker
+     */
+    private function repair() {
+        $reset = $this->connection->getQueryBuilder();
+        $reset->update('jobs')
+            ->set('reserved_at', $reset->expr()->literal(0, IQueryBuilder::PARAM_INT))
+            ->where($reset->expr()->neq('reserved_at', $reset->expr()->literal(0, IQueryBuilder::PARAM_INT)));
 
-		return $reset->execute();
-	}
+        return $reset->execute();
+    }
 
-	public function run(IOutput $output) {
-		if ($this->shouldRun()) {
-			$count = $this->repair();
+    public function run(IOutput $output) {
+        if ($this->shouldRun()) {
+            $count = $this->repair();
 
-			$output->info('Repaired ' . $count . ' pending cron job(s).');
-		} else {
-			$output->info('No need to repair pending cron jobs.');
-		}
-	}
+            $output->info('Repaired ' . $count . ' pending cron job(s).');
+        } else {
+            $output->info('No need to repair pending cron jobs.');
+        }
+    }
 }

lib/private/BackgroundJob/JobList.php

Indentation +342 added lines, -342 removed lines

@@ -39,346 +39,346 @@
 
 class JobList implements IJobList {
 
-	/** @var IDBConnection */
-	protected $connection;
-
-	/**@var IConfig */
-	protected $config;
-
-	/**@var ITimeFactory */
-	protected $timeFactory;
-
-	/** @var int - 12 hours * 3600 seconds*/
-	private $jobTimeOut = 43200;
-
-	/**
-	 * @param IDBConnection $connection
-	 * @param IConfig $config
-	 * @param ITimeFactory $timeFactory
-	 */
-	public function __construct(IDBConnection $connection, IConfig $config, ITimeFactory $timeFactory) {
-		$this->connection = $connection;
-		$this->config = $config;
-		$this->timeFactory = $timeFactory;
-	}
-
-	/**
-	 * @param IJob|string $job
-	 * @param mixed $argument
-	 */
-	public function add($job, $argument = null) {
-		if (!$this->has($job, $argument)) {
-			if ($job instanceof IJob) {
-				$class = get_class($job);
-			} else {
-				$class = $job;
-			}
-
-			$argument = json_encode($argument);
-			if (strlen($argument) > 4000) {
-				throw new \InvalidArgumentException('Background job arguments can\'t exceed 4000 characters (json encoded)');
-			}
-
-			$query = $this->connection->getQueryBuilder();
-			$query->insert('jobs')
-				->values([
-					'class' => $query->createNamedParameter($class),
-					'argument' => $query->createNamedParameter($argument),
-					'last_run' => $query->createNamedParameter(0, IQueryBuilder::PARAM_INT),
-					'last_checked' => $query->createNamedParameter($this->timeFactory->getTime(), IQueryBuilder::PARAM_INT),
-				]);
-			$query->execute();
-		}
-	}
-
-	/**
-	 * @param IJob|string $job
-	 * @param mixed $argument
-	 */
-	public function remove($job, $argument = null) {
-		if ($job instanceof IJob) {
-			$class = get_class($job);
-		} else {
-			$class = $job;
-		}
-
-		$query = $this->connection->getQueryBuilder();
-		$query->delete('jobs')
-			->where($query->expr()->eq('class', $query->createNamedParameter($class)));
-		if (!is_null($argument)) {
-			$argument = json_encode($argument);
-			$query->andWhere($query->expr()->eq('argument', $query->createNamedParameter($argument)));
-		}
-		$query->execute();
-	}
-
-	/**
-	 * @param int $id
-	 */
-	protected function removeById($id) {
-		$query = $this->connection->getQueryBuilder();
-		$query->delete('jobs')
-			->where($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
-		$query->execute();
-	}
-
-	/**
-	 * check if a job is in the list
-	 *
-	 * @param IJob|string $job
-	 * @param mixed $argument
-	 * @return bool
-	 */
-	public function has($job, $argument) {
-		if ($job instanceof IJob) {
-			$class = get_class($job);
-		} else {
-			$class = $job;
-		}
-		$argument = json_encode($argument);
-
-		$query = $this->connection->getQueryBuilder();
-		$query->select('id')
-			->from('jobs')
-			->where($query->expr()->eq('class', $query->createNamedParameter($class)))
-			->andWhere($query->expr()->eq('argument', $query->createNamedParameter($argument)))
-			->setMaxResults(1);
-
-		$result = $query->execute();
-		$row = $result->fetch();
-		$result->closeCursor();
-
-		return (bool) $row;
-	}
-
-	/**
-	 * get all jobs in the list
-	 *
-	 * @return IJob[]
-	 * @deprecated 9.0.0 - This method is dangerous since it can cause load and
-	 * memory problems when creating too many instances.
-	 */
-	public function getAll() {
-		$query = $this->connection->getQueryBuilder();
-		$query->select('*')
-			->from('jobs');
-		$result = $query->execute();
-
-		$jobs = [];
-		while ($row = $result->fetch()) {
-			$job = $this->buildJob($row);
-			if ($job) {
-				$jobs[] = $job;
-			}
-		}
-		$result->closeCursor();
-
-		return $jobs;
-	}
-
-	/**
-	 * get the next job in the list
-	 *
-	 * @return IJob|null
-	 * @suppress SqlInjectionChecker
-	 */
-	public function getNext() {
-		$query = $this->connection->getQueryBuilder();
-		$query->select('*')
-			->from('jobs')
-			->where($query->expr()->lte('reserved_at', $query->createNamedParameter($this->timeFactory->getTime() - $this->jobTimeOut, IQueryBuilder::PARAM_INT)))
-			->andWhere($query->expr()->lte('last_checked', $query->createNamedParameter($this->timeFactory->getTime(), IQueryBuilder::PARAM_INT)))
-			->orderBy('last_checked', 'ASC')
-			->setMaxResults(1);
-
-		$update = $this->connection->getQueryBuilder();
-		$update->update('jobs')
-			->set('reserved_at', $update->createNamedParameter($this->timeFactory->getTime()))
-			->set('last_checked', $update->createNamedParameter($this->timeFactory->getTime()))
-			->where($update->expr()->eq('id', $update->createParameter('jobid')))
-			->andWhere($update->expr()->eq('reserved_at', $update->createParameter('reserved_at')))
-			->andWhere($update->expr()->eq('last_checked', $update->createParameter('last_checked')));
-
-		$result = $query->execute();
-		$row = $result->fetch();
-		$result->closeCursor();
-
-		if ($row) {
-			$update->setParameter('jobid', $row['id']);
-			$update->setParameter('reserved_at', $row['reserved_at']);
-			$update->setParameter('last_checked', $row['last_checked']);
-			$count = $update->execute();
-
-			if ($count === 0) {
-				// Background job already executed elsewhere, try again.
-				return $this->getNext();
-			}
-			$job = $this->buildJob($row);
-
-			if ($job === null) {
-				// set the last_checked to 12h in the future to not check failing jobs all over again
-				$reset = $this->connection->getQueryBuilder();
-				$reset->update('jobs')
-					->set('reserved_at', $reset->expr()->literal(0, IQueryBuilder::PARAM_INT))
-					->set('last_checked', $reset->createNamedParameter($this->timeFactory->getTime() + 12 * 3600, IQueryBuilder::PARAM_INT))
-					->where($reset->expr()->eq('id', $reset->createNamedParameter($row['id'], IQueryBuilder::PARAM_INT)));
-				$reset->execute();
-
-				// Background job from disabled app, try again.
-				return $this->getNext();
-			}
-
-			return $job;
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * @param int $id
-	 * @return IJob|null
-	 */
-	public function getById($id) {
-		$query = $this->connection->getQueryBuilder();
-		$query->select('*')
-			->from('jobs')
-			->where($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
-		$result = $query->execute();
-		$row = $result->fetch();
-		$result->closeCursor();
-
-		if ($row) {
-			return $this->buildJob($row);
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * get the job object from a row in the db
-	 *
-	 * @param array $row
-	 * @return IJob|null
-	 */
-	private function buildJob($row) {
-		try {
-			try {
-				// Try to load the job as a service
-				/** @var IJob $job */
-				$job = \OC::$server->query($row['class']);
-			} catch (QueryException $e) {
-				if (class_exists($row['class'])) {
-					$class = $row['class'];
-					$job = new $class();
-				} else {
-					// job from disabled app or old version of an app, no need to do anything
-					return null;
-				}
-			}
-
-			$job->setId($row['id']);
-			$job->setLastRun($row['last_run']);
-			$job->setArgument(json_decode($row['argument'], true));
-			return $job;
-		} catch (AutoloadNotAllowedException $e) {
-			// job is from a disabled app, ignore
-			return null;
-		}
-	}
-
-	/**
-	 * set the job that was last ran
-	 *
-	 * @param IJob $job
-	 */
-	public function setLastJob(IJob $job) {
-		$this->unlockJob($job);
-		$this->config->setAppValue('backgroundjob', 'lastjob', $job->getId());
-	}
-
-	/**
-	 * Remove the reservation for a job
-	 *
-	 * @param IJob $job
-	 * @suppress SqlInjectionChecker
-	 */
-	public function unlockJob(IJob $job) {
-		$query = $this->connection->getQueryBuilder();
-		$query->update('jobs')
-			->set('reserved_at', $query->expr()->literal(0, IQueryBuilder::PARAM_INT))
-			->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), IQueryBuilder::PARAM_INT)));
-		$query->execute();
-	}
-
-	/**
-	 * get the id of the last ran job
-	 *
-	 * @return int
-	 * @deprecated 9.1.0 - The functionality behind the value is deprecated, it
-	 *    only tells you which job finished last, but since we now allow multiple
-	 *    executors to run in parallel, it's not used to calculate the next job.
-	 */
-	public function getLastJob() {
-		return (int) $this->config->getAppValue('backgroundjob', 'lastjob', 0);
-	}
-
-	/**
-	 * set the lastRun of $job to now
-	 *
-	 * @param IJob $job
-	 */
-	public function setLastRun(IJob $job) {
-		$query = $this->connection->getQueryBuilder();
-		$query->update('jobs')
-			->set('last_run', $query->createNamedParameter(time(), IQueryBuilder::PARAM_INT))
-			->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), IQueryBuilder::PARAM_INT)));
-		$query->execute();
-	}
-
-	/**
-	 * @param IJob $job
-	 * @param $timeTaken
-	 */
-	public function setExecutionTime(IJob $job, $timeTaken) {
-		$query = $this->connection->getQueryBuilder();
-		$query->update('jobs')
-			->set('execution_duration', $query->createNamedParameter($timeTaken, IQueryBuilder::PARAM_INT))
-			->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), IQueryBuilder::PARAM_INT)));
-		$query->execute();
-	}
-
-	/**
-	 * checks if a job is still running (reserved_at time is smaller than 12 hours ago)
-	 *
-	 * Background information:
-	 *
-	 * The 12 hours is the same timeout that is also used to re-schedule an non-terminated
-	 * job (see getNext()). The idea here is to give a job enough time to run very
-	 * long but still be able to recognize that it maybe crashed and re-schedule it
-	 * after the timeout. It's more likely to be crashed at that time than it ran
-	 * that long.
-	 *
-	 * In theory it could lead to an nearly endless loop (as in - at most 12 hours).
-	 * The cron command will not start new jobs when maintenance mode is active and
-	 * this method is only executed in maintenance mode (see where it is called in
-	 * the upgrader class. So this means in the worst case we wait 12 hours when a
-	 * job has crashed. On the other hand: then the instance should be fixed anyways.
-	 *
-	 * @return bool
-	 */
-	public function isAnyJobRunning(): bool {
-		$query = $this->connection->getQueryBuilder();
-		$query->select('*')
-			->from('jobs')
-			->where($query->expr()->gt('reserved_at', $query->createNamedParameter($this->timeFactory->getTime() - $this->jobTimeOut, IQueryBuilder::PARAM_INT)))
-			->setMaxResults(1);
-		$result = $query->execute();
-		$row = $result->fetch();
-		$result->closeCursor();
-
-		if ($row) {
-			return true;
-		}
-		return false;
-	}
+    /** @var IDBConnection */
+    protected $connection;
+
+    /**@var IConfig */
+    protected $config;
+
+    /**@var ITimeFactory */
+    protected $timeFactory;
+
+    /** @var int - 12 hours * 3600 seconds*/
+    private $jobTimeOut = 43200;
+
+    /**
+     * @param IDBConnection $connection
+     * @param IConfig $config
+     * @param ITimeFactory $timeFactory
+     */
+    public function __construct(IDBConnection $connection, IConfig $config, ITimeFactory $timeFactory) {
+        $this->connection = $connection;
+        $this->config = $config;
+        $this->timeFactory = $timeFactory;
+    }
+
+    /**
+     * @param IJob|string $job
+     * @param mixed $argument
+     */
+    public function add($job, $argument = null) {
+        if (!$this->has($job, $argument)) {
+            if ($job instanceof IJob) {
+                $class = get_class($job);
+            } else {
+                $class = $job;
+            }
+
+            $argument = json_encode($argument);
+            if (strlen($argument) > 4000) {
+                throw new \InvalidArgumentException('Background job arguments can\'t exceed 4000 characters (json encoded)');
+            }
+
+            $query = $this->connection->getQueryBuilder();
+            $query->insert('jobs')
+                ->values([
+                    'class' => $query->createNamedParameter($class),
+                    'argument' => $query->createNamedParameter($argument),
+                    'last_run' => $query->createNamedParameter(0, IQueryBuilder::PARAM_INT),
+                    'last_checked' => $query->createNamedParameter($this->timeFactory->getTime(), IQueryBuilder::PARAM_INT),
+                ]);
+            $query->execute();
+        }
+    }
+
+    /**
+     * @param IJob|string $job
+     * @param mixed $argument
+     */
+    public function remove($job, $argument = null) {
+        if ($job instanceof IJob) {
+            $class = get_class($job);
+        } else {
+            $class = $job;
+        }
+
+        $query = $this->connection->getQueryBuilder();
+        $query->delete('jobs')
+            ->where($query->expr()->eq('class', $query->createNamedParameter($class)));
+        if (!is_null($argument)) {
+            $argument = json_encode($argument);
+            $query->andWhere($query->expr()->eq('argument', $query->createNamedParameter($argument)));
+        }
+        $query->execute();
+    }
+
+    /**
+     * @param int $id
+     */
+    protected function removeById($id) {
+        $query = $this->connection->getQueryBuilder();
+        $query->delete('jobs')
+            ->where($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
+        $query->execute();
+    }
+
+    /**
+     * check if a job is in the list
+     *
+     * @param IJob|string $job
+     * @param mixed $argument
+     * @return bool
+     */
+    public function has($job, $argument) {
+        if ($job instanceof IJob) {
+            $class = get_class($job);
+        } else {
+            $class = $job;
+        }
+        $argument = json_encode($argument);
+
+        $query = $this->connection->getQueryBuilder();
+        $query->select('id')
+            ->from('jobs')
+            ->where($query->expr()->eq('class', $query->createNamedParameter($class)))
+            ->andWhere($query->expr()->eq('argument', $query->createNamedParameter($argument)))
+            ->setMaxResults(1);
+
+        $result = $query->execute();
+        $row = $result->fetch();
+        $result->closeCursor();
+
+        return (bool) $row;
+    }
+
+    /**
+     * get all jobs in the list
+     *
+     * @return IJob[]
+     * @deprecated 9.0.0 - This method is dangerous since it can cause load and
+     * memory problems when creating too many instances.
+     */
+    public function getAll() {
+        $query = $this->connection->getQueryBuilder();
+        $query->select('*')
+            ->from('jobs');
+        $result = $query->execute();
+
+        $jobs = [];
+        while ($row = $result->fetch()) {
+            $job = $this->buildJob($row);
+            if ($job) {
+                $jobs[] = $job;
+            }
+        }
+        $result->closeCursor();
+
+        return $jobs;
+    }
+
+    /**
+     * get the next job in the list
+     *
+     * @return IJob|null
+     * @suppress SqlInjectionChecker
+     */
+    public function getNext() {
+        $query = $this->connection->getQueryBuilder();
+        $query->select('*')
+            ->from('jobs')
+            ->where($query->expr()->lte('reserved_at', $query->createNamedParameter($this->timeFactory->getTime() - $this->jobTimeOut, IQueryBuilder::PARAM_INT)))
+            ->andWhere($query->expr()->lte('last_checked', $query->createNamedParameter($this->timeFactory->getTime(), IQueryBuilder::PARAM_INT)))
+            ->orderBy('last_checked', 'ASC')
+            ->setMaxResults(1);
+
+        $update = $this->connection->getQueryBuilder();
+        $update->update('jobs')
+            ->set('reserved_at', $update->createNamedParameter($this->timeFactory->getTime()))
+            ->set('last_checked', $update->createNamedParameter($this->timeFactory->getTime()))
+            ->where($update->expr()->eq('id', $update->createParameter('jobid')))
+            ->andWhere($update->expr()->eq('reserved_at', $update->createParameter('reserved_at')))
+            ->andWhere($update->expr()->eq('last_checked', $update->createParameter('last_checked')));
+
+        $result = $query->execute();
+        $row = $result->fetch();
+        $result->closeCursor();
+
+        if ($row) {
+            $update->setParameter('jobid', $row['id']);
+            $update->setParameter('reserved_at', $row['reserved_at']);
+            $update->setParameter('last_checked', $row['last_checked']);
+            $count = $update->execute();
+
+            if ($count === 0) {
+                // Background job already executed elsewhere, try again.
+                return $this->getNext();
+            }
+            $job = $this->buildJob($row);
+
+            if ($job === null) {
+                // set the last_checked to 12h in the future to not check failing jobs all over again
+                $reset = $this->connection->getQueryBuilder();
+                $reset->update('jobs')
+                    ->set('reserved_at', $reset->expr()->literal(0, IQueryBuilder::PARAM_INT))
+                    ->set('last_checked', $reset->createNamedParameter($this->timeFactory->getTime() + 12 * 3600, IQueryBuilder::PARAM_INT))
+                    ->where($reset->expr()->eq('id', $reset->createNamedParameter($row['id'], IQueryBuilder::PARAM_INT)));
+                $reset->execute();
+
+                // Background job from disabled app, try again.
+                return $this->getNext();
+            }
+
+            return $job;
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * @param int $id
+     * @return IJob|null
+     */
+    public function getById($id) {
+        $query = $this->connection->getQueryBuilder();
+        $query->select('*')
+            ->from('jobs')
+            ->where($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
+        $result = $query->execute();
+        $row = $result->fetch();
+        $result->closeCursor();
+
+        if ($row) {
+            return $this->buildJob($row);
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * get the job object from a row in the db
+     *
+     * @param array $row
+     * @return IJob|null
+     */
+    private function buildJob($row) {
+        try {
+            try {
+                // Try to load the job as a service
+                /** @var IJob $job */
+                $job = \OC::$server->query($row['class']);
+            } catch (QueryException $e) {
+                if (class_exists($row['class'])) {
+                    $class = $row['class'];
+                    $job = new $class();
+                } else {
+                    // job from disabled app or old version of an app, no need to do anything
+                    return null;
+                }
+            }
+
+            $job->setId($row['id']);
+            $job->setLastRun($row['last_run']);
+            $job->setArgument(json_decode($row['argument'], true));
+            return $job;
+        } catch (AutoloadNotAllowedException $e) {
+            // job is from a disabled app, ignore
+            return null;
+        }
+    }
+
+    /**
+     * set the job that was last ran
+     *
+     * @param IJob $job
+     */
+    public function setLastJob(IJob $job) {
+        $this->unlockJob($job);
+        $this->config->setAppValue('backgroundjob', 'lastjob', $job->getId());
+    }
+
+    /**
+     * Remove the reservation for a job
+     *
+     * @param IJob $job
+     * @suppress SqlInjectionChecker
+     */
+    public function unlockJob(IJob $job) {
+        $query = $this->connection->getQueryBuilder();
+        $query->update('jobs')
+            ->set('reserved_at', $query->expr()->literal(0, IQueryBuilder::PARAM_INT))
+            ->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), IQueryBuilder::PARAM_INT)));
+        $query->execute();
+    }
+
+    /**
+     * get the id of the last ran job
+     *
+     * @return int
+     * @deprecated 9.1.0 - The functionality behind the value is deprecated, it
+     *    only tells you which job finished last, but since we now allow multiple
+     *    executors to run in parallel, it's not used to calculate the next job.
+     */
+    public function getLastJob() {
+        return (int) $this->config->getAppValue('backgroundjob', 'lastjob', 0);
+    }
+
+    /**
+     * set the lastRun of $job to now
+     *
+     * @param IJob $job
+     */
+    public function setLastRun(IJob $job) {
+        $query = $this->connection->getQueryBuilder();
+        $query->update('jobs')
+            ->set('last_run', $query->createNamedParameter(time(), IQueryBuilder::PARAM_INT))
+            ->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), IQueryBuilder::PARAM_INT)));
+        $query->execute();
+    }
+
+    /**
+     * @param IJob $job
+     * @param $timeTaken
+     */
+    public function setExecutionTime(IJob $job, $timeTaken) {
+        $query = $this->connection->getQueryBuilder();
+        $query->update('jobs')
+            ->set('execution_duration', $query->createNamedParameter($timeTaken, IQueryBuilder::PARAM_INT))
+            ->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), IQueryBuilder::PARAM_INT)));
+        $query->execute();
+    }
+
+    /**
+     * checks if a job is still running (reserved_at time is smaller than 12 hours ago)
+     *
+     * Background information:
+     *
+     * The 12 hours is the same timeout that is also used to re-schedule an non-terminated
+     * job (see getNext()). The idea here is to give a job enough time to run very
+     * long but still be able to recognize that it maybe crashed and re-schedule it
+     * after the timeout. It's more likely to be crashed at that time than it ran
+     * that long.
+     *
+     * In theory it could lead to an nearly endless loop (as in - at most 12 hours).
+     * The cron command will not start new jobs when maintenance mode is active and
+     * this method is only executed in maintenance mode (see where it is called in
+     * the upgrader class. So this means in the worst case we wait 12 hours when a
+     * job has crashed. On the other hand: then the instance should be fixed anyways.
+     *
+     * @return bool
+     */
+    public function isAnyJobRunning(): bool {
+        $query = $this->connection->getQueryBuilder();
+        $query->select('*')
+            ->from('jobs')
+            ->where($query->expr()->gt('reserved_at', $query->createNamedParameter($this->timeFactory->getTime() - $this->jobTimeOut, IQueryBuilder::PARAM_INT)))
+            ->setMaxResults(1);
+        $result = $query->execute();
+        $row = $result->fetch();
+        $result->closeCursor();
+
+        if ($row) {
+            return true;
+        }
+        return false;
+    }
 }