<?php
/**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2023, 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\Model\User;
+use Friendica\Network\HTTPException\InternalServerErrorException;
+use Friendica\Util\DateTimeFormat;
use Friendica\Util\Strings;
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($basePath, $via_worker, App\Mode $mode)
+ public static function check(string $basePath, bool $via_worker)
{
if (!DBA::connected()) {
return;
}
// Don't check the status if the last update was failed
- if (DI::config()->get('system', 'update', Update::SUCCESS, true) == Update::FAILED) {
+ if (DI::config()->get('system', 'update', Update::SUCCESS) == Update::FAILED) {
return;
}
$build = DI::config()->get('system', 'build');
if (empty($build)) {
- DI::config()->set('system', 'build', DB_UPDATE_VERSION - 1);
- $build = DB_UPDATE_VERSION - 1;
+ // legacy option - check if there's something in the Config table
+ if (DBStructure::existsTable('config')) {
+ $dbConfig = DBA::selectFirst('config', ['v'], ['cat' => 'system', 'k' => 'build']);
+ if (!empty($dbConfig)) {
+ $build = $dbConfig['v'];
+ }
+ }
+
+ if (empty($build)) {
+ DI::config()->set('system', 'build', DB_UPDATE_VERSION - 1);
+ $build = DB_UPDATE_VERSION - 1;
+ }
}
// 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 < 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);
+ } else {
+ throw new InternalServerErrorException($error);
+ }
+ }
+
+ // The postupdate has to completed version 1288 for the new post views to take over
+ $postupdate = DI::keyValue()->get('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);
+ } else {
+ throw new InternalServerErrorException($error);
+ }
}
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');
}
}
}
* 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): string
{
// In force mode, we release the dbupdate lock first
// Necessary in case of an stuck update
DI::lock()->release('dbupdate', true);
}
- $build = DI::config()->get('system', 'build', null, true);
+ $build = DI::config()->get('system', 'build');
- if (empty($build) || ($build > DB_UPDATE_VERSION)) {
- $build = DB_UPDATE_VERSION - 1;
- DI::config()->set('system', 'build', $build);
+ if (empty($build)) {
+ $dbConfig = DBA::selectFirst('config', ['v'], ['cat' => 'system', 'k' => 'build']);
+ if (!empty($dbConfig)) {
+ $build = $dbConfig['v'];
+ }
+
+ if (empty($build) || ($build > DB_UPDATE_VERSION)) {
+ DI::config()->set('system', 'build', DB_UPDATE_VERSION - 1);
+ $build = DB_UPDATE_VERSION - 1;
+ }
}
if ($build != DB_UPDATE_VERSION || $force) {
$stored = intval($build);
$current = intval(DB_UPDATE_VERSION);
if ($stored < $current || $force) {
- DI::config()->load('database');
-
- Logger::notice('Update starting.', ['from' => $stored, 'to' => $current]);
+ DI::config()->reload();
// 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);
- if ($retryBuild !== $build) {
- Logger::notice('Update already done.', ['from' => $stored, 'to' => $current]);
- DI::lock()->release('dbupdate');
- return '';
+ $retryBuild = DI::config()->get('system', 'build');
+ if ($retryBuild != $build) {
+ // legacy option - check if there's something in the Config table
+ if (DBStructure::existsTable('config')) {
+ $dbConfig = DBA::selectFirst('config', ['v'], ['cat' => 'system', 'k' => 'build']);
+ if (!empty($dbConfig)) {
+ $retryBuild = intval($dbConfig['v']);
+ }
+ }
+
+ if ($retryBuild != $build) {
+ Logger::notice('Update already done.', ['from' => $build, 'retry' => $retryBuild, 'to' => $current]);
+ DI::lock()->release('dbupdate');
+ 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()->beginTransaction()
+ ->set('system', 'maintenance', false)
+ ->delete('system', 'maintenance_reason')
+ ->commit();
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(
Logger::error('Update ERROR.', ['from' => $stored, 'to' => $current, 'retval' => $retval]);
DI::config()->set('system', 'update', Update::FAILED);
DI::lock()->release('dbupdate');
+ DI::config()->beginTransaction()
+ ->set('system', 'maintenance', false)
+ ->delete('system', 'maintenance_reason')
+ ->commit();
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()->beginTransaction()
+ ->set('system', 'maintenance', false)
+ ->delete('system', 'maintenance_reason')
+ ->commit();
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()->beginTransaction()
+ ->set('system', 'maintenance', false)
+ ->delete('system', 'maintenance_reason')
+ ->commit();
+
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');
}
}
}
/**
* 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): bool
{
- $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.
// 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;
}
}
*
* @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($update_id, $error_message) {
- //send the administrators an e-mail
- $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?
- if (!DBA::isResult($adminlist)) {
+ private static function updateFailed(int $update_id, string $error_message)
+ {
+ $adminEmails = User::getAdminListForEmailing(['uid', 'language', 'email']);
+ if (!$adminEmails) {
Logger::warning('Cannot notify administrators .', ['update' => $update_id, 'message' => $error_message]);
-
- // Don't continue
return;
}
- $sent = [];
-
- // every admin could had different language
- while ($admin = DBA::fetch($adminlist)) {
- if (in_array($admin['email'], $sent)) {
- continue;
- }
- $sent[] = $admin['email'];
-
- $lang = $admin['language'] ?? 'en';
- $l10n = DI::l10n()->withLang($lang);
+ foreach($adminEmails as $admin) {
+ $l10n = DI::l10n()->withLang($admin['language'] ?: 'en');
$preamble = Strings::deindent($l10n->t("
The friendica developers released update %s recently,
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()
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];
- $adminlist = DBA::select('user', ['uid', 'language', 'email'], $condition, ['order' => ['uid']]);
+ foreach(User::getAdminListForEmailing(['uid', 'language', 'email']) as $admin) {
+ $l10n = DI::l10n()->withLang($admin['language'] ?: 'en');
- if (DBA::isResult($adminlist)) {
- $sent = [];
+ $preamble = Strings::deindent($l10n->t('
+ The friendica database was successfully updated from %s to %s.',
+ $from_build, $to_build));
- // every admin could had different language
- while ($admin = DBA::fetch($adminlist)) {
- if (in_array($admin['email'], $sent)) {
- continue;
- }
- $sent[] = $admin['email'];
-
- $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.",
- $from_build, $to_build));
-
- $email = DI::emailer()
- ->newSystemMail()
- ->withMessage($l10n->t('[Friendica Notify] Database update'), $preamble)
- ->forUser($admin)
- ->withRecipient($admin['email'])
- ->build();
- DI::emailer()->send($email);
- }
+ $email = DI::emailer()
+ ->newSystemMail()
+ ->withMessage($l10n->t('[Friendica Notify] Database update'), $preamble)
+ ->forUser($admin)
+ ->withRecipient($admin['email'])
+ ->build();
+ DI::emailer()->send($email);
}
- //try the logger
Logger::debug('Database structure update successful.');
}
}
projects / friendica.git / blobdiff