X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCore%2FUpdate.php;h=827029d50e184a52a5f93468cb0409d8242f657d;hb=0d1fa70e2ecb372d158871285e0cda5f6d77194a;hp=d2bbc237c7b656a078a539fbd15c759c3b2cedda;hpb=c4fef79f32c318dc048565d919b6755f01433f8e;p=friendica.git diff --git a/src/Core/Update.php b/src/Core/Update.php index d2bbc237c7..827029d50e 100644 --- a/src/Core/Update.php +++ b/src/Core/Update.php @@ -1,14 +1,30 @@ . + * + */ namespace Friendica\Core; use Friendica\App; -use Friendica\Core\Config\Cache\IConfigCache; use Friendica\Database\DBA; use Friendica\Database\DBStructure; -use Friendica\Util\BasePath; -use Friendica\Util\Config\ConfigFileLoader; -use Friendica\Util\Config\ConfigFileSaver; +use Friendica\DI; use Friendica\Util\Strings; class Update @@ -17,7 +33,7 @@ class Update const FAILED = 1; /** - * @brief Function to check if the Database structure needs an update. + * Function to check if the Database structure needs an update. * * @param string $basePath The base path of this application * @param boolean $via_worker Is the check run via the worker? @@ -31,18 +47,15 @@ class Update return; } - // Check if the config files are set correctly - self::checkConfigFile($basePath, $mode); - // Don't check the status if the last update was failed - if (Config::get('system', 'update', Update::SUCCESS, true) == Update::FAILED) { + if (DI::config()->get('system', 'update', Update::SUCCESS, true) == Update::FAILED) { return; } - $build = Config::get('system', 'build'); + $build = DI::config()->get('system', 'build'); if (empty($build)) { - Config::set('system', 'build', DB_UPDATE_VERSION - 1); + DI::config()->set('system', 'build', DB_UPDATE_VERSION - 1); $build = DB_UPDATE_VERSION - 1; } @@ -80,14 +93,14 @@ class Update // In force mode, we release the dbupdate lock first // Necessary in case of an stuck update if ($override) { - Lock::release('dbupdate', true); + DI::lock()->release('dbupdate', true); } - $build = Config::get('system', 'build', null, true); + $build = DI::config()->get('system', 'build', null, true); if (empty($build) || ($build > DB_UPDATE_VERSION)) { $build = DB_UPDATE_VERSION - 1; - Config::set('system', 'build', $build); + DI::config()->set('system', 'build', $build); } if ($build != DB_UPDATE_VERSION || $force) { @@ -96,28 +109,28 @@ class Update $stored = intval($build); $current = intval(DB_UPDATE_VERSION); if ($stored < $current || $force) { - Config::load('database'); + DI::config()->load('database'); Logger::info('Update starting.', ['from' => $stored, 'to' => $current]); // Compare the current structure with the defined structure // If the Lock is acquired, never release it automatically to avoid double updates - if (Lock::acquire('dbupdate', 120, Cache::INFINITE)) { + if (DI::lock()->acquire('dbupdate', 120, Cache\Duration::INFINITE)) { // Checks if the build changed during Lock acquiring (so no double update occurs) - $retryBuild = Config::get('system', 'build', null, true); + $retryBuild = DI::config()->get('system', 'build', null, true); if ($retryBuild !== $build) { Logger::info('Update already done.', ['from' => $stored, 'to' => $current]); - Lock::release('dbupdate'); + DI::lock()->release('dbupdate'); return ''; } // run the pre_update_nnnn functions in update.php for ($x = $stored + 1; $x <= $current; $x++) { - $r = self::runUpdateFunction($x, 'pre_update'); + $r = self::runUpdateFunction($x, 'pre_update', $sendMail); if (!$r) { - Config::set('system', 'update', Update::FAILED); - Lock::release('dbupdate'); + DI::config()->set('system', 'update', Update::FAILED); + DI::lock()->release('dbupdate'); return $r; } } @@ -132,21 +145,21 @@ class Update ); } Logger::error('Update ERROR.', ['from' => $stored, 'to' => $current, 'retval' => $retval]); - Config::set('system', 'update', Update::FAILED); - Lock::release('dbupdate'); + DI::config()->set('system', 'update', Update::FAILED); + DI::lock()->release('dbupdate'); return $retval; } else { - Config::set('database', 'last_successful_update', $current); - Config::set('database', 'last_successful_update_time', time()); + DI::config()->set('database', 'last_successful_update', $current); + DI::config()->set('database', 'last_successful_update_time', time()); Logger::info('Update finished.', ['from' => $stored, 'to' => $current]); } // run the update_nnnn functions in update.php for ($x = $stored + 1; $x <= $current; $x++) { - $r = self::runUpdateFunction($x, 'update'); + $r = self::runUpdateFunction($x, 'update', $sendMail); if (!$r) { - Config::set('system', 'update', Update::FAILED); - Lock::release('dbupdate'); + DI::config()->set('system', 'update', Update::FAILED); + DI::lock()->release('dbupdate'); return $r; } } @@ -156,8 +169,8 @@ class Update self::updateSuccessfull($stored, $current); } - Config::set('system', 'update', Update::SUCCESS); - Lock::release('dbupdate'); + DI::config()->set('system', 'update', Update::SUCCESS); + DI::lock()->release('dbupdate'); } } } @@ -168,13 +181,14 @@ class Update /** * Executes a specific update function * - * @param int $x the DB version number of the function - * @param string $prefix the prefix of the function (update, pre_update) - * + * @param int $x the DB version number of the function + * @param string $prefix the prefix of the function (update, pre_update) + * @param bool $sendMail whether to send emails on success/failure + * @return bool true, if the update function worked * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ - public static function runUpdateFunction($x, $prefix) + public static function runUpdateFunction($x, $prefix, bool $sendMail = true) { $funcname = $prefix . '_' . $x; @@ -188,29 +202,31 @@ class Update // If the update fails or times-out completely you may need to // delete the config entry to try again. - if (Lock::acquire('dbupdate_function', 120,Cache::INFINITE)) { + if (DI::lock()->acquire('dbupdate_function', 120, Cache\Duration::INFINITE)) { // call the specific update $retval = $funcname(); if ($retval) { - //send the administrator an e-mail - self::updateFailed( - $x, - L10n::t('Update %s failed. See error logs.', $x) - ); + if ($sendMail) { + //send the administrator an e-mail + self::updateFailed( + $x, + DI::l10n()->t('Update %s failed. See error logs.', $x) + ); + } Logger::error('Update function ERROR.', ['function' => $funcname, 'retval' => $retval]); - Lock::release('dbupdate_function'); + DI::lock()->release('dbupdate_function'); return false; } else { - Config::set('database', 'last_successful_update_function', $funcname); - Config::set('database', 'last_successful_update_function_time', time()); + DI::config()->set('database', 'last_successful_update_function', $funcname); + DI::config()->set('database', 'last_successful_update_function_time', time()); if ($prefix == 'update') { - Config::set('system', 'build', $x); + DI::config()->set('system', 'build', $x); } - Lock::release('dbupdate_function'); + DI::lock()->release('dbupdate_function'); Logger::info('Update function finished.', ['function' => $funcname]); return true; } @@ -218,152 +234,14 @@ class Update } else { Logger::info('Update function skipped.', ['function' => $funcname]); - Config::set('database', 'last_successful_update_function', $funcname); - Config::set('database', 'last_successful_update_function_time', time()); + DI::config()->set('database', 'last_successful_update_function', $funcname); + DI::config()->set('database', 'last_successful_update_function_time', time()); if ($prefix == 'update') { - Config::set('system', 'build', $x); - } - - return true; - } - } - - /** - * Checks the config settings and saves given config values into the config file - * - * @param string $basePath The basepath of Friendica - * @param App\Mode $mode The current App mode - * - * @return bool True, if something has been saved - */ - public static function checkConfigFile($basePath, App\Mode $mode) - { - if (empty($basePath)) { - $basePath = BasePath::create(dirname(__DIR__, 2)); - } - - $config = [ - 'config' => [ - 'hostname' => [ - 'allowEmpty' => false, - 'default' => '', - ], - ], - 'system' => [ - 'basepath' => [ - 'allowEmpty' => false, - 'default' => $basePath, - ], - ] - ]; - - $configFileLoader = new ConfigFileLoader($basePath, $mode); - $configCache = new Config\Cache\ConfigCache(); - $configFileLoader->setupCache($configCache, true); - - // checks if something is to update, otherwise skip this function at all - $missingConfig = $configCache->keyDiff($config); - if (empty($missingConfig)) { - return true; - } - - // We just want one update process - if (Lock::acquire('config_update')) { - $configFileSaver = new ConfigFileSaver($basePath); - - $updated = false; - $toDelete = []; - - foreach ($missingConfig as $category => $keys) { - foreach ($keys as $key => $value) { - if (self::updateConfigEntry($configCache, $configFileSaver, $category, $key, $value['allowEmpty'], $value['default'])) { - $toDelete[] = ['cat' => $category, 'key' => $key]; - $updated = true; - }; - } - } - - // In case there is nothing to do, skip the update - if (!$updated) { - Lock::release('config_update'); - return true; - } - - if (!$configFileSaver->saveToConfigFile()) { - Logger::alert('Config entry update failed - maybe wrong permission?'); - Lock::release('config_update'); - return false; + DI::config()->set('system', 'build', $x); } - // After the successful save, remove the db values - foreach ($toDelete as $delete) { - DBA::delete('config', ['cat' => $delete['cat'], 'k' => $delete['key']]); - } - - Lock::release('config_update'); - } - - return true; - } - - /** - * Adds a value to the ConfigFileSave in case it isn't already updated - * - * @param IConfigCache $configCache The cached config file - * @param ConfigFileSaver $configFileSaver The config file saver - * @param string $cat The config category - * @param string $key The config key - * @param bool $allowEmpty If true, empty values are valid (Default there has to be a variable) - * @param string $default A default value, if none of the settings are valid - * - * @return boolean True, if a value was updated - * - * @throws \Exception if DBA or Logger doesn't work - */ - private static function updateConfigEntry( - IConfigCache $configCache, - ConfigFileSaver $configFileSaver, - $cat, - $key, - $allowEmpty = false, - $default = '') - { - - // check if the config file differs from the whole configuration (= The db contains other values) - $fileValue = $configCache->get($cat, $key); - $dbConfig = DBA::selectFirst('config', ['v'], ['cat' => $cat, 'k' => $key]); - - if (DBA::isResult($dbConfig)) { - $dbValue = $dbConfig['v']; - } else { - $dbValue = null; - } - - // If the db contains a config value, check it - if (( - ($allowEmpty && isset($dbValue)) || - (!$allowEmpty && !empty($dbValue)) - ) && - $fileValue !== $dbValue) { - Logger::info('Difference in config found', ['cat' => $cat, 'key' => $key, 'file' => $fileValue, 'db' => $dbValue]); - $configFileSaver->addConfigValue($cat, $key, $dbValue); - return true; - - // If both config values are not set, use the default value - } elseif ( - ($allowEmpty && !isset($fileValue) && !isset($dbValue)) || - (!$allowEmpty && empty($fileValue) && empty($dbValue) && !empty($default))) { - - Logger::info('Using default for config', ['cat' => $cat, 'key' => $key, 'value' => $default]); - $configFileSaver->addConfigValue($cat, $key, $default); return true; - - // If either the file config value isn't empty or the db value is the same as the - // file config value, skip it - } else { - Logger::debug('No Difference in config found', ['cat' => $cat, 'key' => $key, 'value' => $fileValue, 'db' => $dbValue]); - return false; } } @@ -376,7 +254,7 @@ class Update */ private static function updateFailed($update_id, $error_message) { //send the administrators an e-mail - $condition = ['email' => explode(",", str_replace(" ", "", Config::get('config', 'admin_email'))), 'parent-uid' => 0]; + $condition = ['email' => explode(",", str_replace(" ", "", DI::config()->get('config', 'admin_email'))), 'parent-uid' => 0]; $adminlist = DBA::select('user', ['uid', 'language', 'email'], $condition, ['order' => ['uid']]); // No valid result? @@ -396,27 +274,24 @@ class Update } $sent[] = $admin['email']; - $lang = (($admin['language'])?$admin['language']:'en'); - L10n::pushLang($lang); + $lang = $admin['language'] ?? 'en'; + $l10n = DI::l10n()->withLang($lang); - $preamble = Strings::deindent(L10n::t(" + $preamble = Strings::deindent($l10n->t(" The friendica developers released update %s recently, but when I tried to install it, something went terribly wrong. This needs to be fixed soon and I can't do it alone. Please contact a friendica developer if you can not help me on your own. My database might be invalid.", $update_id)); - $body = L10n::t("The error message is\n[pre]%s[/pre]", $error_message); - - notification([ - 'uid' => $admin['uid'], - 'type' => SYSTEM_EMAIL, - 'to_email' => $admin['email'], - 'subject' => l10n::t('[Friendica Notify] Database update'), - 'preamble' => $preamble, - 'body' => $body, - 'language' => $lang] - ); - L10n::popLang(); + $body = $l10n->t("The error message is\n[pre]%s[/pre]", $error_message); + + $email = DI::emailer() + ->newSystemMail() + ->withMessage($l10n->t('[Friendica Notify] Database update'), $preamble, $body) + ->forUser($admin) + ->withRecipient($admin['email']) + ->build(); + DI::emailer()->send($email); } //try the logger @@ -426,7 +301,7 @@ class Update private static function updateSuccessfull($from_build, $to_build) { //send the administrators an e-mail - $condition = ['email' => explode(",", str_replace(" ", "", Config::get('config', 'admin_email'))), 'parent-uid' => 0]; + $condition = ['email' => explode(",", str_replace(" ", "", DI::config()->get('config', 'admin_email'))), 'parent-uid' => 0]; $adminlist = DBA::select('user', ['uid', 'language', 'email'], $condition, ['order' => ['uid']]); if (DBA::isResult($adminlist)) { @@ -440,21 +315,19 @@ class Update $sent[] = $admin['email']; $lang = (($admin['language']) ? $admin['language'] : 'en'); - L10n::pushLang($lang); + $l10n = DI::l10n()->withLang($lang); - $preamble = Strings::deindent(L10n::t(" + $preamble = Strings::deindent($l10n->t(" The friendica database was successfully updated from %s to %s.", $from_build, $to_build)); - notification([ - 'uid' => $admin['uid'], - 'type' => SYSTEM_EMAIL, - 'to_email' => $admin['email'], - 'preamble' => $preamble, - 'body' => $preamble, - 'language' => $lang] - ); - L10n::popLang(); + $email = DI::emailer() + ->newSystemMail() + ->withMessage($l10n->t('[Friendica Notify] Database update'), $preamble) + ->forUser($admin) + ->withRecipient($admin['email']) + ->build(); + DI::emailer()->send($email); } }