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)
  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                         // legacy option - check if there's something in the Config table
  65                         if (DBStructure::existsTable('config')) {
  66                                 $dbConfig = DBA::selectFirst('config', ['v'], ['cat' => 'system', 'k' => 'build']);
  67                                 if (!empty($dbConfig)) {
  68                                         $build = $dbConfig['v'];
  69                                 }
  70                         }
  71
  72                         if (empty($build)) {
  73                                 DI::config()->set('system', 'build', DB_UPDATE_VERSION - 1);
  74                                 $build = DB_UPDATE_VERSION - 1;
  75                         }
  76                 }
  77
  78                 // We don't support upgrading from very old versions anymore
  79                 if ($build < self::NEW_TABLE_STRUCTURE_VERSION) {
  80                         $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);
  81                         if (DI::mode()->getExecutor() == Mode::INDEX) {
  82                                 die($error);
  83                         } else {
  84                                 throw new InternalServerErrorException($error);
  85                         }
  86                 }
  87
  88                 // The postupdate has to completed version 1288 for the new post views to take over
  89                 $postupdate = DI::keyValue()->get('post_update_version') ?? self::NEW_TABLE_STRUCTURE_VERSION;
  90                 if ($postupdate < self::NEW_TABLE_STRUCTURE_VERSION) {
  91                         $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);
  92                         if (DI::mode()->getExecutor() == Mode::INDEX) {
  93                                 die($error);
  94                         } else {
  95                                 throw new InternalServerErrorException($error);
  96                         }
  97                 }
  98
  99                 if ($build < DB_UPDATE_VERSION) {
 100                         if ($via_worker) {
 101                                 /*
 102                                  * Calling the database update directly via the worker enables us to perform database changes to the workerqueue table itself.
 103                                  * This is a fallback, since normally the database update will be performed by a worker job.
 104                                  * This worker job doesn't work for changes to the "workerqueue" table itself.
 105                                  */
 106                                 self::run($basePath);
 107                         } else {
 108                                 Worker::add(Worker::PRIORITY_CRITICAL, 'DBUpdate');
 109                         }
 110                 }
 111         }
 112
 113         /**
 114          * Automatic database updates
 115          *
 116          * @param string $basePath The base path of this application
 117          * @param bool   $force    Force the Update-Check even if the database version doesn't match
 118          * @param bool   $override Overrides any running/stuck updates
 119          * @param bool   $verbose  Run the Update-Check verbose
 120          * @param bool   $sendMail Sends a Mail to the administrator in case of success/failure
 121          * @return string Empty string if the update is successful, error messages otherwise
 122          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 123          */
 124         public static function run(string $basePath, bool $force = false, bool $override = false, bool $verbose = false, bool $sendMail = true): string
 125         {
 126                 // In force mode, we release the dbupdate lock first
 127                 // Necessary in case of an stuck update
 128                 if ($override) {
 129                         DI::lock()->release('dbupdate', true);
 130                 }
 131
 132                 $build = DI::config()->get('system', 'build');
 133
 134                 if (empty($build)) {
 135                         // legacy option - check if the Config table exists
 136                         if (DBStructure::existsTable('config')) {
 137                                 $dbConfig = DBA::selectFirst('config', ['v'], ['cat' => 'system', 'k' => 'build']);
 138                                 if (!empty($dbConfig)) {
 139                                         $build = $dbConfig['v'];
 140                                 }
 141                         }
 142
 143                         if (empty($build) || ($build > DB_UPDATE_VERSION)) {
 144                                 // legacy option - check if the Config table exists
 145                                 if (DBStructure::existsTable('config')) {
 146                                         DI::config()->set('system', 'build', DB_UPDATE_VERSION - 1);
 147                                 }
 148                                 $build = DB_UPDATE_VERSION - 1;
 149                         }
 150                 }
 151
 152                 if ($build != DB_UPDATE_VERSION || $force) {
 153                         require_once 'update.php';
 154
 155                         $stored = intval($build);
 156                         $current = intval(DB_UPDATE_VERSION);
 157                         if ($stored < $current || $force) {
 158                                 DI::config()->reload();
 159
 160                                 // Compare the current structure with the defined structure
 161                                 // If the Lock is acquired, never release it automatically to avoid double updates
 162                                 if (DI::lock()->acquire('dbupdate', 0, Cache\Enum\Duration::INFINITE)) {
 163
 164                                         Logger::notice('Update starting.', ['from' => $stored, 'to' => $current]);
 165
 166                                         // Checks if the build changed during Lock acquiring (so no double update occurs)
 167                                         $retryBuild = DI::config()->get('system', 'build');
 168                                         if ($retryBuild != $build) {
 169                                                 // legacy option - check if there's something in the Config table
 170                                                 if (DBStructure::existsTable('config')) {
 171                                                         $dbConfig = DBA::selectFirst('config', ['v'], ['cat' => 'system', 'k' => 'build']);
 172                                                         if (!empty($dbConfig)) {
 173                                                                 $retryBuild = intval($dbConfig['v']);
 174                                                         }
 175                                                 }
 176
 177                                                 if ($retryBuild != $build) {
 178                                                         Logger::notice('Update already done.', ['from' => $build, 'retry' => $retryBuild, 'to' => $current]);
 179                                                         DI::lock()->release('dbupdate');
 180                                                         return '';
 181                                                 }
 182                                         }
 183
 184                                         DI::config()->set('system', 'maintenance', 1);
 185
 186                                         // run the pre_update_nnnn functions in update.php
 187                                         for ($version = $stored + 1; $version <= $current; $version++) {
 188                                                 Logger::notice('Execute pre update.', ['version' => $version]);
 189                                                 DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: executing pre update %d',
 190                                                         DateTimeFormat::utcNow() . ' ' . date('e'), $version));
 191                                                 $r = self::runUpdateFunction($version, 'pre_update', $sendMail);
 192                                                 if (!$r) {
 193                                                         Logger::warning('Pre update failed', ['version' => $version]);
 194                                                         DI::config()->set('system', 'update', Update::FAILED);
 195                                                         DI::lock()->release('dbupdate');
 196                                                         DI::config()->beginTransaction()
 197                                                                                 ->set('system', 'maintenance', false)
 198                                                                                 ->delete('system', 'maintenance_reason')
 199                                                                                 ->commit();
 200                                                         return $r;
 201                                                 } else {
 202                                                         Logger::notice('Pre update executed.', ['version' => $version]);
 203                                                 }
 204                                         }
 205
 206                                         // update the structure in one call
 207                                         Logger::notice('Execute structure update');
 208                                         $retval = DBStructure::performUpdate(false, $verbose);
 209                                         if (!empty($retval)) {
 210                                                 if ($sendMail) {
 211                                                         self::updateFailed(
 212                                                                 DB_UPDATE_VERSION,
 213                                                                 $retval
 214                                                         );
 215                                                 }
 216                                                 Logger::error('Update ERROR.', ['from' => $stored, 'to' => $current, 'retval' => $retval]);
 217                                                 DI::config()->set('system', 'update', Update::FAILED);
 218                                                 DI::lock()->release('dbupdate');
 219                                                 DI::config()->beginTransaction()
 220                                                                         ->set('system', 'maintenance', false)
 221                                                                         ->delete('system', 'maintenance_reason')
 222                                                                         ->commit();
 223                                                 return $retval;
 224                                         } else {
 225                                                 Logger::notice('Database structure update finished.', ['from' => $stored, 'to' => $current]);
 226                                         }
 227
 228                                         // run the update_nnnn functions in update.php
 229                                         for ($version = $stored + 1; $version <= $current; $version++) {
 230                                                 Logger::notice('Execute post update.', ['version' => $version]);
 231                                                 DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: executing post update %d',
 232                                                         DateTimeFormat::utcNow() . ' ' . date('e'), $version));
 233                                                 $r = self::runUpdateFunction($version, 'update', $sendMail);
 234                                                 if (!$r) {
 235                                                         Logger::warning('Post update failed', ['version' => $version]);
 236                                                         DI::config()->set('system', 'update', Update::FAILED);
 237                                                         DI::lock()->release('dbupdate');
 238                                                         DI::config()->beginTransaction()
 239                                                                                 ->set('system', 'maintenance', false)
 240                                                                                 ->delete('system', 'maintenance_reason')
 241                                                                                 ->commit();
 242                                                         return $r;
 243                                                 } else {
 244                                                         DI::config()->set('system', 'build', $version);
 245                                                         Logger::notice('Post update executed.', ['version' => $version]);
 246                                                 }
 247                                         }
 248
 249                                         DI::config()->set('system', 'build', $current);
 250                                         DI::config()->set('system', 'update', Update::SUCCESS);
 251                                         DI::lock()->release('dbupdate');
 252                                         DI::config()->beginTransaction()
 253                                                                 ->set('system', 'maintenance', false)
 254                                                                 ->delete('system', 'maintenance_reason')
 255                                                                 ->commit();
 256
 257                                         Logger::notice('Update success.', ['from' => $stored, 'to' => $current]);
 258                                         if ($sendMail) {
 259                                                 self::updateSuccessful($stored, $current);
 260                                         }
 261                                 } else {
 262                                         Logger::warning('Update lock could not be acquired');
 263                                 }
 264                         }
 265                 }
 266
 267                 return '';
 268         }
 269
 270         /**
 271          * Executes a specific update function
 272          *
 273          * @param int    $version  the DB version number of the function
 274          * @param string $prefix   the prefix of the function (update, pre_update)
 275          * @param bool   $sendMail whether to send emails on success/failure
 276          * @return bool true, if the update function worked
 277          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 278          */
 279         public static function runUpdateFunction(int $version, string $prefix, bool $sendMail = true): bool
 280         {
 281                 $funcname = $prefix . '_' . $version;
 282
 283                 Logger::notice('Update function start.', ['function' => $funcname]);
 284
 285                 if (function_exists($funcname)) {
 286                         // There could be a lot of processes running or about to run.
 287                         // We want exactly one process to run the update command.
 288                         // So store the fact that we're taking responsibility
 289                         // after first checking to see if somebody else already has.
 290                         // If the update fails or times-out completely you may need to
 291                         // delete the config entry to try again.
 292
 293                         if (DI::lock()->acquire('dbupdate_function', 120, Cache\Enum\Duration::INFINITE)) {
 294
 295                                 // call the specific update
 296                                 Logger::notice('Pre update function start.', ['function' => $funcname]);
 297                                 $retval = $funcname();
 298                                 Logger::notice('Update function done.', ['function' => $funcname]);
 299
 300                                 if ($retval) {
 301                                         if ($sendMail) {
 302                                                 //send the administrator an e-mail
 303                                                 self::updateFailed(
 304                                                         $version,
 305                                                         DI::l10n()->t('Update %s failed. See error logs.', $version)
 306                                                 );
 307                                         }
 308                                         Logger::error('Update function ERROR.', ['function' => $funcname, 'retval' => $retval]);
 309                                         DI::lock()->release('dbupdate_function');
 310                                         return false;
 311                                 } else {
 312                                         DI::lock()->release('dbupdate_function');
 313                                         Logger::notice('Update function finished.', ['function' => $funcname]);
 314                                         return true;
 315                                 }
 316                         } else {
 317                                 Logger::error('Locking failed.', ['function' => $funcname]);
 318                                 return false;
 319                         }
 320                 } else {
 321                         Logger::notice('Update function skipped.', ['function' => $funcname]);
 322                         return true;
 323                 }
 324         }
 325
 326         /**
 327          * send the email and do what is needed to do on update fails
 328          *
 329          * @param int    $update_id     number of failed update
 330          * @param string $error_message error message
 331          * @return void
 332          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 333          */
 334         private static function updateFailed(int $update_id, string $error_message)
 335         {
 336                 $adminEmails = User::getAdminListForEmailing(['uid', 'language', 'email']);
 337                 if (!$adminEmails) {
 338                         Logger::warning('Cannot notify administrators .', ['update' => $update_id, 'message' => $error_message]);
 339                         return;
 340                 }
 341
 342                 foreach($adminEmails as $admin) {
 343                         $l10n = DI::l10n()->withLang($admin['language'] ?: 'en');
 344
 345                         $preamble = Strings::deindent($l10n->t("
 346                                 The friendica developers released update %s recently,
 347                                 but when I tried to install it, something went terribly wrong.
 348                                 This needs to be fixed soon and I can't do it alone. Please contact a
 349                                 friendica developer if you can not help me on your own. My database might be invalid.",
 350                                 $update_id));
 351                         $body     = $l10n->t('The error message is\n[pre]%s[/pre]', $error_message);
 352
 353                         $email = DI::emailer()
 354                                 ->newSystemMail()
 355                                 ->withMessage($l10n->t('[Friendica Notify] Database update'), $preamble, $body)
 356                                 ->forUser($admin)
 357                                 ->withRecipient($admin['email'])
 358                                 ->build();
 359                         DI::emailer()->send($email);
 360                 }
 361
 362                 Logger::alert('Database structure update failed.', ['error' => $error_message]);
 363         }
 364
 365         /**
 366          * Send a mail to the administrator about the successful update
 367          *
 368          * @param integer $from_build
 369          * @param integer $to_build
 370          * @return void
 371          */
 372         private static function updateSuccessful(int $from_build, int $to_build)
 373         {
 374                 foreach(User::getAdminListForEmailing(['uid', 'language', 'email']) as $admin) {
 375                         $l10n = DI::l10n()->withLang($admin['language'] ?: 'en');
 376
 377                         $preamble = Strings::deindent($l10n->t('
 378                                 The friendica database was successfully updated from %s to %s.',
 379                                 $from_build, $to_build));
 380
 381                         $email = DI::emailer()
 382                                 ->newSystemMail()
 383                                 ->withMessage($l10n->t('[Friendica Notify] Database update'), $preamble)
 384                                 ->forUser($admin)
 385                                 ->withRecipient($admin['email'])
 386                                 ->build();
 387                         DI::emailer()->send($email);
 388                 }
 389
 390                 Logger::debug('Database structure update successful.');
 391         }
 392 }