From e33f5612ab09c888a2925307338205a6ef5f0271 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roland=20H=C3=A4der?= Date: Mon, 27 Jun 2022 12:09:31 +0200 Subject: [PATCH] Changes: - added some type-hints - added some documentation - changed some double-quotes to single --- src/Core/Update.php | 19 +++++++------ src/Database/DBStructure.php | 2 +- src/Database/PostUpdate.php | 54 ++++++++++++++++++------------------ update.php | 2 +- 4 files changed, 39 insertions(+), 38 deletions(-) diff --git a/src/Core/Update.php b/src/Core/Update.php index 978baec10..ddb9effd7 100644 --- a/src/Core/Update.php +++ b/src/Core/Update.php @@ -41,7 +41,7 @@ class 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(string $basePath, bool $via_worker, App\Mode $mode) @@ -73,7 +73,7 @@ class Update } // The postupdate has to completed version 1288 for the new post views to take over - $postupdate = DI::config()->get("system", "post_update_version", NEW_TABLE_STRUCTURE_VERSION); + $postupdate = DI::config()->get('system', 'post_update_version', NEW_TABLE_STRUCTURE_VERSION); if ($postupdate < 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) { @@ -85,9 +85,11 @@ class Update 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'); @@ -103,11 +105,10 @@ class Update * @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(string $basePath, bool $force = false, bool $override = false, bool $verbose = false, bool $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 @@ -228,11 +229,10 @@ class Update * @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(int $version, string $prefix, bool $sendMail = true) + public static function runUpdateFunction(int $version, string $prefix, bool $sendMail = true): bool { $funcname = $prefix . '_' . $version; @@ -284,6 +284,7 @@ class Update * * @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(int $update_id, string $error_message) { diff --git a/src/Database/DBStructure.php b/src/Database/DBStructure.php index 0756ad099..0ef99bb10 100644 --- a/src/Database/DBStructure.php +++ b/src/Database/DBStructure.php @@ -73,7 +73,7 @@ class DBStructure */ public static function dropTables(bool $execute) { - $postupdate = DI::config()->get("system", "post_update_version", PostUpdate::VERSION); + $postupdate = DI::config()->get('system', 'post_update_version', PostUpdate::VERSION); if ($postupdate < PostUpdate::VERSION) { echo DI::l10n()->t('The post update is at version %d, it has to be at %d to safely drop the tables.', $postupdate, PostUpdate::VERSION); return; diff --git a/src/Database/PostUpdate.php b/src/Database/PostUpdate.php index a8a0a1abd..26eef2c94 100644 --- a/src/Database/PostUpdate.php +++ b/src/Database/PostUpdate.php @@ -538,7 +538,7 @@ class PostUpdate private static function update1347() { // Was the script completed? - if (DI::config()->get("system", "post_update_version") >= 1347) { + if (DI::config()->get('system', 'post_update_version') >= 1347) { return true; } @@ -547,7 +547,7 @@ class PostUpdate return true; } - $id = DI::config()->get("system", "post_update_version_1347_id", 0); + $id = DI::config()->get('system', 'post_update_version_1347_id', 0); Logger::info('Start', ['item' => $id]); @@ -582,12 +582,12 @@ class PostUpdate } DBA::close($items); - DI::config()->set("system", "post_update_version_1347_id", $id); + DI::config()->set('system', 'post_update_version_1347_id', $id); Logger::info('Processed', ['rows' => $rows, 'last' => $id]); if ($start_id == $id) { - DI::config()->set("system", "post_update_version", 1347); + DI::config()->set('system', 'post_update_version', 1347); Logger::info('Done'); return true; } @@ -605,11 +605,11 @@ class PostUpdate private static function update1348() { // Was the script completed? - if (DI::config()->get("system", "post_update_version") >= 1348) { + if (DI::config()->get('system', 'post_update_version') >= 1348) { return true; } - $id = DI::config()->get("system", "post_update_version_1348_id", 0); + $id = DI::config()->get('system', 'post_update_version_1348_id', 0); Logger::info('Start', ['contact' => $id]); @@ -635,12 +635,12 @@ class PostUpdate } DBA::close($contacts); - DI::config()->set("system", "post_update_version_1348_id", $id); + DI::config()->set('system', 'post_update_version_1348_id', $id); Logger::info('Processed', ['rows' => $rows, 'last' => $id]); if ($start_id == $id) { - DI::config()->set("system", "post_update_version", 1348); + DI::config()->set('system', 'post_update_version', 1348); Logger::info('Done'); return true; } @@ -658,11 +658,11 @@ class PostUpdate private static function update1349() { // Was the script completed? - if (DI::config()->get("system", "post_update_version") >= 1349) { + if (DI::config()->get('system', 'post_update_version') >= 1349) { return true; } - $id = DI::config()->get("system", "post_update_version_1349_id", ''); + $id = DI::config()->get('system', 'post_update_version_1349_id', ''); Logger::info('Start', ['apcontact' => $id]); @@ -688,12 +688,12 @@ class PostUpdate } DBA::close($apcontacts); - DI::config()->set("system", "post_update_version_1349_id", $id); + DI::config()->set('system', 'post_update_version_1349_id', $id); Logger::info('Processed', ['rows' => $rows, 'last' => $id]); if ($start_id == $id) { - DI::config()->set("system", "post_update_version", 1349); + DI::config()->set('system', 'post_update_version', 1349); Logger::info('Done'); return true; } @@ -711,7 +711,7 @@ class PostUpdate private static function update1383() { // Was the script completed? - if (DI::config()->get("system", "post_update_version") >= 1383) { + if (DI::config()->get('system', 'post_update_version') >= 1383) { return true; } @@ -737,7 +737,7 @@ class PostUpdate } DBA::close($photos); - DI::config()->set("system", "post_update_version", 1383); + DI::config()->set('system', 'post_update_version', 1383); Logger::info('Done', ['deleted' => $deleted]); return true; } @@ -752,7 +752,7 @@ class PostUpdate private static function update1384() { // Was the script completed? - if (DI::config()->get("system", "post_update_version") >= 1384) { + if (DI::config()->get('system', 'post_update_version') >= 1384) { return true; } @@ -782,7 +782,7 @@ class PostUpdate Logger::info('Processed', ['rows' => $rows]); if ($rows <= 100) { - DI::config()->set("system", "post_update_version", 1384); + DI::config()->set('system', 'post_update_version', 1384); Logger::info('Done'); return true; } @@ -800,12 +800,12 @@ class PostUpdate private static function update1400() { // Was the script completed? - if (DI::config()->get("system", "post_update_version") >= 1400) { + if (DI::config()->get('system', 'post_update_version') >= 1400) { return true; } if (!DBStructure::existsTable('item')) { - DI::config()->set("system", "post_update_version", 1400); + DI::config()->set('system', 'post_update_version', 1400); return true; } @@ -829,7 +829,7 @@ class PostUpdate Logger::info('Processed', ['rows' => $rows]); if ($rows <= 100) { - DI::config()->set("system", "post_update_version", 1400); + DI::config()->set('system', 'post_update_version', 1400); Logger::info('Done'); return true; } @@ -847,7 +847,7 @@ class PostUpdate private static function update1424() { // Was the script completed? - if (DI::config()->get("system", "post_update_version") >= 1424) { + if (DI::config()->get('system', 'post_update_version') >= 1424) { return true; } @@ -871,7 +871,7 @@ class PostUpdate Logger::info('Processed', ['rows' => $rows]); if ($rows <= 100) { - DI::config()->set("system", "post_update_version", 1424); + DI::config()->set('system', 'post_update_version', 1424); Logger::info('Done'); return true; } @@ -889,7 +889,7 @@ class PostUpdate private static function update1425() { // Was the script completed? - if (DI::config()->get("system", "post_update_version") >= 1425) { + if (DI::config()->get('system', 'post_update_version') >= 1425) { return true; } @@ -918,7 +918,7 @@ class PostUpdate Logger::info('Processed', ['rows' => $rows]); if ($rows <= 100) { - DI::config()->set("system", "post_update_version", 1425); + DI::config()->set('system', 'post_update_version', 1425); Logger::info('Done'); return true; } @@ -936,7 +936,7 @@ class PostUpdate private static function update1426() { // Was the script completed? - if (DI::config()->get("system", "post_update_version") >= 1426) { + if (DI::config()->get('system', 'post_update_version') >= 1426) { return true; } @@ -965,7 +965,7 @@ class PostUpdate Logger::info('Processed', ['rows' => $rows]); if ($rows <= 100) { - DI::config()->set("system", "post_update_version", 1426); + DI::config()->set('system', 'post_update_version', 1426); Logger::info('Done'); return true; } @@ -983,7 +983,7 @@ class PostUpdate private static function update1427() { // Was the script completed? - if (DI::config()->get("system", "post_update_version") >= 1427) { + if (DI::config()->get('system', 'post_update_version') >= 1427) { return true; } @@ -1012,7 +1012,7 @@ class PostUpdate Logger::info('Processed', ['rows' => $rows]); if ($rows <= 100) { - DI::config()->set("system", "post_update_version", 1427); + DI::config()->set('system', 'post_update_version', 1427); Logger::info('Done'); return true; } diff --git a/update.php b/update.php index 2c5e2f5c1..d66691b96 100644 --- a/update.php +++ b/update.php @@ -981,7 +981,7 @@ function update_1429() return Update::FAILED; } - DI::config()->set("system", "post_update_version", 1423); + DI::config()->set('system', 'post_update_version', 1423); return Update::SUCCESS; }