Toolbox.py 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865
  1. # Copyright (c) 2019 Ultimaker B.V.
  2. # Toolbox is released under the terms of the LGPLv3 or higher.
  3. import json
  4. import os
  5. import tempfile
  6. import platform
  7. from typing import cast, Any, Dict, List, Set, TYPE_CHECKING, Tuple, Optional, Union
  8. from PyQt5.QtCore import QUrl, QObject, pyqtProperty, pyqtSignal, pyqtSlot
  9. from PyQt5.QtNetwork import QNetworkAccessManager, QNetworkRequest, QNetworkReply
  10. from UM.Logger import Logger
  11. from UM.PluginRegistry import PluginRegistry
  12. from UM.Extension import Extension
  13. from UM.i18n import i18nCatalog
  14. from UM.Version import Version
  15. from cura import ApplicationMetadata
  16. from cura import UltimakerCloudAuthentication
  17. from cura.CuraApplication import CuraApplication
  18. from cura.Machines.ContainerTree import ContainerTree
  19. from .AuthorsModel import AuthorsModel
  20. from .PackagesModel import PackagesModel
  21. if TYPE_CHECKING:
  22. from cura.Settings.GlobalStack import GlobalStack
  23. i18n_catalog = i18nCatalog("cura")
  24. ## The Toolbox class is responsible of communicating with the server through the API
  25. class Toolbox(QObject, Extension):
  26. def __init__(self, application: CuraApplication) -> None:
  27. super().__init__()
  28. self._application = application # type: CuraApplication
  29. self._sdk_version = ApplicationMetadata.CuraSDKVersion # type: Union[str, int]
  30. self._cloud_api_version = UltimakerCloudAuthentication.CuraCloudAPIVersion # type: str
  31. self._cloud_api_root = UltimakerCloudAuthentication.CuraCloudAPIRoot # type: str
  32. self._api_url = None # type: Optional[str]
  33. # Network:
  34. self._download_request = None # type: Optional[QNetworkRequest]
  35. self._download_reply = None # type: Optional[QNetworkReply]
  36. self._download_progress = 0 # type: float
  37. self._is_downloading = False # type: bool
  38. self._network_manager = None # type: Optional[QNetworkAccessManager]
  39. self._request_headers = [] # type: List[Tuple[bytes, bytes]]
  40. self._updateRequestHeader()
  41. self._request_urls = {} # type: Dict[str, QUrl]
  42. self._to_update = [] # type: List[str] # Package_ids that are waiting to be updated
  43. self._old_plugin_ids = set() # type: Set[str]
  44. self._old_plugin_metadata = dict() # type: Dict[str, Dict[str, Any]]
  45. # The responses as given by the server parsed to a list.
  46. self._server_response_data = {
  47. "authors": [],
  48. "packages": []
  49. } # type: Dict[str, List[Any]]
  50. # Models:
  51. self._models = {
  52. "authors": AuthorsModel(self),
  53. "packages": PackagesModel(self),
  54. } # type: Dict[str, Union[AuthorsModel, PackagesModel]]
  55. self._plugins_showcase_model = PackagesModel(self)
  56. self._plugins_available_model = PackagesModel(self)
  57. self._plugins_installed_model = PackagesModel(self)
  58. self._materials_showcase_model = AuthorsModel(self)
  59. self._materials_available_model = AuthorsModel(self)
  60. self._materials_installed_model = PackagesModel(self)
  61. self._materials_generic_model = PackagesModel(self)
  62. # These properties are for keeping track of the UI state:
  63. # ----------------------------------------------------------------------
  64. # View category defines which filter to use, and therefore effectively
  65. # which category is currently being displayed. For example, possible
  66. # values include "plugin" or "material", but also "installed".
  67. self._view_category = "plugin" # type: str
  68. # View page defines which type of page layout to use. For example,
  69. # possible values include "overview", "detail" or "author".
  70. self._view_page = "welcome" # type: str
  71. # Active package refers to which package is currently being downloaded,
  72. # installed, or otherwise modified.
  73. self._active_package = None # type: Optional[Dict[str, Any]]
  74. self._dialog = None # type: Optional[QObject]
  75. self._confirm_reset_dialog = None # type: Optional[QObject]
  76. self._resetUninstallVariables()
  77. self._restart_required = False # type: bool
  78. # variables for the license agreement dialog
  79. self._license_dialog_plugin_name = "" # type: str
  80. self._license_dialog_license_content = "" # type: str
  81. self._license_dialog_plugin_file_location = "" # type: str
  82. self._restart_dialog_message = "" # type: str
  83. self._application.initializationFinished.connect(self._onAppInitialized)
  84. self._application.getCuraAPI().account.accessTokenChanged.connect(self._updateRequestHeader)
  85. # Signals:
  86. # --------------------------------------------------------------------------
  87. # Downloading changes
  88. activePackageChanged = pyqtSignal()
  89. onDownloadProgressChanged = pyqtSignal()
  90. onIsDownloadingChanged = pyqtSignal()
  91. restartRequiredChanged = pyqtSignal()
  92. installChanged = pyqtSignal()
  93. enabledChanged = pyqtSignal()
  94. # UI changes
  95. viewChanged = pyqtSignal()
  96. detailViewChanged = pyqtSignal()
  97. filterChanged = pyqtSignal()
  98. metadataChanged = pyqtSignal()
  99. showLicenseDialog = pyqtSignal()
  100. uninstallVariablesChanged = pyqtSignal()
  101. def _loginStateChanged(self):
  102. self._updateRequestHeader()
  103. if self._application.getCuraAPI().account.isLoggedIn:
  104. self.setViewPage("loading")
  105. self._fetchPackageData()
  106. else:
  107. self.setViewPage("welcome")
  108. def _updateRequestHeader(self):
  109. self._request_headers = [
  110. (b"User-Agent",
  111. str.encode(
  112. "%s/%s (%s %s)" % (
  113. self._application.getApplicationName(),
  114. self._application.getVersion(),
  115. platform.system(),
  116. platform.machine(),
  117. )
  118. ))
  119. ]
  120. access_token = self._application.getCuraAPI().account.accessToken
  121. if access_token:
  122. self._request_headers.append((b"Authorization", "Bearer {}".format(access_token).encode()))
  123. def _resetUninstallVariables(self) -> None:
  124. self._package_id_to_uninstall = None # type: Optional[str]
  125. self._package_name_to_uninstall = ""
  126. self._package_used_materials = [] # type: List[Tuple[GlobalStack, str, str]]
  127. self._package_used_qualities = [] # type: List[Tuple[GlobalStack, str, str]]
  128. @pyqtSlot(str, int)
  129. def ratePackage(self, package_id: str, rating: int) -> None:
  130. url = QUrl("{base_url}/packages/{package_id}/ratings".format(base_url=self._api_url, package_id = package_id))
  131. self._rate_request = QNetworkRequest(url)
  132. for header_name, header_value in self._request_headers:
  133. cast(QNetworkRequest, self._rate_request).setRawHeader(header_name, header_value)
  134. data = "{\"data\": {\"cura_version\": \"%s\", \"rating\": %i}}" % (Version(self._application.getVersion()), rating)
  135. self._rate_reply = cast(QNetworkAccessManager, self._network_manager).put(self._rate_request, data.encode())
  136. @pyqtSlot(result = str)
  137. def getLicenseDialogPluginName(self) -> str:
  138. return self._license_dialog_plugin_name
  139. @pyqtSlot(result = str)
  140. def getLicenseDialogPluginFileLocation(self) -> str:
  141. return self._license_dialog_plugin_file_location
  142. @pyqtSlot(result = str)
  143. def getLicenseDialogLicenseContent(self) -> str:
  144. return self._license_dialog_license_content
  145. def openLicenseDialog(self, plugin_name: str, license_content: str, plugin_file_location: str) -> None:
  146. self._license_dialog_plugin_name = plugin_name
  147. self._license_dialog_license_content = license_content
  148. self._license_dialog_plugin_file_location = plugin_file_location
  149. self.showLicenseDialog.emit()
  150. # This is a plugin, so most of the components required are not ready when
  151. # this is initialized. Therefore, we wait until the application is ready.
  152. def _onAppInitialized(self) -> None:
  153. self._plugin_registry = self._application.getPluginRegistry()
  154. self._package_manager = self._application.getPackageManager()
  155. self._api_url = "{cloud_api_root}/cura-packages/v{cloud_api_version}/cura/v{sdk_version}".format(
  156. cloud_api_root = self._cloud_api_root,
  157. cloud_api_version = self._cloud_api_version,
  158. sdk_version = self._sdk_version
  159. )
  160. self._request_urls = {
  161. "authors": QUrl("{base_url}/authors".format(base_url = self._api_url)),
  162. "packages": QUrl("{base_url}/packages".format(base_url = self._api_url))
  163. }
  164. self._application.getCuraAPI().account.loginStateChanged.connect(self._loginStateChanged)
  165. if CuraApplication.getInstance().getPreferences().getValue("info/automatic_update_check"):
  166. # Request the latest and greatest!
  167. self._fetchPackageData()
  168. def _fetchPackageData(self):
  169. # Create the network manager:
  170. # This was formerly its own function but really had no reason to be as
  171. # it was never called more than once ever.
  172. if self._network_manager is not None:
  173. self._network_manager.finished.disconnect(self._onRequestFinished)
  174. self._network_manager.networkAccessibleChanged.disconnect(self._onNetworkAccessibleChanged)
  175. self._network_manager = QNetworkAccessManager()
  176. self._network_manager.finished.connect(self._onRequestFinished)
  177. self._network_manager.networkAccessibleChanged.connect(self._onNetworkAccessibleChanged)
  178. # Make remote requests:
  179. self._makeRequestByType("packages")
  180. self._makeRequestByType("authors")
  181. # Gather installed packages:
  182. self._updateInstalledModels()
  183. # Displays the toolbox
  184. @pyqtSlot()
  185. def launch(self) -> None:
  186. if not self._dialog:
  187. self._dialog = self._createDialog("Toolbox.qml")
  188. if not self._dialog:
  189. Logger.log("e", "Unexpected error trying to create the 'Marketplace' dialog.")
  190. return
  191. if self._application.getCuraAPI().account.isLoggedIn:
  192. self.setViewPage("loading")
  193. self._fetchPackageData()
  194. else:
  195. self.setViewPage("welcome")
  196. self._dialog.show()
  197. # Apply enabled/disabled state to installed plugins
  198. self.enabledChanged.emit()
  199. def _createDialog(self, qml_name: str) -> Optional[QObject]:
  200. Logger.log("d", "Marketplace: Creating dialog [%s].", qml_name)
  201. plugin_path = PluginRegistry.getInstance().getPluginPath(self.getPluginId())
  202. if not plugin_path:
  203. return None
  204. path = os.path.join(plugin_path, "resources", "qml", qml_name)
  205. dialog = self._application.createQmlComponent(path, {"toolbox": self})
  206. if not dialog:
  207. raise Exception("Failed to create Marketplace dialog")
  208. return dialog
  209. def _convertPluginMetadata(self, plugin_data: Dict[str, Any]) -> Optional[Dict[str, Any]]:
  210. try:
  211. highest_sdk_version_supported = Version(0)
  212. for supported_version in plugin_data["plugin"]["supported_sdk_versions"]:
  213. if supported_version > highest_sdk_version_supported:
  214. highest_sdk_version_supported = supported_version
  215. formatted = {
  216. "package_id": plugin_data["id"],
  217. "package_type": "plugin",
  218. "display_name": plugin_data["plugin"]["name"],
  219. "package_version": plugin_data["plugin"]["version"],
  220. "sdk_version": highest_sdk_version_supported,
  221. "author": {
  222. "author_id": plugin_data["plugin"]["author"],
  223. "display_name": plugin_data["plugin"]["author"]
  224. },
  225. "is_installed": True,
  226. "description": plugin_data["plugin"]["description"]
  227. }
  228. return formatted
  229. except KeyError:
  230. Logger.log("w", "Unable to convert plugin meta data %s", str(plugin_data))
  231. return None
  232. @pyqtSlot()
  233. def _updateInstalledModels(self) -> None:
  234. # This is moved here to avoid code duplication and so that after installing plugins they get removed from the
  235. # list of old plugins
  236. old_plugin_ids = self._plugin_registry.getInstalledPlugins()
  237. installed_package_ids = self._package_manager.getAllInstalledPackageIDs()
  238. scheduled_to_remove_package_ids = self._package_manager.getToRemovePackageIDs()
  239. self._old_plugin_ids = set()
  240. self._old_plugin_metadata = dict()
  241. for plugin_id in old_plugin_ids:
  242. # Neither the installed packages nor the packages that are scheduled to remove are old plugins
  243. if plugin_id not in installed_package_ids and plugin_id not in scheduled_to_remove_package_ids:
  244. Logger.log("d", "Found a plugin that was installed with the old plugin browser: %s", plugin_id)
  245. old_metadata = self._plugin_registry.getMetaData(plugin_id)
  246. new_metadata = self._convertPluginMetadata(old_metadata)
  247. if new_metadata is None:
  248. # Something went wrong converting it.
  249. continue
  250. self._old_plugin_ids.add(plugin_id)
  251. self._old_plugin_metadata[new_metadata["package_id"]] = new_metadata
  252. all_packages = self._package_manager.getAllInstalledPackagesInfo()
  253. if "plugin" in all_packages:
  254. # For old plugins, we only want to include the old custom plugin that were installed via the old toolbox.
  255. # The bundled plugins will be included in JSON files in the "bundled_packages" folder, so the bundled
  256. # plugins should be excluded from the old plugins list/dict.
  257. all_plugin_package_ids = set(package["package_id"] for package in all_packages["plugin"])
  258. self._old_plugin_ids = set(plugin_id for plugin_id in self._old_plugin_ids
  259. if plugin_id not in all_plugin_package_ids)
  260. self._old_plugin_metadata = {k: v for k, v in self._old_plugin_metadata.items() if k in self._old_plugin_ids}
  261. self._plugins_installed_model.setMetadata(all_packages["plugin"] + list(self._old_plugin_metadata.values()))
  262. self.metadataChanged.emit()
  263. if "material" in all_packages:
  264. self._materials_installed_model.setMetadata(all_packages["material"])
  265. self.metadataChanged.emit()
  266. @pyqtSlot(str)
  267. def install(self, file_path: str) -> None:
  268. self._package_manager.installPackage(file_path)
  269. self.installChanged.emit()
  270. self._updateInstalledModels()
  271. self.metadataChanged.emit()
  272. self._restart_required = True
  273. self.restartRequiredChanged.emit()
  274. ## Check package usage and uninstall
  275. # If the package is in use, you'll get a confirmation dialog to set everything to default
  276. @pyqtSlot(str)
  277. def checkPackageUsageAndUninstall(self, package_id: str) -> None:
  278. package_used_materials, package_used_qualities = self._package_manager.getMachinesUsingPackage(package_id)
  279. if package_used_materials or package_used_qualities:
  280. # Set up "uninstall variables" for resetMaterialsQualitiesAndUninstall
  281. self._package_id_to_uninstall = package_id
  282. package_info = self._package_manager.getInstalledPackageInfo(package_id)
  283. self._package_name_to_uninstall = package_info.get("display_name", package_info.get("package_id"))
  284. self._package_used_materials = package_used_materials
  285. self._package_used_qualities = package_used_qualities
  286. # Ask change to default material / profile
  287. if self._confirm_reset_dialog is None:
  288. self._confirm_reset_dialog = self._createDialog("ToolboxConfirmUninstallResetDialog.qml")
  289. self.uninstallVariablesChanged.emit()
  290. if self._confirm_reset_dialog is None:
  291. Logger.log("e", "ToolboxConfirmUninstallResetDialog should have been initialized, but it is not. Not showing dialog and not uninstalling package.")
  292. else:
  293. self._confirm_reset_dialog.show()
  294. else:
  295. # Plain uninstall
  296. self.uninstall(package_id)
  297. @pyqtProperty(str, notify = uninstallVariablesChanged)
  298. def pluginToUninstall(self) -> str:
  299. return self._package_name_to_uninstall
  300. @pyqtProperty(str, notify = uninstallVariablesChanged)
  301. def uninstallUsedMaterials(self) -> str:
  302. return "\n".join(["%s (%s)" % (str(global_stack.getName()), material) for global_stack, extruder_nr, material in self._package_used_materials])
  303. @pyqtProperty(str, notify = uninstallVariablesChanged)
  304. def uninstallUsedQualities(self) -> str:
  305. return "\n".join(["%s (%s)" % (str(global_stack.getName()), quality) for global_stack, extruder_nr, quality in self._package_used_qualities])
  306. @pyqtSlot()
  307. def closeConfirmResetDialog(self) -> None:
  308. if self._confirm_reset_dialog is not None:
  309. self._confirm_reset_dialog.close()
  310. ## Uses "uninstall variables" to reset qualities and materials, then uninstall
  311. # It's used as an action on Confirm reset on Uninstall
  312. @pyqtSlot()
  313. def resetMaterialsQualitiesAndUninstall(self) -> None:
  314. application = CuraApplication.getInstance()
  315. machine_manager = application.getMachineManager()
  316. container_tree = ContainerTree.getInstance()
  317. for global_stack, extruder_nr, container_id in self._package_used_materials:
  318. extruder = global_stack.extruderList[int(extruder_nr)]
  319. approximate_diameter = extruder.getApproximateMaterialDiameter()
  320. variant_node = container_tree.machines[global_stack.definition.getId()].variants[extruder.variant.getName()]
  321. default_material_node = variant_node.preferredMaterial(approximate_diameter)
  322. machine_manager.setMaterial(extruder_nr, default_material_node, global_stack = global_stack)
  323. for global_stack, extruder_nr, container_id in self._package_used_qualities:
  324. variant_names = [extruder.variant.getName() for extruder in global_stack.extruderList]
  325. material_bases = [extruder.material.getMetaDataEntry("base_file") for extruder in global_stack.extruderList]
  326. extruder_enabled = [extruder.isEnabled for extruder in global_stack.extruderList]
  327. definition_id = global_stack.definition.getId()
  328. machine_node = container_tree.machines[definition_id]
  329. default_quality_group = machine_node.getQualityGroups(variant_names, material_bases, extruder_enabled)[machine_node.preferred_quality_type]
  330. machine_manager.setQualityGroup(default_quality_group, global_stack = global_stack)
  331. if self._package_id_to_uninstall is not None:
  332. self._markPackageMaterialsAsToBeUninstalled(self._package_id_to_uninstall)
  333. self.uninstall(self._package_id_to_uninstall)
  334. self._resetUninstallVariables()
  335. self.closeConfirmResetDialog()
  336. def _markPackageMaterialsAsToBeUninstalled(self, package_id: str) -> None:
  337. container_registry = self._application.getContainerRegistry()
  338. all_containers = self._package_manager.getPackageContainerIds(package_id)
  339. for container_id in all_containers:
  340. containers = container_registry.findInstanceContainers(id = container_id)
  341. if not containers:
  342. continue
  343. container = containers[0]
  344. if container.getMetaDataEntry("type") != "material":
  345. continue
  346. root_material_id = container.getMetaDataEntry("base_file")
  347. root_material_containers = container_registry.findInstanceContainers(id = root_material_id)
  348. if not root_material_containers:
  349. continue
  350. root_material_container = root_material_containers[0]
  351. root_material_container.setMetaDataEntry("removed", True)
  352. @pyqtSlot(str)
  353. def uninstall(self, package_id: str) -> None:
  354. self._package_manager.removePackage(package_id, force_add = True)
  355. self.installChanged.emit()
  356. self._updateInstalledModels()
  357. self.metadataChanged.emit()
  358. self._restart_required = True
  359. self.restartRequiredChanged.emit()
  360. ## Actual update packages that are in self._to_update
  361. def _update(self) -> None:
  362. if self._to_update:
  363. plugin_id = self._to_update.pop(0)
  364. remote_package = self.getRemotePackage(plugin_id)
  365. if remote_package:
  366. download_url = remote_package["download_url"]
  367. Logger.log("d", "Updating package [%s]..." % plugin_id)
  368. self.startDownload(download_url)
  369. else:
  370. Logger.log("e", "Could not update package [%s] because there is no remote package info available.", plugin_id)
  371. if self._to_update:
  372. self._application.callLater(self._update)
  373. ## Update a plugin by plugin_id
  374. @pyqtSlot(str)
  375. def update(self, plugin_id: str) -> None:
  376. self._to_update.append(plugin_id)
  377. self._application.callLater(self._update)
  378. @pyqtSlot(str)
  379. def enable(self, plugin_id: str) -> None:
  380. self._plugin_registry.enablePlugin(plugin_id)
  381. self.enabledChanged.emit()
  382. Logger.log("i", "%s was set as 'active'.", plugin_id)
  383. self._restart_required = True
  384. self.restartRequiredChanged.emit()
  385. @pyqtSlot(str)
  386. def disable(self, plugin_id: str) -> None:
  387. self._plugin_registry.disablePlugin(plugin_id)
  388. self.enabledChanged.emit()
  389. Logger.log("i", "%s was set as 'deactive'.", plugin_id)
  390. self._restart_required = True
  391. self.restartRequiredChanged.emit()
  392. @pyqtProperty(bool, notify = metadataChanged)
  393. def dataReady(self) -> bool:
  394. return self._packages_model is not None
  395. @pyqtProperty(bool, notify = restartRequiredChanged)
  396. def restartRequired(self) -> bool:
  397. return self._restart_required
  398. @pyqtSlot()
  399. def restart(self) -> None:
  400. self._application.windowClosed()
  401. def getRemotePackage(self, package_id: str) -> Optional[Dict]:
  402. # TODO: make the lookup in a dict, not a loop. canUpdate is called for every item.
  403. remote_package = None
  404. for package in self._server_response_data["packages"]:
  405. if package["package_id"] == package_id:
  406. remote_package = package
  407. break
  408. return remote_package
  409. @pyqtSlot(str, result = bool)
  410. def canDowngrade(self, package_id: str) -> bool:
  411. # If the currently installed version is higher than the bundled version (if present), the we can downgrade
  412. # this package.
  413. local_package = self._package_manager.getInstalledPackageInfo(package_id)
  414. if local_package is None:
  415. return False
  416. bundled_package = self._package_manager.getBundledPackageInfo(package_id)
  417. if bundled_package is None:
  418. return False
  419. local_version = Version(local_package["package_version"])
  420. bundled_version = Version(bundled_package["package_version"])
  421. return bundled_version < local_version
  422. @pyqtSlot(str, result = bool)
  423. def isInstalled(self, package_id: str) -> bool:
  424. result = self._package_manager.isPackageInstalled(package_id)
  425. # Also check the old plugins list if it's not found in the package manager.
  426. if not result:
  427. result = self.isOldPlugin(package_id)
  428. return result
  429. @pyqtSlot(str, result = int)
  430. def getNumberOfInstalledPackagesByAuthor(self, author_id: str) -> int:
  431. count = 0
  432. for package in self._materials_installed_model.items:
  433. if package["author_id"] == author_id:
  434. count += 1
  435. return count
  436. # This slot is only used to get the number of material packages by author, not any other type of packages.
  437. @pyqtSlot(str, result = int)
  438. def getTotalNumberOfMaterialPackagesByAuthor(self, author_id: str) -> int:
  439. count = 0
  440. for package in self._server_response_data["packages"]:
  441. if package["package_type"] == "material":
  442. if package["author"]["author_id"] == author_id:
  443. count += 1
  444. return count
  445. @pyqtSlot(str, result = bool)
  446. def isEnabled(self, package_id: str) -> bool:
  447. if package_id in self._plugin_registry.getActivePlugins():
  448. return True
  449. return False
  450. # Check for plugins that were installed with the old plugin browser
  451. def isOldPlugin(self, plugin_id: str) -> bool:
  452. return plugin_id in self._old_plugin_ids
  453. def getOldPluginPackageMetadata(self, plugin_id: str) -> Optional[Dict[str, Any]]:
  454. return self._old_plugin_metadata.get(plugin_id)
  455. def isLoadingComplete(self) -> bool:
  456. populated = 0
  457. for metadata_list in self._server_response_data.items():
  458. if metadata_list:
  459. populated += 1
  460. return populated == len(self._server_response_data.items())
  461. # Make API Calls
  462. # --------------------------------------------------------------------------
  463. def _makeRequestByType(self, request_type: str) -> None:
  464. Logger.log("d", "Requesting %s metadata from server.", request_type)
  465. request = QNetworkRequest(self._request_urls[request_type])
  466. for header_name, header_value in self._request_headers:
  467. request.setRawHeader(header_name, header_value)
  468. if self._network_manager:
  469. self._network_manager.get(request)
  470. @pyqtSlot(str)
  471. def startDownload(self, url: str) -> None:
  472. Logger.log("i", "Attempting to download & install package from %s.", url)
  473. url = QUrl(url)
  474. self._download_request = QNetworkRequest(url)
  475. if hasattr(QNetworkRequest, "FollowRedirectsAttribute"):
  476. # Patch for Qt 5.6-5.8
  477. cast(QNetworkRequest, self._download_request).setAttribute(QNetworkRequest.FollowRedirectsAttribute, True)
  478. if hasattr(QNetworkRequest, "RedirectPolicyAttribute"):
  479. # Patch for Qt 5.9+
  480. cast(QNetworkRequest, self._download_request).setAttribute(QNetworkRequest.RedirectPolicyAttribute, True)
  481. for header_name, header_value in self._request_headers:
  482. cast(QNetworkRequest, self._download_request).setRawHeader(header_name, header_value)
  483. self._download_reply = cast(QNetworkAccessManager, self._network_manager).get(self._download_request)
  484. self.setDownloadProgress(0)
  485. self.setIsDownloading(True)
  486. cast(QNetworkReply, self._download_reply).downloadProgress.connect(self._onDownloadProgress)
  487. @pyqtSlot()
  488. def cancelDownload(self) -> None:
  489. Logger.log("i", "User cancelled the download of a package.")
  490. self.resetDownload()
  491. def resetDownload(self) -> None:
  492. if self._download_reply:
  493. try:
  494. self._download_reply.downloadProgress.disconnect(self._onDownloadProgress)
  495. except (TypeError, RuntimeError): # Raised when the method is not connected to the signal yet.
  496. pass # Don't need to disconnect.
  497. try:
  498. self._download_reply.abort()
  499. except RuntimeError:
  500. # In some cases the garbage collector is a bit to agressive, which causes the dowload_reply
  501. # to be deleted (especially if the machine has been put to sleep). As we don't know what exactly causes
  502. # this (The issue probably lives in the bowels of (py)Qt somewhere), we can only catch and ignore it.
  503. pass
  504. self._download_reply = None
  505. self._download_request = None
  506. self.setDownloadProgress(0)
  507. self.setIsDownloading(False)
  508. # Handlers for Network Events
  509. # --------------------------------------------------------------------------
  510. def _onNetworkAccessibleChanged(self, network_accessibility: QNetworkAccessManager.NetworkAccessibility) -> None:
  511. if network_accessibility == QNetworkAccessManager.NotAccessible:
  512. self.resetDownload()
  513. def _onRequestFinished(self, reply: QNetworkReply) -> None:
  514. if reply.error() == QNetworkReply.TimeoutError:
  515. Logger.log("w", "Got a timeout.")
  516. self.setViewPage("errored")
  517. self.resetDownload()
  518. return
  519. if reply.error() == QNetworkReply.HostNotFoundError:
  520. Logger.log("w", "Unable to reach server.")
  521. self.setViewPage("errored")
  522. self.resetDownload()
  523. return
  524. if reply.operation() == QNetworkAccessManager.GetOperation:
  525. for response_type, url in self._request_urls.items():
  526. if reply.url() == url:
  527. if reply.attribute(QNetworkRequest.HttpStatusCodeAttribute) == 200:
  528. try:
  529. json_data = json.loads(bytes(reply.readAll()).decode("utf-8"))
  530. # Check for errors:
  531. if "errors" in json_data:
  532. for error in json_data["errors"]:
  533. Logger.log("e", "%s", error["title"])
  534. return
  535. # Create model and apply metadata:
  536. if not self._models[response_type]:
  537. Logger.log("e", "Could not find the %s model.", response_type)
  538. break
  539. self._server_response_data[response_type] = json_data["data"]
  540. self._models[response_type].setMetadata(self._server_response_data[response_type])
  541. if response_type == "packages":
  542. self._models[response_type].setFilter({"type": "plugin"})
  543. self.reBuildMaterialsModels()
  544. self.reBuildPluginsModels()
  545. self._notifyPackageManager()
  546. elif response_type == "authors":
  547. self._models[response_type].setFilter({"package_types": "material"})
  548. self._models[response_type].setFilter({"tags": "generic"})
  549. self.metadataChanged.emit()
  550. if self.isLoadingComplete():
  551. self.setViewPage("overview")
  552. except json.decoder.JSONDecodeError:
  553. Logger.log("w", "Received invalid JSON for %s.", response_type)
  554. break
  555. else:
  556. Logger.log("w", "Unable to connect with the server, we got a response code %s while trying to connect to %s", reply.attribute(QNetworkRequest.HttpStatusCodeAttribute), reply.url())
  557. self.setViewPage("errored")
  558. self.resetDownload()
  559. elif reply.operation() == QNetworkAccessManager.PutOperation:
  560. # Ignore any operation that is not a get operation
  561. pass
  562. # This function goes through all known remote versions of a package and notifies the package manager of this change
  563. def _notifyPackageManager(self):
  564. for package in self._server_response_data["packages"]:
  565. self._package_manager.addAvailablePackageVersion(package["package_id"], Version(package["package_version"]))
  566. def _onDownloadProgress(self, bytes_sent: int, bytes_total: int) -> None:
  567. if bytes_total > 0:
  568. new_progress = bytes_sent / bytes_total * 100
  569. self.setDownloadProgress(new_progress)
  570. if bytes_sent == bytes_total:
  571. self.setIsDownloading(False)
  572. self._download_reply = cast(QNetworkReply, self._download_reply)
  573. self._download_reply.downloadProgress.disconnect(self._onDownloadProgress)
  574. # Check if the download was sucessfull
  575. if self._download_reply.attribute(QNetworkRequest.HttpStatusCodeAttribute) != 200:
  576. try:
  577. Logger.log("w", "Failed to download package. The following error was returned: %s", json.loads(bytes(self._download_reply.readAll()).decode("utf-8")))
  578. except json.decoder.JSONDecodeError:
  579. Logger.logException("w", "Failed to download package and failed to parse a response from it")
  580. finally:
  581. return
  582. # Must not delete the temporary file on Windows
  583. self._temp_plugin_file = tempfile.NamedTemporaryFile(mode = "w+b", suffix = ".curapackage", delete = False)
  584. file_path = self._temp_plugin_file.name
  585. # Write first and close, otherwise on Windows, it cannot read the file
  586. self._temp_plugin_file.write(cast(QNetworkReply, self._download_reply).readAll())
  587. self._temp_plugin_file.close()
  588. self._onDownloadComplete(file_path)
  589. def _onDownloadComplete(self, file_path: str) -> None:
  590. Logger.log("i", "Download complete.")
  591. package_info = self._package_manager.getPackageInfo(file_path)
  592. if not package_info:
  593. Logger.log("w", "Package file [%s] was not a valid CuraPackage.", file_path)
  594. return
  595. license_content = self._package_manager.getPackageLicense(file_path)
  596. if license_content is not None:
  597. self.openLicenseDialog(package_info["package_id"], license_content, file_path)
  598. return
  599. self.install(file_path)
  600. # Getter & Setters for Properties:
  601. # --------------------------------------------------------------------------
  602. def setDownloadProgress(self, progress: float) -> None:
  603. if progress != self._download_progress:
  604. self._download_progress = progress
  605. self.onDownloadProgressChanged.emit()
  606. @pyqtProperty(int, fset = setDownloadProgress, notify = onDownloadProgressChanged)
  607. def downloadProgress(self) -> float:
  608. return self._download_progress
  609. def setIsDownloading(self, is_downloading: bool) -> None:
  610. if self._is_downloading != is_downloading:
  611. self._is_downloading = is_downloading
  612. self.onIsDownloadingChanged.emit()
  613. @pyqtProperty(bool, fset = setIsDownloading, notify = onIsDownloadingChanged)
  614. def isDownloading(self) -> bool:
  615. return self._is_downloading
  616. def setActivePackage(self, package: Dict[str, Any]) -> None:
  617. if self._active_package != package:
  618. self._active_package = package
  619. self.activePackageChanged.emit()
  620. ## The active package is the package that is currently being downloaded
  621. @pyqtProperty(QObject, fset = setActivePackage, notify = activePackageChanged)
  622. def activePackage(self) -> Optional[Dict[str, Any]]:
  623. return self._active_package
  624. def setViewCategory(self, category: str = "plugin") -> None:
  625. if self._view_category != category:
  626. self._view_category = category
  627. self.viewChanged.emit()
  628. @pyqtProperty(str, fset = setViewCategory, notify = viewChanged)
  629. def viewCategory(self) -> str:
  630. return self._view_category
  631. def setViewPage(self, page: str = "overview") -> None:
  632. if self._view_page != page:
  633. self._view_page = page
  634. self.viewChanged.emit()
  635. @pyqtProperty(str, fset = setViewPage, notify = viewChanged)
  636. def viewPage(self) -> str:
  637. return self._view_page
  638. # Exposed Models:
  639. # --------------------------------------------------------------------------
  640. @pyqtProperty(QObject, constant=True)
  641. def authorsModel(self) -> AuthorsModel:
  642. return cast(AuthorsModel, self._models["authors"])
  643. @pyqtProperty(QObject, constant=True)
  644. def packagesModel(self) -> PackagesModel:
  645. return cast(PackagesModel, self._models["packages"])
  646. @pyqtProperty(QObject, constant=True)
  647. def pluginsShowcaseModel(self) -> PackagesModel:
  648. return self._plugins_showcase_model
  649. @pyqtProperty(QObject, constant=True)
  650. def pluginsAvailableModel(self) -> PackagesModel:
  651. return self._plugins_available_model
  652. @pyqtProperty(QObject, constant=True)
  653. def pluginsInstalledModel(self) -> PackagesModel:
  654. return self._plugins_installed_model
  655. @pyqtProperty(QObject, constant=True)
  656. def materialsShowcaseModel(self) -> AuthorsModel:
  657. return self._materials_showcase_model
  658. @pyqtProperty(QObject, constant=True)
  659. def materialsAvailableModel(self) -> AuthorsModel:
  660. return self._materials_available_model
  661. @pyqtProperty(QObject, constant=True)
  662. def materialsInstalledModel(self) -> PackagesModel:
  663. return self._materials_installed_model
  664. @pyqtProperty(QObject, constant=True)
  665. def materialsGenericModel(self) -> PackagesModel:
  666. return self._materials_generic_model
  667. # Filter Models:
  668. # --------------------------------------------------------------------------
  669. @pyqtSlot(str, str, str)
  670. def filterModelByProp(self, model_type: str, filter_type: str, parameter: str) -> None:
  671. if not self._models[model_type]:
  672. Logger.log("w", "Couldn't filter %s model because it doesn't exist.", model_type)
  673. return
  674. self._models[model_type].setFilter({filter_type: parameter})
  675. self.filterChanged.emit()
  676. @pyqtSlot(str, "QVariantMap")
  677. def setFilters(self, model_type: str, filter_dict: dict) -> None:
  678. if not self._models[model_type]:
  679. Logger.log("w", "Couldn't filter %s model because it doesn't exist.", model_type)
  680. return
  681. self._models[model_type].setFilter(filter_dict)
  682. self.filterChanged.emit()
  683. @pyqtSlot(str)
  684. def removeFilters(self, model_type: str) -> None:
  685. if not self._models[model_type]:
  686. Logger.log("w", "Couldn't remove filters on %s model because it doesn't exist.", model_type)
  687. return
  688. self._models[model_type].setFilter({})
  689. self.filterChanged.emit()
  690. # HACK(S):
  691. # --------------------------------------------------------------------------
  692. def reBuildMaterialsModels(self) -> None:
  693. materials_showcase_metadata = []
  694. materials_available_metadata = []
  695. materials_generic_metadata = []
  696. processed_authors = [] # type: List[str]
  697. for item in self._server_response_data["packages"]:
  698. if item["package_type"] == "material":
  699. author = item["author"]
  700. if author["author_id"] in processed_authors:
  701. continue
  702. # Generic materials to be in the same section
  703. if "generic" in item["tags"]:
  704. materials_generic_metadata.append(item)
  705. else:
  706. if "showcase" in item["tags"]:
  707. materials_showcase_metadata.append(author)
  708. else:
  709. materials_available_metadata.append(author)
  710. processed_authors.append(author["author_id"])
  711. self._materials_showcase_model.setMetadata(materials_showcase_metadata)
  712. self._materials_available_model.setMetadata(materials_available_metadata)
  713. self._materials_generic_model.setMetadata(materials_generic_metadata)
  714. def reBuildPluginsModels(self) -> None:
  715. plugins_showcase_metadata = []
  716. plugins_available_metadata = []
  717. for item in self._server_response_data["packages"]:
  718. if item["package_type"] == "plugin":
  719. if "showcase" in item["tags"]:
  720. plugins_showcase_metadata.append(item)
  721. else:
  722. plugins_available_metadata.append(item)
  723. self._plugins_showcase_model.setMetadata(plugins_showcase_metadata)
  724. self._plugins_available_model.setMetadata(plugins_available_metadata)