mirror of
https://git.mirrors.martin98.com/https://github.com/Ultimaker/Cura
synced 2025-06-03 02:34:30 +08:00
572721e20d
Only the deserialize() functions themselves may pass the ContainerFormatError on, because their callers will have to handle those errors anyway. Contributes to issue CURA-5045.
109 lines
4.8 KiB
Python
109 lines
4.8 KiB
Python
# Copyright (c) 2018 Ultimaker B.V.
|
|
# Cura is released under the terms of the LGPLv3 or higher.
|
|
import configparser
|
|
|
|
from UM.PluginRegistry import PluginRegistry
|
|
from UM.Logger import Logger
|
|
from UM.Settings.ContainerFormatError import ContainerFormatError
|
|
from UM.Settings.InstanceContainer import InstanceContainer # The new profile to make.
|
|
from cura.ProfileReader import ProfileReader
|
|
|
|
import zipfile
|
|
|
|
## A plugin that reads profile data from Cura profile files.
|
|
#
|
|
# It reads a profile from a .curaprofile file, and returns it as a profile
|
|
# instance.
|
|
class CuraProfileReader(ProfileReader):
|
|
## Initialises the cura profile reader.
|
|
# This does nothing since the only other function is basically stateless.
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
## Reads a cura profile from a file and returns it.
|
|
#
|
|
# \param file_name The file to read the cura profile from.
|
|
# \return The cura profile that was in the file, if any. If the file could
|
|
# not be read or didn't contain a valid profile, \code None \endcode is
|
|
# returned.
|
|
def read(self, file_name):
|
|
try:
|
|
with zipfile.ZipFile(file_name, "r") as archive:
|
|
results = []
|
|
for profile_id in archive.namelist():
|
|
with archive.open(profile_id) as f:
|
|
serialized = f.read()
|
|
profile = self._loadProfile(serialized.decode("utf-8"), profile_id)
|
|
if profile is not None:
|
|
results.append(profile)
|
|
return results
|
|
|
|
except zipfile.BadZipFile:
|
|
# It must be an older profile from Cura 2.1.
|
|
with open(file_name, encoding = "utf-8") as fhandle:
|
|
serialized = fhandle.read()
|
|
return [self._loadProfile(serialized, profile_id) for serialized, profile_id in self._upgradeProfile(serialized, file_name)]
|
|
|
|
## Convert a profile from an old Cura to this Cura if needed.
|
|
#
|
|
# \param serialized \type{str} The profile data to convert in the serialized on-disk format.
|
|
# \param profile_id \type{str} The name of the profile.
|
|
# \return \type{List[Tuple[str,str]]} List of serialized profile strings and matching profile names.
|
|
def _upgradeProfile(self, serialized, profile_id):
|
|
parser = configparser.ConfigParser(interpolation=None)
|
|
parser.read_string(serialized)
|
|
|
|
if "general" not in parser:
|
|
Logger.log("w", "Missing required section 'general'.")
|
|
return []
|
|
if "version" not in parser["general"]:
|
|
Logger.log("w", "Missing required 'version' property")
|
|
return []
|
|
|
|
version = int(parser["general"]["version"])
|
|
if InstanceContainer.Version != version:
|
|
name = parser["general"]["name"]
|
|
return self._upgradeProfileVersion(serialized, name, version)
|
|
else:
|
|
return [(serialized, profile_id)]
|
|
|
|
## Load a profile from a serialized string.
|
|
#
|
|
# \param serialized \type{str} The profile data to read.
|
|
# \param profile_id \type{str} The name of the profile.
|
|
# \return \type{InstanceContainer|None}
|
|
def _loadProfile(self, serialized, profile_id):
|
|
# Create an empty profile.
|
|
profile = InstanceContainer(profile_id)
|
|
profile.addMetaDataEntry("type", "quality_changes")
|
|
try:
|
|
profile.deserialize(serialized)
|
|
except ContainerFormatError as e:
|
|
Logger.log("e", "Error in the format of a container: %s", str(e))
|
|
return None
|
|
except Exception as e:
|
|
Logger.log("e", "Error while trying to parse profile: %s", str(e))
|
|
return None
|
|
return profile
|
|
|
|
## Upgrade a serialized profile to the current profile format.
|
|
#
|
|
# \param serialized \type{str} The profile data to convert.
|
|
# \param profile_id \type{str} The name of the profile.
|
|
# \param source_version \type{int} The profile version of 'serialized'.
|
|
# \return \type{List[Tuple[str,str]]} List of serialized profile strings and matching profile names.
|
|
def _upgradeProfileVersion(self, serialized, profile_id, source_version):
|
|
converter_plugins = PluginRegistry.getInstance().getAllMetaData(filter={"version_upgrade": {} }, active_only=True)
|
|
|
|
source_format = ("profile", source_version)
|
|
profile_convert_funcs = [plugin["version_upgrade"][source_format][2] for plugin in converter_plugins
|
|
if source_format in plugin["version_upgrade"] and plugin["version_upgrade"][source_format][1] == InstanceContainer.Version]
|
|
|
|
if not profile_convert_funcs:
|
|
return []
|
|
|
|
filenames, outputs = profile_convert_funcs[0](serialized, profile_id)
|
|
if filenames is None and outputs is None:
|
|
return []
|
|
return list(zip(outputs, filenames))
|