CuraContainerRegistry.py 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837
  1. # Copyright (c) 2019 Ultimaker B.V.
  2. # Cura is released under the terms of the LGPLv3 or higher.
  3. import os
  4. import re
  5. import configparser
  6. from typing import Any, cast, Dict, Optional, List, Union, Tuple
  7. from PyQt5.QtWidgets import QMessageBox
  8. from UM.Decorators import override
  9. from UM.Settings.ContainerFormatError import ContainerFormatError
  10. from UM.Settings.Interfaces import ContainerInterface
  11. from UM.Settings.ContainerRegistry import ContainerRegistry
  12. from UM.Settings.ContainerStack import ContainerStack
  13. from UM.Settings.InstanceContainer import InstanceContainer
  14. from UM.Settings.SettingInstance import SettingInstance
  15. from UM.Logger import Logger
  16. from UM.Message import Message
  17. from UM.Platform import Platform
  18. from UM.PluginRegistry import PluginRegistry # For getting the possible profile writers to write with.
  19. from UM.Resources import Resources
  20. from UM.Util import parseBool
  21. from cura.ReaderWriters.ProfileWriter import ProfileWriter
  22. from . import ExtruderStack
  23. from . import GlobalStack
  24. import cura.CuraApplication
  25. from cura.Settings.cura_empty_instance_containers import empty_quality_container
  26. from cura.Machines.ContainerTree import ContainerTree
  27. from cura.ReaderWriters.ProfileReader import NoProfileException, ProfileReader
  28. from UM.i18n import i18nCatalog
  29. catalog = i18nCatalog("cura")
  30. class CuraContainerRegistry(ContainerRegistry):
  31. def __init__(self, *args, **kwargs):
  32. super().__init__(*args, **kwargs)
  33. # We don't have all the machines loaded in the beginning, so in order to add the missing extruder stack
  34. # for single extrusion machines, we subscribe to the containerAdded signal, and whenever a global stack
  35. # is added, we check to see if an extruder stack needs to be added.
  36. self.containerAdded.connect(self._onContainerAdded)
  37. @override(ContainerRegistry)
  38. def addContainer(self, container: ContainerInterface) -> bool:
  39. """Overridden from ContainerRegistry
  40. Adds a container to the registry.
  41. This will also try to convert a ContainerStack to either Extruder or
  42. Global stack based on metadata information.
  43. """
  44. # Note: Intentional check with type() because we want to ignore subclasses
  45. if type(container) == ContainerStack:
  46. container = self._convertContainerStack(cast(ContainerStack, container))
  47. if isinstance(container, InstanceContainer) and type(container) != type(self.getEmptyInstanceContainer()):
  48. # Check against setting version of the definition.
  49. required_setting_version = cura.CuraApplication.CuraApplication.SettingVersion
  50. actual_setting_version = int(container.getMetaDataEntry("setting_version", default = 0))
  51. if required_setting_version != actual_setting_version:
  52. 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))
  53. return False # Don't add.
  54. return super().addContainer(container)
  55. def createUniqueName(self, container_type: str, current_name: str, new_name: str, fallback_name: str) -> str:
  56. """Create a name that is not empty and unique
  57. :param container_type: :type{string} Type of the container (machine, quality, ...)
  58. :param current_name: :type{} Current name of the container, which may be an acceptable option
  59. :param new_name: :type{string} Base name, which may not be unique
  60. :param fallback_name: :type{string} Name to use when (stripped) new_name is empty
  61. :return: :type{string} Name that is unique for the specified type and name/id
  62. """
  63. new_name = new_name.strip()
  64. num_check = re.compile(r"(.*?)\s*#\d+$").match(new_name)
  65. if num_check:
  66. new_name = num_check.group(1)
  67. if new_name == "":
  68. new_name = fallback_name
  69. unique_name = new_name
  70. i = 1
  71. # In case we are renaming, the current name of the container is also a valid end-result
  72. while self._containerExists(container_type, unique_name) and unique_name != current_name:
  73. i += 1
  74. unique_name = "%s #%d" % (new_name, i)
  75. return unique_name
  76. def _containerExists(self, container_type: str, container_name: str):
  77. """Check if a container with of a certain type and a certain name or id exists
  78. Both the id and the name are checked, because they may not be the same and it is better if they are both unique
  79. :param container_type: :type{string} Type of the container (machine, quality, ...)
  80. :param container_name: :type{string} Name to check
  81. """
  82. container_class = ContainerStack if container_type == "machine" else InstanceContainer
  83. return self.findContainersMetadata(container_type = container_class, id = container_name, type = container_type, ignore_case = True) or \
  84. self.findContainersMetadata(container_type = container_class, name = container_name, type = container_type)
  85. def exportQualityProfile(self, container_list: List[InstanceContainer], file_name: str, file_type: str) -> bool:
  86. """Exports an profile to a file
  87. :param container_list: :type{list} the containers to export. This is not
  88. necessarily in any order!
  89. :param file_name: :type{str} the full path and filename to export to.
  90. :param file_type: :type{str} the file type with the format "<description> (*.<extension>)"
  91. :return: True if the export succeeded, false otherwise.
  92. """
  93. # Parse the fileType to deduce what plugin can save the file format.
  94. # fileType has the format "<description> (*.<extension>)"
  95. split = file_type.rfind(" (*.") # Find where the description ends and the extension starts.
  96. if split < 0: # Not found. Invalid format.
  97. Logger.log("e", "Invalid file format identifier %s", file_type)
  98. return False
  99. description = file_type[:split]
  100. extension = file_type[split + 4:-1] # Leave out the " (*." and ")".
  101. if not file_name.endswith("." + extension): # Auto-fill the extension if the user did not provide any.
  102. file_name += "." + extension
  103. # On Windows, QML FileDialog properly asks for overwrite confirm, but not on other platforms, so handle those ourself.
  104. if not Platform.isWindows():
  105. if os.path.exists(file_name):
  106. result = QMessageBox.question(None, catalog.i18nc("@title:window", "File Already Exists"),
  107. 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))
  108. if result == QMessageBox.No:
  109. return False
  110. profile_writer = self._findProfileWriter(extension, description)
  111. try:
  112. if profile_writer is None:
  113. raise Exception("Unable to find a profile writer")
  114. success = profile_writer.write(file_name, container_list)
  115. except Exception as e:
  116. Logger.log("e", "Failed to export profile to %s: %s", file_name, str(e))
  117. 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)),
  118. lifetime = 0,
  119. title = catalog.i18nc("@info:title", "Error"))
  120. m.show()
  121. return False
  122. if not success:
  123. Logger.log("w", "Failed to export profile to %s: Writer plugin reported failure.", file_name)
  124. 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),
  125. lifetime = 0,
  126. title = catalog.i18nc("@info:title", "Error"))
  127. m.show()
  128. return False
  129. m = Message(catalog.i18nc("@info:status Don't translate the XML tag <filename>!", "Exported profile to <filename>{0}</filename>", file_name),
  130. title = catalog.i18nc("@info:title", "Export succeeded"))
  131. m.show()
  132. return True
  133. def _findProfileWriter(self, extension: str, description: str) -> Optional[ProfileWriter]:
  134. """Gets the plugin object matching the criteria
  135. :param extension:
  136. :param description:
  137. :return: The plugin object matching the given extension and description.
  138. """
  139. plugin_registry = PluginRegistry.getInstance()
  140. for plugin_id, meta_data in self._getIOPlugins("profile_writer"):
  141. for supported_type in meta_data["profile_writer"]: # All file types this plugin can supposedly write.
  142. supported_extension = supported_type.get("extension", None)
  143. if supported_extension == extension: # This plugin supports a file type with the same extension.
  144. supported_description = supported_type.get("description", None)
  145. if supported_description == description: # The description is also identical. Assume it's the same file type.
  146. return cast(ProfileWriter, plugin_registry.getPluginObject(plugin_id))
  147. return None
  148. def importProfile(self, file_name: str) -> Dict[str, str]:
  149. """Imports a profile from a file
  150. :param file_name: The full path and filename of the profile to import.
  151. :return: Dict with a 'status' key containing the string 'ok', 'warning' or 'error',
  152. and a 'message' key containing a message for the user.
  153. """
  154. Logger.log("d", "Attempting to import profile %s", file_name)
  155. if not file_name:
  156. return { "status": "error", "message": catalog.i18nc("@info:status Don't translate the XML tags <filename>!", "Failed to import profile from <filename>{0}</filename>: {1}", file_name, "Invalid path")}
  157. global_stack = cura.CuraApplication.CuraApplication.getInstance().getGlobalContainerStack()
  158. if not global_stack:
  159. return {"status": "error", "message": catalog.i18nc("@info:status Don't translate the XML tags <filename>!", "Can't import profile from <filename>{0}</filename> before a printer is added.", file_name)}
  160. container_tree = ContainerTree.getInstance()
  161. machine_extruders = global_stack.extruderList
  162. plugin_registry = PluginRegistry.getInstance()
  163. extension = file_name.split(".")[-1]
  164. for plugin_id, meta_data in self._getIOPlugins("profile_reader"):
  165. if meta_data["profile_reader"][0]["extension"] != extension:
  166. continue
  167. profile_reader = cast(ProfileReader, plugin_registry.getPluginObject(plugin_id))
  168. try:
  169. profile_or_list = profile_reader.read(file_name) # Try to open the file with the profile reader.
  170. except NoProfileException:
  171. return { "status": "ok", "message": catalog.i18nc("@info:status Don't translate the XML tags <filename>!", "No custom profile to import in file <filename>{0}</filename>", file_name)}
  172. except Exception as e:
  173. # 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.
  174. Logger.log("e", "Failed to import profile from %s: %s while using profile reader. Got exception %s", file_name, profile_reader.getPluginId(), str(e))
  175. return { "status": "error", "message": catalog.i18nc("@info:status Don't translate the XML tags <filename>!", "Failed to import profile from <filename>{0}</filename>:", file_name) + "\n<message>" + str(e) + "</message>"}
  176. if profile_or_list:
  177. # Ensure it is always a list of profiles
  178. if not isinstance(profile_or_list, list):
  179. profile_or_list = [profile_or_list]
  180. # First check if this profile is suitable for this machine
  181. global_profile = None
  182. extruder_profiles = []
  183. if len(profile_or_list) == 1:
  184. global_profile = profile_or_list[0]
  185. else:
  186. for profile in profile_or_list:
  187. if not profile.getMetaDataEntry("position"):
  188. global_profile = profile
  189. else:
  190. extruder_profiles.append(profile)
  191. extruder_profiles = sorted(extruder_profiles, key = lambda x: int(x.getMetaDataEntry("position", default = "0")))
  192. profile_or_list = [global_profile] + extruder_profiles
  193. if not global_profile:
  194. Logger.log("e", "Incorrect profile [%s]. Could not find global profile", file_name)
  195. return { "status": "error",
  196. "message": catalog.i18nc("@info:status Don't translate the XML tags <filename>!", "This profile <filename>{0}</filename> contains incorrect data, could not import it.", file_name)}
  197. profile_definition = global_profile.getMetaDataEntry("definition")
  198. # Make sure we have a profile_definition in the file:
  199. if profile_definition is None:
  200. break
  201. machine_definitions = self.findContainers(id = profile_definition)
  202. if not machine_definitions:
  203. Logger.log("e", "Incorrect profile [%s]. Unknown machine type [%s]", file_name, profile_definition)
  204. return {"status": "error",
  205. "message": catalog.i18nc("@info:status Don't translate the XML tags <filename>!", "This profile <filename>{0}</filename> contains incorrect data, could not import it.", file_name)
  206. }
  207. machine_definition = machine_definitions[0]
  208. # Get the expected machine definition.
  209. # i.e.: We expect gcode for a UM2 Extended to be defined as normal UM2 gcode...
  210. has_machine_quality = parseBool(machine_definition.getMetaDataEntry("has_machine_quality", "false"))
  211. profile_definition = machine_definition.getMetaDataEntry("quality_definition", machine_definition.getId()) if has_machine_quality else "fdmprinter"
  212. expected_machine_definition = container_tree.machines[global_stack.definition.getId()].quality_definition
  213. # And check if the profile_definition matches either one (showing error if not):
  214. if profile_definition != expected_machine_definition:
  215. Logger.log("d", "Profile {file_name} is for machine {profile_definition}, but the current active machine is {expected_machine_definition}. Changing profile's definition.".format(file_name = file_name, profile_definition = profile_definition, expected_machine_definition = expected_machine_definition))
  216. global_profile.setMetaDataEntry("definition", expected_machine_definition)
  217. for extruder_profile in extruder_profiles:
  218. extruder_profile.setMetaDataEntry("definition", expected_machine_definition)
  219. quality_name = global_profile.getName()
  220. quality_type = global_profile.getMetaDataEntry("quality_type")
  221. name_seed = os.path.splitext(os.path.basename(file_name))[0]
  222. new_name = self.uniqueName(name_seed)
  223. # Ensure it is always a list of profiles
  224. if type(profile_or_list) is not list:
  225. profile_or_list = [profile_or_list]
  226. # Make sure that there are also extruder stacks' quality_changes, not just one for the global stack
  227. if len(profile_or_list) == 1:
  228. global_profile = profile_or_list[0]
  229. extruder_profiles = []
  230. for idx, extruder in enumerate(global_stack.extruderList):
  231. profile_id = ContainerRegistry.getInstance().uniqueName(global_stack.getId() + "_extruder_" + str(idx + 1))
  232. profile = InstanceContainer(profile_id)
  233. profile.setName(quality_name)
  234. profile.setMetaDataEntry("setting_version", cura.CuraApplication.CuraApplication.SettingVersion)
  235. profile.setMetaDataEntry("type", "quality_changes")
  236. profile.setMetaDataEntry("definition", expected_machine_definition)
  237. profile.setMetaDataEntry("quality_type", quality_type)
  238. profile.setDirty(True)
  239. if idx == 0:
  240. # Move all per-extruder settings to the first extruder's quality_changes
  241. for qc_setting_key in global_profile.getAllKeys():
  242. settable_per_extruder = global_stack.getProperty(qc_setting_key, "settable_per_extruder")
  243. if settable_per_extruder:
  244. setting_value = global_profile.getProperty(qc_setting_key, "value")
  245. setting_definition = global_stack.getSettingDefinition(qc_setting_key)
  246. if setting_definition is not None:
  247. new_instance = SettingInstance(setting_definition, profile)
  248. new_instance.setProperty("value", setting_value)
  249. new_instance.resetState() # Ensure that the state is not seen as a user state.
  250. profile.addInstance(new_instance)
  251. profile.setDirty(True)
  252. global_profile.removeInstance(qc_setting_key, postpone_emit = True)
  253. extruder_profiles.append(profile)
  254. for profile in extruder_profiles:
  255. profile_or_list.append(profile)
  256. # Import all profiles
  257. profile_ids_added = [] # type: List[str]
  258. additional_message = None
  259. for profile_index, profile in enumerate(profile_or_list):
  260. if profile_index == 0:
  261. # This is assumed to be the global profile
  262. profile_id = (cast(ContainerInterface, global_stack.getBottom()).getId() + "_" + name_seed).lower().replace(" ", "_")
  263. elif profile_index < len(machine_extruders) + 1:
  264. # This is assumed to be an extruder profile
  265. extruder_id = machine_extruders[profile_index - 1].definition.getId()
  266. extruder_position = str(profile_index - 1)
  267. if not profile.getMetaDataEntry("position"):
  268. profile.setMetaDataEntry("position", extruder_position)
  269. else:
  270. profile.setMetaDataEntry("position", extruder_position)
  271. profile_id = (extruder_id + "_" + name_seed).lower().replace(" ", "_")
  272. else: # More extruders in the imported file than in the machine.
  273. continue # Delete the additional profiles.
  274. configuration_successful, message = self._configureProfile(profile, profile_id, new_name, expected_machine_definition)
  275. if configuration_successful:
  276. additional_message = message
  277. else:
  278. # Remove any profiles that were added.
  279. for profile_id in profile_ids_added + [profile.getId()]:
  280. self.removeContainer(profile_id)
  281. if not message:
  282. message = ""
  283. return {"status": "error", "message": catalog.i18nc(
  284. "@info:status Don't translate the XML tag <filename>!",
  285. "Failed to import profile from <filename>{0}</filename>:",
  286. file_name) + " " + message}
  287. profile_ids_added.append(profile.getId())
  288. result_status = "ok"
  289. success_message = catalog.i18nc("@info:status", "Successfully imported profile {0}.", profile_or_list[0].getName())
  290. if additional_message:
  291. result_status = "warning"
  292. success_message += additional_message
  293. return {"status": result_status, "message": success_message}
  294. # This message is throw when the profile reader doesn't find any profile in the file
  295. return {"status": "error", "message": catalog.i18nc("@info:status", "File {0} does not contain any valid profile.", file_name)}
  296. # If it hasn't returned by now, none of the plugins loaded the profile successfully.
  297. return {"status": "error", "message": catalog.i18nc("@info:status", "Profile {0} has an unknown file type or is corrupted.", file_name)}
  298. @override(ContainerRegistry)
  299. def load(self) -> None:
  300. super().load()
  301. self._registerSingleExtrusionMachinesExtruderStacks()
  302. self._connectUpgradedExtruderStacksToMachines()
  303. @override(ContainerRegistry)
  304. def loadAllMetadata(self) -> None:
  305. super().loadAllMetadata()
  306. self._cleanUpInvalidQualityChanges()
  307. def _cleanUpInvalidQualityChanges(self) -> None:
  308. # We've seen cases where it was possible for quality_changes to be incorrectly added. This is to ensure that
  309. # any such leftovers are purged from the registry.
  310. quality_changes = ContainerRegistry.getInstance().findContainersMetadata(type="quality_changes")
  311. profile_count_by_name = {} # type: Dict[str, int]
  312. for quality_change in quality_changes:
  313. name = str(quality_change.get("name", ""))
  314. if name == "empty":
  315. continue
  316. if name not in profile_count_by_name:
  317. profile_count_by_name[name] = 0
  318. profile_count_by_name[name] += 1
  319. for profile_name, profile_count in profile_count_by_name.items():
  320. if profile_count > 1:
  321. continue
  322. # Only one profile found, this should not ever be the case, so that profile needs to be removed!
  323. Logger.log("d", "Found an invalid quality_changes profile with the name %s. Going to remove that now", profile_name)
  324. invalid_quality_changes = ContainerRegistry.getInstance().findContainersMetadata(name=profile_name)
  325. self.removeContainer(invalid_quality_changes[0]["id"])
  326. @override(ContainerRegistry)
  327. def _isMetadataValid(self, metadata: Optional[Dict[str, Any]]) -> bool:
  328. """Check if the metadata for a container is okay before adding it.
  329. This overrides the one from UM.Settings.ContainerRegistry because we
  330. also require that the setting_version is correct.
  331. """
  332. if metadata is None:
  333. return False
  334. if "setting_version" not in metadata:
  335. return False
  336. try:
  337. if int(metadata["setting_version"]) != cura.CuraApplication.CuraApplication.SettingVersion:
  338. return False
  339. except ValueError: #Not parsable as int.
  340. return False
  341. return True
  342. def _configureProfile(self, profile: InstanceContainer, id_seed: str, new_name: str, machine_definition_id: str) -> Tuple[bool, Optional[str]]:
  343. """Update an imported profile to match the current machine configuration.
  344. :param profile: The profile to configure.
  345. :param id_seed: The base ID for the profile. May be changed so it does not conflict with existing containers.
  346. :param new_name: The new name for the profile.
  347. :returns: tuple (configuration_successful, message)
  348. WHERE
  349. bool configuration_successful: Whether the process of configuring the profile was successful
  350. optional str message: A message indicating the outcome of configuring the profile. If the configuration
  351. is successful, this message can be None or contain a warning
  352. """
  353. profile.setDirty(True) # Ensure the profiles are correctly saved
  354. new_id = self.createUniqueName("quality_changes", "", id_seed, catalog.i18nc("@label", "Custom profile"))
  355. profile.setMetaDataEntry("id", new_id)
  356. profile.setName(new_name)
  357. # Set the unique Id to the profile, so it's generating a new one even if the user imports the same profile
  358. # It also solves an issue with importing profiles from G-Codes
  359. profile.setMetaDataEntry("id", new_id)
  360. profile.setMetaDataEntry("definition", machine_definition_id)
  361. if "type" in profile.getMetaData():
  362. profile.setMetaDataEntry("type", "quality_changes")
  363. else:
  364. profile.setMetaDataEntry("type", "quality_changes")
  365. quality_type = profile.getMetaDataEntry("quality_type")
  366. if not quality_type:
  367. return False, catalog.i18nc("@info:status", "Profile is missing a quality type.")
  368. global_stack = cura.CuraApplication.CuraApplication.getInstance().getGlobalContainerStack()
  369. if not global_stack:
  370. return False, catalog.i18nc("@info:status", "Global stack is missing.")
  371. definition_id = ContainerTree.getInstance().machines[global_stack.definition.getId()].quality_definition
  372. profile.setDefinition(definition_id)
  373. if not self.addContainer(profile):
  374. return False, catalog.i18nc("@info:status", "Unable to add the profile.")
  375. # "not_supported" profiles can be imported.
  376. if quality_type == empty_quality_container.getMetaDataEntry("quality_type"):
  377. return True, None
  378. # Check to make sure the imported profile actually makes sense in context of the current configuration.
  379. # This prevents issues where importing a "draft" profile for a machine without "draft" qualities would report as
  380. # successfully imported but then fail to show up.
  381. available_quality_groups_dict = {name: quality_group for name, quality_group in ContainerTree.getInstance().getCurrentQualityGroups().items() if quality_group.is_available}
  382. all_quality_groups_dict = ContainerTree.getInstance().getCurrentQualityGroups()
  383. # If the quality type doesn't exist at all in the quality_groups of this machine, reject the profile
  384. if quality_type not in all_quality_groups_dict:
  385. return False, catalog.i18nc("@info:status", "Quality type '{0}' is not compatible with the current active machine definition '{1}'.", quality_type, definition_id)
  386. # If the quality_type exists in the quality_groups of this printer but it is not available with the current
  387. # machine configuration (e.g. not available for the selected nozzles), accept it with a warning
  388. if quality_type not in available_quality_groups_dict:
  389. return True, "\n\n" + catalog.i18nc("@info:status", "Warning: The profile is not visible because its quality type '{0}' is not available for the current configuration. "
  390. "Switch to a material/nozzle combination that can use this quality type.", quality_type)
  391. return True, None
  392. @override(ContainerRegistry)
  393. def saveDirtyContainers(self) -> None:
  394. # Lock file for "more" atomically loading and saving to/from config dir.
  395. with self.lockFile():
  396. # Save base files first
  397. for instance in self.findDirtyContainers(container_type=InstanceContainer):
  398. if instance.getMetaDataEntry("removed"):
  399. continue
  400. if instance.getId() == instance.getMetaData().get("base_file"):
  401. self.saveContainer(instance)
  402. for instance in self.findDirtyContainers(container_type=InstanceContainer):
  403. if instance.getMetaDataEntry("removed"):
  404. continue
  405. self.saveContainer(instance)
  406. for stack in self.findContainerStacks():
  407. self.saveContainer(stack)
  408. def _getIOPlugins(self, io_type):
  409. """Gets a list of profile writer plugins
  410. :return: List of tuples of (plugin_id, meta_data).
  411. """
  412. plugin_registry = PluginRegistry.getInstance()
  413. active_plugin_ids = plugin_registry.getActivePlugins()
  414. result = []
  415. for plugin_id in active_plugin_ids:
  416. meta_data = plugin_registry.getMetaData(plugin_id)
  417. if io_type in meta_data:
  418. result.append( (plugin_id, meta_data) )
  419. return result
  420. def _convertContainerStack(self, container: ContainerStack) -> Union[ExtruderStack.ExtruderStack, GlobalStack.GlobalStack]:
  421. """Convert an "old-style" pure ContainerStack to either an Extruder or Global stack."""
  422. assert type(container) == ContainerStack
  423. container_type = container.getMetaDataEntry("type")
  424. if container_type not in ("extruder_train", "machine"):
  425. # It is not an extruder or machine, so do nothing with the stack
  426. return container
  427. Logger.log("d", "Converting ContainerStack {stack} to {type}", stack = container.getId(), type = container_type)
  428. if container_type == "extruder_train":
  429. new_stack = ExtruderStack.ExtruderStack(container.getId())
  430. else:
  431. new_stack = GlobalStack.GlobalStack(container.getId())
  432. container_contents = container.serialize()
  433. new_stack.deserialize(container_contents)
  434. # Delete the old configuration file so we do not get double stacks
  435. if os.path.isfile(container.getPath()):
  436. os.remove(container.getPath())
  437. return new_stack
  438. def _registerSingleExtrusionMachinesExtruderStacks(self) -> None:
  439. machines = self.findContainerStacks(type = "machine", machine_extruder_trains = {"0": "fdmextruder"})
  440. for machine in machines:
  441. extruder_stacks = self.findContainerStacks(type = "extruder_train", machine = machine.getId())
  442. if not extruder_stacks:
  443. self.addExtruderStackForSingleExtrusionMachine(machine, "fdmextruder")
  444. def _onContainerAdded(self, container: ContainerInterface) -> None:
  445. # We don't have all the machines loaded in the beginning, so in order to add the missing extruder stack
  446. # for single extrusion machines, we subscribe to the containerAdded signal, and whenever a global stack
  447. # is added, we check to see if an extruder stack needs to be added.
  448. if not isinstance(container, ContainerStack) or container.getMetaDataEntry("type") != "machine":
  449. return
  450. machine_extruder_trains = container.getMetaDataEntry("machine_extruder_trains")
  451. if machine_extruder_trains is not None and machine_extruder_trains != {"0": "fdmextruder"}:
  452. return
  453. extruder_stacks = self.findContainerStacks(type = "extruder_train", machine = container.getId())
  454. if not extruder_stacks:
  455. self.addExtruderStackForSingleExtrusionMachine(container, "fdmextruder")
  456. #
  457. # new_global_quality_changes is optional. It is only used in project loading for a scenario like this:
  458. # - override the current machine
  459. # - create new for custom quality profile
  460. # new_global_quality_changes is the new global quality changes container in this scenario.
  461. # create_new_ids indicates if new unique ids must be created
  462. #
  463. def addExtruderStackForSingleExtrusionMachine(self, machine, extruder_id, new_global_quality_changes = None, create_new_ids = True):
  464. new_extruder_id = extruder_id
  465. application = cura.CuraApplication.CuraApplication.getInstance()
  466. extruder_definitions = self.findDefinitionContainers(id = new_extruder_id)
  467. if not extruder_definitions:
  468. Logger.log("w", "Could not find definition containers for extruder %s", new_extruder_id)
  469. return
  470. extruder_definition = extruder_definitions[0]
  471. unique_name = self.uniqueName(machine.getName() + " " + new_extruder_id) if create_new_ids else machine.getName() + " " + new_extruder_id
  472. extruder_stack = ExtruderStack.ExtruderStack(unique_name)
  473. extruder_stack.setName(extruder_definition.getName())
  474. extruder_stack.setDefinition(extruder_definition)
  475. extruder_stack.setMetaDataEntry("position", extruder_definition.getMetaDataEntry("position"))
  476. # create a new definition_changes container for the extruder stack
  477. definition_changes_id = self.uniqueName(extruder_stack.getId() + "_settings") if create_new_ids else extruder_stack.getId() + "_settings"
  478. definition_changes_name = definition_changes_id
  479. definition_changes = InstanceContainer(definition_changes_id, parent = application)
  480. definition_changes.setName(definition_changes_name)
  481. definition_changes.setMetaDataEntry("setting_version", application.SettingVersion)
  482. definition_changes.setMetaDataEntry("type", "definition_changes")
  483. definition_changes.setMetaDataEntry("definition", extruder_definition.getId())
  484. # move definition_changes settings if exist
  485. for setting_key in definition_changes.getAllKeys():
  486. if machine.definition.getProperty(setting_key, "settable_per_extruder"):
  487. setting_value = machine.definitionChanges.getProperty(setting_key, "value")
  488. if setting_value is not None:
  489. # move it to the extruder stack's definition_changes
  490. setting_definition = machine.getSettingDefinition(setting_key)
  491. new_instance = SettingInstance(setting_definition, definition_changes)
  492. new_instance.setProperty("value", setting_value)
  493. new_instance.resetState() # Ensure that the state is not seen as a user state.
  494. definition_changes.addInstance(new_instance)
  495. definition_changes.setDirty(True)
  496. machine.definitionChanges.removeInstance(setting_key, postpone_emit = True)
  497. self.addContainer(definition_changes)
  498. extruder_stack.setDefinitionChanges(definition_changes)
  499. # create empty user changes container otherwise
  500. user_container_id = self.uniqueName(extruder_stack.getId() + "_user") if create_new_ids else extruder_stack.getId() + "_user"
  501. user_container_name = user_container_id
  502. user_container = InstanceContainer(user_container_id, parent = application)
  503. user_container.setName(user_container_name)
  504. user_container.setMetaDataEntry("type", "user")
  505. user_container.setMetaDataEntry("machine", machine.getId())
  506. user_container.setMetaDataEntry("setting_version", application.SettingVersion)
  507. user_container.setDefinition(machine.definition.getId())
  508. user_container.setMetaDataEntry("position", extruder_stack.getMetaDataEntry("position"))
  509. if machine.userChanges:
  510. # For the newly created extruder stack, we need to move all "per-extruder" settings to the user changes
  511. # container to the extruder stack.
  512. for user_setting_key in machine.userChanges.getAllKeys():
  513. settable_per_extruder = machine.getProperty(user_setting_key, "settable_per_extruder")
  514. if settable_per_extruder:
  515. setting_value = machine.getProperty(user_setting_key, "value")
  516. setting_definition = machine.getSettingDefinition(user_setting_key)
  517. new_instance = SettingInstance(setting_definition, definition_changes)
  518. new_instance.setProperty("value", setting_value)
  519. new_instance.resetState() # Ensure that the state is not seen as a user state.
  520. user_container.addInstance(new_instance)
  521. user_container.setDirty(True)
  522. machine.userChanges.removeInstance(user_setting_key, postpone_emit = True)
  523. self.addContainer(user_container)
  524. extruder_stack.setUserChanges(user_container)
  525. empty_variant = application.empty_variant_container
  526. empty_material = application.empty_material_container
  527. empty_quality = application.empty_quality_container
  528. if machine.variant.getId() not in ("empty", "empty_variant"):
  529. variant = machine.variant
  530. else:
  531. variant = empty_variant
  532. extruder_stack.variant = variant
  533. if machine.material.getId() not in ("empty", "empty_material"):
  534. material = machine.material
  535. else:
  536. material = empty_material
  537. extruder_stack.material = material
  538. if machine.quality.getId() not in ("empty", "empty_quality"):
  539. quality = machine.quality
  540. else:
  541. quality = empty_quality
  542. extruder_stack.quality = quality
  543. machine_quality_changes = machine.qualityChanges
  544. if new_global_quality_changes is not None:
  545. machine_quality_changes = new_global_quality_changes
  546. if machine_quality_changes.getId() not in ("empty", "empty_quality_changes"):
  547. extruder_quality_changes_container = self.findInstanceContainers(name = machine_quality_changes.getName(), extruder = extruder_id)
  548. if extruder_quality_changes_container:
  549. extruder_quality_changes_container = extruder_quality_changes_container[0]
  550. quality_changes_id = extruder_quality_changes_container.getId()
  551. extruder_stack.qualityChanges = self.findInstanceContainers(id = quality_changes_id)[0]
  552. else:
  553. # Some extruder quality_changes containers can be created at runtime as files in the qualities
  554. # folder. Those files won't be loaded in the registry immediately. So we also need to search
  555. # the folder to see if the quality_changes exists.
  556. extruder_quality_changes_container = self._findQualityChangesContainerInCuraFolder(machine_quality_changes.getName())
  557. if extruder_quality_changes_container:
  558. quality_changes_id = extruder_quality_changes_container.getId()
  559. extruder_quality_changes_container.setMetaDataEntry("position", extruder_definition.getMetaDataEntry("position"))
  560. extruder_stack.qualityChanges = self.findInstanceContainers(id = quality_changes_id)[0]
  561. else:
  562. # If we still cannot find a quality changes container for the extruder, create a new one
  563. container_name = machine_quality_changes.getName()
  564. container_id = self.uniqueName(extruder_stack.getId() + "_qc_" + container_name)
  565. extruder_quality_changes_container = InstanceContainer(container_id, parent = application)
  566. extruder_quality_changes_container.setName(container_name)
  567. extruder_quality_changes_container.setMetaDataEntry("type", "quality_changes")
  568. extruder_quality_changes_container.setMetaDataEntry("setting_version", application.SettingVersion)
  569. extruder_quality_changes_container.setMetaDataEntry("position", extruder_definition.getMetaDataEntry("position"))
  570. extruder_quality_changes_container.setMetaDataEntry("quality_type", machine_quality_changes.getMetaDataEntry("quality_type"))
  571. extruder_quality_changes_container.setMetaDataEntry("intent_category", "default") # Intent categories weren't a thing back then.
  572. extruder_quality_changes_container.setDefinition(machine_quality_changes.getDefinition().getId())
  573. self.addContainer(extruder_quality_changes_container)
  574. extruder_stack.qualityChanges = extruder_quality_changes_container
  575. if not extruder_quality_changes_container:
  576. Logger.log("w", "Could not find quality_changes named [%s] for extruder [%s]",
  577. machine_quality_changes.getName(), extruder_stack.getId())
  578. else:
  579. # Move all per-extruder settings to the extruder's quality changes
  580. for qc_setting_key in machine_quality_changes.getAllKeys():
  581. settable_per_extruder = machine.getProperty(qc_setting_key, "settable_per_extruder")
  582. if settable_per_extruder:
  583. setting_value = machine_quality_changes.getProperty(qc_setting_key, "value")
  584. setting_definition = machine.getSettingDefinition(qc_setting_key)
  585. new_instance = SettingInstance(setting_definition, definition_changes)
  586. new_instance.setProperty("value", setting_value)
  587. new_instance.resetState() # Ensure that the state is not seen as a user state.
  588. extruder_quality_changes_container.addInstance(new_instance)
  589. extruder_quality_changes_container.setDirty(True)
  590. machine_quality_changes.removeInstance(qc_setting_key, postpone_emit=True)
  591. else:
  592. extruder_stack.qualityChanges = self.findInstanceContainers(id = "empty_quality_changes")[0]
  593. self.addContainer(extruder_stack)
  594. # Also need to fix the other qualities that are suitable for this machine. Those quality changes may still have
  595. # per-extruder settings in the container for the machine instead of the extruder.
  596. if machine_quality_changes.getId() not in ("empty", "empty_quality_changes"):
  597. quality_changes_machine_definition_id = machine_quality_changes.getDefinition().getId()
  598. else:
  599. whole_machine_definition = machine.definition
  600. machine_entry = machine.definition.getMetaDataEntry("machine")
  601. if machine_entry is not None:
  602. container_registry = ContainerRegistry.getInstance()
  603. whole_machine_definition = container_registry.findDefinitionContainers(id = machine_entry)[0]
  604. quality_changes_machine_definition_id = "fdmprinter"
  605. if whole_machine_definition.getMetaDataEntry("has_machine_quality"):
  606. quality_changes_machine_definition_id = machine.definition.getMetaDataEntry("quality_definition",
  607. whole_machine_definition.getId())
  608. qcs = self.findInstanceContainers(type = "quality_changes", definition = quality_changes_machine_definition_id)
  609. qc_groups = {} # map of qc names -> qc containers
  610. for qc in qcs:
  611. qc_name = qc.getName()
  612. if qc_name not in qc_groups:
  613. qc_groups[qc_name] = []
  614. qc_groups[qc_name].append(qc)
  615. # Try to find from the quality changes cura directory too
  616. quality_changes_container = self._findQualityChangesContainerInCuraFolder(machine_quality_changes.getName())
  617. if quality_changes_container:
  618. qc_groups[qc_name].append(quality_changes_container)
  619. for qc_name, qc_list in qc_groups.items():
  620. qc_dict = {"global": None, "extruders": []}
  621. for qc in qc_list:
  622. extruder_position = qc.getMetaDataEntry("position")
  623. if extruder_position is not None:
  624. qc_dict["extruders"].append(qc)
  625. else:
  626. qc_dict["global"] = qc
  627. if qc_dict["global"] is not None and len(qc_dict["extruders"]) == 1:
  628. # Move per-extruder settings
  629. for qc_setting_key in qc_dict["global"].getAllKeys():
  630. settable_per_extruder = machine.getProperty(qc_setting_key, "settable_per_extruder")
  631. if settable_per_extruder:
  632. setting_value = qc_dict["global"].getProperty(qc_setting_key, "value")
  633. setting_definition = machine.getSettingDefinition(qc_setting_key)
  634. new_instance = SettingInstance(setting_definition, definition_changes)
  635. new_instance.setProperty("value", setting_value)
  636. new_instance.resetState() # Ensure that the state is not seen as a user state.
  637. qc_dict["extruders"][0].addInstance(new_instance)
  638. qc_dict["extruders"][0].setDirty(True)
  639. qc_dict["global"].removeInstance(qc_setting_key, postpone_emit=True)
  640. # Set next stack at the end
  641. extruder_stack.setNextStack(machine)
  642. return extruder_stack
  643. def _findQualityChangesContainerInCuraFolder(self, name: str) -> Optional[InstanceContainer]:
  644. quality_changes_dir = Resources.getPath(cura.CuraApplication.CuraApplication.ResourceTypes.QualityChangesInstanceContainer)
  645. instance_container = None
  646. for item in os.listdir(quality_changes_dir):
  647. file_path = os.path.join(quality_changes_dir, item)
  648. if not os.path.isfile(file_path):
  649. continue
  650. parser = configparser.ConfigParser(interpolation = None)
  651. try:
  652. parser.read([file_path])
  653. except Exception:
  654. # Skip, it is not a valid stack file
  655. continue
  656. if not parser.has_option("general", "name"):
  657. continue
  658. if parser["general"]["name"] == name:
  659. # Load the container
  660. container_id = os.path.basename(file_path).replace(".inst.cfg", "")
  661. if self.findInstanceContainers(id = container_id):
  662. # This container is already in the registry, skip it
  663. continue
  664. instance_container = InstanceContainer(container_id)
  665. with open(file_path, "r", encoding = "utf-8") as f:
  666. serialized = f.read()
  667. try:
  668. instance_container.deserialize(serialized, file_path)
  669. except ContainerFormatError:
  670. Logger.logException("e", "Unable to deserialize InstanceContainer %s", file_path)
  671. continue
  672. self.addContainer(instance_container)
  673. break
  674. return instance_container
  675. # Fix the extruders that were upgraded to ExtruderStack instances during addContainer.
  676. # The stacks are now responsible for setting the next stack on deserialize. However,
  677. # due to problems with loading order, some stacks may not have the proper next stack
  678. # set after upgrading, because the proper global stack was not yet loaded. This method
  679. # makes sure those extruders also get the right stack set.
  680. def _connectUpgradedExtruderStacksToMachines(self) -> None:
  681. extruder_stacks = self.findContainers(container_type = ExtruderStack.ExtruderStack)
  682. for extruder_stack in extruder_stacks:
  683. if extruder_stack.getNextStack():
  684. # Has the right next stack, so ignore it.
  685. continue
  686. machines = ContainerRegistry.getInstance().findContainerStacks(id = extruder_stack.getMetaDataEntry("machine", ""))
  687. if machines:
  688. extruder_stack.setNextStack(machines[0])
  689. else:
  690. Logger.log("w", "Could not find machine {machine} for extruder {extruder}", machine = extruder_stack.getMetaDataEntry("machine"), extruder = extruder_stack.getId())
  691. # Override just for the type.
  692. @classmethod
  693. @override(ContainerRegistry)
  694. def getInstance(cls, *args, **kwargs) -> "CuraContainerRegistry":
  695. return cast(CuraContainerRegistry, super().getInstance(*args, **kwargs))