mirror of
https://git.mirrors.martin98.com/https://github.com/Ultimaker/Cura
synced 2025-04-22 21:59:37 +08:00
d69bf84424
Converted doxygen style comments to reStructuredText style in the files found in Cura/cura/Backup directory recursively using the script dox_2_rst.py (provided in the Uranium repo). Comments were manually checked and changed if needed.
81 lines
3.1 KiB
Python
81 lines
3.1 KiB
Python
# Copyright (c) 2018 Ultimaker B.V.
|
|
# Cura is released under the terms of the LGPLv3 or higher.
|
|
|
|
from typing import Dict, Optional, Tuple, TYPE_CHECKING
|
|
|
|
from UM.Logger import Logger
|
|
from cura.Backups.Backup import Backup
|
|
|
|
if TYPE_CHECKING:
|
|
from cura.CuraApplication import CuraApplication
|
|
|
|
|
|
class BackupsManager:
|
|
"""
|
|
The BackupsManager is responsible for managing the creating and restoring of
|
|
back-ups.
|
|
|
|
Back-ups themselves are represented in a different class.
|
|
"""
|
|
|
|
def __init__(self, application: "CuraApplication") -> None:
|
|
self._application = application
|
|
|
|
def createBackup(self) -> Tuple[Optional[bytes], Optional[Dict[str, str]]]:
|
|
"""
|
|
Get a back-up of the current configuration.
|
|
|
|
:return: A tuple containing a ZipFile (the actual back-up) and a dict containing some metadata (like version).
|
|
"""
|
|
|
|
self._disableAutoSave()
|
|
backup = Backup(self._application)
|
|
backup.makeFromCurrent()
|
|
self._enableAutoSave()
|
|
# We don't return a Backup here because we want plugins only to interact with our API and not full objects.
|
|
return backup.zip_file, backup.meta_data
|
|
|
|
def restoreBackup(self, zip_file: bytes, meta_data: Dict[str, str]) -> None:
|
|
"""
|
|
Restore a back-up from a given ZipFile.
|
|
|
|
:param zip_file: A bytes object containing the actual back-up.
|
|
:param meta_data: A dict containing some metadata that is needed to restore the back-up correctly.
|
|
"""
|
|
|
|
if not meta_data.get("cura_release", None):
|
|
# If there is no "cura_release" specified in the meta data, we don't execute a backup restore.
|
|
Logger.log("w", "Tried to restore a backup without specifying a Cura version number.")
|
|
return
|
|
|
|
self._disableAutoSave()
|
|
|
|
backup = Backup(self._application, zip_file = zip_file, meta_data = meta_data)
|
|
restored = backup.restore()
|
|
if restored:
|
|
# At this point, Cura will need to restart for the changes to take effect.
|
|
# We don't want to store the data at this point as that would override the just-restored backup.
|
|
self._application.windowClosed(save_data = False)
|
|
|
|
def _disableAutoSave(self) -> None:
|
|
"""Here we (try to) disable the saving as it might interfere with restoring a back-up."""
|
|
|
|
self._application.enableSave(False)
|
|
auto_save = self._application.getAutoSave()
|
|
# The auto save is only not created if the application has not yet started.
|
|
if auto_save:
|
|
auto_save.setEnabled(False)
|
|
else:
|
|
Logger.log("e", "Unable to disable the autosave as application init has not been completed")
|
|
|
|
def _enableAutoSave(self) -> None:
|
|
"""Re-enable auto-save and other saving after we're done."""
|
|
|
|
self._application.enableSave(True)
|
|
auto_save = self._application.getAutoSave()
|
|
# The auto save is only not created if the application has not yet started.
|
|
if auto_save:
|
|
auto_save.setEnabled(True)
|
|
else:
|
|
Logger.log("e", "Unable to enable the autosave as application init has not been completed")
|