src/Core/Update.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Core;
  23
  24 use Friendica\App;
  25 use Friendica\App\Mode;
  26 use Friendica\Database\DBA;
  27 use Friendica\Database\DBStructure;
  28 use Friendica\DI;
  29 use Friendica\Model\User;
  30 use Friendica\Network\HTTPException\InternalServerErrorException;
  31 use Friendica\Util\DateTimeFormat;
  32 use Friendica\Util\Strings;
  33
  34 class Update
  35 {
  36         const SUCCESS = 0;
  37         const FAILED  = 1;
  38
  39         const NEW_TABLE_STRUCTURE_VERSION = 1288;
  40
  41         /**
  42          * Function to check if the Database structure needs an update.
  43          *
  44          * @param string   $basePath   The base path of this application
  45          * @param boolean  $via_worker Is the check run via the worker?
  46          * @param App\Mode $mode       The current app mode
  47          * @return void
  48          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  49          */
  50         public static function check(string $basePath, bool $via_worker, App\Mode $mode)
  51         {
  52                 if (!DBA::connected()) {
  53                         return;
  54                 }
  55
  56                 // Don't check the status if the last update was failed
  57                 if (DI::config()->get('system', 'update', Update::SUCCESS) == Update::FAILED) {
  58                         return;
  59                 }
  60
  61                 $build = DI::config()->get('system', 'build');
  62
  63                 if (empty($build)) {
  64                         DI::config()->set('system', 'build', DB_UPDATE_VERSION - 1);
  65                         $build = DB_UPDATE_VERSION - 1;
  66                 }
  67
  68                 // We don't support upgrading from very old versions anymore
  69                 if ($build < self::NEW_TABLE_STRUCTURE_VERSION) {
  70                         $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);
  71                         if (DI::mode()->getExecutor() == Mode::INDEX) {
  72                                 die($error);
  73                         } else {
  74                                 throw new InternalServerErrorException($error);
  75                         }
  76                 }
  77
  78                 // The postupdate has to completed version 1288 for the new post views to take over
  79                 $postupdate = DI::keyValue()->get('post_update_version') ?? self::NEW_TABLE_STRUCTURE_VERSION;
  80                 if ($postupdate < self::NEW_TABLE_STRUCTURE_VERSION) {
  81                         $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);
  82                         if (DI::mode()->getExecutor() == Mode::INDEX) {
  83                                 die($error);
  84                         } else {
  85                                 throw new InternalServerErrorException($error);
  86                         }
  87                 }
  88
  89                 if ($build < DB_UPDATE_VERSION) {
  90                         if ($via_worker) {
  91                                 /*
  92                                  * Calling the database update directly via the worker enables us to perform database changes to the workerqueue table itself.
  93                                  * This is a fallback, since normally the database update will be performed by a worker job.
  94                                  * This worker job doesn't work for changes to the "workerqueue" table itself.
  95                                  */
  96                                 self::run($basePath);
  97                         } else {
  98                                 Worker::add(Worker::PRIORITY_CRITICAL, 'DBUpdate');
  99                         }
 100                 }
 101         }
 102
 103         /**
 104          * Automatic database updates
 105          *
 106          * @param string $basePath The base path of this application
 107          * @param bool   $force    Force the Update-Check even if the database version doesn't match
 108          * @param bool   $override Overrides any running/stuck updates
 109          * @param bool   $verbose  Run the Update-Check verbose
 110          * @param bool   $sendMail Sends a Mail to the administrator in case of success/failure
 111          * @return string Empty string if the update is successful, error messages otherwise
 112          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 113          */
 114         public static function run(string $basePath, bool $force = false, bool $override = false, bool $verbose = false, bool $sendMail = true): string
 115         {
 116                 // In force mode, we release the dbupdate lock first
 117                 // Necessary in case of an stuck update
 118                 if ($override) {
 119                         DI::lock()->release('dbupdate', true);
 120                 }
 121
 122                 $build = DI::config()->get('system', 'build', null);
 123
 124                 if (empty($build) || ($build > DB_UPDATE_VERSION)) {
 125                         $build = DB_UPDATE_VERSION - 1;
 126                         DI::config()->set('system', 'build', $build);
 127                 }
 128
 129                 if ($build != DB_UPDATE_VERSION || $force) {
 130                         require_once 'update.php';
 131
 132                         $stored = intval($build);
 133                         $current = intval(DB_UPDATE_VERSION);
 134                         if ($stored < $current || $force) {
 135                                 DI::config()->reload();
 136
 137                                 // Compare the current structure with the defined structure
 138                                 // If the Lock is acquired, never release it automatically to avoid double updates
 139                                 if (DI::lock()->acquire('dbupdate', 0, Cache\Enum\Duration::INFINITE)) {
 140
 141                                         Logger::notice('Update starting.', ['from' => $stored, 'to' => $current]);
 142
 143                                         // Checks if the build changed during Lock acquiring (so no double update occurs)
 144                                         $retryBuild = DI::config()->get('system', 'build', null);
 145                                         if ($retryBuild !== $build) {
 146                                                 Logger::notice('Update already done.', ['from' => $stored, 'to' => $current]);
 147                                                 DI::lock()->release('dbupdate');
 148                                                 return '';
 149                                         }
 150
 151                                         DI::config()->set('system', 'maintenance', 1);
 152
 153                                         // run the pre_update_nnnn functions in update.php
 154                                         for ($version = $stored + 1; $version <= $current; $version++) {
 155                                                 Logger::notice('Execute pre update.', ['version' => $version]);
 156                                                 DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: executing pre update %d',
 157                                                         DateTimeFormat::utcNow() . ' ' . date('e'), $version));
 158                                                 $r = self::runUpdateFunction($version, 'pre_update', $sendMail);
 159                                                 if (!$r) {
 160                                                         Logger::warning('Pre update failed', ['version' => $version]);
 161                                                         DI::config()->set('system', 'update', Update::FAILED);
 162                                                         DI::lock()->release('dbupdate');
 163                                                         DI::config()->set('system', 'maintenance', false, false);
 164                                                         DI::config()->delete('system', 'maintenance_reason', false);
 165                                                         DI::config()->save();
 166                                                         return $r;
 167                                                 } else {
 168                                                         Logger::notice('Pre update executed.', ['version' => $version]);
 169                                                 }
 170                                         }
 171
 172                                         // update the structure in one call
 173                                         Logger::notice('Execute structure update');
 174                                         $retval = DBStructure::performUpdate(false, $verbose);
 175                                         if (!empty($retval)) {
 176                                                 if ($sendMail) {
 177                                                         self::updateFailed(
 178                                                                 DB_UPDATE_VERSION,
 179                                                                 $retval
 180                                                         );
 181                                                 }
 182                                                 Logger::error('Update ERROR.', ['from' => $stored, 'to' => $current, 'retval' => $retval]);
 183                                                 DI::config()->set('system', 'update', Update::FAILED);
 184                                                 DI::lock()->release('dbupdate');
 185                                                 DI::config()->set('system', 'maintenance', false, false);
 186                                                 DI::config()->delete('system', 'maintenance_reason', false);
 187                                                 DI::config()->save();
 188                                                 return $retval;
 189                                         } else {
 190                                                 Logger::notice('Database structure update finished.', ['from' => $stored, 'to' => $current]);
 191                                         }
 192
 193                                         // run the update_nnnn functions in update.php
 194                                         for ($version = $stored + 1; $version <= $current; $version++) {
 195                                                 Logger::notice('Execute post update.', ['version' => $version]);
 196                                                 DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: executing post update %d',
 197                                                         DateTimeFormat::utcNow() . ' ' . date('e'), $version));
 198                                                 $r = self::runUpdateFunction($version, 'update', $sendMail);
 199                                                 if (!$r) {
 200                                                         Logger::warning('Post update failed', ['version' => $version]);
 201                                                         DI::config()->set('system', 'update', Update::FAILED);
 202                                                         DI::lock()->release('dbupdate');
 203                                                         DI::config()->set('system', 'maintenance', false, false);
 204                                                         DI::config()->delete('system', 'maintenance_reason', false);
 205                                                         DI::config()->save();
 206                                                         return $r;
 207                                                 } else {
 208                                                         DI::config()->set('system', 'build', $version);
 209                                                         Logger::notice('Post update executed.', ['version' => $version]);
 210                                                 }
 211                                         }
 212
 213                                         DI::config()->set('system', 'build', $current);
 214                                         DI::config()->set('system', 'update', Update::SUCCESS);
 215                                         DI::lock()->release('dbupdate');
 216                                         DI::config()->set('system', 'maintenance', false, false);
 217                                         DI::config()->delete('system', 'maintenance_reason',  false);
 218                                         DI::config()->save();
 219
 220                                         Logger::notice('Update success.', ['from' => $stored, 'to' => $current]);
 221                                         if ($sendMail) {
 222                                                 self::updateSuccessful($stored, $current);
 223                                         }
 224                                 } else {
 225                                         Logger::warning('Update lock could not be acquired');
 226                                 }
 227                         }
 228                 }
 229
 230                 return '';
 231         }
 232
 233         /**
 234          * Executes a specific update function
 235          *
 236          * @param int    $version  the DB version number of the function
 237          * @param string $prefix   the prefix of the function (update, pre_update)
 238          * @param bool   $sendMail whether to send emails on success/failure
 239          * @return bool true, if the update function worked
 240          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 241          */
 242         public static function runUpdateFunction(int $version, string $prefix, bool $sendMail = true): bool
 243         {
 244                 $funcname = $prefix . '_' . $version;
 245
 246                 Logger::notice('Update function start.', ['function' => $funcname]);
 247
 248                 if (function_exists($funcname)) {
 249                         // There could be a lot of processes running or about to run.
 250                         // We want exactly one process to run the update command.
 251                         // So store the fact that we're taking responsibility
 252                         // after first checking to see if somebody else already has.
 253                         // If the update fails or times-out completely you may need to
 254                         // delete the config entry to try again.
 255
 256                         if (DI::lock()->acquire('dbupdate_function', 120, Cache\Enum\Duration::INFINITE)) {
 257
 258                                 // call the specific update
 259                                 Logger::notice('Pre update function start.', ['function' => $funcname]);
 260                                 $retval = $funcname();
 261                                 Logger::notice('Update function done.', ['function' => $funcname]);
 262
 263                                 if ($retval) {
 264                                         if ($sendMail) {
 265                                                 //send the administrator an e-mail
 266                                                 self::updateFailed(
 267                                                         $version,
 268                                                         DI::l10n()->t('Update %s failed. See error logs.', $version)
 269                                                 );
 270                                         }
 271                                         Logger::error('Update function ERROR.', ['function' => $funcname, 'retval' => $retval]);
 272                                         DI::lock()->release('dbupdate_function');
 273                                         return false;
 274                                 } else {
 275                                         DI::lock()->release('dbupdate_function');
 276                                         Logger::notice('Update function finished.', ['function' => $funcname]);
 277                                         return true;
 278                                 }
 279                         } else {
 280                                 Logger::error('Locking failed.', ['function' => $funcname]);
 281                                 return false;
 282                         }
 283                 } else {
 284                         Logger::notice('Update function skipped.', ['function' => $funcname]);
 285                         return true;
 286                 }
 287         }
 288
 289         /**
 290          * send the email and do what is needed to do on update fails
 291          *
 292          * @param int    $update_id     number of failed update
 293          * @param string $error_message error message
 294          * @return void
 295          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 296          */
 297         private static function updateFailed(int $update_id, string $error_message)
 298         {
 299                 $adminEmails = User::getAdminListForEmailing(['uid', 'language', 'email']);
 300                 if (!$adminEmails) {
 301                         Logger::warning('Cannot notify administrators .', ['update' => $update_id, 'message' => $error_message]);
 302                         return;
 303                 }
 304
 305                 foreach($adminEmails as $admin) {
 306                         $l10n = DI::l10n()->withLang($admin['language'] ?: 'en');
 307
 308                         $preamble = Strings::deindent($l10n->t("
 309                                 The friendica developers released update %s recently,
 310                                 but when I tried to install it, something went terribly wrong.
 311                                 This needs to be fixed soon and I can't do it alone. Please contact a
 312                                 friendica developer if you can not help me on your own. My database might be invalid.",
 313                                 $update_id));
 314                         $body     = $l10n->t('The error message is\n[pre]%s[/pre]', $error_message);
 315
 316                         $email = DI::emailer()
 317                                 ->newSystemMail()
 318                                 ->withMessage($l10n->t('[Friendica Notify] Database update'), $preamble, $body)
 319                                 ->forUser($admin)
 320                                 ->withRecipient($admin['email'])
 321                                 ->build();
 322                         DI::emailer()->send($email);
 323                 }
 324
 325                 Logger::alert('Database structure update failed.', ['error' => $error_message]);
 326         }
 327
 328         /**
 329          * Send a mail to the administrator about the successful update
 330          *
 331          * @param integer $from_build
 332          * @param integer $to_build
 333          * @return void
 334          */
 335         private static function updateSuccessful(int $from_build, int $to_build)
 336         {
 337                 foreach(User::getAdminListForEmailing(['uid', 'language', 'email']) as $admin) {
 338                         $l10n = DI::l10n()->withLang($admin['language'] ?: 'en');
 339
 340                         $preamble = Strings::deindent($l10n->t('
 341                                 The friendica database was successfully updated from %s to %s.',
 342                                 $from_build, $to_build));
 343
 344                         $email = DI::emailer()
 345                                 ->newSystemMail()
 346                                 ->withMessage($l10n->t('[Friendica Notify] Database update'), $preamble)
 347                                 ->forUser($admin)
 348                                 ->withRecipient($admin['email'])
 349                                 ->build();
 350                         DI::emailer()->send($email);
 351                 }
 352
 353                 Logger::debug('Database structure update successful.');
 354         }
 355 }