]> git.mxchange.org Git - friendica.git/blobdiff - src/Core/Update.php
Merge pull request #11506 from annando/featured-worker
[friendica.git] / src / Core / Update.php
index 0fca9744a951255e48354ddae485e8fd87ae0cb7..978baec10f871b55f3f2de2596f4787dde30be81 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2022, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
 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;
 
 class Update
@@ -41,7 +44,7 @@ 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;
@@ -60,8 +63,24 @@ class Update
                }
 
                // 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) {
@@ -80,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
@@ -111,11 +130,11 @@ class Update
                        if ($stored < $current || $force) {
                                DI::config()->load('database');
 
-                               Logger::notice('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 (DI::lock()->acquire('dbupdate', 120, Cache\Duration::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 = DI::config()->get('system', 'build', null, true);
@@ -125,19 +144,29 @@ class Update
                                                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', $sendMail);
+                                       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) {
-                                                       Logger::warning('Pre update failed', ['version' => $x]);
+                                                       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(
@@ -148,31 +177,44 @@ class Update
                                                Logger::error('Update ERROR.', ['from' => $stored, 'to' => $current, 'retval' => $retval]);
                                                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 {
-                                               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]);
+                                               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', $sendMail);
+                                       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) {
-                                                       Logger::warning('Post update failed', ['version' => $x]);
+                                                       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);
                                        }
-
-                                       DI::config()->set('system', 'update', Update::SUCCESS);
-                                       DI::lock()->release('dbupdate');
+                               } else {
+                                       Logger::warning('Update lock could not be acquired');
                                }
                        }
                }
@@ -183,18 +225,18 @@ class Update
        /**
         * Executes a specific update function
         *
-        * @param int    $x        the DB version number of the function
+        * @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, bool $sendMail = true)
+       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.
@@ -204,49 +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\Duration::INFINITE)) {
+                       if (DI::lock()->acquire('dbupdate_function', 120, Cache\Enum\Duration::INFINITE)) {
 
                                // call the specific update
-                               Logger::info('Pre update function start.', ['function' => $funcname]);
+                               Logger::notice('Pre update function start.', ['function' => $funcname]);
                                $retval = $funcname();
-                               Logger::info('Update function done.', ['function' => $funcname]);
+                               Logger::notice('Update function done.', ['function' => $funcname]);
 
                                if ($retval) {
                                        if ($sendMail) {
                                                //send the administrator an e-mail
                                                self::updateFailed(
-                                                       $x,
-                                                       DI::l10n()->t('Update %s failed. See error logs.', $x)
+                                                       $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 {
-                                       DI::config()->set('database', 'last_successful_update_function', $funcname);
-                                       DI::config()->set('database', 'last_successful_update_function_time', time());
-
-                                       if ($prefix == 'update') {
-                                               DI::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]);
-
-                       DI::config()->set('database', 'last_successful_update_function', $funcname);
-                       DI::config()->set('database', 'last_successful_update_function_time', time());
-
-                       if ($prefix == 'update') {
-                               DI::config()->set('system', 'build', $x);
-                       }
-
+                       Logger::notice('Update function skipped.', ['function' => $funcname]);
                        return true;
                }
        }
@@ -258,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(" ", "", DI::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?
@@ -289,7 +317,7 @@ 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);
+                       $body     = $l10n->t('The error message is\n[pre]%s[/pre]', $error_message);
 
                        $email = DI::emailer()
                                ->newSystemMail()
@@ -300,14 +328,20 @@ class Update
                        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(" ", "", DI::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)) {
@@ -323,8 +357,8 @@ class Update
                                $lang = (($admin['language']) ? $admin['language'] : 'en');
                                $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));
 
                                $email = DI::emailer()
@@ -337,7 +371,6 @@ class Update
                        }
                }
 
-               //try the logger
                Logger::debug('Database structure update successful.');
        }
 }