From 8eb3bddc2a6cdbded1fa8ba694a4f443cd2fa072 Mon Sep 17 00:00:00 2001 From: Michael Date: Sat, 30 Jan 2021 13:31:59 +0000 Subject: [PATCH] Reduce the parameter chaos by splitting the update function --- src/Console/DatabaseStructure.php | 2 +- src/Core/Installer.php | 2 +- src/Core/Update.php | 2 +- src/Database/DBStructure.php | 68 +++++++++++++++++++++++++------ src/Module/Admin/DBSync.php | 2 +- src/Module/Admin/Summary.php | 2 +- 6 files changed, 60 insertions(+), 18 deletions(-) diff --git a/src/Console/DatabaseStructure.php b/src/Console/DatabaseStructure.php index 343c90023d..3898774a5a 100644 --- a/src/Console/DatabaseStructure.php +++ b/src/Console/DatabaseStructure.php @@ -106,7 +106,7 @@ HELP; switch ($this->getArgument(0)) { case "dryrun": - $output = DBStructure::update($basePath, true, false); + $output = DBStructure::dryRun(); break; case "update": $force = $this->getOption(['f', 'force'], false); diff --git a/src/Core/Installer.php b/src/Core/Installer.php index 70ee4bba40..85538d579f 100644 --- a/src/Core/Installer.php +++ b/src/Core/Installer.php @@ -192,7 +192,7 @@ class Installer */ public function installDatabase($basePath) { - $result = DBStructure::update($basePath, false, true, true); + $result = DBStructure::install($basePath); if ($result) { $txt = DI::l10n()->t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . EOL; diff --git a/src/Core/Update.php b/src/Core/Update.php index d2a3c810e3..204c0d0ac3 100644 --- a/src/Core/Update.php +++ b/src/Core/Update.php @@ -166,7 +166,7 @@ class Update // update the structure in one call Logger::notice('Execute structure update'); - $retval = DBStructure::update($basePath, $verbose, true); + $retval = DBStructure::performUpdate(false, $verbose); if (!empty($retval)) { if ($sendMail) { self::updateFailed( diff --git a/src/Database/DBStructure.php b/src/Database/DBStructure.php index c8375c8575..f461cedd51 100644 --- a/src/Database/DBStructure.php +++ b/src/Database/DBStructure.php @@ -361,6 +361,54 @@ class DBStructure return ($sql); } + /** + * Perform a database structure dryrun (means: just simulating) + * + * @throws Exception + */ + public static function dryRun() + { + self::update(DI::app()->getBasePath(), true, false); + } + + /** + * Updates DB structure and returns eventual errors messages + * + * @param bool $enable_maintenance_mode Set the maintenance mode + * @param bool $verbose Display the SQL commands + * + * @return string Empty string if the update is successful, error messages otherwise + * @throws Exception + */ + public static function performUpdate(bool $enable_maintenance_mode = true, bool $verbose = false) + { + if ($enable_maintenance_mode) { + DI::config()->set('system', 'maintenance', 1); + } + + $status = self::update(DI::app()->getBasePath(), $verbose, true); + + if ($enable_maintenance_mode) { + DI::config()->set('system', 'maintenance', 0); + DI::config()->set('system', 'maintenance_reason', ''); + } + + return $status; + } + + /** + * Updates DB structure from the installation and returns eventual errors messages + * + * @param string $basePath The base path of this application + * + * @return string Empty string if the update is successful, error messages otherwise + * @throws Exception + */ + public static function install(string $basePath) + { + return self::update($basePath, false, true, true); + } + /** * Updates DB structure and returns eventual errors messages * @@ -373,16 +421,15 @@ class DBStructure * @return string Empty string if the update is successful, error messages otherwise * @throws Exception */ - public static function update($basePath, $verbose, $action, $install = false, array $tables = null, array $definition = null) + private static function update($basePath, $verbose, $action, $install = false, array $tables = null, array $definition = null) { - $in_maintenance = DI::config()->get('system', 'maintenance'); + $in_maintenance_mode = DI::config()->get('system', 'maintenance'); - if ($action && !$install) { - if (self::isUpdating()) { - return DI::l10n()->t('Another database update is currently running.'); - } + if ($action && !$install && self::isUpdating()) { + return DI::l10n()->t('Another database update is currently running.'); + } - DI::config()->set('system', 'maintenance', 1); + if ($in_maintenance_mode) { DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: Database update', DateTimeFormat::utcNow() . ' ' . date('e'))); } @@ -682,7 +729,7 @@ class DBStructure } if ($action) { - if (!$install) { + if ($in_maintenance_mode) { DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: updating %s table.', DateTimeFormat::utcNow() . ' ' . date('e'), $name)); } @@ -739,11 +786,6 @@ class DBStructure self::checkInitialValues(); if ($action && !$install) { - if (!$in_maintenance) { - DI::config()->set('system', 'maintenance', 0); - DI::config()->set('system', 'maintenance_reason', ''); - } - if ($errors) { DI::config()->set('system', 'dbupdate', self::UPDATE_FAILED); } else { diff --git a/src/Module/Admin/DBSync.php b/src/Module/Admin/DBSync.php index 662fe08e27..df7fdeaa67 100644 --- a/src/Module/Admin/DBSync.php +++ b/src/Module/Admin/DBSync.php @@ -54,7 +54,7 @@ class DBSync extends BaseAdmin break; case 'check': // @TODO Seems like a similar logic like Update::check() - $retval = DBStructure::update($a->getBasePath(), false, true); + $retval = DBStructure::performUpdate(); if ($retval === '') { $o = DI::l10n()->t("Database structure update %s was successfully applied.", DB_UPDATE_VERSION) . "
"; } else { diff --git a/src/Module/Admin/Summary.php b/src/Module/Admin/Summary.php index a130c48393..c232b5be5a 100644 --- a/src/Module/Admin/Summary.php +++ b/src/Module/Admin/Summary.php @@ -82,7 +82,7 @@ class Summary extends BaseAdmin } if (DI::config()->get('system', 'dbupdate', DBStructure::UPDATE_NOT_CHECKED) == DBStructure::UPDATE_NOT_CHECKED) { - DBStructure::update($a->getBasePath(), false, true); + DBStructure::performUpdate(); } if (DI::config()->get('system', 'dbupdate') == DBStructure::UPDATE_FAILED) {