]> git.mxchange.org Git - friendica.git/blob - src/Core/Update.php
add self for unfollowed contact
[friendica.git] / 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                         $dbConfig = DBA::selectFirst('config', ['v'], ['cat' => 'system', 'k' => 'build']);
136                         if (!empty($dbConfig)) {
137                                 $build = $dbConfig['v'];
138                         }
139
140                         if (empty($build) || ($build > DB_UPDATE_VERSION)) {
141                                 DI::config()->set('system', 'build', DB_UPDATE_VERSION - 1);
142                                 $build = DB_UPDATE_VERSION - 1;
143                         }
144                 }
145
146                 if ($build != DB_UPDATE_VERSION || $force) {
147                         require_once 'update.php';
148
149                         $stored = intval($build);
150                         $current = intval(DB_UPDATE_VERSION);
151                         if ($stored < $current || $force) {
152                                 DI::config()->reload();
153
154                                 // Compare the current structure with the defined structure
155                                 // If the Lock is acquired, never release it automatically to avoid double updates
156                                 if (DI::lock()->acquire('dbupdate', 0, Cache\Enum\Duration::INFINITE)) {
157
158                                         Logger::notice('Update starting.', ['from' => $stored, 'to' => $current]);
159
160                                         // Checks if the build changed during Lock acquiring (so no double update occurs)
161                                         $retryBuild = DI::config()->get('system', 'build');
162                                         if ($retryBuild != $build) {
163                                                 // legacy option - check if there's something in the Config table
164                                                 if (DBStructure::existsTable('config')) {
165                                                         $dbConfig = DBA::selectFirst('config', ['v'], ['cat' => 'system', 'k' => 'build']);
166                                                         if (!empty($dbConfig)) {
167                                                                 $retryBuild = intval($dbConfig['v']);
168                                                         }
169                                                 }
170
171                                                 if ($retryBuild != $build) {
172                                                         Logger::notice('Update already done.', ['from' => $build, 'retry' => $retryBuild, 'to' => $current]);
173                                                         DI::lock()->release('dbupdate');
174                                                         return '';
175                                                 }
176                                         }
177
178                                         DI::config()->set('system', 'maintenance', 1);
179
180                                         // run the pre_update_nnnn functions in update.php
181                                         for ($version = $stored + 1; $version <= $current; $version++) {
182                                                 Logger::notice('Execute pre update.', ['version' => $version]);
183                                                 DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: executing pre update %d',
184                                                         DateTimeFormat::utcNow() . ' ' . date('e'), $version));
185                                                 $r = self::runUpdateFunction($version, 'pre_update', $sendMail);
186                                                 if (!$r) {
187                                                         Logger::warning('Pre update failed', ['version' => $version]);
188                                                         DI::config()->set('system', 'update', Update::FAILED);
189                                                         DI::lock()->release('dbupdate');
190                                                         DI::config()->beginTransaction()
191                                                                                 ->set('system', 'maintenance', false)
192                                                                                 ->delete('system', 'maintenance_reason')
193                                                                                 ->commit();
194                                                         return $r;
195                                                 } else {
196                                                         Logger::notice('Pre update executed.', ['version' => $version]);
197                                                 }
198                                         }
199
200                                         // update the structure in one call
201                                         Logger::notice('Execute structure update');
202                                         $retval = DBStructure::performUpdate(false, $verbose);
203                                         if (!empty($retval)) {
204                                                 if ($sendMail) {
205                                                         self::updateFailed(
206                                                                 DB_UPDATE_VERSION,
207                                                                 $retval
208                                                         );
209                                                 }
210                                                 Logger::error('Update ERROR.', ['from' => $stored, 'to' => $current, 'retval' => $retval]);
211                                                 DI::config()->set('system', 'update', Update::FAILED);
212                                                 DI::lock()->release('dbupdate');
213                                                 DI::config()->beginTransaction()
214                                                                         ->set('system', 'maintenance', false)
215                                                                         ->delete('system', 'maintenance_reason')
216                                                                         ->commit();
217                                                 return $retval;
218                                         } else {
219                                                 Logger::notice('Database structure update finished.', ['from' => $stored, 'to' => $current]);
220                                         }
221
222                                         // run the update_nnnn functions in update.php
223                                         for ($version = $stored + 1; $version <= $current; $version++) {
224                                                 Logger::notice('Execute post update.', ['version' => $version]);
225                                                 DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: executing post update %d',
226                                                         DateTimeFormat::utcNow() . ' ' . date('e'), $version));
227                                                 $r = self::runUpdateFunction($version, 'update', $sendMail);
228                                                 if (!$r) {
229                                                         Logger::warning('Post update failed', ['version' => $version]);
230                                                         DI::config()->set('system', 'update', Update::FAILED);
231                                                         DI::lock()->release('dbupdate');
232                                                         DI::config()->beginTransaction()
233                                                                                 ->set('system', 'maintenance', false)
234                                                                                 ->delete('system', 'maintenance_reason')
235                                                                                 ->commit();
236                                                         return $r;
237                                                 } else {
238                                                         DI::config()->set('system', 'build', $version);
239                                                         Logger::notice('Post update executed.', ['version' => $version]);
240                                                 }
241                                         }
242
243                                         DI::config()->set('system', 'build', $current);
244                                         DI::config()->set('system', 'update', Update::SUCCESS);
245                                         DI::lock()->release('dbupdate');
246                                         DI::config()->beginTransaction()
247                                                                 ->set('system', 'maintenance', false)
248                                                                 ->delete('system', 'maintenance_reason')
249                                                                 ->commit();
250
251                                         Logger::notice('Update success.', ['from' => $stored, 'to' => $current]);
252                                         if ($sendMail) {
253                                                 self::updateSuccessful($stored, $current);
254                                         }
255                                 } else {
256                                         Logger::warning('Update lock could not be acquired');
257                                 }
258                         }
259                 }
260
261                 return '';
262         }
263
264         /**
265          * Executes a specific update function
266          *
267          * @param int    $version  the DB version number of the function
268          * @param string $prefix   the prefix of the function (update, pre_update)
269          * @param bool   $sendMail whether to send emails on success/failure
270          * @return bool true, if the update function worked
271          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
272          */
273         public static function runUpdateFunction(int $version, string $prefix, bool $sendMail = true): bool
274         {
275                 $funcname = $prefix . '_' . $version;
276
277                 Logger::notice('Update function start.', ['function' => $funcname]);
278
279                 if (function_exists($funcname)) {
280                         // There could be a lot of processes running or about to run.
281                         // We want exactly one process to run the update command.
282                         // So store the fact that we're taking responsibility
283                         // after first checking to see if somebody else already has.
284                         // If the update fails or times-out completely you may need to
285                         // delete the config entry to try again.
286
287                         if (DI::lock()->acquire('dbupdate_function', 120, Cache\Enum\Duration::INFINITE)) {
288
289                                 // call the specific update
290                                 Logger::notice('Pre update function start.', ['function' => $funcname]);
291                                 $retval = $funcname();
292                                 Logger::notice('Update function done.', ['function' => $funcname]);
293
294                                 if ($retval) {
295                                         if ($sendMail) {
296                                                 //send the administrator an e-mail
297                                                 self::updateFailed(
298                                                         $version,
299                                                         DI::l10n()->t('Update %s failed. See error logs.', $version)
300                                                 );
301                                         }
302                                         Logger::error('Update function ERROR.', ['function' => $funcname, 'retval' => $retval]);
303                                         DI::lock()->release('dbupdate_function');
304                                         return false;
305                                 } else {
306                                         DI::lock()->release('dbupdate_function');
307                                         Logger::notice('Update function finished.', ['function' => $funcname]);
308                                         return true;
309                                 }
310                         } else {
311                                 Logger::error('Locking failed.', ['function' => $funcname]);
312                                 return false;
313                         }
314                 } else {
315                         Logger::notice('Update function skipped.', ['function' => $funcname]);
316                         return true;
317                 }
318         }
319
320         /**
321          * send the email and do what is needed to do on update fails
322          *
323          * @param int    $update_id     number of failed update
324          * @param string $error_message error message
325          * @return void
326          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
327          */
328         private static function updateFailed(int $update_id, string $error_message)
329         {
330                 $adminEmails = User::getAdminListForEmailing(['uid', 'language', 'email']);
331                 if (!$adminEmails) {
332                         Logger::warning('Cannot notify administrators .', ['update' => $update_id, 'message' => $error_message]);
333                         return;
334                 }
335
336                 foreach($adminEmails as $admin) {
337                         $l10n = DI::l10n()->withLang($admin['language'] ?: 'en');
338
339                         $preamble = Strings::deindent($l10n->t("
340                                 The friendica developers released update %s recently,
341                                 but when I tried to install it, something went terribly wrong.
342                                 This needs to be fixed soon and I can't do it alone. Please contact a
343                                 friendica developer if you can not help me on your own. My database might be invalid.",
344                                 $update_id));
345                         $body     = $l10n->t('The error message is\n[pre]%s[/pre]', $error_message);
346
347                         $email = DI::emailer()
348                                 ->newSystemMail()
349                                 ->withMessage($l10n->t('[Friendica Notify] Database update'), $preamble, $body)
350                                 ->forUser($admin)
351                                 ->withRecipient($admin['email'])
352                                 ->build();
353                         DI::emailer()->send($email);
354                 }
355
356                 Logger::alert('Database structure update failed.', ['error' => $error_message]);
357         }
358
359         /**
360          * Send a mail to the administrator about the successful update
361          *
362          * @param integer $from_build
363          * @param integer $to_build
364          * @return void
365          */
366         private static function updateSuccessful(int $from_build, int $to_build)
367         {
368                 foreach(User::getAdminListForEmailing(['uid', 'language', 'email']) as $admin) {
369                         $l10n = DI::l10n()->withLang($admin['language'] ?: 'en');
370
371                         $preamble = Strings::deindent($l10n->t('
372                                 The friendica database was successfully updated from %s to %s.',
373                                 $from_build, $to_build));
374
375                         $email = DI::emailer()
376                                 ->newSystemMail()
377                                 ->withMessage($l10n->t('[Friendica Notify] Database update'), $preamble)
378                                 ->forUser($admin)
379                                 ->withRecipient($admin['email'])
380                                 ->build();
381                         DI::emailer()->send($email);
382                 }
383
384                 Logger::debug('Database structure update successful.');
385         }
386 }