src/Core/Update.php

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