123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410 |
- # Copyright (c) 2017 Ultimaker B.V.
- # Cura is released under the terms of the LGPLv3 or higher.
- import os
- import os.path
- import re
- from typing import Optional
- from PyQt5.QtWidgets import QMessageBox
- from UM.Decorators import override
- from UM.Settings.ContainerRegistry import ContainerRegistry
- from UM.Settings.ContainerStack import ContainerStack
- from UM.Settings.InstanceContainer import InstanceContainer
- from UM.Application import Application
- from UM.Logger import Logger
- from UM.Message import Message
- from UM.Platform import Platform
- from UM.PluginRegistry import PluginRegistry #For getting the possible profile writers to write with.
- from UM.Util import parseBool
- from . import ExtruderStack
- from . import GlobalStack
- from .ContainerManager import ContainerManager
- from .ExtruderManager import ExtruderManager
- from cura.CuraApplication import CuraApplication
- from UM.i18n import i18nCatalog
- catalog = i18nCatalog("cura")
- class CuraContainerRegistry(ContainerRegistry):
- def __init__(self, *args, **kwargs):
- super().__init__(*args, **kwargs)
- ## Overridden from ContainerRegistry
- #
- # Adds a container to the registry.
- #
- # This will also try to convert a ContainerStack to either Extruder or
- # Global stack based on metadata information.
- @override(ContainerRegistry)
- def addContainer(self, container):
- # Note: Intentional check with type() because we want to ignore subclasses
- if type(container) == ContainerStack:
- container = self._convertContainerStack(container)
- if isinstance(container, InstanceContainer) and type(container) != type(self.getEmptyInstanceContainer()):
- #Check against setting version of the definition.
- required_setting_version = CuraApplication.SettingVersion
- actual_setting_version = int(container.getMetaDataEntry("setting_version", default = 0))
- if required_setting_version != actual_setting_version:
- Logger.log("w", "Instance container {container_id} is outdated. Its setting version is {actual_setting_version} but it should be {required_setting_version}.".format(container_id = container.getId(), actual_setting_version = actual_setting_version, required_setting_version = required_setting_version))
- return #Don't add.
- super().addContainer(container)
- ## Create a name that is not empty and unique
- # \param container_type \type{string} Type of the container (machine, quality, ...)
- # \param current_name \type{} Current name of the container, which may be an acceptable option
- # \param new_name \type{string} Base name, which may not be unique
- # \param fallback_name \type{string} Name to use when (stripped) new_name is empty
- # \return \type{string} Name that is unique for the specified type and name/id
- def createUniqueName(self, container_type, current_name, new_name, fallback_name):
- new_name = new_name.strip()
- num_check = re.compile("(.*?)\s*#\d+$").match(new_name)
- if num_check:
- new_name = num_check.group(1)
- if new_name == "":
- new_name = fallback_name
- unique_name = new_name
- i = 1
- # In case we are renaming, the current name of the container is also a valid end-result
- while self._containerExists(container_type, unique_name) and unique_name != current_name:
- i += 1
- unique_name = "%s #%d" % (new_name, i)
- return unique_name
- ## Check if a container with of a certain type and a certain name or id exists
- # Both the id and the name are checked, because they may not be the same and it is better if they are both unique
- # \param container_type \type{string} Type of the container (machine, quality, ...)
- # \param container_name \type{string} Name to check
- def _containerExists(self, container_type, container_name):
- container_class = ContainerStack if container_type == "machine" else InstanceContainer
- return self.findContainers(container_class, id = container_name, type = container_type, ignore_case = True) or \
- self.findContainers(container_class, name = container_name, type = container_type)
- ## Exports an profile to a file
- #
- # \param instance_ids \type{list} the IDs of the profiles to export.
- # \param file_name \type{str} the full path and filename to export to.
- # \param file_type \type{str} the file type with the format "<description> (*.<extension>)"
- def exportProfile(self, instance_ids, file_name, file_type):
- # Parse the fileType to deduce what plugin can save the file format.
- # fileType has the format "<description> (*.<extension>)"
- split = file_type.rfind(" (*.") # Find where the description ends and the extension starts.
- if split < 0: # Not found. Invalid format.
- Logger.log("e", "Invalid file format identifier %s", file_type)
- return
- description = file_type[:split]
- extension = file_type[split + 4:-1] # Leave out the " (*." and ")".
- if not file_name.endswith("." + extension): # Auto-fill the extension if the user did not provide any.
- file_name += "." + extension
- # On Windows, QML FileDialog properly asks for overwrite confirm, but not on other platforms, so handle those ourself.
- if not Platform.isWindows():
- if os.path.exists(file_name):
- result = QMessageBox.question(None, catalog.i18nc("@title:window", "File Already Exists"),
- catalog.i18nc("@label Don't translate the XML tag <filename>!", "The file <filename>{0}</filename> already exists. Are you sure you want to overwrite it?").format(file_name))
- if result == QMessageBox.No:
- return
- found_containers = []
- extruder_positions = []
- for instance_id in instance_ids:
- containers = ContainerRegistry.getInstance().findInstanceContainers(id=instance_id)
- if containers:
- found_containers.append(containers[0])
- # Determine the position of the extruder of this container
- extruder_id = containers[0].getMetaDataEntry("extruder", "")
- if extruder_id == "":
- # Global stack
- extruder_positions.append(-1)
- else:
- extruder_containers = ContainerRegistry.getInstance().findDefinitionContainers(id=extruder_id)
- if extruder_containers:
- extruder_positions.append(int(extruder_containers[0].getMetaDataEntry("position", 0)))
- else:
- extruder_positions.append(0)
- # Ensure the profiles are always exported in order (global, extruder 0, extruder 1, ...)
- found_containers = [containers for (positions, containers) in sorted(zip(extruder_positions, found_containers))]
- profile_writer = self._findProfileWriter(extension, description)
- try:
- success = profile_writer.write(file_name, found_containers)
- except Exception as e:
- Logger.log("e", "Failed to export profile to %s: %s", file_name, str(e))
- m = Message(catalog.i18nc("@info:status Don't translate the XML tags <filename> or <message>!", "Failed to export profile to <filename>{0}</filename>: <message>{1}</message>", file_name, str(e)),
- lifetime = 0,
- title = catalog.i18nc("@info:title", "Error"))
- m.show()
- return
- if not success:
- Logger.log("w", "Failed to export profile to %s: Writer plugin reported failure.", file_name)
- m = Message(catalog.i18nc("@info:status Don't translate the XML tag <filename>!", "Failed to export profile to <filename>{0}</filename>: Writer plugin reported failure.", file_name),
- lifetime = 0,
- title = catalog.i18nc("@info:title", "Error"))
- m.show()
- return
- m = Message(catalog.i18nc("@info:status Don't translate the XML tag <filename>!", "Exported profile to <filename>{0}</filename>", file_name),
- title = catalog.i18nc("@info:title", "Export succeeded"))
- m.show()
- ## Gets the plugin object matching the criteria
- # \param extension
- # \param description
- # \return The plugin object matching the given extension and description.
- def _findProfileWriter(self, extension, description):
- plugin_registry = PluginRegistry.getInstance()
- for plugin_id, meta_data in self._getIOPlugins("profile_writer"):
- for supported_type in meta_data["profile_writer"]: # All file types this plugin can supposedly write.
- supported_extension = supported_type.get("extension", None)
- if supported_extension == extension: # This plugin supports a file type with the same extension.
- supported_description = supported_type.get("description", None)
- if supported_description == description: # The description is also identical. Assume it's the same file type.
- return plugin_registry.getPluginObject(plugin_id)
- return None
- ## Imports a profile from a file
- #
- # \param file_name \type{str} the full path and filename of the profile to import
- # \return \type{Dict} dict with a 'status' key containing the string 'ok' or 'error', and a 'message' key
- # containing a message for the user
- def importProfile(self, file_name):
- Logger.log("d", "Attempting to import profile %s", file_name)
- if not file_name:
- return { "status": "error", "message": catalog.i18nc("@info:status Don't translate the XML tags <filename> or <message>!", "Failed to import profile from <filename>{0}</filename>: <message>{1}</message>", file_name, "Invalid path")}
- plugin_registry = PluginRegistry.getInstance()
- extension = file_name.split(".")[-1]
- global_container_stack = Application.getInstance().getGlobalContainerStack()
- if not global_container_stack:
- return
- machine_extruders = list(ExtruderManager.getInstance().getMachineExtruders(global_container_stack.getId()))
- machine_extruders.sort(key = lambda k: k.getMetaDataEntry("position"))
- for plugin_id, meta_data in self._getIOPlugins("profile_reader"):
- if meta_data["profile_reader"][0]["extension"] != extension:
- continue
- profile_reader = plugin_registry.getPluginObject(plugin_id)
- try:
- profile_or_list = profile_reader.read(file_name) # Try to open the file with the profile reader.
- except Exception as e:
- # Note that this will fail quickly. That is, if any profile reader throws an exception, it will stop reading. It will only continue reading if the reader returned None.
- Logger.log("e", "Failed to import profile from %s: %s while using profile reader. Got exception %s", file_name,profile_reader.getPluginId(), str(e))
- return { "status": "error", "message": catalog.i18nc("@info:status Don't translate the XML tags <filename> or <message>!", "Failed to import profile from <filename>{0}</filename>: <message>{1}</message>", file_name, str(e))}
- if profile_or_list: # Success!
- name_seed = os.path.splitext(os.path.basename(file_name))[0]
- new_name = self.uniqueName(name_seed)
- if type(profile_or_list) is not list:
- profile = profile_or_list
- result = self._configureProfile(profile, name_seed, new_name)
- if result is not None:
- return {"status": "error", "message": catalog.i18nc("@info:status Don't translate the XML tags <filename> or <message>!", "Failed to import profile from <filename>{0}</filename>: <message>{1}</message>", file_name, result)}
- return {"status": "ok", "message": catalog.i18nc("@info:status", "Successfully imported profile {0}", profile.getName())}
- else:
- profile_index = -1
- global_profile = None
- for profile in profile_or_list:
- if profile_index >= 0:
- if len(machine_extruders) > profile_index:
- extruder_id = Application.getInstance().getMachineManager().getQualityDefinitionId(machine_extruders[profile_index].getBottom())
- # Ensure the extruder profiles get non-conflicting names
- # NB: these are not user-facing
- if "extruder" in profile.getMetaData():
- profile.setMetaDataEntry("extruder", extruder_id)
- else:
- profile.addMetaDataEntry("extruder", extruder_id)
- profile_id = (extruder_id + "_" + name_seed).lower().replace(" ", "_")
- elif profile_index == 0:
- # Importing a multiextrusion profile into a single extrusion machine; merge 1st extruder profile into global profile
- profile._id = self.uniqueName("temporary_profile")
- self.addContainer(profile)
- ContainerManager.getInstance().mergeContainers(global_profile.getId(), profile.getId())
- self.removeContainer(profile.getId())
- break
- else:
- # The imported composite profile has a profile for an extruder that this machine does not have. Ignore this extruder-profile
- break
- else:
- global_profile = profile
- profile_id = (global_container_stack.getBottom().getId() + "_" + name_seed).lower().replace(" ", "_")
- result = self._configureProfile(profile, profile_id, new_name)
- if result is not None:
- return {"status": "error", "message": catalog.i18nc("@info:status Don't translate the XML tags <filename> or <message>!", "Failed to import profile from <filename>{0}</filename>: <message>{1}</message>", file_name, result)}
- profile_index += 1
- return {"status": "ok", "message": catalog.i18nc("@info:status", "Successfully imported profile {0}", profile_or_list[0].getName())}
- # If it hasn't returned by now, none of the plugins loaded the profile successfully.
- return {"status": "error", "message": catalog.i18nc("@info:status", "Profile {0} has an unknown file type or is corrupted.", file_name)}
- @override(ContainerRegistry)
- def load(self):
- super().load()
- self._fixupExtruders()
- ## Update an imported profile to match the current machine configuration.
- #
- # \param profile The profile to configure.
- # \param id_seed The base ID for the profile. May be changed so it does not conflict with existing containers.
- # \param new_name The new name for the profile.
- #
- # \return None if configuring was successful or an error message if an error occurred.
- def _configureProfile(self, profile: InstanceContainer, id_seed: str, new_name: str) -> Optional[str]:
- profile.setReadOnly(False)
- profile.setDirty(True) # Ensure the profiles are correctly saved
- new_id = self.createUniqueName("quality_changes", "", id_seed, catalog.i18nc("@label", "Custom profile"))
- profile._id = new_id
- profile.setName(new_name)
- if "type" in profile.getMetaData():
- profile.setMetaDataEntry("type", "quality_changes")
- else:
- profile.addMetaDataEntry("type", "quality_changes")
- quality_type = profile.getMetaDataEntry("quality_type")
- if not quality_type:
- return catalog.i18nc("@info:status", "Profile is missing a quality type.")
- quality_type_criteria = {"quality_type": quality_type}
- if self._machineHasOwnQualities():
- profile.setDefinition(self._activeQualityDefinition())
- if self._machineHasOwnMaterials():
- active_material_id = self._activeMaterialId()
- if active_material_id and active_material_id != "empty": # only update if there is an active material
- profile.addMetaDataEntry("material", active_material_id)
- quality_type_criteria["material"] = active_material_id
- quality_type_criteria["definition"] = profile.getDefinition().getId()
- else:
- profile.setDefinition(ContainerRegistry.getInstance().findDefinitionContainers(id="fdmprinter")[0])
- quality_type_criteria["definition"] = "fdmprinter"
- machine_definition = Application.getInstance().getGlobalContainerStack().getBottom()
- del quality_type_criteria["definition"]
- materials = None
- if "material" in quality_type_criteria:
- materials = ContainerRegistry.getInstance().findInstanceContainers(id = quality_type_criteria["material"])
- del quality_type_criteria["material"]
- # Check to make sure the imported profile actually makes sense in context of the current configuration.
- # This prevents issues where importing a "draft" profile for a machine without "draft" qualities would report as
- # successfully imported but then fail to show up.
- from cura.QualityManager import QualityManager
- qualities = QualityManager.getInstance()._getFilteredContainersForStack(machine_definition, materials, **quality_type_criteria)
- if not qualities:
- return catalog.i18nc("@info:status", "Could not find a quality type {0} for the current configuration.", quality_type)
- ContainerRegistry.getInstance().addContainer(profile)
- return None
- ## Gets a list of profile writer plugins
- # \return List of tuples of (plugin_id, meta_data).
- def _getIOPlugins(self, io_type):
- plugin_registry = PluginRegistry.getInstance()
- active_plugin_ids = plugin_registry.getActivePlugins()
- result = []
- for plugin_id in active_plugin_ids:
- meta_data = plugin_registry.getMetaData(plugin_id)
- if io_type in meta_data:
- result.append( (plugin_id, meta_data) )
- return result
- ## Get the definition to use to select quality profiles for the active machine
- # \return the active quality definition object or None if there is no quality definition
- def _activeQualityDefinition(self):
- global_container_stack = Application.getInstance().getGlobalContainerStack()
- if global_container_stack:
- definition_id = Application.getInstance().getMachineManager().getQualityDefinitionId(global_container_stack.getBottom())
- definition = self.findDefinitionContainers(id=definition_id)[0]
- if definition:
- return definition
- return None
- ## Returns true if the current machine requires its own materials
- # \return True if the current machine requires its own materials
- def _machineHasOwnMaterials(self):
- global_container_stack = Application.getInstance().getGlobalContainerStack()
- if global_container_stack:
- return global_container_stack.getMetaDataEntry("has_materials", False)
- return False
- ## Gets the ID of the active material
- # \return the ID of the active material or the empty string
- def _activeMaterialId(self):
- global_container_stack = Application.getInstance().getGlobalContainerStack()
- if global_container_stack and global_container_stack.material:
- return global_container_stack.material.getId()
- return ""
- ## Returns true if the current machien requires its own quality profiles
- # \return true if the current machien requires its own quality profiles
- def _machineHasOwnQualities(self):
- global_container_stack = Application.getInstance().getGlobalContainerStack()
- if global_container_stack:
- return parseBool(global_container_stack.getMetaDataEntry("has_machine_quality", False))
- return False
- ## Convert an "old-style" pure ContainerStack to either an Extruder or Global stack.
- def _convertContainerStack(self, container):
- assert type(container) == ContainerStack
- container_type = container.getMetaDataEntry("type")
- if container_type not in ("extruder_train", "machine"):
- # It is not an extruder or machine, so do nothing with the stack
- return container
- Logger.log("d", "Converting ContainerStack {stack} to {type}", stack = container.getId(), type = container_type)
- new_stack = None
- if container_type == "extruder_train":
- new_stack = ExtruderStack.ExtruderStack(container.getId())
- else:
- new_stack = GlobalStack.GlobalStack(container.getId())
- container_contents = container.serialize()
- new_stack.deserialize(container_contents)
- # Delete the old configuration file so we do not get double stacks
- if os.path.isfile(container.getPath()):
- os.remove(container.getPath())
- return new_stack
- # Fix the extruders that were upgraded to ExtruderStack instances during addContainer.
- # The stacks are now responsible for setting the next stack on deserialize. However,
- # due to problems with loading order, some stacks may not have the proper next stack
- # set after upgrading, because the proper global stack was not yet loaded. This method
- # makes sure those extruders also get the right stack set.
- def _fixupExtruders(self):
- extruder_stacks = self.findContainers(ExtruderStack.ExtruderStack)
- for extruder_stack in extruder_stacks:
- if extruder_stack.getNextStack():
- # Has the right next stack, so ignore it.
- continue
- machines = ContainerRegistry.getInstance().findContainerStacks(id=extruder_stack.getMetaDataEntry("machine", ""))
- if machines:
- extruder_stack.setNextStack(machines[0])
- else:
- Logger.log("w", "Could not find machine {machine} for extruder {extruder}", machine = extruder_stack.getMetaDataEntry("machine"), extruder = extruder_stack.getId())
|