- added some type-hints
- added some documentation
- changed some double-quotes to single
This commit is contained in:
Roland Häder 2022-06-27 12:09:31 +02:00
parent a392a22eee
commit e33f5612ab
No known key found for this signature in database
GPG Key ID: C82EDE5DDFA0BA77
4 changed files with 39 additions and 38 deletions

View File

@ -41,7 +41,7 @@ class Update
* @param string $basePath The base path of this application * @param string $basePath The base path of this application
* @param boolean $via_worker Is the check run via the worker? * @param boolean $via_worker Is the check run via the worker?
* @param App\Mode $mode The current app mode * @param App\Mode $mode The current app mode
* * @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/ */
public static function check(string $basePath, bool $via_worker, App\Mode $mode) 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 // 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) { 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); $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) { if (DI::mode()->getExecutor() == Mode::INDEX) {
@ -85,9 +85,11 @@ class Update
if ($build < DB_UPDATE_VERSION) { if ($build < DB_UPDATE_VERSION) {
if ($via_worker) { 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. * Calling the database update directly via the worker enables us to perform database changes to the workerqueue table itself.
// This worker job doesn't work for 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); self::run($basePath);
} else { } else {
Worker::add(PRIORITY_CRITICAL, 'DBUpdate'); Worker::add(PRIORITY_CRITICAL, 'DBUpdate');
@ -103,11 +105,10 @@ class Update
* @param bool $override Overrides any running/stuck updates * @param bool $override Overrides any running/stuck updates
* @param bool $verbose Run the Update-Check verbose * @param bool $verbose Run the Update-Check verbose
* @param bool $sendMail Sends a Mail to the administrator in case of success/failure * @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 * @return string Empty string if the update is successful, error messages otherwise
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @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 // In force mode, we release the dbupdate lock first
// Necessary in case of an stuck update // Necessary in case of an stuck update
@ -228,11 +229,10 @@ class Update
* @param int $version 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 string $prefix the prefix of the function (update, pre_update)
* @param bool $sendMail whether to send emails on success/failure * @param bool $sendMail whether to send emails on success/failure
* @return bool true, if the update function worked * @return bool true, if the update function worked
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @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; $funcname = $prefix . '_' . $version;
@ -284,6 +284,7 @@ class Update
* *
* @param int $update_id number of failed update * @param int $update_id number of failed update
* @param string $error_message error message * @param string $error_message error message
* @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/ */
private static function updateFailed(int $update_id, string $error_message) { private static function updateFailed(int $update_id, string $error_message) {

View File

@ -73,7 +73,7 @@ class DBStructure
*/ */
public static function dropTables(bool $execute) 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) { 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); 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; return;

View File

@ -538,7 +538,7 @@ class PostUpdate
private static function update1347() private static function update1347()
{ {
// Was the script completed? // Was the script completed?
if (DI::config()->get("system", "post_update_version") >= 1347) { if (DI::config()->get('system', 'post_update_version') >= 1347) {
return true; return true;
} }
@ -547,7 +547,7 @@ class PostUpdate
return true; 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]); Logger::info('Start', ['item' => $id]);
@ -582,12 +582,12 @@ class PostUpdate
} }
DBA::close($items); 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]); Logger::info('Processed', ['rows' => $rows, 'last' => $id]);
if ($start_id == $id) { if ($start_id == $id) {
DI::config()->set("system", "post_update_version", 1347); DI::config()->set('system', 'post_update_version', 1347);
Logger::info('Done'); Logger::info('Done');
return true; return true;
} }
@ -605,11 +605,11 @@ class PostUpdate
private static function update1348() private static function update1348()
{ {
// Was the script completed? // Was the script completed?
if (DI::config()->get("system", "post_update_version") >= 1348) { if (DI::config()->get('system', 'post_update_version') >= 1348) {
return true; 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]); Logger::info('Start', ['contact' => $id]);
@ -635,12 +635,12 @@ class PostUpdate
} }
DBA::close($contacts); 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]); Logger::info('Processed', ['rows' => $rows, 'last' => $id]);
if ($start_id == $id) { if ($start_id == $id) {
DI::config()->set("system", "post_update_version", 1348); DI::config()->set('system', 'post_update_version', 1348);
Logger::info('Done'); Logger::info('Done');
return true; return true;
} }
@ -658,11 +658,11 @@ class PostUpdate
private static function update1349() private static function update1349()
{ {
// Was the script completed? // Was the script completed?
if (DI::config()->get("system", "post_update_version") >= 1349) { if (DI::config()->get('system', 'post_update_version') >= 1349) {
return true; 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]); Logger::info('Start', ['apcontact' => $id]);
@ -688,12 +688,12 @@ class PostUpdate
} }
DBA::close($apcontacts); 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]); Logger::info('Processed', ['rows' => $rows, 'last' => $id]);
if ($start_id == $id) { if ($start_id == $id) {
DI::config()->set("system", "post_update_version", 1349); DI::config()->set('system', 'post_update_version', 1349);
Logger::info('Done'); Logger::info('Done');
return true; return true;
} }
@ -711,7 +711,7 @@ class PostUpdate
private static function update1383() private static function update1383()
{ {
// Was the script completed? // Was the script completed?
if (DI::config()->get("system", "post_update_version") >= 1383) { if (DI::config()->get('system', 'post_update_version') >= 1383) {
return true; return true;
} }
@ -737,7 +737,7 @@ class PostUpdate
} }
DBA::close($photos); DBA::close($photos);
DI::config()->set("system", "post_update_version", 1383); DI::config()->set('system', 'post_update_version', 1383);
Logger::info('Done', ['deleted' => $deleted]); Logger::info('Done', ['deleted' => $deleted]);
return true; return true;
} }
@ -752,7 +752,7 @@ class PostUpdate
private static function update1384() private static function update1384()
{ {
// Was the script completed? // Was the script completed?
if (DI::config()->get("system", "post_update_version") >= 1384) { if (DI::config()->get('system', 'post_update_version') >= 1384) {
return true; return true;
} }
@ -782,7 +782,7 @@ class PostUpdate
Logger::info('Processed', ['rows' => $rows]); Logger::info('Processed', ['rows' => $rows]);
if ($rows <= 100) { if ($rows <= 100) {
DI::config()->set("system", "post_update_version", 1384); DI::config()->set('system', 'post_update_version', 1384);
Logger::info('Done'); Logger::info('Done');
return true; return true;
} }
@ -800,12 +800,12 @@ class PostUpdate
private static function update1400() private static function update1400()
{ {
// Was the script completed? // Was the script completed?
if (DI::config()->get("system", "post_update_version") >= 1400) { if (DI::config()->get('system', 'post_update_version') >= 1400) {
return true; return true;
} }
if (!DBStructure::existsTable('item')) { if (!DBStructure::existsTable('item')) {
DI::config()->set("system", "post_update_version", 1400); DI::config()->set('system', 'post_update_version', 1400);
return true; return true;
} }
@ -829,7 +829,7 @@ class PostUpdate
Logger::info('Processed', ['rows' => $rows]); Logger::info('Processed', ['rows' => $rows]);
if ($rows <= 100) { if ($rows <= 100) {
DI::config()->set("system", "post_update_version", 1400); DI::config()->set('system', 'post_update_version', 1400);
Logger::info('Done'); Logger::info('Done');
return true; return true;
} }
@ -847,7 +847,7 @@ class PostUpdate
private static function update1424() private static function update1424()
{ {
// Was the script completed? // Was the script completed?
if (DI::config()->get("system", "post_update_version") >= 1424) { if (DI::config()->get('system', 'post_update_version') >= 1424) {
return true; return true;
} }
@ -871,7 +871,7 @@ class PostUpdate
Logger::info('Processed', ['rows' => $rows]); Logger::info('Processed', ['rows' => $rows]);
if ($rows <= 100) { if ($rows <= 100) {
DI::config()->set("system", "post_update_version", 1424); DI::config()->set('system', 'post_update_version', 1424);
Logger::info('Done'); Logger::info('Done');
return true; return true;
} }
@ -889,7 +889,7 @@ class PostUpdate
private static function update1425() private static function update1425()
{ {
// Was the script completed? // Was the script completed?
if (DI::config()->get("system", "post_update_version") >= 1425) { if (DI::config()->get('system', 'post_update_version') >= 1425) {
return true; return true;
} }
@ -918,7 +918,7 @@ class PostUpdate
Logger::info('Processed', ['rows' => $rows]); Logger::info('Processed', ['rows' => $rows]);
if ($rows <= 100) { if ($rows <= 100) {
DI::config()->set("system", "post_update_version", 1425); DI::config()->set('system', 'post_update_version', 1425);
Logger::info('Done'); Logger::info('Done');
return true; return true;
} }
@ -936,7 +936,7 @@ class PostUpdate
private static function update1426() private static function update1426()
{ {
// Was the script completed? // Was the script completed?
if (DI::config()->get("system", "post_update_version") >= 1426) { if (DI::config()->get('system', 'post_update_version') >= 1426) {
return true; return true;
} }
@ -965,7 +965,7 @@ class PostUpdate
Logger::info('Processed', ['rows' => $rows]); Logger::info('Processed', ['rows' => $rows]);
if ($rows <= 100) { if ($rows <= 100) {
DI::config()->set("system", "post_update_version", 1426); DI::config()->set('system', 'post_update_version', 1426);
Logger::info('Done'); Logger::info('Done');
return true; return true;
} }
@ -983,7 +983,7 @@ class PostUpdate
private static function update1427() private static function update1427()
{ {
// Was the script completed? // Was the script completed?
if (DI::config()->get("system", "post_update_version") >= 1427) { if (DI::config()->get('system', 'post_update_version') >= 1427) {
return true; return true;
} }
@ -1012,7 +1012,7 @@ class PostUpdate
Logger::info('Processed', ['rows' => $rows]); Logger::info('Processed', ['rows' => $rows]);
if ($rows <= 100) { if ($rows <= 100) {
DI::config()->set("system", "post_update_version", 1427); DI::config()->set('system', 'post_update_version', 1427);
Logger::info('Done'); Logger::info('Done');
return true; return true;
} }

View File

@ -981,7 +981,7 @@ function update_1429()
return Update::FAILED; return Update::FAILED;
} }
DI::config()->set("system", "post_update_version", 1423); DI::config()->set('system', 'post_update_version', 1423);
return Update::SUCCESS; return Update::SUCCESS;
} }