]> git.mxchange.org Git - friendica.git/blobdiff - src/Core/Update.php
Merge pull request #12153 from nupplaphil/feat/woodpecker
[friendica.git] / src / Core / Update.php
index 96d2f0a8b119065f17ed4e06f5474e1d43e64b50..5f425172099a55cf132e8648f899ef4e349592c6 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
  *
@@ -27,6 +27,7 @@ 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
@@ -34,13 +35,15 @@ class Update
        const SUCCESS = 0;
        const FAILED  = 1;
 
+       const NEW_TABLE_STRUCTURE_VERSION = 1288;
+
        /**
         * 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?
         * @param App\Mode $mode       The current app mode
-        *
+        * @return void
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function check(string $basePath, bool $via_worker, App\Mode $mode)
@@ -62,7 +65,7 @@ class Update
                }
 
                // We don't support upgrading from very old versions anymore
-               if ($build < NEW_TABLE_STRUCTURE_VERSION) {
+               if ($build < self::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);
@@ -71,9 +74,9 @@ class Update
                        }
                }
 
-               // The postupdate has to completed version 1281 for the new post views to take over
-               $postupdate = DI::config()->get("system", "post_update_version");
-               if ($postupdate < NEW_TABLE_STRUCTURE_VERSION) {
+               // The postupdate has to completed version 1288 for the new post views to take over
+               $postupdate = DI::config()->get('system', 'post_update_version', self::NEW_TABLE_STRUCTURE_VERSION);
+               if ($postupdate < self::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);
@@ -84,12 +87,14 @@ class Update
 
                if ($build < DB_UPDATE_VERSION) {
                        if ($via_worker) {
-                               // Calling the database update directly via the worker enables us to perform database changes to the workerqueue table itself.
-                               // This is a fallback, since normally the database update will be performed by a worker job.
-                               // This worker job doesn't work for changes to the "workerqueue" table itself.
+                               /*
+                                * Calling the database update directly via the worker enables us to perform database changes to the workerqueue table itself.
+                                * This is a fallback, since normally the database update will be performed by a worker job.
+                                * This worker job doesn't work for changes to the "workerqueue" table itself.
+                                */
                                self::run($basePath);
                        } else {
-                               Worker::add(PRIORITY_CRITICAL, 'DBUpdate');
+                               Worker::add(Worker::PRIORITY_CRITICAL, 'DBUpdate');
                        }
                }
        }
@@ -102,11 +107,10 @@ class Update
         * @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(string $basePath, bool $force = false, bool $override = false, bool $verbose = false, bool $sendMail = true)
+       public static function run(string $basePath, bool $force = false, bool $override = false, bool $verbose = false, bool $sendMail = true): string
        {
                // In force mode, we release the dbupdate lock first
                // Necessary in case of an stuck update
@@ -131,7 +135,7 @@ class Update
 
                                // 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', 0, Cache\Duration::INFINITE)) {
+                               if (DI::lock()->acquire('dbupdate', 0, Cache\Enum\Duration::INFINITE)) {
 
                                        Logger::notice('Update starting.', ['from' => $stored, 'to' => $current]);
 
@@ -143,14 +147,20 @@ class Update
                                                return '';
                                        }
 
+                                       DI::config()->set('system', 'maintenance', 1);
+               
                                        // run the pre_update_nnnn functions in update.php
                                        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' => $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]);
@@ -159,7 +169,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(
@@ -170,6 +180,8 @@ 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 {
                                                Logger::notice('Database structure update finished.', ['from' => $stored, 'to' => $current]);
@@ -178,11 +190,15 @@ class Update
                                        // run the update_nnnn functions in update.php
                                        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' => $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);
@@ -193,11 +209,15 @@ class Update
                                        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::updateSuccessful($stored, $current);
                                        }
+                               } else {
+                                       Logger::warning('Update lock could not be acquired');
                                }
                        }
                }
@@ -211,11 +231,10 @@ class 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(int $version, string $prefix, bool $sendMail = true)
+       public static function runUpdateFunction(int $version, string $prefix, bool $sendMail = true): bool
        {
                $funcname = $prefix . '_' . $version;
 
@@ -229,7 +248,7 @@ 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::notice('Pre update function start.', ['function' => $funcname]);
@@ -267,6 +286,7 @@ class Update
         *
         * @param int    $update_id     number of failed update
         * @param string $error_message error message
+        * @return void
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        private static function updateFailed(int $update_id, string $error_message) {