3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Core;
25 use Friendica\App\Mode;
26 use Friendica\Database\DBA;
27 use Friendica\Database\DBStructure;
29 use Friendica\Network\HTTPException\InternalServerErrorException;
30 use Friendica\Util\DateTimeFormat;
31 use Friendica\Util\Strings;
39 * Function to check if the Database structure needs an update.
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
45 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
47 public static function check(string $basePath, bool $via_worker, App\Mode $mode)
49 if (!DBA::connected()) {
53 // Don't check the status if the last update was failed
54 if (DI::config()->get('system', 'update', Update::SUCCESS, true) == Update::FAILED) {
58 $build = DI::config()->get('system', 'build');
61 DI::config()->set('system', 'build', DB_UPDATE_VERSION - 1);
62 $build = DB_UPDATE_VERSION - 1;
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) {
71 throw new InternalServerErrorException($error);
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) {
82 throw new InternalServerErrorException($error);
86 if ($build < DB_UPDATE_VERSION) {
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.
93 Worker::add(PRIORITY_CRITICAL, 'DBUpdate');
99 * Automatic database updates
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
107 * @return string Empty string if the update is successful, error messages otherwise
108 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
110 public static function run(string $basePath, bool $force = false, bool $override = false, bool $verbose = false, bool $sendMail = true)
112 // In force mode, we release the dbupdate lock first
113 // Necessary in case of an stuck update
115 DI::lock()->release('dbupdate', true);
118 $build = DI::config()->get('system', 'build', null, true);
120 if (empty($build) || ($build > DB_UPDATE_VERSION)) {
121 $build = DB_UPDATE_VERSION - 1;
122 DI::config()->set('system', 'build', $build);
125 if ($build != DB_UPDATE_VERSION || $force) {
126 require_once 'update.php';
128 $stored = intval($build);
129 $current = intval(DB_UPDATE_VERSION);
130 if ($stored < $current || $force) {
131 DI::config()->load('database');
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\Duration::INFINITE)) {
137 Logger::notice('Update starting.', ['from' => $stored, 'to' => $current]);
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');
147 DI::config()->set('system', 'maintenance', 1);
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);
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', '');
163 Logger::notice('Pre update executed.', ['version' => $version]);
167 // update the structure in one call
168 Logger::notice('Execute structure update');
169 $retval = DBStructure::performUpdate(false, $verbose);
170 if (!empty($retval)) {
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', '');
184 Logger::notice('Database structure update finished.', ['from' => $stored, 'to' => $current]);
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);
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', '');
201 DI::config()->set('system', 'build', $version);
202 Logger::notice('Post update executed.', ['version' => $version]);
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', '');
212 Logger::notice('Update success.', ['from' => $stored, 'to' => $current]);
214 self::updateSuccessful($stored, $current);
224 * Executes a specific update function
226 * @param int $version the DB version number of the function
227 * @param string $prefix the prefix of the function (update, pre_update)
228 * @param bool $sendMail whether to send emails on success/failure
230 * @return bool true, if the update function worked
231 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
233 public static function runUpdateFunction(int $version, string $prefix, bool $sendMail = true)
235 $funcname = $prefix . '_' . $version;
237 Logger::notice('Update function start.', ['function' => $funcname]);
239 if (function_exists($funcname)) {
240 // There could be a lot of processes running or about to run.
241 // We want exactly one process to run the update command.
242 // So store the fact that we're taking responsibility
243 // after first checking to see if somebody else already has.
244 // If the update fails or times-out completely you may need to
245 // delete the config entry to try again.
247 if (DI::lock()->acquire('dbupdate_function', 120, Cache\Duration::INFINITE)) {
249 // call the specific update
250 Logger::notice('Pre update function start.', ['function' => $funcname]);
251 $retval = $funcname();
252 Logger::notice('Update function done.', ['function' => $funcname]);
256 //send the administrator an e-mail
259 DI::l10n()->t('Update %s failed. See error logs.', $version)
262 Logger::error('Update function ERROR.', ['function' => $funcname, 'retval' => $retval]);
263 DI::lock()->release('dbupdate_function');
266 DI::lock()->release('dbupdate_function');
267 Logger::notice('Update function finished.', ['function' => $funcname]);
271 Logger::error('Locking failed.', ['function' => $funcname]);
275 Logger::notice('Update function skipped.', ['function' => $funcname]);
281 * send the email and do what is needed to do on update fails
283 * @param int $update_id number of failed update
284 * @param string $error_message error message
285 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
287 private static function updateFailed(int $update_id, string $error_message) {
288 //send the administrators an e-mail
289 $condition = ['email' => explode(',', str_replace(' ', '', DI::config()->get('config', 'admin_email'))), 'parent-uid' => 0];
290 $adminlist = DBA::select('user', ['uid', 'language', 'email'], $condition, ['order' => ['uid']]);
293 if (!DBA::isResult($adminlist)) {
294 Logger::warning('Cannot notify administrators .', ['update' => $update_id, 'message' => $error_message]);
302 // every admin could had different language
303 while ($admin = DBA::fetch($adminlist)) {
304 if (in_array($admin['email'], $sent)) {
307 $sent[] = $admin['email'];
309 $lang = $admin['language'] ?? 'en';
310 $l10n = DI::l10n()->withLang($lang);
312 $preamble = Strings::deindent($l10n->t("
313 The friendica developers released update %s recently,
314 but when I tried to install it, something went terribly wrong.
315 This needs to be fixed soon and I can't do it alone. Please contact a
316 friendica developer if you can not help me on your own. My database might be invalid.",
318 $body = $l10n->t('The error message is\n[pre]%s[/pre]', $error_message);
320 $email = DI::emailer()
322 ->withMessage($l10n->t('[Friendica Notify] Database update'), $preamble, $body)
324 ->withRecipient($admin['email'])
326 DI::emailer()->send($email);
329 Logger::alert('Database structure update failed.', ['error' => $error_message]);
333 * Send a mail to the administrator about the successful update
335 * @param integer $from_build
336 * @param integer $to_build
339 private static function updateSuccessful(int $from_build, int $to_build)
341 //send the administrators an e-mail
342 $condition = ['email' => explode(',', str_replace(' ', '', DI::config()->get('config', 'admin_email'))), 'parent-uid' => 0];
343 $adminlist = DBA::select('user', ['uid', 'language', 'email'], $condition, ['order' => ['uid']]);
345 if (DBA::isResult($adminlist)) {
348 // every admin could had different language
349 while ($admin = DBA::fetch($adminlist)) {
350 if (in_array($admin['email'], $sent)) {
353 $sent[] = $admin['email'];
355 $lang = (($admin['language']) ? $admin['language'] : 'en');
356 $l10n = DI::l10n()->withLang($lang);
358 $preamble = Strings::deindent($l10n->t('
359 The friendica database was successfully updated from %s to %s.',
360 $from_build, $to_build));
362 $email = DI::emailer()
364 ->withMessage($l10n->t('[Friendica Notify] Database update'), $preamble)
366 ->withRecipient($admin['email'])
368 DI::emailer()->send($email);
372 Logger::debug('Database structure update successful.');