X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCore%2FUpdate.php;h=978baec10f871b55f3f2de2596f4787dde30be81;hb=69984ac6bcf08a1c3ce8967ad3ec4ca954039b75;hp=62ea573db6174d8566cfe7ed0ae65fc046ec298f;hpb=6ccf038053431ae55100f061ee96d4549fe8f8ed;p=friendica.git diff --git a/src/Core/Update.php b/src/Core/Update.php index 62ea573db6..978baec10f 100644 --- a/src/Core/Update.php +++ b/src/Core/Update.php @@ -1,13 +1,34 @@ . + * + */ namespace Friendica\Core; use Friendica\App; +use Friendica\App\Mode; use Friendica\Database\DBA; use Friendica\Database\DBStructure; use Friendica\DI; +use Friendica\Network\HTTPException\InternalServerErrorException; +use Friendica\Util\DateTimeFormat; use Friendica\Util\Strings; -use Friendica\Core\Cache\Cache; class Update { @@ -15,7 +36,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? @@ -23,27 +44,43 @@ class Update * * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ - public static function check($basePath, $via_worker, App\Mode $mode) + public static function check(string $basePath, bool $via_worker, App\Mode $mode) { if (!DBA::connected()) { return; } // 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; } // We don't support upgrading from very old versions anymore - if ($build < NEW_UPDATE_ROUTINE_VERSION) { - die('You try to update from a version prior to database version 1170. The direct upgrade path is not supported. Please update to version 3.5.4 before updating to this version.'); + if ($build < NEW_TABLE_STRUCTURE_VERSION) { + $error = DI::l10n()->t('Updates from version %s are not supported. Please update at least to version 2021.01 and wait until the postupdate finished version 1383.', $build); + if (DI::mode()->getExecutor() == Mode::INDEX) { + die($error); + } else { + throw new InternalServerErrorException($error); + } + } + + // The postupdate has to completed version 1288 for the new post views to take over + $postupdate = DI::config()->get("system", "post_update_version", NEW_TABLE_STRUCTURE_VERSION); + if ($postupdate < NEW_TABLE_STRUCTURE_VERSION) { + $error = DI::l10n()->t('Updates from postupdate version %s are not supported. Please update at least to version 2021.01 and wait until the postupdate finished version 1383.', $postupdate); + if (DI::mode()->getExecutor() == Mode::INDEX) { + die($error); + } else { + throw new InternalServerErrorException($error); + } } if ($build < DB_UPDATE_VERSION) { @@ -62,15 +99,15 @@ class Update * Automatic database updates * * @param string $basePath The base path of this application - * @param bool $force Force the Update-Check even if the database version doesn't match - * @param bool $override Overrides any running/stuck updates - * @param bool $verbose Run the Update-Check verbose - * @param bool $sendMail Sends a Mail to the administrator in case of success/failure + * @param bool $force Force the Update-Check even if the database version doesn't match + * @param bool $override Overrides any running/stuck updates + * @param bool $verbose Run the Update-Check verbose + * @param bool $sendMail Sends a Mail to the administrator in case of success/failure * * @return string Empty string if the update is successful, error messages otherwise * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ - public static function run($basePath, $force = false, $override = false, $verbose = false, $sendMail = true) + public static function run(string $basePath, bool $force = false, bool $override = false, bool $verbose = false, bool $sendMail = true) { // In force mode, we release the dbupdate lock first // Necessary in case of an stuck update @@ -78,11 +115,11 @@ class Update 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) { @@ -91,34 +128,45 @@ class Update $stored = intval($build); $current = intval(DB_UPDATE_VERSION); if ($stored < $current || $force) { - Config::load('database'); - - Logger::info('Update starting.', ['from' => $stored, 'to' => $current]); + DI::config()->load('database'); // Compare the current structure with the defined structure // If the Lock is acquired, never release it automatically to avoid double updates - if (DI::lock()->acquire('dbupdate', 120, Cache::INFINITE)) { + if (DI::lock()->acquire('dbupdate', 0, Cache\Enum\Duration::INFINITE)) { + + Logger::notice('Update starting.', ['from' => $stored, 'to' => $current]); // 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]); + Logger::notice('Update already done.', ['from' => $stored, 'to' => $current]); DI::lock()->release('dbupdate'); return ''; } + DI::config()->set('system', 'maintenance', 1); + // run the pre_update_nnnn functions in update.php - for ($x = $stored + 1; $x <= $current; $x++) { - $r = self::runUpdateFunction($x, 'pre_update'); + for ($version = $stored + 1; $version <= $current; $version++) { + Logger::notice('Execute pre update.', ['version' => $version]); + DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: executing pre update %d', + DateTimeFormat::utcNow() . ' ' . date('e'), $version)); + $r = self::runUpdateFunction($version, 'pre_update', $sendMail); if (!$r) { - Config::set('system', 'update', Update::FAILED); + Logger::warning('Pre update failed', ['version' => $version]); + DI::config()->set('system', 'update', Update::FAILED); DI::lock()->release('dbupdate'); + DI::config()->set('system', 'maintenance', 0); + DI::config()->set('system', 'maintenance_reason', ''); return $r; + } else { + Logger::notice('Pre update executed.', ['version' => $version]); } } // update the structure in one call - $retval = DBStructure::update($basePath, $verbose, true); + Logger::notice('Execute structure update'); + $retval = DBStructure::performUpdate(false, $verbose); if (!empty($retval)) { if ($sendMail) { self::updateFailed( @@ -127,32 +175,46 @@ class Update ); } Logger::error('Update ERROR.', ['from' => $stored, 'to' => $current, 'retval' => $retval]); - Config::set('system', 'update', Update::FAILED); + DI::config()->set('system', 'update', Update::FAILED); DI::lock()->release('dbupdate'); + DI::config()->set('system', 'maintenance', 0); + DI::config()->set('system', 'maintenance_reason', ''); return $retval; } else { - Config::set('database', 'last_successful_update', $current); - Config::set('database', 'last_successful_update_time', time()); - Logger::info('Update finished.', ['from' => $stored, 'to' => $current]); + Logger::notice('Database structure 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'); + for ($version = $stored + 1; $version <= $current; $version++) { + Logger::notice('Execute post update.', ['version' => $version]); + DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: executing post update %d', + DateTimeFormat::utcNow() . ' ' . date('e'), $version)); + $r = self::runUpdateFunction($version, 'update', $sendMail); if (!$r) { - Config::set('system', 'update', Update::FAILED); + Logger::warning('Post update failed', ['version' => $version]); + DI::config()->set('system', 'update', Update::FAILED); DI::lock()->release('dbupdate'); + DI::config()->set('system', 'maintenance', 0); + DI::config()->set('system', 'maintenance_reason', ''); return $r; + } else { + DI::config()->set('system', 'build', $version); + Logger::notice('Post update executed.', ['version' => $version]); } } + DI::config()->set('system', 'build', $current); + DI::config()->set('system', 'update', Update::SUCCESS); + DI::lock()->release('dbupdate'); + DI::config()->set('system', 'maintenance', 0); + DI::config()->set('system', 'maintenance_reason', ''); + Logger::notice('Update success.', ['from' => $stored, 'to' => $current]); if ($sendMail) { - self::updateSuccessfull($stored, $current); + self::updateSuccessful($stored, $current); } - - Config::set('system', 'update', Update::SUCCESS); - DI::lock()->release('dbupdate'); + } else { + Logger::warning('Update lock could not be acquired'); } } } @@ -163,17 +225,18 @@ 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 $version 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(int $version, string $prefix, bool $sendMail = true) { - $funcname = $prefix . '_' . $x; + $funcname = $prefix . '_' . $version; - Logger::info('Update function start.', ['function' => $funcname]); + Logger::notice('Update function start.', ['function' => $funcname]); if (function_exists($funcname)) { // There could be a lot of processes running or about to run. @@ -183,43 +246,35 @@ class Update // If the update fails or times-out completely you may need to // delete the config entry to try again. - if (DI::lock()->acquire('dbupdate_function', 120,Cache::INFINITE)) { + if (DI::lock()->acquire('dbupdate_function', 120, Cache\Enum\Duration::INFINITE)) { // call the specific update + Logger::notice('Pre update function start.', ['function' => $funcname]); $retval = $funcname(); + Logger::notice('Update function done.', ['function' => $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( + $version, + DI::l10n()->t('Update %s failed. See error logs.', $version) + ); + } Logger::error('Update function ERROR.', ['function' => $funcname, 'retval' => $retval]); 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()); - - if ($prefix == 'update') { - Config::set('system', 'build', $x); - } - DI::lock()->release('dbupdate_function'); - Logger::info('Update function finished.', ['function' => $funcname]); + Logger::notice('Update function finished.', ['function' => $funcname]); return true; } + } else { + Logger::error('Locking failed.', ['function' => $funcname]); + return false; } } 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()); - - if ($prefix == 'update') { - Config::set('system', 'build', $x); - } - + Logger::notice('Update function skipped.', ['function' => $funcname]); return true; } } @@ -231,9 +286,9 @@ class Update * @param string $error_message error message * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ - private static function updateFailed($update_id, $error_message) { + private static function updateFailed(int $update_id, string $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? @@ -253,8 +308,8 @@ class Update } $sent[] = $admin['email']; - $lang = (($admin['language'])?$admin['language']:'en'); - $l10n = L10n::withLang($lang); + $lang = $admin['language'] ?? 'en'; + $l10n = DI::l10n()->withLang($lang); $preamble = Strings::deindent($l10n->t(" The friendica developers released update %s recently, @@ -262,27 +317,31 @@ class Update 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] - ); + $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 - Logger::alert('Database structure update FAILED.', ['error' => $error_message]); + Logger::alert('Database structure update failed.', ['error' => $error_message]); } - private static function updateSuccessfull($from_build, $to_build) + /** + * Send a mail to the administrator about the successful update + * + * @param integer $from_build + * @param integer $to_build + * @return void + */ + private static function updateSuccessful(int $from_build, int $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)) { @@ -296,25 +355,22 @@ class Update $sent[] = $admin['email']; $lang = (($admin['language']) ? $admin['language'] : 'en'); - $l10n = L10n::withLang($lang); + $l10n = DI::l10n()->withLang($lang); - $preamble = Strings::deindent($l10n->t(" - The friendica database was successfully updated from %s to %s.", + $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'], - 'subject' => l10n::t('[Friendica Notify] Database update'), - 'preamble' => $preamble, - 'body' => $preamble, - 'language' => $lang] - ); + $email = DI::emailer() + ->newSystemMail() + ->withMessage($l10n->t('[Friendica Notify] Database update'), $preamble) + ->forUser($admin) + ->withRecipient($admin['email']) + ->build(); + DI::emailer()->send($email); } } - //try the logger Logger::debug('Database structure update successful.'); } }