PostProcessingPlugin.py 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394
  1. # Copyright (c) 2018 Jaime van Kessel, Ultimaker B.V.
  2. # The PostProcessingPlugin is released under the terms of the AGPLv3 or higher.
  3. import configparser # The script lists are stored in metadata as serialised config files.
  4. import importlib.util
  5. import io # To allow configparser to write to a string.
  6. import os.path
  7. import pkgutil
  8. import sys
  9. from typing import Dict, Type, TYPE_CHECKING, List, Optional, cast
  10. from PyQt5.QtCore import QObject, pyqtProperty, pyqtSignal, pyqtSlot
  11. from UM.Application import Application
  12. from UM.Extension import Extension
  13. from UM.Logger import Logger
  14. from UM.PluginRegistry import PluginRegistry
  15. from UM.Resources import Resources
  16. from UM.Trust import Trust, TrustBasics
  17. from UM.i18n import i18nCatalog
  18. from cura import ApplicationMetadata
  19. from cura.CuraApplication import CuraApplication
  20. i18n_catalog = i18nCatalog("cura")
  21. if TYPE_CHECKING:
  22. from .Script import Script
  23. class PostProcessingPlugin(QObject, Extension):
  24. """Extension type plugin that enables pre-written scripts to post process g-code files."""
  25. def __init__(self, parent = None) -> None:
  26. QObject.__init__(self, parent)
  27. Extension.__init__(self)
  28. self.setMenuName(i18n_catalog.i18nc("@item:inmenu", "Post Processing"))
  29. self.addMenuItem(i18n_catalog.i18nc("@item:inmenu", "Modify G-Code"), self.showPopup)
  30. self._view = None
  31. # Loaded scripts are all scripts that can be used
  32. self._loaded_scripts = {} # type: Dict[str, Type[Script]]
  33. self._script_labels = {} # type: Dict[str, str]
  34. # Script list contains instances of scripts in loaded_scripts.
  35. # There can be duplicates, which will be executed in sequence.
  36. self._script_list = [] # type: List[Script]
  37. self._selected_script_index = -1
  38. self._global_container_stack = Application.getInstance().getGlobalContainerStack()
  39. if self._global_container_stack:
  40. self._global_container_stack.metaDataChanged.connect(self._restoreScriptInforFromMetadata)
  41. Application.getInstance().getOutputDeviceManager().writeStarted.connect(self.execute)
  42. Application.getInstance().globalContainerStackChanged.connect(self._onGlobalContainerStackChanged) # When the current printer changes, update the list of scripts.
  43. CuraApplication.getInstance().mainWindowChanged.connect(self._createView) # When the main window is created, create the view so that we can display the post-processing icon if necessary.
  44. selectedIndexChanged = pyqtSignal()
  45. @pyqtProperty(str, notify = selectedIndexChanged)
  46. def selectedScriptDefinitionId(self) -> Optional[str]:
  47. try:
  48. return self._script_list[self._selected_script_index].getDefinitionId()
  49. except IndexError:
  50. return ""
  51. @pyqtProperty(str, notify=selectedIndexChanged)
  52. def selectedScriptStackId(self) -> Optional[str]:
  53. try:
  54. return self._script_list[self._selected_script_index].getStackId()
  55. except IndexError:
  56. return ""
  57. def execute(self, output_device) -> None:
  58. """Execute all post-processing scripts on the gcode."""
  59. scene = Application.getInstance().getController().getScene()
  60. # If the scene does not have a gcode, do nothing
  61. if not hasattr(scene, "gcode_dict"):
  62. return
  63. gcode_dict = getattr(scene, "gcode_dict")
  64. if not gcode_dict:
  65. return
  66. # get gcode list for the active build plate
  67. active_build_plate_id = CuraApplication.getInstance().getMultiBuildPlateModel().activeBuildPlate
  68. gcode_list = gcode_dict[active_build_plate_id]
  69. if not gcode_list:
  70. return
  71. if ";POSTPROCESSED" not in gcode_list[0]:
  72. for script in self._script_list:
  73. try:
  74. gcode_list = script.execute(gcode_list)
  75. except Exception:
  76. Logger.logException("e", "Exception in post-processing script.")
  77. if len(self._script_list): # Add comment to g-code if any changes were made.
  78. gcode_list[0] += ";POSTPROCESSED\n"
  79. gcode_dict[active_build_plate_id] = gcode_list
  80. setattr(scene, "gcode_dict", gcode_dict)
  81. else:
  82. Logger.log("e", "Already post processed")
  83. @pyqtSlot(int)
  84. def setSelectedScriptIndex(self, index: int) -> None:
  85. if self._selected_script_index != index:
  86. self._selected_script_index = index
  87. self.selectedIndexChanged.emit()
  88. @pyqtProperty(int, notify = selectedIndexChanged)
  89. def selectedScriptIndex(self) -> int:
  90. return self._selected_script_index
  91. @pyqtSlot(int, int)
  92. def moveScript(self, index: int, new_index: int) -> None:
  93. if new_index < 0 or new_index > len(self._script_list) - 1:
  94. return # nothing needs to be done
  95. else:
  96. # Magical switch code.
  97. self._script_list[new_index], self._script_list[index] = self._script_list[index], self._script_list[new_index]
  98. self.scriptListChanged.emit()
  99. self.selectedIndexChanged.emit() #Ensure that settings are updated
  100. self._propertyChanged()
  101. @pyqtSlot(int)
  102. def removeScriptByIndex(self, index: int) -> None:
  103. """Remove a script from the active script list by index."""
  104. self._script_list.pop(index)
  105. if len(self._script_list) - 1 < self._selected_script_index:
  106. self._selected_script_index = len(self._script_list) - 1
  107. self.scriptListChanged.emit()
  108. self.selectedIndexChanged.emit() # Ensure that settings are updated
  109. self._propertyChanged()
  110. def loadAllScripts(self) -> None:
  111. """Load all scripts from all paths where scripts can be found.
  112. This should probably only be done on init.
  113. """
  114. if self._loaded_scripts: # Already loaded.
  115. return
  116. # The PostProcessingPlugin path is for built-in scripts.
  117. # The Resources path is where the user should store custom scripts.
  118. # The Preferences path is legacy, where the user may previously have stored scripts.
  119. for root in [PluginRegistry.getInstance().getPluginPath("PostProcessingPlugin"), Resources.getStoragePath(Resources.Resources), Resources.getStoragePath(Resources.Preferences)]:
  120. if root is None:
  121. continue
  122. path = os.path.join(root, "scripts")
  123. if not os.path.isdir(path):
  124. try:
  125. os.makedirs(path)
  126. except OSError:
  127. Logger.log("w", "Unable to create a folder for scripts: " + path)
  128. continue
  129. self.loadScripts(path)
  130. def loadScripts(self, path: str) -> None:
  131. """Load all scripts from provided path.
  132. This should probably only be done on init.
  133. :param path: Path to check for scripts.
  134. """
  135. if ApplicationMetadata.IsEnterpriseVersion:
  136. # Delete all __pycache__ not in installation folder, as it may present a security risk.
  137. # It prevents this very strange scenario (should already be prevented on enterprise because signed-fault):
  138. # - Copy an existing script from the postprocessing-script folder to the appdata scripts folder.
  139. # - Also copy the entire __pycache__ folder from the first to the last location.
  140. # - Leave the __pycache__ as is, but write malicious code just before the class begins.
  141. # - It'll execute, despite that the script has not been signed.
  142. # It's not known if these reproduction steps are minimal, but it does at least happen in this case.
  143. install_prefix = os.path.abspath(CuraApplication.getInstance().getInstallPrefix())
  144. try:
  145. is_in_installation_path = os.path.commonpath([install_prefix, path]).startswith(install_prefix)
  146. except ValueError:
  147. is_in_installation_path = False
  148. if not is_in_installation_path:
  149. TrustBasics.removeCached(path)
  150. scripts = pkgutil.iter_modules(path = [path])
  151. """Load all scripts in the scripts folders"""
  152. for loader, script_name, ispkg in scripts:
  153. # Iterate over all scripts.
  154. if script_name not in sys.modules:
  155. try:
  156. file_path = os.path.join(path, script_name + ".py")
  157. if not self._isScriptAllowed(file_path):
  158. Logger.warning("Skipped loading post-processing script {}: not trusted".format(file_path))
  159. continue
  160. spec = importlib.util.spec_from_file_location(__name__ + "." + script_name,
  161. file_path)
  162. loaded_script = importlib.util.module_from_spec(spec)
  163. if spec.loader is None:
  164. continue
  165. spec.loader.exec_module(loaded_script) # type: ignore
  166. sys.modules[script_name] = loaded_script #TODO: This could be a security risk. Overwrite any module with a user-provided name?
  167. loaded_class = getattr(loaded_script, script_name)
  168. temp_object = loaded_class()
  169. Logger.log("d", "Begin loading of script: %s", script_name)
  170. try:
  171. setting_data = temp_object.getSettingData()
  172. if "name" in setting_data and "key" in setting_data:
  173. self._script_labels[setting_data["key"]] = setting_data["name"]
  174. self._loaded_scripts[setting_data["key"]] = loaded_class
  175. else:
  176. Logger.log("w", "Script %s.py has no name or key", script_name)
  177. self._script_labels[script_name] = script_name
  178. self._loaded_scripts[script_name] = loaded_class
  179. except AttributeError:
  180. Logger.log("e", "Script %s.py is not a recognised script type. Ensure it inherits Script", script_name)
  181. except NotImplementedError:
  182. Logger.log("e", "Script %s.py has no implemented settings", script_name)
  183. except Exception as e:
  184. Logger.logException("e", "Exception occurred while loading post processing plugin: {error_msg}".format(error_msg = str(e)))
  185. loadedScriptListChanged = pyqtSignal()
  186. @pyqtProperty("QVariantList", notify = loadedScriptListChanged)
  187. def loadedScriptList(self) -> List[str]:
  188. return sorted(list(self._loaded_scripts.keys()))
  189. @pyqtSlot(str, result = str)
  190. def getScriptLabelByKey(self, key: str) -> Optional[str]:
  191. return self._script_labels.get(key)
  192. scriptListChanged = pyqtSignal()
  193. @pyqtProperty("QStringList", notify = scriptListChanged)
  194. def scriptList(self) -> List[str]:
  195. script_list = [script.getSettingData()["key"] for script in self._script_list]
  196. return script_list
  197. @pyqtSlot(str)
  198. def addScriptToList(self, key: str) -> None:
  199. Logger.log("d", "Adding script %s to list.", key)
  200. new_script = self._loaded_scripts[key]()
  201. new_script.initialize()
  202. self._script_list.append(new_script)
  203. self.setSelectedScriptIndex(len(self._script_list) - 1)
  204. self.scriptListChanged.emit()
  205. self._propertyChanged()
  206. def _restoreScriptInforFromMetadata(self):
  207. self.loadAllScripts()
  208. new_stack = self._global_container_stack
  209. if new_stack is None:
  210. return
  211. self._script_list.clear()
  212. if not new_stack.getMetaDataEntry("post_processing_scripts"): # Missing or empty.
  213. self.scriptListChanged.emit() # Even emit this if it didn't change. We want it to write the empty list to the stack's metadata.
  214. self.setSelectedScriptIndex(-1)
  215. return
  216. self._script_list.clear()
  217. scripts_list_strs = new_stack.getMetaDataEntry("post_processing_scripts")
  218. for script_str in scripts_list_strs.split(
  219. "\n"): # Encoded config files should never contain three newlines in a row. At most 2, just before section headers.
  220. if not script_str: # There were no scripts in this one (or a corrupt file caused more than 3 consecutive newlines here).
  221. continue
  222. script_str = script_str.replace(r"\\\n", "\n").replace(r"\\\\", "\\\\") # Unescape escape sequences.
  223. script_parser = configparser.ConfigParser(interpolation=None)
  224. script_parser.optionxform = str # type: ignore # Don't transform the setting keys as they are case-sensitive.
  225. script_parser.read_string(script_str)
  226. for script_name, settings in script_parser.items(): # There should only be one, really! Otherwise we can't guarantee the order or allow multiple uses of the same script.
  227. if script_name == "DEFAULT": # ConfigParser always has a DEFAULT section, but we don't fill it. Ignore this one.
  228. continue
  229. if script_name not in self._loaded_scripts: # Don't know this post-processing plug-in.
  230. Logger.log("e",
  231. "Unknown post-processing script {script_name} was encountered in this global stack.".format(
  232. script_name=script_name))
  233. continue
  234. new_script = self._loaded_scripts[script_name]()
  235. new_script.initialize()
  236. for setting_key, setting_value in settings.items(): # Put all setting values into the script.
  237. if new_script._instance is not None:
  238. new_script._instance.setProperty(setting_key, "value", setting_value)
  239. self._script_list.append(new_script)
  240. self.setSelectedScriptIndex(0)
  241. # Ensure that we always force an update (otherwise the fields don't update correctly!)
  242. self.selectedIndexChanged.emit()
  243. self.scriptListChanged.emit()
  244. self._propertyChanged()
  245. def _onGlobalContainerStackChanged(self) -> None:
  246. """When the global container stack is changed, swap out the list of active scripts."""
  247. if self._global_container_stack:
  248. self._global_container_stack.metaDataChanged.disconnect(self._restoreScriptInforFromMetadata)
  249. self._global_container_stack = Application.getInstance().getGlobalContainerStack()
  250. if self._global_container_stack:
  251. self._global_container_stack.metaDataChanged.connect(self._restoreScriptInforFromMetadata)
  252. self._restoreScriptInforFromMetadata()
  253. @pyqtSlot()
  254. def writeScriptsToStack(self) -> None:
  255. script_list_strs = [] # type: List[str]
  256. for script in self._script_list:
  257. parser = configparser.ConfigParser(interpolation = None) # We'll encode the script as a config with one section. The section header is the key and its values are the settings.
  258. parser.optionxform = str # type: ignore # Don't transform the setting keys as they are case-sensitive.
  259. script_name = script.getSettingData()["key"]
  260. parser.add_section(script_name)
  261. for key in script.getSettingData()["settings"]:
  262. value = script.getSettingValueByKey(key)
  263. parser[script_name][key] = str(value)
  264. serialized = io.StringIO() # ConfigParser can only write to streams. Fine.
  265. parser.write(serialized)
  266. serialized.seek(0)
  267. script_str = serialized.read()
  268. script_str = script_str.replace("\\\\", r"\\\\").replace("\n", r"\\\n") # Escape newlines because configparser sees those as section delimiters.
  269. script_list_strs.append(script_str)
  270. script_list_string = "\n".join(script_list_strs) # ConfigParser should never output three newlines in a row when serialised, so it's a safe delimiter.
  271. if self._global_container_stack is None:
  272. return
  273. # Ensure we don't get triggered by our own write.
  274. self._global_container_stack.metaDataChanged.disconnect(self._restoreScriptInforFromMetadata)
  275. if "post_processing_scripts" not in self._global_container_stack.getMetaData():
  276. self._global_container_stack.setMetaDataEntry("post_processing_scripts", "")
  277. self._global_container_stack.setMetaDataEntry("post_processing_scripts", script_list_string)
  278. # We do want to listen to other events.
  279. self._global_container_stack.metaDataChanged.connect(self._restoreScriptInforFromMetadata)
  280. def _createView(self) -> None:
  281. """Creates the view used by show popup.
  282. The view is saved because of the fairly aggressive garbage collection.
  283. """
  284. Logger.log("d", "Creating post processing plugin view.")
  285. self.loadAllScripts()
  286. # Create the plugin dialog component
  287. path = os.path.join(cast(str, PluginRegistry.getInstance().getPluginPath("PostProcessingPlugin")), "PostProcessingPlugin.qml")
  288. self._view = CuraApplication.getInstance().createQmlComponent(path, {"manager": self})
  289. if self._view is None:
  290. Logger.log("e", "Not creating PostProcessing button near save button because the QML component failed to be created.")
  291. return
  292. Logger.log("d", "Post processing view created.")
  293. # Create the save button component
  294. CuraApplication.getInstance().addAdditionalComponent("saveButton", self._view.findChild(QObject, "postProcessingSaveAreaButton"))
  295. def showPopup(self) -> None:
  296. """Show the (GUI) popup of the post processing plugin."""
  297. if self._view is None:
  298. self._createView()
  299. if self._view is None:
  300. Logger.log("e", "Not creating PostProcessing window since the QML component failed to be created.")
  301. return
  302. self._view.show()
  303. def _propertyChanged(self) -> None:
  304. """Property changed: trigger re-slice
  305. To do this we use the global container stack propertyChanged.
  306. Re-slicing is necessary for setting changes in this plugin, because the changes
  307. are applied only once per "fresh" gcode
  308. """
  309. global_container_stack = Application.getInstance().getGlobalContainerStack()
  310. if global_container_stack is not None:
  311. global_container_stack.propertyChanged.emit("post_processing_plugin", "value")
  312. @staticmethod
  313. def _isScriptAllowed(file_path: str) -> bool:
  314. """Checks whether the given file is allowed to be loaded"""
  315. if not ApplicationMetadata.IsEnterpriseVersion:
  316. # No signature needed
  317. return True
  318. dir_path = os.path.split(file_path)[0] # type: str
  319. plugin_path = PluginRegistry.getInstance().getPluginPath("PostProcessingPlugin")
  320. assert plugin_path is not None # appease mypy
  321. bundled_path = os.path.join(plugin_path, "scripts")
  322. if dir_path == bundled_path:
  323. # Bundled scripts are trusted.
  324. return True
  325. trust_instance = Trust.getInstanceOrNone()
  326. if trust_instance is not None and Trust.signatureFileExistsFor(file_path):
  327. if trust_instance.signedFileCheck(file_path):
  328. return True
  329. return False # Default verdict should be False, being the most secure fallback