ThreeMFWorkspaceReader.py 66 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237
  1. # Copyright (c) 2021 Ultimaker B.V.
  2. # Cura is released under the terms of the LGPLv3 or higher.
  3. from configparser import ConfigParser
  4. import zipfile
  5. import os
  6. import json
  7. from typing import cast, Dict, List, Optional, Tuple, Any, Set
  8. import xml.etree.ElementTree as ET
  9. from UM.Workspace.WorkspaceReader import WorkspaceReader
  10. from UM.Application import Application
  11. from UM.Logger import Logger
  12. from UM.Message import Message
  13. from UM.i18n import i18nCatalog
  14. from UM.Settings.ContainerFormatError import ContainerFormatError
  15. from UM.Settings.ContainerStack import ContainerStack
  16. from UM.Settings.DefinitionContainer import DefinitionContainer
  17. from UM.Settings.InstanceContainer import InstanceContainer
  18. from UM.Settings.ContainerRegistry import ContainerRegistry
  19. from UM.MimeTypeDatabase import MimeTypeDatabase, MimeType
  20. from UM.Job import Job
  21. from UM.Preferences import Preferences
  22. from cura.Machines.ContainerTree import ContainerTree
  23. from cura.Settings.CuraStackBuilder import CuraStackBuilder
  24. from cura.Settings.ExtruderManager import ExtruderManager
  25. from cura.Settings.ExtruderStack import ExtruderStack
  26. from cura.Settings.GlobalStack import GlobalStack
  27. from cura.Settings.IntentManager import IntentManager
  28. from cura.Settings.CuraContainerStack import _ContainerIndexes
  29. from cura.CuraApplication import CuraApplication
  30. from cura.Utils.Threading import call_on_qt_thread
  31. from PyQt5.QtCore import QCoreApplication
  32. from .WorkspaceDialog import WorkspaceDialog
  33. i18n_catalog = i18nCatalog("cura")
  34. _ignored_machine_network_metadata = {
  35. "um_cloud_cluster_id",
  36. "um_network_key",
  37. "um_linked_to_account",
  38. "host_guid",
  39. "removal_warning",
  40. "group_name",
  41. "group_size",
  42. "connection_type"
  43. } # type: Set[str]
  44. class ContainerInfo:
  45. def __init__(self, file_name: Optional[str], serialized: Optional[str], parser: Optional[ConfigParser]) -> None:
  46. self.file_name = file_name
  47. self.serialized = serialized
  48. self.parser = parser
  49. self.container = None
  50. self.definition_id = None
  51. class QualityChangesInfo:
  52. def __init__(self) -> None:
  53. self.name = None
  54. self.global_info = None
  55. self.extruder_info_dict = {} # type: Dict[str, ContainerInfo]
  56. class MachineInfo:
  57. def __init__(self) -> None:
  58. self.container_id = None
  59. self.name = None
  60. self.definition_id = None
  61. self.metadata_dict = {} # type: Dict[str, str]
  62. self.quality_type = None
  63. self.intent_category = None
  64. self.custom_quality_name = None
  65. self.quality_changes_info = None
  66. self.variant_info = None
  67. self.definition_changes_info = None
  68. self.user_changes_info = None
  69. self.extruder_info_dict = {} # type: Dict[str, ExtruderInfo]
  70. class ExtruderInfo:
  71. def __init__(self) -> None:
  72. self.position = None
  73. self.enabled = True
  74. self.variant_info = None
  75. self.root_material_id = None
  76. self.definition_changes_info = None
  77. self.user_changes_info = None
  78. self.intent_info = None
  79. class ThreeMFWorkspaceReader(WorkspaceReader):
  80. """Base implementation for reading 3MF workspace files."""
  81. def __init__(self) -> None:
  82. super().__init__()
  83. self._supported_extensions = [".3mf"]
  84. self._dialog = WorkspaceDialog()
  85. self._3mf_mesh_reader = None
  86. self._container_registry = ContainerRegistry.getInstance()
  87. # suffixes registered with the MimeTypes don't start with a dot '.'
  88. self._definition_container_suffix = "." + cast(MimeType, ContainerRegistry.getMimeTypeForContainer(DefinitionContainer)).preferredSuffix
  89. self._material_container_suffix = None # We have to wait until all other plugins are loaded before we can set it
  90. self._instance_container_suffix = "." + cast(MimeType, ContainerRegistry.getMimeTypeForContainer(InstanceContainer)).preferredSuffix
  91. self._container_stack_suffix = "." + cast(MimeType, ContainerRegistry.getMimeTypeForContainer(ContainerStack)).preferredSuffix
  92. self._extruder_stack_suffix = "." + cast(MimeType, ContainerRegistry.getMimeTypeForContainer(ExtruderStack)).preferredSuffix
  93. self._global_stack_suffix = "." + cast(MimeType, ContainerRegistry.getMimeTypeForContainer(GlobalStack)).preferredSuffix
  94. # Certain instance container types are ignored because we make the assumption that only we make those types
  95. # of containers. They are:
  96. # - quality
  97. # - variant
  98. self._ignored_instance_container_types = {"quality", "variant"}
  99. self._resolve_strategies = {} # type: Dict[str, str]
  100. self._id_mapping = {} # type: Dict[str, str]
  101. # In Cura 2.5 and 2.6, the empty profiles used to have those long names
  102. self._old_empty_profile_id_dict = {"empty_%s" % k: "empty" for k in ["material", "variant"]}
  103. self._old_new_materials = {} # type: Dict[str, str]
  104. self._machine_info = None
  105. def _clearState(self):
  106. self._id_mapping = {}
  107. self._old_new_materials = {}
  108. self._machine_info = None
  109. def getNewId(self, old_id: str):
  110. """Get a unique name based on the old_id. This is different from directly calling the registry in that it caches results.
  111. This has nothing to do with speed, but with getting consistent new naming for instances & objects.
  112. """
  113. if old_id not in self._id_mapping:
  114. self._id_mapping[old_id] = self._container_registry.uniqueName(old_id)
  115. return self._id_mapping[old_id]
  116. def _determineGlobalAndExtruderStackFiles(self, project_file_name: str, file_list: List[str]) -> Tuple[str, List[str]]:
  117. """Separates the given file list into a list of GlobalStack files and a list of ExtruderStack files.
  118. In old versions, extruder stack files have the same suffix as container stack files ".stack.cfg".
  119. """
  120. archive = zipfile.ZipFile(project_file_name, "r")
  121. global_stack_file_list = [name for name in file_list if name.endswith(self._global_stack_suffix)]
  122. extruder_stack_file_list = [name for name in file_list if name.endswith(self._extruder_stack_suffix)]
  123. # separate container stack files and extruder stack files
  124. files_to_determine = [name for name in file_list if name.endswith(self._container_stack_suffix)]
  125. for file_name in files_to_determine:
  126. # FIXME: HACK!
  127. # We need to know the type of the stack file, but we can only know it if we deserialize it.
  128. # The default ContainerStack.deserialize() will connect signals, which is not desired in this case.
  129. # Since we know that the stack files are INI files, so we directly use the ConfigParser to parse them.
  130. serialized = archive.open(file_name).read().decode("utf-8")
  131. stack_config = ConfigParser(interpolation = None)
  132. stack_config.read_string(serialized)
  133. # sanity check
  134. if not stack_config.has_option("metadata", "type"):
  135. Logger.log("e", "%s in %s doesn't seem to be valid stack file", file_name, project_file_name)
  136. continue
  137. stack_type = stack_config.get("metadata", "type")
  138. if stack_type == "extruder_train":
  139. extruder_stack_file_list.append(file_name)
  140. elif stack_type == "machine":
  141. global_stack_file_list.append(file_name)
  142. else:
  143. Logger.log("w", "Unknown container stack type '%s' from %s in %s",
  144. stack_type, file_name, project_file_name)
  145. if len(global_stack_file_list) > 1:
  146. Logger.log("e", "More than one global stack file found: [{file_list}]".format(file_list = global_stack_file_list))
  147. #But we can recover by just getting the first global stack file.
  148. if len(global_stack_file_list) == 0:
  149. Logger.log("e", "No global stack file found!")
  150. raise FileNotFoundError("No global stack file found!")
  151. return global_stack_file_list[0], extruder_stack_file_list
  152. def preRead(self, file_name, show_dialog=True, *args, **kwargs):
  153. """Read some info so we can make decisions
  154. :param file_name:
  155. :param show_dialog: In case we use preRead() to check if a file is a valid project file,
  156. we don't want to show a dialog.
  157. """
  158. self._clearState()
  159. self._3mf_mesh_reader = Application.getInstance().getMeshFileHandler().getReaderForFile(file_name)
  160. if self._3mf_mesh_reader and self._3mf_mesh_reader.preRead(file_name) == WorkspaceReader.PreReadResult.accepted:
  161. pass
  162. else:
  163. Logger.log("w", "Could not find reader that was able to read the scene data for 3MF workspace")
  164. return WorkspaceReader.PreReadResult.failed
  165. self._machine_info = MachineInfo()
  166. machine_type = ""
  167. variant_type_name = i18n_catalog.i18nc("@label", "Nozzle")
  168. # Check if there are any conflicts, so we can ask the user.
  169. archive = zipfile.ZipFile(file_name, "r")
  170. cura_file_names = [name for name in archive.namelist() if name.startswith("Cura/")]
  171. resolve_strategy_keys = ["machine", "material", "quality_changes"]
  172. self._resolve_strategies = {k: None for k in resolve_strategy_keys}
  173. containers_found_dict = {k: False for k in resolve_strategy_keys}
  174. #
  175. # Read definition containers
  176. #
  177. machine_definition_id = None
  178. updatable_machines = []
  179. machine_definition_container_count = 0
  180. extruder_definition_container_count = 0
  181. definition_container_files = [name for name in cura_file_names if name.endswith(self._definition_container_suffix)]
  182. for definition_container_file in definition_container_files:
  183. container_id = self._stripFileToId(definition_container_file)
  184. definitions = self._container_registry.findDefinitionContainersMetadata(id = container_id)
  185. serialized = archive.open(definition_container_file).read().decode("utf-8")
  186. if not definitions:
  187. definition_container = DefinitionContainer.deserializeMetadata(serialized, container_id)[0]
  188. else:
  189. definition_container = definitions[0]
  190. definition_container_type = definition_container.get("type")
  191. if definition_container_type == "machine":
  192. machine_definition_id = container_id
  193. machine_definition_containers = self._container_registry.findDefinitionContainers(id = machine_definition_id)
  194. if machine_definition_containers:
  195. updatable_machines = [machine for machine in self._container_registry.findContainerStacks(type = "machine") if machine.definition == machine_definition_containers[0]]
  196. machine_type = definition_container["name"]
  197. variant_type_name = definition_container.get("variants_name", variant_type_name)
  198. machine_definition_container_count += 1
  199. elif definition_container_type == "extruder":
  200. extruder_definition_container_count += 1
  201. else:
  202. Logger.log("w", "Unknown definition container type %s for %s",
  203. definition_container_type, definition_container_file)
  204. QCoreApplication.processEvents() # Ensure that the GUI does not freeze.
  205. Job.yieldThread()
  206. if machine_definition_container_count != 1:
  207. return WorkspaceReader.PreReadResult.failed # Not a workspace file but ordinary 3MF.
  208. material_ids_to_names_map = {}
  209. material_conflict = False
  210. xml_material_profile = self._getXmlProfileClass()
  211. reverse_material_id_dict = {}
  212. if self._material_container_suffix is None:
  213. self._material_container_suffix = ContainerRegistry.getMimeTypeForContainer(xml_material_profile).preferredSuffix
  214. if xml_material_profile:
  215. material_container_files = [name for name in cura_file_names if name.endswith(self._material_container_suffix)]
  216. for material_container_file in material_container_files:
  217. container_id = self._stripFileToId(material_container_file)
  218. serialized = archive.open(material_container_file).read().decode("utf-8")
  219. metadata_list = xml_material_profile.deserializeMetadata(serialized, container_id)
  220. reverse_map = {metadata["id"]: container_id for metadata in metadata_list}
  221. reverse_material_id_dict.update(reverse_map)
  222. material_ids_to_names_map[container_id] = self._getMaterialLabelFromSerialized(serialized)
  223. if self._container_registry.findContainersMetadata(id = container_id): #This material already exists.
  224. containers_found_dict["material"] = True
  225. if not self._container_registry.isReadOnly(container_id): # Only non readonly materials can be in conflict
  226. material_conflict = True
  227. QCoreApplication.processEvents() # Ensure that the GUI does not freeze.
  228. Job.yieldThread()
  229. # Check if any quality_changes instance container is in conflict.
  230. instance_container_files = [name for name in cura_file_names if name.endswith(self._instance_container_suffix)]
  231. quality_name = ""
  232. custom_quality_name = ""
  233. intent_name = ""
  234. intent_category = ""
  235. num_settings_overridden_by_quality_changes = 0 # How many settings are changed by the quality changes
  236. num_user_settings = 0
  237. quality_changes_conflict = False
  238. self._machine_info.quality_changes_info = QualityChangesInfo()
  239. quality_changes_info_list = []
  240. instance_container_info_dict = {} # id -> parser
  241. for instance_container_file_name in instance_container_files:
  242. container_id = self._stripFileToId(instance_container_file_name)
  243. serialized = archive.open(instance_container_file_name).read().decode("utf-8")
  244. # Qualities and variants don't have upgrades, so don't upgrade them
  245. parser = ConfigParser(interpolation = None, comment_prefixes = ())
  246. parser.read_string(serialized)
  247. container_type = parser["metadata"]["type"]
  248. if container_type not in ("quality", "variant"):
  249. serialized = InstanceContainer._updateSerialized(serialized, instance_container_file_name)
  250. parser = ConfigParser(interpolation = None, comment_prefixes = ())
  251. parser.read_string(serialized)
  252. container_info = ContainerInfo(instance_container_file_name, serialized, parser)
  253. instance_container_info_dict[container_id] = container_info
  254. container_type = parser["metadata"]["type"]
  255. if container_type == "quality_changes":
  256. quality_changes_info_list.append(container_info)
  257. if not parser.has_option("metadata", "position"):
  258. self._machine_info.quality_changes_info.name = parser["general"]["name"]
  259. self._machine_info.quality_changes_info.global_info = container_info
  260. else:
  261. position = parser["metadata"]["position"]
  262. self._machine_info.quality_changes_info.extruder_info_dict[position] = container_info
  263. custom_quality_name = parser["general"]["name"]
  264. values = parser["values"] if parser.has_section("values") else dict()
  265. num_settings_overridden_by_quality_changes += len(values)
  266. # Check if quality changes already exists.
  267. quality_changes = self._container_registry.findInstanceContainers(name = custom_quality_name,
  268. type = "quality_changes")
  269. if quality_changes:
  270. containers_found_dict["quality_changes"] = True
  271. # Check if there really is a conflict by comparing the values
  272. instance_container = InstanceContainer(container_id)
  273. try:
  274. instance_container.deserialize(serialized, file_name = instance_container_file_name)
  275. except ContainerFormatError:
  276. Logger.logException("e", "Failed to deserialize InstanceContainer %s from project file %s",
  277. instance_container_file_name, file_name)
  278. return ThreeMFWorkspaceReader.PreReadResult.failed
  279. if quality_changes[0] != instance_container:
  280. quality_changes_conflict = True
  281. elif container_type == "quality":
  282. if not quality_name:
  283. quality_name = parser["general"]["name"]
  284. elif container_type == "intent":
  285. if not intent_name:
  286. intent_name = parser["general"]["name"]
  287. intent_category = parser["metadata"]["intent_category"]
  288. elif container_type == "user":
  289. num_user_settings += len(parser["values"])
  290. elif container_type in self._ignored_instance_container_types:
  291. # Ignore certain instance container types
  292. Logger.log("w", "Ignoring instance container [%s] with type [%s]", container_id, container_type)
  293. continue
  294. QCoreApplication.processEvents() # Ensure that the GUI does not freeze.
  295. Job.yieldThread()
  296. if self._machine_info.quality_changes_info.global_info is None:
  297. self._machine_info.quality_changes_info = None
  298. # Load ContainerStack files and ExtruderStack files
  299. try:
  300. global_stack_file, extruder_stack_files = self._determineGlobalAndExtruderStackFiles(
  301. file_name, cura_file_names)
  302. except FileNotFoundError:
  303. return WorkspaceReader.PreReadResult.failed
  304. machine_conflict = False
  305. # Because there can be cases as follows:
  306. # - the global stack exists but some/all of the extruder stacks DON'T exist
  307. # - the global stack DOESN'T exist but some/all of the extruder stacks exist
  308. # To simplify this, only check if the global stack exists or not
  309. global_stack_id = self._stripFileToId(global_stack_file)
  310. serialized = archive.open(global_stack_file).read().decode("utf-8")
  311. serialized = GlobalStack._updateSerialized(serialized, global_stack_file)
  312. machine_name = self._getMachineNameFromSerializedStack(serialized)
  313. self._machine_info.metadata_dict = self._getMetaDataDictFromSerializedStack(serialized)
  314. # Check if the definition has been changed (this usually happens due to an upgrade)
  315. id_list = self._getContainerIdListFromSerialized(serialized)
  316. if id_list[7] != machine_definition_id:
  317. machine_definition_id = id_list[7]
  318. stacks = self._container_registry.findContainerStacks(name = machine_name, type = "machine")
  319. existing_global_stack = None
  320. global_stack = None
  321. if stacks:
  322. global_stack = stacks[0]
  323. existing_global_stack = global_stack
  324. containers_found_dict["machine"] = True
  325. # Check if there are any changes at all in any of the container stacks.
  326. for index, container_id in enumerate(id_list):
  327. # take into account the old empty container IDs
  328. container_id = self._old_empty_profile_id_dict.get(container_id, container_id)
  329. if global_stack.getContainer(index).getId() != container_id:
  330. machine_conflict = True
  331. break
  332. if updatable_machines and not containers_found_dict["machine"]:
  333. containers_found_dict["machine"] = True
  334. # Get quality type
  335. parser = ConfigParser(interpolation = None)
  336. parser.read_string(serialized)
  337. quality_container_id = parser["containers"][str(_ContainerIndexes.Quality)]
  338. quality_type = "empty_quality"
  339. if quality_container_id not in ("empty", "empty_quality"):
  340. if quality_container_id in instance_container_info_dict:
  341. quality_type = instance_container_info_dict[quality_container_id].parser["metadata"]["quality_type"]
  342. else: # If a version upgrade changed the quality profile in the stack, we'll need to look for it in the built-in profiles instead of the workspace.
  343. quality_matches = ContainerRegistry.getInstance().findContainersMetadata(id = quality_container_id)
  344. if quality_matches: # If there's no profile with this ID, leave it empty_quality.
  345. quality_type = quality_matches[0]["quality_type"]
  346. # Get machine info
  347. serialized = archive.open(global_stack_file).read().decode("utf-8")
  348. serialized = GlobalStack._updateSerialized(serialized, global_stack_file)
  349. parser = ConfigParser(interpolation = None)
  350. parser.read_string(serialized)
  351. definition_changes_id = parser["containers"][str(_ContainerIndexes.DefinitionChanges)]
  352. if definition_changes_id not in ("empty", "empty_definition_changes"):
  353. self._machine_info.definition_changes_info = instance_container_info_dict[definition_changes_id]
  354. user_changes_id = parser["containers"][str(_ContainerIndexes.UserChanges)]
  355. if user_changes_id not in ("empty", "empty_user_changes"):
  356. self._machine_info.user_changes_info = instance_container_info_dict[user_changes_id]
  357. # Also check variant and material in case it doesn't have extruder stacks
  358. if not extruder_stack_files:
  359. position = "0"
  360. extruder_info = ExtruderInfo()
  361. extruder_info.position = position
  362. variant_id = parser["containers"][str(_ContainerIndexes.Variant)]
  363. material_id = parser["containers"][str(_ContainerIndexes.Material)]
  364. if variant_id not in ("empty", "empty_variant"):
  365. extruder_info.variant_info = instance_container_info_dict[variant_id]
  366. if material_id not in ("empty", "empty_material"):
  367. root_material_id = reverse_material_id_dict[material_id]
  368. extruder_info.root_material_id = root_material_id
  369. self._machine_info.extruder_info_dict[position] = extruder_info
  370. else:
  371. variant_id = parser["containers"][str(_ContainerIndexes.Variant)]
  372. if variant_id not in ("empty", "empty_variant"):
  373. self._machine_info.variant_info = instance_container_info_dict[variant_id]
  374. QCoreApplication.processEvents() # Ensure that the GUI does not freeze.
  375. Job.yieldThread()
  376. materials_in_extruders_dict = {} # Which material is in which extruder
  377. # if the global stack is found, we check if there are conflicts in the extruder stacks
  378. for extruder_stack_file in extruder_stack_files:
  379. serialized = archive.open(extruder_stack_file).read().decode("utf-8")
  380. serialized = ExtruderStack._updateSerialized(serialized, extruder_stack_file)
  381. parser = ConfigParser(interpolation = None)
  382. parser.read_string(serialized)
  383. # The check should be done for the extruder stack that's associated with the existing global stack,
  384. # and those extruder stacks may have different IDs.
  385. # So we check according to the positions
  386. position = parser["metadata"]["position"]
  387. variant_id = parser["containers"][str(_ContainerIndexes.Variant)]
  388. material_id = parser["containers"][str(_ContainerIndexes.Material)]
  389. extruder_info = ExtruderInfo()
  390. extruder_info.position = position
  391. if parser.has_option("metadata", "enabled"):
  392. extruder_info.enabled = parser["metadata"]["enabled"]
  393. if variant_id not in ("empty", "empty_variant"):
  394. if variant_id in instance_container_info_dict:
  395. extruder_info.variant_info = instance_container_info_dict[variant_id]
  396. if material_id not in ("empty", "empty_material"):
  397. root_material_id = reverse_material_id_dict[material_id]
  398. extruder_info.root_material_id = root_material_id
  399. materials_in_extruders_dict[position] = material_ids_to_names_map[reverse_material_id_dict[material_id]]
  400. definition_changes_id = parser["containers"][str(_ContainerIndexes.DefinitionChanges)]
  401. if definition_changes_id not in ("empty", "empty_definition_changes"):
  402. extruder_info.definition_changes_info = instance_container_info_dict[definition_changes_id]
  403. user_changes_id = parser["containers"][str(_ContainerIndexes.UserChanges)]
  404. if user_changes_id not in ("empty", "empty_user_changes"):
  405. extruder_info.user_changes_info = instance_container_info_dict[user_changes_id]
  406. self._machine_info.extruder_info_dict[position] = extruder_info
  407. intent_id = parser["containers"][str(_ContainerIndexes.Intent)]
  408. if intent_id not in ("empty", "empty_intent"):
  409. extruder_info.intent_info = instance_container_info_dict[intent_id]
  410. if not machine_conflict and containers_found_dict["machine"] and global_stack:
  411. if int(position) >= len(global_stack.extruderList):
  412. continue
  413. existing_extruder_stack = global_stack.extruderList[int(position)]
  414. # check if there are any changes at all in any of the container stacks.
  415. id_list = self._getContainerIdListFromSerialized(serialized)
  416. for index, container_id in enumerate(id_list):
  417. # take into account the old empty container IDs
  418. container_id = self._old_empty_profile_id_dict.get(container_id, container_id)
  419. if existing_extruder_stack.getContainer(index).getId() != container_id:
  420. machine_conflict = True
  421. break
  422. # Now we know which material is in which extruder. Let's use that to sort the material_labels according to
  423. # their extruder position
  424. material_labels = [material_name for pos, material_name in sorted(materials_in_extruders_dict.items())]
  425. machine_extruder_count = self._getMachineExtruderCount()
  426. if machine_extruder_count:
  427. material_labels = material_labels[:machine_extruder_count]
  428. num_visible_settings = 0
  429. try:
  430. temp_preferences = Preferences()
  431. serialized = archive.open("Cura/preferences.cfg").read().decode("utf-8")
  432. temp_preferences.deserialize(serialized)
  433. visible_settings_string = temp_preferences.getValue("general/visible_settings")
  434. has_visible_settings_string = visible_settings_string is not None
  435. if visible_settings_string is not None:
  436. num_visible_settings = len(visible_settings_string.split(";"))
  437. active_mode = temp_preferences.getValue("cura/active_mode")
  438. if not active_mode:
  439. active_mode = Application.getInstance().getPreferences().getValue("cura/active_mode")
  440. except KeyError:
  441. # If there is no preferences file, it's not a workspace, so notify user of failure.
  442. Logger.log("w", "File %s is not a valid workspace.", file_name)
  443. return WorkspaceReader.PreReadResult.failed
  444. # Check if the machine definition exists. If not, indicate failure because we do not import definition files.
  445. def_results = self._container_registry.findDefinitionContainersMetadata(id = machine_definition_id)
  446. if not def_results:
  447. message = Message(i18n_catalog.i18nc("@info:status Don't translate the XML tags <filename> or <message>!",
  448. "Project file <filename>{0}</filename> contains an unknown machine type"
  449. " <message>{1}</message>. Cannot import the machine."
  450. " Models will be imported instead.", file_name, machine_definition_id),
  451. title = i18n_catalog.i18nc("@info:title", "Open Project File"))
  452. message.show()
  453. Logger.log("i", "Could unknown machine definition %s in project file %s, cannot import it.",
  454. self._machine_info.definition_id, file_name)
  455. return WorkspaceReader.PreReadResult.failed
  456. # In case we use preRead() to check if a file is a valid project file, we don't want to show a dialog.
  457. if not show_dialog:
  458. return WorkspaceReader.PreReadResult.accepted
  459. # prepare data for the dialog
  460. num_extruders = extruder_definition_container_count
  461. if num_extruders == 0:
  462. num_extruders = 1 # No extruder stacks found, which means there is one extruder
  463. extruders = num_extruders * [""]
  464. quality_name = custom_quality_name if custom_quality_name else quality_name
  465. self._machine_info.container_id = global_stack_id
  466. self._machine_info.name = machine_name
  467. self._machine_info.definition_id = machine_definition_id
  468. self._machine_info.quality_type = quality_type
  469. self._machine_info.custom_quality_name = quality_name
  470. self._machine_info.intent_category = intent_category
  471. is_printer_group = False
  472. if machine_conflict:
  473. group_name = existing_global_stack.getMetaDataEntry("group_name")
  474. if group_name is not None:
  475. is_printer_group = True
  476. machine_name = group_name
  477. # Show the dialog, informing the user what is about to happen.
  478. self._dialog.setMachineConflict(machine_conflict)
  479. self._dialog.setIsPrinterGroup(is_printer_group)
  480. self._dialog.setQualityChangesConflict(quality_changes_conflict)
  481. self._dialog.setMaterialConflict(material_conflict)
  482. self._dialog.setHasVisibleSettingsField(has_visible_settings_string)
  483. self._dialog.setNumVisibleSettings(num_visible_settings)
  484. self._dialog.setQualityName(quality_name)
  485. self._dialog.setQualityType(quality_type)
  486. self._dialog.setIntentName(intent_name)
  487. self._dialog.setNumSettingsOverriddenByQualityChanges(num_settings_overridden_by_quality_changes)
  488. self._dialog.setNumUserSettings(num_user_settings)
  489. self._dialog.setActiveMode(active_mode)
  490. self._dialog.setUpdatableMachines(updatable_machines)
  491. self._dialog.setMachineName(machine_name)
  492. self._dialog.setMaterialLabels(material_labels)
  493. self._dialog.setMachineType(machine_type)
  494. self._dialog.setExtruders(extruders)
  495. self._dialog.setVariantType(variant_type_name)
  496. self._dialog.setHasObjectsOnPlate(Application.getInstance().platformActivity)
  497. self._dialog.show()
  498. # Block until the dialog is closed.
  499. self._dialog.waitForClose()
  500. if self._dialog.getResult() == {}:
  501. return WorkspaceReader.PreReadResult.cancelled
  502. self._resolve_strategies = self._dialog.getResult()
  503. #
  504. # There can be 3 resolve strategies coming from the dialog:
  505. # - new: create a new container
  506. # - override: override the existing container
  507. # - None: There is no conflict, which means containers with the same IDs may or may not be there already.
  508. # If there is an existing container, there is no conflict between them, and default to "override"
  509. # If there is no existing container, default to "new"
  510. #
  511. # Default values
  512. for key, strategy in self._resolve_strategies.items():
  513. if key not in containers_found_dict or strategy is not None:
  514. continue
  515. self._resolve_strategies[key] = "override" if containers_found_dict[key] else "new"
  516. return WorkspaceReader.PreReadResult.accepted
  517. @call_on_qt_thread
  518. def read(self, file_name):
  519. """Read the project file
  520. Add all the definitions / materials / quality changes that do not exist yet. Then it loads
  521. all the stacks into the container registry. In some cases it will reuse the container for the global stack.
  522. It handles old style project files containing .stack.cfg as well as new style project files
  523. containing global.cfg / extruder.cfg
  524. :param file_name:
  525. """
  526. application = CuraApplication.getInstance()
  527. try:
  528. archive = zipfile.ZipFile(file_name, "r")
  529. except EnvironmentError as e:
  530. message = Message(i18n_catalog.i18nc("@info:error Don't translate the XML tags <filename> or <message>!",
  531. "Project file <filename>{0}</filename> is suddenly inaccessible: <message>{1}</message>.", file_name, str(e)),
  532. title = i18n_catalog.i18nc("@info:title", "Can't Open Project File"))
  533. message.show()
  534. self.setWorkspaceName("")
  535. return [], {}
  536. except zipfile.BadZipFile as e:
  537. message = Message(i18n_catalog.i18nc("@info:error Don't translate the XML tags <filename> or <message>!",
  538. "Project file <filename>{0}</filename> is corrupt: <message>{1}</message>.", file_name, str(e)),
  539. title = i18n_catalog.i18nc("@info:title", "Can't Open Project File"))
  540. message.show()
  541. self.setWorkspaceName("")
  542. return [], {}
  543. cura_file_names = [name for name in archive.namelist() if name.startswith("Cura/")]
  544. # Create a shadow copy of the preferences (we don't want all of the preferences, but we do want to re-use its
  545. # parsing code.
  546. temp_preferences = Preferences()
  547. serialized = archive.open("Cura/preferences.cfg").read().decode("utf-8")
  548. temp_preferences.deserialize(serialized)
  549. # Copy a number of settings from the temp preferences to the global
  550. global_preferences = application.getInstance().getPreferences()
  551. visible_settings = temp_preferences.getValue("general/visible_settings")
  552. if visible_settings is None:
  553. Logger.log("w", "Workspace did not contain visible settings. Leaving visibility unchanged")
  554. else:
  555. global_preferences.setValue("general/visible_settings", visible_settings)
  556. global_preferences.setValue("cura/active_setting_visibility_preset", "custom")
  557. categories_expanded = temp_preferences.getValue("cura/categories_expanded")
  558. if categories_expanded is None:
  559. Logger.log("w", "Workspace did not contain expanded categories. Leaving them unchanged")
  560. else:
  561. global_preferences.setValue("cura/categories_expanded", categories_expanded)
  562. application.expandedCategoriesChanged.emit() # Notify the GUI of the change
  563. # If there are no machines of the same type, create a new machine.
  564. if self._resolve_strategies["machine"] != "override" or self._dialog.updatableMachinesModel.count <= 1:
  565. # We need to create a new machine
  566. machine_name = self._container_registry.uniqueName(self._machine_info.name)
  567. # Printers with modifiable number of extruders (such as CFFF) will specify a machine_extruder_count in their
  568. # quality_changes file. If that's the case, take the extruder count into account when creating the machine
  569. # or else the extruderList will return only the first extruder, leading to missing non-global settings in
  570. # the other extruders.
  571. machine_extruder_count = self._getMachineExtruderCount() # type: Optional[int]
  572. global_stack = CuraStackBuilder.createMachine(machine_name, self._machine_info.definition_id, machine_extruder_count)
  573. if global_stack: # Only switch if creating the machine was successful.
  574. extruder_stack_dict = {str(position): extruder for position, extruder in enumerate(global_stack.extruderList)}
  575. self._container_registry.addContainer(global_stack)
  576. else:
  577. # Find the machine which will be overridden
  578. global_stacks = self._container_registry.findContainerStacks(id = self._dialog.getMachineToOverride(), type = "machine")
  579. if not global_stacks:
  580. message = Message(i18n_catalog.i18nc("@info:error Don't translate the XML tag <filename>!",
  581. "Project file <filename>{0}</filename> is made using profiles that"
  582. " are unknown to this version of Ultimaker Cura.", file_name))
  583. message.show()
  584. self.setWorkspaceName("")
  585. return [], {}
  586. global_stack = global_stacks[0]
  587. extruder_stacks = self._container_registry.findContainerStacks(machine = global_stack.getId(),
  588. type = "extruder_train")
  589. extruder_stack_dict = {stack.getMetaDataEntry("position"): stack for stack in extruder_stacks}
  590. # Make sure that those extruders have the global stack as the next stack or later some value evaluation
  591. # will fail.
  592. for stack in extruder_stacks:
  593. stack.setNextStack(global_stack, connect_signals = False)
  594. Logger.log("d", "Workspace loading is checking definitions...")
  595. # Get all the definition files & check if they exist. If not, add them.
  596. definition_container_files = [name for name in cura_file_names if name.endswith(self._definition_container_suffix)]
  597. for definition_container_file in definition_container_files:
  598. container_id = self._stripFileToId(definition_container_file)
  599. definitions = self._container_registry.findDefinitionContainersMetadata(id = container_id)
  600. if not definitions:
  601. definition_container = DefinitionContainer(container_id)
  602. try:
  603. definition_container.deserialize(archive.open(definition_container_file).read().decode("utf-8"),
  604. file_name = definition_container_file)
  605. except ContainerFormatError:
  606. # We cannot just skip the definition file because everything else later will just break if the
  607. # machine definition cannot be found.
  608. Logger.logException("e", "Failed to deserialize definition file %s in project file %s",
  609. definition_container_file, file_name)
  610. definition_container = self._container_registry.findDefinitionContainers(id = "fdmprinter")[0] #Fall back to defaults.
  611. self._container_registry.addContainer(definition_container)
  612. Job.yieldThread()
  613. QCoreApplication.processEvents() # Ensure that the GUI does not freeze.
  614. Logger.log("d", "Workspace loading is checking materials...")
  615. # Get all the material files and check if they exist. If not, add them.
  616. xml_material_profile = self._getXmlProfileClass()
  617. if self._material_container_suffix is None:
  618. self._material_container_suffix = ContainerRegistry.getMimeTypeForContainer(xml_material_profile).suffixes[0]
  619. if xml_material_profile:
  620. material_container_files = [name for name in cura_file_names if name.endswith(self._material_container_suffix)]
  621. for material_container_file in material_container_files:
  622. to_deserialize_material = False
  623. container_id = self._stripFileToId(material_container_file)
  624. need_new_name = False
  625. materials = self._container_registry.findInstanceContainers(id = container_id)
  626. if not materials:
  627. # No material found, deserialize this material later and add it
  628. to_deserialize_material = True
  629. else:
  630. material_container = materials[0]
  631. old_material_root_id = material_container.getMetaDataEntry("base_file")
  632. if old_material_root_id is not None and not self._container_registry.isReadOnly(old_material_root_id): # Only create new materials if they are not read only.
  633. to_deserialize_material = True
  634. if self._resolve_strategies["material"] == "override":
  635. # Remove the old materials and then deserialize the one from the project
  636. root_material_id = material_container.getMetaDataEntry("base_file")
  637. application.getContainerRegistry().removeContainer(root_material_id)
  638. elif self._resolve_strategies["material"] == "new":
  639. # Note that we *must* deserialize it with a new ID, as multiple containers will be
  640. # auto created & added.
  641. container_id = self.getNewId(container_id)
  642. self._old_new_materials[old_material_root_id] = container_id
  643. need_new_name = True
  644. if to_deserialize_material:
  645. material_container = xml_material_profile(container_id)
  646. try:
  647. material_container.deserialize(archive.open(material_container_file).read().decode("utf-8"),
  648. file_name = container_id + "." + self._material_container_suffix)
  649. except ContainerFormatError:
  650. Logger.logException("e", "Failed to deserialize material file %s in project file %s",
  651. material_container_file, file_name)
  652. continue
  653. if need_new_name:
  654. new_name = ContainerRegistry.getInstance().uniqueName(material_container.getName())
  655. material_container.setName(new_name)
  656. material_container.setDirty(True)
  657. self._container_registry.addContainer(material_container)
  658. Job.yieldThread()
  659. QCoreApplication.processEvents() # Ensure that the GUI does not freeze.
  660. if global_stack:
  661. # Handle quality changes if any
  662. self._processQualityChanges(global_stack)
  663. # Prepare the machine
  664. self._applyChangesToMachine(global_stack, extruder_stack_dict)
  665. Logger.log("d", "Workspace loading is notifying rest of the code of changes...")
  666. # Actually change the active machine.
  667. #
  668. # This is scheduled for later is because it depends on the Variant/Material/Qualitiy Managers to have the latest
  669. # data, but those managers will only update upon a container/container metadata changed signal. Because this
  670. # function is running on the main thread (Qt thread), although those "changed" signals have been emitted, but
  671. # they won't take effect until this function is done.
  672. # To solve this, we schedule _updateActiveMachine() for later so it will have the latest data.
  673. self._updateActiveMachine(global_stack)
  674. # Load all the nodes / mesh data of the workspace
  675. nodes = self._3mf_mesh_reader.read(file_name)
  676. if nodes is None:
  677. nodes = []
  678. base_file_name = os.path.basename(file_name)
  679. self.setWorkspaceName(base_file_name)
  680. return nodes, self._loadMetadata(file_name)
  681. @staticmethod
  682. def _loadMetadata(file_name: str) -> Dict[str, Dict[str, Any]]:
  683. result = dict() # type: Dict[str, Dict[str, Any]]
  684. try:
  685. archive = zipfile.ZipFile(file_name, "r")
  686. except zipfile.BadZipFile:
  687. Logger.logException("w", "Unable to retrieve metadata from {fname}: 3MF archive is corrupt.".format(fname = file_name))
  688. return result
  689. except EnvironmentError as e:
  690. Logger.logException("w", "Unable to retrieve metadata from {fname}: File is inaccessible. Error: {err}".format(fname = file_name, err = str(e)))
  691. return result
  692. metadata_files = [name for name in archive.namelist() if name.endswith("plugin_metadata.json")]
  693. for metadata_file in metadata_files:
  694. try:
  695. plugin_id = metadata_file.split("/")[0]
  696. result[plugin_id] = json.loads(archive.open("%s/plugin_metadata.json" % plugin_id).read().decode("utf-8"))
  697. except Exception:
  698. Logger.logException("w", "Unable to retrieve metadata for %s", metadata_file)
  699. return result
  700. def _processQualityChanges(self, global_stack):
  701. if self._machine_info.quality_changes_info is None:
  702. return
  703. # If we have custom profiles, load them
  704. quality_changes_name = self._machine_info.quality_changes_info.name
  705. if self._machine_info.quality_changes_info is not None:
  706. Logger.log("i", "Loading custom profile [%s] from project file",
  707. self._machine_info.quality_changes_info.name)
  708. # Get the correct extruder definition IDs for quality changes
  709. machine_definition_id_for_quality = ContainerTree.getInstance().machines[global_stack.definition.getId()].quality_definition
  710. machine_definition_for_quality = self._container_registry.findDefinitionContainers(id = machine_definition_id_for_quality)[0]
  711. quality_changes_info = self._machine_info.quality_changes_info
  712. quality_changes_quality_type = quality_changes_info.global_info.parser["metadata"]["quality_type"]
  713. # quality changes container may not be present for every extruder. Prepopulate the dict with default values.
  714. quality_changes_intent_category_per_extruder = {position: "default" for position in self._machine_info.extruder_info_dict}
  715. for position, info in quality_changes_info.extruder_info_dict.items():
  716. quality_changes_intent_category_per_extruder[position] = info.parser["metadata"].get("intent_category", "default")
  717. quality_changes_name = quality_changes_info.name
  718. create_new = self._resolve_strategies.get("quality_changes") != "override"
  719. if create_new:
  720. container_info_dict = {None: self._machine_info.quality_changes_info.global_info}
  721. container_info_dict.update(quality_changes_info.extruder_info_dict)
  722. quality_changes_name = self._container_registry.uniqueName(quality_changes_name)
  723. for position, container_info in container_info_dict.items():
  724. extruder_stack = None
  725. intent_category = None # type: Optional[str]
  726. if position is not None:
  727. try:
  728. extruder_stack = global_stack.extruderList[int(position)]
  729. except IndexError:
  730. continue
  731. intent_category = quality_changes_intent_category_per_extruder[position]
  732. container = self._createNewQualityChanges(quality_changes_quality_type, intent_category, quality_changes_name, global_stack, extruder_stack)
  733. container_info.container = container
  734. self._container_registry.addContainer(container)
  735. Logger.log("d", "Created new quality changes container [%s]", container.getId())
  736. else:
  737. # Find the existing containers
  738. quality_changes_containers = self._container_registry.findInstanceContainers(name = quality_changes_name,
  739. type = "quality_changes")
  740. for container in quality_changes_containers:
  741. extruder_position = container.getMetaDataEntry("position")
  742. if extruder_position is None:
  743. quality_changes_info.global_info.container = container
  744. else:
  745. if extruder_position not in quality_changes_info.extruder_info_dict:
  746. quality_changes_info.extruder_info_dict[extruder_position] = ContainerInfo(None, None, None)
  747. container_info = quality_changes_info.extruder_info_dict[extruder_position]
  748. container_info.container = container
  749. # If there is no quality changes for any extruder, create one.
  750. if not quality_changes_info.extruder_info_dict:
  751. container_info = ContainerInfo(None, None, None)
  752. quality_changes_info.extruder_info_dict["0"] = container_info
  753. # If the global stack we're "targeting" has never been active, but was updated from Cura 3.4,
  754. # it might not have its extruders set properly.
  755. if len(global_stack.extruderList) == 0:
  756. ExtruderManager.getInstance().fixSingleExtrusionMachineExtruderDefinition(global_stack)
  757. try:
  758. extruder_stack = global_stack.extruderList[0]
  759. except IndexError:
  760. extruder_stack = None
  761. intent_category = quality_changes_intent_category_per_extruder["0"]
  762. container = self._createNewQualityChanges(quality_changes_quality_type, intent_category, quality_changes_name, global_stack, extruder_stack)
  763. container_info.container = container
  764. self._container_registry.addContainer(container)
  765. Logger.log("d", "Created new quality changes container [%s]", container.getId())
  766. # Clear all existing containers
  767. quality_changes_info.global_info.container.clear()
  768. for container_info in quality_changes_info.extruder_info_dict.values():
  769. if container_info.container:
  770. container_info.container.clear()
  771. # Loop over everything and override the existing containers
  772. global_info = quality_changes_info.global_info
  773. global_info.container.clear() # Clear all
  774. for key, value in global_info.parser["values"].items():
  775. if not machine_definition_for_quality.getProperty(key, "settable_per_extruder"):
  776. global_info.container.setProperty(key, "value", value)
  777. else:
  778. quality_changes_info.extruder_info_dict["0"].container.setProperty(key, "value", value)
  779. for position, container_info in quality_changes_info.extruder_info_dict.items():
  780. if container_info.parser is None:
  781. continue
  782. if container_info.container is None:
  783. try:
  784. extruder_stack = global_stack.extruderList[int(position)]
  785. except IndexError:
  786. continue
  787. intent_category = quality_changes_intent_category_per_extruder[position]
  788. container = self._createNewQualityChanges(quality_changes_quality_type, intent_category, quality_changes_name, global_stack, extruder_stack)
  789. container_info.container = container
  790. self._container_registry.addContainer(container)
  791. for key, value in container_info.parser["values"].items():
  792. container_info.container.setProperty(key, "value", value)
  793. self._machine_info.quality_changes_info.name = quality_changes_name
  794. def _getMachineExtruderCount(self) -> Optional[int]:
  795. """
  796. Extracts the machine extruder count from the definition_changes file of the printer. If it is not specified in
  797. the file, None is returned instead.
  798. :return: The count of the machine's extruders
  799. """
  800. machine_extruder_count = None
  801. if self._machine_info \
  802. and self._machine_info.definition_changes_info \
  803. and "values" in self._machine_info.definition_changes_info.parser \
  804. and "machine_extruder_count" in self._machine_info.definition_changes_info.parser["values"]:
  805. try:
  806. # Theoretically, if the machine_extruder_count is a setting formula (e.g. "=3"), this will produce a
  807. # value error and the project file loading will load the settings in the first extruder only.
  808. # This is not expected to happen though, since all machine definitions define the machine_extruder_count
  809. # as an integer.
  810. machine_extruder_count = int(self._machine_info.definition_changes_info.parser["values"]["machine_extruder_count"])
  811. except ValueError:
  812. Logger.log("w", "'machine_extruder_count' in file '{file_name}' is not a number."
  813. .format(file_name = self._machine_info.definition_changes_info.file_name))
  814. return machine_extruder_count
  815. def _createNewQualityChanges(self, quality_type: str, intent_category: Optional[str], name: str, global_stack: GlobalStack, extruder_stack: Optional[ExtruderStack]) -> InstanceContainer:
  816. """Helper class to create a new quality changes profile.
  817. This will then later be filled with the appropriate data.
  818. :param quality_type: The quality type of the new profile.
  819. :param intent_category: The intent category of the new profile.
  820. :param name: The name for the profile. This will later be made unique so
  821. it doesn't need to be unique yet.
  822. :param global_stack: The global stack showing the configuration that the
  823. profile should be created for.
  824. :param extruder_stack: The extruder stack showing the configuration that
  825. the profile should be created for. If this is None, it will be created
  826. for the global stack.
  827. """
  828. container_registry = CuraApplication.getInstance().getContainerRegistry()
  829. base_id = global_stack.definition.getId() if extruder_stack is None else extruder_stack.getId()
  830. new_id = base_id + "_" + name
  831. new_id = new_id.lower().replace(" ", "_")
  832. new_id = container_registry.uniqueName(new_id)
  833. # Create a new quality_changes container for the quality.
  834. quality_changes = InstanceContainer(new_id)
  835. quality_changes.setName(name)
  836. quality_changes.setMetaDataEntry("type", "quality_changes")
  837. quality_changes.setMetaDataEntry("quality_type", quality_type)
  838. if intent_category is not None:
  839. quality_changes.setMetaDataEntry("intent_category", intent_category)
  840. # If we are creating a container for an extruder, ensure we add that to the container.
  841. if extruder_stack is not None:
  842. quality_changes.setMetaDataEntry("position", extruder_stack.getMetaDataEntry("position"))
  843. # If the machine specifies qualities should be filtered, ensure we match the current criteria.
  844. machine_definition_id = ContainerTree.getInstance().machines[global_stack.definition.getId()].quality_definition
  845. quality_changes.setDefinition(machine_definition_id)
  846. quality_changes.setMetaDataEntry("setting_version", CuraApplication.getInstance().SettingVersion)
  847. quality_changes.setDirty(True)
  848. return quality_changes
  849. @staticmethod
  850. def _clearStack(stack):
  851. application = CuraApplication.getInstance()
  852. stack.definitionChanges.clear()
  853. stack.variant = application.empty_variant_container
  854. stack.material = application.empty_material_container
  855. stack.quality = application.empty_quality_container
  856. stack.qualityChanges = application.empty_quality_changes_container
  857. stack.userChanges.clear()
  858. def _applyDefinitionChanges(self, global_stack, extruder_stack_dict):
  859. values_to_set_for_extruders = {}
  860. if self._machine_info.definition_changes_info is not None:
  861. parser = self._machine_info.definition_changes_info.parser
  862. for key, value in parser["values"].items():
  863. if global_stack.getProperty(key, "settable_per_extruder"):
  864. values_to_set_for_extruders[key] = value
  865. else:
  866. global_stack.definitionChanges.setProperty(key, "value", value)
  867. for position, extruder_stack in extruder_stack_dict.items():
  868. if position not in self._machine_info.extruder_info_dict:
  869. continue
  870. extruder_info = self._machine_info.extruder_info_dict[position]
  871. if extruder_info.definition_changes_info is None:
  872. continue
  873. parser = extruder_info.definition_changes_info.parser
  874. for key, value in values_to_set_for_extruders.items():
  875. extruder_stack.definitionChanges.setProperty(key, "value", value)
  876. if parser is not None:
  877. for key, value in parser["values"].items():
  878. extruder_stack.definitionChanges.setProperty(key, "value", value)
  879. def _applyUserChanges(self, global_stack, extruder_stack_dict):
  880. values_to_set_for_extruder_0 = {}
  881. if self._machine_info.user_changes_info is not None:
  882. parser = self._machine_info.user_changes_info.parser
  883. for key, value in parser["values"].items():
  884. if global_stack.getProperty(key, "settable_per_extruder"):
  885. values_to_set_for_extruder_0[key] = value
  886. else:
  887. global_stack.userChanges.setProperty(key, "value", value)
  888. for position, extruder_stack in extruder_stack_dict.items():
  889. if position not in self._machine_info.extruder_info_dict:
  890. continue
  891. extruder_info = self._machine_info.extruder_info_dict[position]
  892. if extruder_info.user_changes_info is not None:
  893. parser = self._machine_info.extruder_info_dict[position].user_changes_info.parser
  894. if position == "0":
  895. for key, value in values_to_set_for_extruder_0.items():
  896. extruder_stack.userChanges.setProperty(key, "value", value)
  897. if parser is not None:
  898. for key, value in parser["values"].items():
  899. extruder_stack.userChanges.setProperty(key, "value", value)
  900. def _applyVariants(self, global_stack, extruder_stack_dict):
  901. machine_node = ContainerTree.getInstance().machines[global_stack.definition.getId()]
  902. # Take the global variant from the machine info if available.
  903. if self._machine_info.variant_info is not None:
  904. variant_name = self._machine_info.variant_info.parser["general"]["name"]
  905. if variant_name in machine_node.variants:
  906. global_stack.variant = machine_node.variants[variant_name].container
  907. else:
  908. Logger.log("w", "Could not find global variant '{0}'.".format(variant_name))
  909. for position, extruder_stack in extruder_stack_dict.items():
  910. if position not in self._machine_info.extruder_info_dict:
  911. continue
  912. extruder_info = self._machine_info.extruder_info_dict[position]
  913. if extruder_info.variant_info is None:
  914. # If there is no variant_info, try to use the default variant. Otherwise, any available variant.
  915. node = machine_node.variants.get(machine_node.preferred_variant_name, next(iter(machine_node.variants.values())))
  916. else:
  917. variant_name = extruder_info.variant_info.parser["general"]["name"]
  918. node = ContainerTree.getInstance().machines[global_stack.definition.getId()].variants[variant_name]
  919. extruder_stack.variant = node.container
  920. def _applyMaterials(self, global_stack, extruder_stack_dict):
  921. machine_node = ContainerTree.getInstance().machines[global_stack.definition.getId()]
  922. for position, extruder_stack in extruder_stack_dict.items():
  923. if position not in self._machine_info.extruder_info_dict:
  924. continue
  925. extruder_info = self._machine_info.extruder_info_dict[position]
  926. if extruder_info.root_material_id is None:
  927. continue
  928. root_material_id = extruder_info.root_material_id
  929. root_material_id = self._old_new_materials.get(root_material_id, root_material_id)
  930. material_node = machine_node.variants[extruder_stack.variant.getName()].materials[root_material_id]
  931. extruder_stack.material = material_node.container # type: InstanceContainer
  932. def _applyChangesToMachine(self, global_stack, extruder_stack_dict):
  933. # Clear all first
  934. self._clearStack(global_stack)
  935. for extruder_stack in extruder_stack_dict.values():
  936. self._clearStack(extruder_stack)
  937. self._applyDefinitionChanges(global_stack, extruder_stack_dict)
  938. self._applyUserChanges(global_stack, extruder_stack_dict)
  939. self._applyVariants(global_stack, extruder_stack_dict)
  940. self._applyMaterials(global_stack, extruder_stack_dict)
  941. # prepare the quality to select
  942. self._quality_changes_to_apply = None
  943. self._quality_type_to_apply = None
  944. self._intent_category_to_apply = None
  945. if self._machine_info.quality_changes_info is not None:
  946. self._quality_changes_to_apply = self._machine_info.quality_changes_info.name
  947. else:
  948. self._quality_type_to_apply = self._machine_info.quality_type
  949. self._intent_category_to_apply = self._machine_info.intent_category
  950. # Set enabled/disabled for extruders
  951. for position, extruder_stack in extruder_stack_dict.items():
  952. extruder_info = self._machine_info.extruder_info_dict.get(position)
  953. if not extruder_info:
  954. continue
  955. if "enabled" not in extruder_stack.getMetaData():
  956. extruder_stack.setMetaDataEntry("enabled", "True")
  957. extruder_stack.setMetaDataEntry("enabled", str(extruder_info.enabled))
  958. # Set metadata fields that are missing from the global stack
  959. for key, value in self._machine_info.metadata_dict.items():
  960. if key not in _ignored_machine_network_metadata:
  961. global_stack.setMetaDataEntry(key, value)
  962. def _updateActiveMachine(self, global_stack):
  963. # Actually change the active machine.
  964. machine_manager = Application.getInstance().getMachineManager()
  965. container_tree = ContainerTree.getInstance()
  966. machine_manager.setActiveMachine(global_stack.getId())
  967. # Set metadata fields that are missing from the global stack
  968. for key, value in self._machine_info.metadata_dict.items():
  969. if key not in global_stack.getMetaData() and key not in _ignored_machine_network_metadata:
  970. global_stack.setMetaDataEntry(key, value)
  971. if self._quality_changes_to_apply:
  972. quality_changes_group_list = container_tree.getCurrentQualityChangesGroups()
  973. quality_changes_group = next((qcg for qcg in quality_changes_group_list if qcg.name == self._quality_changes_to_apply), None)
  974. if not quality_changes_group:
  975. Logger.log("e", "Could not find quality_changes [%s]", self._quality_changes_to_apply)
  976. return
  977. machine_manager.setQualityChangesGroup(quality_changes_group, no_dialog = True)
  978. else:
  979. self._quality_type_to_apply = self._quality_type_to_apply.lower() if self._quality_type_to_apply else None
  980. quality_group_dict = container_tree.getCurrentQualityGroups()
  981. if self._quality_type_to_apply in quality_group_dict:
  982. quality_group = quality_group_dict[self._quality_type_to_apply]
  983. else:
  984. Logger.log("i", "Could not find quality type [%s], switch to default", self._quality_type_to_apply)
  985. preferred_quality_type = global_stack.getMetaDataEntry("preferred_quality_type")
  986. quality_group = quality_group_dict.get(preferred_quality_type)
  987. if quality_group is None:
  988. Logger.log("e", "Could not get preferred quality type [%s]", preferred_quality_type)
  989. if quality_group is not None:
  990. machine_manager.setQualityGroup(quality_group, no_dialog = True)
  991. # Also apply intent if available
  992. available_intent_category_list = IntentManager.getInstance().currentAvailableIntentCategories()
  993. if self._intent_category_to_apply is not None and self._intent_category_to_apply in available_intent_category_list:
  994. machine_manager.setIntentByCategory(self._intent_category_to_apply)
  995. # Notify everything/one that is to notify about changes.
  996. global_stack.containersChanged.emit(global_stack.getTop())
  997. @staticmethod
  998. def _stripFileToId(file):
  999. mime_type = MimeTypeDatabase.getMimeTypeForFile(file)
  1000. file = mime_type.stripExtension(file)
  1001. return file.replace("Cura/", "")
  1002. def _getXmlProfileClass(self):
  1003. return self._container_registry.getContainerForMimeType(MimeTypeDatabase.getMimeType("application/x-ultimaker-material-profile"))
  1004. @staticmethod
  1005. def _getContainerIdListFromSerialized(serialized):
  1006. """Get the list of ID's of all containers in a container stack by partially parsing it's serialized data."""
  1007. parser = ConfigParser(interpolation = None, empty_lines_in_values = False)
  1008. parser.read_string(serialized)
  1009. container_ids = []
  1010. if "containers" in parser:
  1011. for index, container_id in parser.items("containers"):
  1012. container_ids.append(container_id)
  1013. elif parser.has_option("general", "containers"):
  1014. container_string = parser["general"].get("containers", "")
  1015. container_list = container_string.split(",")
  1016. container_ids = [container_id for container_id in container_list if container_id != ""]
  1017. # HACK: there used to be 6 containers numbering from 0 to 5 in a stack,
  1018. # now we have 7: index 5 becomes "definition_changes"
  1019. if len(container_ids) == 6:
  1020. # Hack; We used to not save the definition changes. Fix this.
  1021. container_ids.insert(5, "empty")
  1022. return container_ids
  1023. @staticmethod
  1024. def _getMachineNameFromSerializedStack(serialized):
  1025. parser = ConfigParser(interpolation = None, empty_lines_in_values = False)
  1026. parser.read_string(serialized)
  1027. return parser["general"].get("name", "")
  1028. @staticmethod
  1029. def _getMetaDataDictFromSerializedStack(serialized: str) -> Dict[str, str]:
  1030. parser = ConfigParser(interpolation = None, empty_lines_in_values = False)
  1031. parser.read_string(serialized)
  1032. return dict(parser["metadata"])
  1033. @staticmethod
  1034. def _getMaterialLabelFromSerialized(serialized):
  1035. data = ET.fromstring(serialized)
  1036. metadata = data.iterfind("./um:metadata/um:name/um:label", {"um": "http://www.ultimaker.com/material"})
  1037. for entry in metadata:
  1038. return entry.text