From ff9abe4359eb8c40f0d66ed000c2deb1e2a6637b Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Mon, 29 Jul 2024 18:02:00 -0400 Subject: [PATCH 1/5] Fix directory moves on backup migration --- app/classes/shared/file_helpers.py | 6 ++---- app/migrations/20240308_multi-backup.py | 10 ++++------ 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/app/classes/shared/file_helpers.py b/app/classes/shared/file_helpers.py index 23bf01dd..4fcd0c21 100644 --- a/app/classes/shared/file_helpers.py +++ b/app/classes/shared/file_helpers.py @@ -183,8 +183,7 @@ class FileHelpers: @staticmethod def move_dir(src_path, dest_path): - FileHelpers.copy_dir(src_path, dest_path) - FileHelpers.del_dirs(src_path) + shutil.move(src_path, dest_path) @staticmethod def move_dir_exist(src_path, dest_path): @@ -193,8 +192,7 @@ class FileHelpers: @staticmethod def move_file(src_path, dest_path): - FileHelpers.copy_file(src_path, dest_path) - FileHelpers.del_file(src_path) + shutil.move(src_path, dest_path) @staticmethod def make_archive(path_to_destination, path_to_zip, comment=""): diff --git a/app/migrations/20240308_multi-backup.py b/app/migrations/20240308_multi-backup.py index db154ec8..bc6dc373 100644 --- a/app/migrations/20240308_multi-backup.py +++ b/app/migrations/20240308_multi-backup.py @@ -175,12 +175,10 @@ def migrate(migrator: Migrator, database, **kwargs): Helpers.ensure_dir_exists( os.path.join(server.backup_path, new_backup.backup_id) ) - for file in os.listdir(server.backup_path): - if not os.path.isdir(os.path.join(os.path.join(server.backup_path, file))): - FileHelpers.move_file( - os.path.join(server.backup_path, file), - os.path.join(server.backup_path, new_backup.backup_id, file), - ) + FileHelpers.move_dir( + os.path.join(server.backup_path), + os.path.join(server.backup_path, new_backup.backup_id), + ) Console.debug("Migrations: Dropping old backup table") # Drop the existing backups table From 4a5875918369ce847b048d036926eb98fc9e3832 Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Mon, 29 Jul 2024 18:04:01 -0400 Subject: [PATCH 2/5] Add function for removing old malformed backups --- app/migrations/20240308_multi-backup.py | 42 +++++++++++++++++++++---- 1 file changed, 36 insertions(+), 6 deletions(-) diff --git a/app/migrations/20240308_multi-backup.py b/app/migrations/20240308_multi-backup.py index bc6dc373..ec46286e 100644 --- a/app/migrations/20240308_multi-backup.py +++ b/app/migrations/20240308_multi-backup.py @@ -13,6 +13,13 @@ from app.classes.shared.file_helpers import FileHelpers logger = logging.getLogger(__name__) +def is_valid_backup(backup, all_servers): + try: + return str(backup.server_id) in all_servers + except (TypeError, peewee.DoesNotExist): + return False + + def migrate(migrator: Migrator, database, **kwargs): """ Write your migrations here. @@ -150,9 +157,17 @@ def migrate(migrator: Migrator, database, **kwargs): migrator.create_table(NewSchedules) migrator.run() - + all_servers = [ + row.server_id for row in Servers.select(Servers.server_id).distinct() + ] + all_backups = Backups.select() + Console.info("Cleaning up orphan backups for all servers") + valid_backups = [ + backup for backup in all_backups if is_valid_backup(backup, all_servers) + ] # Copy data from the existing backups table to the new one - for backup in Backups.select(): + for backup in valid_backups: + Console.info(f"Trying to get server for backup migration {backup.server_id}") # Fetch the related server entry from the Servers table server = Servers.get(Servers.server_id == backup.server_id) Console.info(f"Migrations: Migrating backup for server {server.server_name}") @@ -172,13 +187,28 @@ def migrate(migrator: Migrator, database, **kwargs): default=True, enabled=True, ) + Console.info( + f"New backup table created for {server.server_name} with id {new_backup.backup_id}" + ) Helpers.ensure_dir_exists( os.path.join(server.backup_path, new_backup.backup_id) ) - FileHelpers.move_dir( - os.path.join(server.backup_path), - os.path.join(server.backup_path, new_backup.backup_id), - ) + try: + Console.info( + f"Moving old backups to new backup dir for {server.server_name}" + ) + for file in os.listdir(server.backup_path): + if not os.path.isdir( + os.path.join(os.path.join(server.backup_path, file)) + ): + FileHelpers.move_file( + os.path.join(server.backup_path, file), + os.path.join(server.backup_path, new_backup.backup_id, file), + ) + except FileNotFoundError as why: + logger.error( + f"Could not move backup {file} for {server.server_name} to new location with error {why}" + ) Console.debug("Migrations: Dropping old backup table") # Drop the existing backups table From 9f7f588e85d5f452595c5589a447803ed3ea1925 Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Tue, 30 Jul 2024 14:30:30 -0400 Subject: [PATCH 3/5] Tweak default backup configs to account for bad clone in 4.2.x --- app/classes/models/management.py | 2 ++ app/classes/shared/server.py | 14 ++++++++++++++ app/frontend/templates/panel/server_backup.html | 3 +-- 3 files changed, 17 insertions(+), 2 deletions(-) diff --git a/app/classes/models/management.py b/app/classes/models/management.py index 1a3e4a11..b6be14b5 100644 --- a/app/classes/models/management.py +++ b/app/classes/models/management.py @@ -400,6 +400,8 @@ class HelpersManagement: if "excluded_dirs" in conf: dirs_to_exclude = ",".join(conf["excluded_dirs"]) conf["excluded_dirs"] = dirs_to_exclude + if len(self.get_backups_by_server(conf["server_id"], True)) <= 0: + conf["default"] = True backup = Backups.create(**conf) logger.debug("Creating new backup record.") return backup.backup_id diff --git a/app/classes/shared/server.py b/app/classes/shared/server.py index ab8ca54a..828aa019 100644 --- a/app/classes/shared/server.py +++ b/app/classes/shared/server.py @@ -1373,6 +1373,19 @@ class ServerInstance: def threaded_jar_update(self): server_users = PermissionsServers.get_server_user_list(self.server_id) + # check to make sure a backup config actually exists before starting the update + if len(self.management_helper.get_backups_by_server(self.server_id, True)) <= 0: + for user in server_users: + WebSocketManager().broadcast_user( + user, + "notification", + "Backup config does not exist for " + + self.name + + ". canceling update.", + ) + logger.error(f"Back config does not exist for {self.name}. Update Failed.") + self.stats_helper.set_update(False) + return False was_started = "-1" # Get default backup configuration backup_config = HelpersManagement.get_default_server_backup(self.server_id) @@ -1428,6 +1441,7 @@ class ServerInstance: "notification", "Backup failed for " + self.name + ". canceling update.", ) + self.stats_helper.set_update(False) return False # lets download the files diff --git a/app/frontend/templates/panel/server_backup.html b/app/frontend/templates/panel/server_backup.html index 86cd9415..73fde1cc 100644 --- a/app/frontend/templates/panel/server_backup.html +++ b/app/frontend/templates/panel/server_backup.html @@ -58,8 +58,7 @@
{% if len(data['backups']) == 0 %}
- {{ translate('serverBackups', 'no-backup', data['lang']) }} {{ - translate('serverBackups', 'newBackup',data['lang']) }}. + {{ translate('serverBackups', 'no-backup', data['lang']) }}.
{% end %} {% if len(data['backups']) > 0 %} From 7b739863b35c656ece660c503000e56062d88c6d Mon Sep 17 00:00:00 2001 From: Zedifus Date: Tue, 6 Aug 2024 19:51:39 +0100 Subject: [PATCH 4/5] Update changelog !785 --- CHANGELOG.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d1251076..2fc3f6dc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,12 +1,16 @@ # Changelog -## --- [4.4.1] - 2024/TBD +## --- [4.4.1] - 2024/08/06 + +### Patch Fixes +- Migrations | Fix orphan backup configurations crashing migration operation ([Merge Request](https://gitlab.com/crafty-controller/crafty-4/-/merge_requests/785)) +- Migrations | Fix missing default configuration if no server backup config exists during the migration ([Merge Request](https://gitlab.com/crafty-controller/crafty-4/-/merge_requests/785)) +- Migrations | Fix extended runtime on move procedure during migration ([Merge Request](https://gitlab.com/crafty-controller/crafty-4/-/merge_requests/785)) **-----------------------------------------------------------------------------** -**Initial release was reverted for patching (See Merge Request: [!784](https://gitlab.com/crafty-controller/crafty-4/-/merge_requests/784))** +**Initial release was reverted for patching (See Merge Request: [!784](https://gitlab.com/crafty-controller/crafty-4/-/merge_requests/784))** *2024/07/28* -**-----------------------------------------------------------------------------** -### Refactor +**-----------------------------------------------------------------------------**### Refactor - Backups | Allow multiple backup configurations ([Merge Request](https://gitlab.com/crafty-controller/crafty-4/-/merge_requests/711)) - UploadAPI | Use Crafty's JWT authentication for file uploads ([Merge Request](https://gitlab.com/crafty-controller/crafty-4/-/merge_requests/762)) - UploadAPI | Splice files on the frontend to allow chunked uploads as well as bulk uploads ([Merge Request](https://gitlab.com/crafty-controller/crafty-4/-/merge_requests/762)) From 7c16737fabd0455e32c0388cb4d24d2f2b343595 Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Tue, 6 Aug 2024 14:59:10 -0400 Subject: [PATCH 5/5] Appease sonar return nothing instead of false --- app/classes/shared/server.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/classes/shared/server.py b/app/classes/shared/server.py index 828aa019..6aec5fc4 100644 --- a/app/classes/shared/server.py +++ b/app/classes/shared/server.py @@ -1385,7 +1385,7 @@ class ServerInstance: ) logger.error(f"Back config does not exist for {self.name}. Update Failed.") self.stats_helper.set_update(False) - return False + return was_started = "-1" # Get default backup configuration backup_config = HelpersManagement.get_default_server_backup(self.server_id) @@ -1442,7 +1442,7 @@ class ServerInstance: "Backup failed for " + self.name + ". canceling update.", ) self.stats_helper.set_update(False) - return False + return # lets download the files if HelperServers.get_server_type_by_id(self.server_id) != "minecraft-bedrock":