DigitalFactoryController.py 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628
  1. # Copyright (c) 2021 Ultimaker B.V.
  2. # Cura is released under the terms of the LGPLv3 or higher.
  3. import json
  4. import math
  5. import os
  6. import tempfile
  7. import threading
  8. from enum import IntEnum
  9. from pathlib import Path
  10. from typing import Optional, List, Dict, Any, cast
  11. from PyQt5.QtCore import pyqtSignal, QObject, pyqtSlot, pyqtProperty, Q_ENUMS, QTimer, QUrl
  12. from PyQt5.QtNetwork import QNetworkReply
  13. from PyQt5.QtQml import qmlRegisterType, qmlRegisterUncreatableType
  14. from UM.FileHandler.FileHandler import FileHandler
  15. from UM.Logger import Logger
  16. from UM.Message import Message
  17. from UM.Scene.SceneNode import SceneNode
  18. from UM.Signal import Signal
  19. from UM.TaskManagement.HttpRequestManager import HttpRequestManager
  20. from cura.API import Account
  21. from cura.CuraApplication import CuraApplication
  22. from cura.UltimakerCloud.UltimakerCloudScope import UltimakerCloudScope
  23. from .BackwardsCompatibleMessage import getBackwardsCompatibleMessage
  24. from .DFFileExportAndUploadManager import DFFileExportAndUploadManager
  25. from .DigitalFactoryApiClient import DigitalFactoryApiClient
  26. from .DigitalFactoryFileModel import DigitalFactoryFileModel
  27. from .DigitalFactoryFileResponse import DigitalFactoryFileResponse
  28. from .DigitalFactoryProjectModel import DigitalFactoryProjectModel
  29. from .DigitalFactoryProjectResponse import DigitalFactoryProjectResponse
  30. class RetrievalStatus(IntEnum):
  31. """
  32. The status of an http get request.
  33. This is not an enum, because we want to use it in QML and QML doesn't recognize Python enums.
  34. """
  35. Idle = 0
  36. InProgress = 1
  37. Success = 2
  38. Failed = 3
  39. class DFRetrievalStatus(QObject):
  40. """
  41. Used as an intermediate QObject that registers the RetrievalStatus as a recognizable enum in QML, so that it can
  42. be used within QML objects as DigitalFactory.RetrievalStatus.<status>
  43. """
  44. Q_ENUMS(RetrievalStatus)
  45. class DigitalFactoryController(QObject):
  46. DISK_WRITE_BUFFER_SIZE = 256 * 1024 # 256 KB
  47. selectedProjectIndexChanged = pyqtSignal(int, arguments = ["newProjectIndex"])
  48. """Signal emitted whenever the selected project is changed in the projects dropdown menu"""
  49. selectedFileIndicesChanged = pyqtSignal("QList<int>", arguments = ["newFileIndices"])
  50. """Signal emitted whenever the selected file is changed in the files table"""
  51. retrievingProjectsStatusChanged = pyqtSignal(int, arguments = ["status"])
  52. """Signal emitted whenever the status of the 'retrieving projects' http get request is changed"""
  53. retrievingFilesStatusChanged = pyqtSignal(int, arguments = ["status"])
  54. """Signal emitted whenever the status of the 'retrieving files in project' http get request is changed"""
  55. creatingNewProjectStatusChanged = pyqtSignal(int, arguments = ["status"])
  56. """Signal emitted whenever the status of the 'create new library project' http get request is changed"""
  57. hasMoreProjectsToLoadChanged = pyqtSignal()
  58. """Signal emitted whenever the variable hasMoreProjectsToLoad is changed. This variable is used to determine if
  59. the paginated list of projects has more pages to show"""
  60. preselectedProjectChanged = pyqtSignal()
  61. """Signal emitted whenever a preselected project is set. Whenever there is a preselected project, it means that it is
  62. the only project in the ProjectModel. When the preselected project is invalidated, the ProjectsModel needs to be
  63. retrieved again."""
  64. projectCreationErrorTextChanged = pyqtSignal()
  65. """Signal emitted whenever the creation of a new project fails and a specific error message is returned from the
  66. server."""
  67. """Signals to inform about the process of the file upload"""
  68. uploadStarted = Signal()
  69. uploadFileProgress = Signal()
  70. uploadFileSuccess = Signal()
  71. uploadFileError = Signal()
  72. uploadFileFinished = Signal()
  73. """Signal to inform about the state of user access."""
  74. userAccessStateChanged = pyqtSignal(bool)
  75. """Signal to inform whether the user is allowed to create more Library projects."""
  76. userCanCreateNewLibraryProjectChanged = pyqtSignal(bool)
  77. def __init__(self, application: CuraApplication) -> None:
  78. super().__init__(parent = None)
  79. self._application = application
  80. self._dialog = None # type: Optional["QObject"]
  81. self.file_handlers = {} # type: Dict[str, FileHandler]
  82. self.nodes = None # type: Optional[List[SceneNode]]
  83. self.file_upload_manager = None # type: Optional[DFFileExportAndUploadManager]
  84. self._has_preselected_project = False # type: bool
  85. self._api = DigitalFactoryApiClient(self._application, on_error = lambda error: Logger.log("e", str(error)), projects_limit_per_page = 20)
  86. # Indicates whether there are more pages of projects that can be loaded from the API
  87. self._has_more_projects_to_load = False
  88. self._account = self._application.getInstance().getCuraAPI().account # type: Account
  89. self._account.loginStateChanged.connect(self._onLoginStateChanged)
  90. self._current_workspace_information = CuraApplication.getInstance().getCurrentWorkspaceInformation()
  91. # Initialize the project model
  92. self._project_model = DigitalFactoryProjectModel()
  93. self._selected_project_idx = -1
  94. self._project_creation_error_text = "Something went wrong while creating a new project. Please try again."
  95. self._project_filter = ""
  96. self._project_filter_change_timer = QTimer()
  97. self._project_filter_change_timer.setInterval(200)
  98. self._project_filter_change_timer.setSingleShot(True)
  99. self._project_filter_change_timer.timeout.connect(self._applyProjectFilter)
  100. # Initialize the file model
  101. self._file_model = DigitalFactoryFileModel()
  102. self._selected_file_indices = [] # type: List[int]
  103. # Filled after the application has been initialized
  104. self._supported_file_types = {} # type: Dict[str, str]
  105. # For cleaning up the files afterwards:
  106. self._erase_temp_files_lock = threading.Lock()
  107. # The statuses which indicate whether Cura is waiting for a response from the DigitalFactory API
  108. self.retrieving_files_status = RetrievalStatus.Idle
  109. self.retrieving_projects_status = RetrievalStatus.Idle
  110. self.creating_new_project_status = RetrievalStatus.Idle
  111. self._application.engineCreatedSignal.connect(self._onEngineCreated)
  112. self._application.initializationFinished.connect(self._applicationInitializationFinished)
  113. self._user_has_access = False
  114. self._user_account_can_create_new_project = False
  115. def clear(self) -> None:
  116. self._project_model.clearProjects()
  117. self._api.clear()
  118. self._has_preselected_project = False
  119. self.preselectedProjectChanged.emit()
  120. self.setRetrievingFilesStatus(RetrievalStatus.Idle)
  121. self.setRetrievingProjectsStatus(RetrievalStatus.Idle)
  122. self.setCreatingNewProjectStatus(RetrievalStatus.Idle)
  123. self.setSelectedProjectIndex(-1)
  124. def _onLoginStateChanged(self, logged_in: bool) -> None:
  125. def callback(has_access, **kwargs):
  126. self._user_has_access = has_access
  127. self.userAccessStateChanged.emit(logged_in)
  128. self._api.checkUserHasAccess(callback)
  129. def userAccountHasLibraryAccess(self) -> bool:
  130. """
  131. Checks whether the currently logged in user account has access to the Digital Library
  132. :return: True if the user account has Digital Library access, else False
  133. """
  134. if self._user_has_access:
  135. self._api.checkUserCanCreateNewLibraryProject(callback = self.setCanCreateNewLibraryProject)
  136. return self._user_has_access
  137. def initialize(self, preselected_project_id: Optional[str] = None) -> None:
  138. self.clear()
  139. if self._account.isLoggedIn and self.userAccountHasLibraryAccess():
  140. self.setRetrievingProjectsStatus(RetrievalStatus.InProgress)
  141. if preselected_project_id:
  142. self._api.getProject(preselected_project_id, on_finished = self.setProjectAsPreselected, failed = self._onGetProjectFailed)
  143. else:
  144. self._api.getProjectsFirstPage(search_filter = self._project_filter, on_finished = self._onGetProjectsFirstPageFinished, failed = self._onGetProjectsFailed)
  145. def setProjectAsPreselected(self, df_project: DigitalFactoryProjectResponse) -> None:
  146. """
  147. Sets the received df_project as the preselected one. When a project is preselected, it should be the only
  148. project inside the model, so this function first makes sure to clear the projects model.
  149. :param df_project: The library project intended to be set as preselected
  150. """
  151. self._project_model.clearProjects()
  152. self._project_model.setProjects([df_project])
  153. self.setSelectedProjectIndex(0)
  154. self.setHasPreselectedProject(True)
  155. self.setRetrievingProjectsStatus(RetrievalStatus.Success)
  156. self.setCreatingNewProjectStatus(RetrievalStatus.Success)
  157. def _onGetProjectFailed(self, reply: QNetworkReply, error: QNetworkReply.NetworkError) -> None:
  158. reply_string = bytes(reply.readAll()).decode()
  159. self.setHasPreselectedProject(False)
  160. Logger.log("w", "Something went wrong while trying to retrieve a the preselected Digital Library project. Error: {}".format(reply_string))
  161. def _onGetProjectsFirstPageFinished(self, df_projects: List[DigitalFactoryProjectResponse]) -> None:
  162. """
  163. Set the first page of projects received from the digital factory library in the project model. Called whenever
  164. the retrieval of the first page of projects is successful.
  165. :param df_projects: A list of all the Digital Factory Library projects linked to the user's account
  166. """
  167. self.setHasMoreProjectsToLoad(self._api.hasMoreProjectsToLoad())
  168. self._project_model.setProjects(df_projects)
  169. self.setRetrievingProjectsStatus(RetrievalStatus.Success)
  170. @pyqtSlot()
  171. def loadMoreProjects(self) -> None:
  172. """
  173. Initiates the process of retrieving the next page of the projects list from the API.
  174. """
  175. self._api.getMoreProjects(on_finished = self.loadMoreProjectsFinished, failed = self._onGetProjectsFailed)
  176. self.setRetrievingProjectsStatus(RetrievalStatus.InProgress)
  177. def loadMoreProjectsFinished(self, df_projects: List[DigitalFactoryProjectResponse]) -> None:
  178. """
  179. Set the projects received from the digital factory library in the project model. Called whenever the retrieval
  180. of the projects is successful.
  181. :param df_projects: A list of all the Digital Factory Library projects linked to the user's account
  182. """
  183. self.setHasMoreProjectsToLoad(self._api.hasMoreProjectsToLoad())
  184. self._project_model.extendProjects(df_projects)
  185. self.setRetrievingProjectsStatus(RetrievalStatus.Success)
  186. def _onGetProjectsFailed(self, reply: QNetworkReply, error: QNetworkReply.NetworkError) -> None:
  187. """
  188. Error function, called whenever the retrieval of projects fails.
  189. """
  190. self.setRetrievingProjectsStatus(RetrievalStatus.Failed)
  191. Logger.log("w", "Failed to retrieve the list of projects from the Digital Library. Error encountered: {}".format(error))
  192. def getProjectFilesFinished(self, df_files_in_project: List[DigitalFactoryFileResponse]) -> None:
  193. """
  194. Set the files received from the digital factory library in the file model. The files are filtered to only
  195. contain the files which can be opened by Cura.
  196. Called whenever the retrieval of the files is successful.
  197. :param df_files_in_project: A list of all the Digital Factory Library files that exist in a library project
  198. """
  199. # Filter to show only the files that can be opened in Cura
  200. self._file_model.setFilters({"file_name": lambda x: Path(x).suffix[1:].lower() in self._supported_file_types}) # the suffix is in format '.xyz', so omit the dot at the start
  201. self._file_model.setFiles(df_files_in_project)
  202. self.setRetrievingFilesStatus(RetrievalStatus.Success)
  203. def getProjectFilesFailed(self, reply: QNetworkReply, error: QNetworkReply.NetworkError) -> None:
  204. """
  205. Error function, called whenever the retrieval of the files in a library project fails.
  206. """
  207. Logger.log("w", "Failed to retrieve the list of files in project '{}' from the Digital Library".format(self._project_model._projects[self._selected_project_idx]))
  208. self.setRetrievingFilesStatus(RetrievalStatus.Failed)
  209. @pyqtSlot()
  210. def clearProjectSelection(self) -> None:
  211. """
  212. Clear the selected project.
  213. """
  214. if self._has_preselected_project:
  215. self.setHasPreselectedProject(False)
  216. else:
  217. self.setSelectedProjectIndex(-1)
  218. @pyqtSlot(int)
  219. def setSelectedProjectIndex(self, project_idx: int) -> None:
  220. """
  221. Sets the index of the project which is currently selected in the dropdown menu. Then, it uses the project_id of
  222. that project to retrieve the list of files included in that project and display it in the interface.
  223. :param project_idx: The index of the currently selected project
  224. """
  225. if project_idx < -1 or project_idx >= len(self._project_model.items):
  226. Logger.log("w", "The selected project index is invalid.")
  227. project_idx = -1 # -1 is a valid index for the combobox and it is handled as "nothing is selected"
  228. self._selected_project_idx = project_idx
  229. self.selectedProjectIndexChanged.emit(project_idx)
  230. # Clear the files from the previously-selected project and refresh the files model with the newly-selected-
  231. # project's files
  232. self._file_model.clearFiles()
  233. self.selectedFileIndicesChanged.emit([])
  234. if 0 <= project_idx < len(self._project_model.items):
  235. library_project_id = self._project_model.items[project_idx]["libraryProjectId"]
  236. self.setRetrievingFilesStatus(RetrievalStatus.InProgress)
  237. self._api.getListOfFilesInProject(library_project_id, on_finished = self.getProjectFilesFinished, failed = self.getProjectFilesFailed)
  238. @pyqtProperty(int, fset = setSelectedProjectIndex, notify = selectedProjectIndexChanged)
  239. def selectedProjectIndex(self) -> int:
  240. return self._selected_project_idx
  241. @pyqtSlot("QList<int>")
  242. def setSelectedFileIndices(self, file_indices: List[int]) -> None:
  243. """
  244. Sets the index of the file which is currently selected in the list of files.
  245. :param file_indices: The index of the currently selected file
  246. """
  247. if file_indices != self._selected_file_indices:
  248. self._selected_file_indices = file_indices
  249. self.selectedFileIndicesChanged.emit(file_indices)
  250. def setProjectFilter(self, new_filter: str) -> None:
  251. """
  252. Called when the user wants to change the search filter for projects.
  253. The filter is not immediately applied. There is some delay to allow the user to finish typing.
  254. :param new_filter: The new filter that the user wants to apply.
  255. """
  256. self._project_filter = new_filter
  257. self._project_filter_change_timer.start()
  258. """
  259. Signal to notify Qt that the applied filter has changed.
  260. """
  261. projectFilterChanged = pyqtSignal()
  262. @pyqtProperty(str, notify = projectFilterChanged, fset = setProjectFilter)
  263. def projectFilter(self) -> str:
  264. """
  265. The current search filter being applied to the project list.
  266. :return: The current search filter being applied to the project list.
  267. """
  268. return self._project_filter
  269. def _applyProjectFilter(self) -> None:
  270. """
  271. Actually apply the current filter to search for projects with the user-defined search string.
  272. :return:
  273. """
  274. self.clear()
  275. self.projectFilterChanged.emit()
  276. self._api.getProjectsFirstPage(search_filter = self._project_filter, on_finished = self._onGetProjectsFirstPageFinished, failed = self._onGetProjectsFailed)
  277. @pyqtProperty(QObject, constant = True)
  278. def digitalFactoryProjectModel(self) -> "DigitalFactoryProjectModel":
  279. return self._project_model
  280. @pyqtProperty(QObject, constant = True)
  281. def digitalFactoryFileModel(self) -> "DigitalFactoryFileModel":
  282. return self._file_model
  283. def setHasMoreProjectsToLoad(self, has_more_projects_to_load: bool) -> None:
  284. """
  285. Set the value that indicates whether there are more pages of projects that can be loaded from the API
  286. :param has_more_projects_to_load: Whether there are more pages of projects
  287. """
  288. if has_more_projects_to_load != self._has_more_projects_to_load:
  289. self._has_more_projects_to_load = has_more_projects_to_load
  290. self.hasMoreProjectsToLoadChanged.emit()
  291. @pyqtProperty(bool, fset = setHasMoreProjectsToLoad, notify = hasMoreProjectsToLoadChanged)
  292. def hasMoreProjectsToLoad(self) -> bool:
  293. """
  294. :return: whether there are more pages for projects that can be loaded from the API
  295. """
  296. return self._has_more_projects_to_load
  297. @pyqtSlot(str)
  298. def createLibraryProjectAndSetAsPreselected(self, project_name: Optional[str]) -> None:
  299. """
  300. Creates a new project with the given name in the Digital Library.
  301. :param project_name: The name that will be used for the new project
  302. """
  303. if project_name:
  304. self._api.createNewProject(project_name, self.setProjectAsPreselected, self._createNewLibraryProjectFailed)
  305. self.setCreatingNewProjectStatus(RetrievalStatus.InProgress)
  306. else:
  307. Logger.log("w", "No project name provided while attempting to create a new project. Aborting the project creation.")
  308. def _createNewLibraryProjectFailed(self, reply: QNetworkReply, error: QNetworkReply.NetworkError) -> None:
  309. reply_string = bytes(reply.readAll()).decode()
  310. self._project_creation_error_text = "Something went wrong while creating the new project. Please try again."
  311. if reply_string:
  312. reply_dict = json.loads(reply_string)
  313. if "errors" in reply_dict and len(reply_dict["errors"]) >= 1 and "title" in reply_dict["errors"][0]:
  314. self._project_creation_error_text = "Error while creating the new project: {}".format(reply_dict["errors"][0]["title"])
  315. self.projectCreationErrorTextChanged.emit()
  316. self.setCreatingNewProjectStatus(RetrievalStatus.Failed)
  317. Logger.log("e", "Something went wrong while trying to create a new a project. Error: {}".format(reply_string))
  318. def setRetrievingProjectsStatus(self, new_status: RetrievalStatus) -> None:
  319. """
  320. Sets the status of the "retrieving library projects" http call.
  321. :param new_status: The new status
  322. """
  323. self.retrieving_projects_status = new_status
  324. self.retrievingProjectsStatusChanged.emit(int(new_status))
  325. @pyqtProperty(int, fset = setRetrievingProjectsStatus, notify = retrievingProjectsStatusChanged)
  326. def retrievingProjectsStatus(self) -> int:
  327. return int(self.retrieving_projects_status)
  328. def setRetrievingFilesStatus(self, new_status: RetrievalStatus) -> None:
  329. """
  330. Sets the status of the "retrieving files list in the selected library project" http call.
  331. :param new_status: The new status
  332. """
  333. self.retrieving_files_status = new_status
  334. self.retrievingFilesStatusChanged.emit(int(new_status))
  335. @pyqtProperty(int, fset = setRetrievingFilesStatus, notify = retrievingFilesStatusChanged)
  336. def retrievingFilesStatus(self) -> int:
  337. return int(self.retrieving_files_status)
  338. def setCreatingNewProjectStatus(self, new_status: RetrievalStatus) -> None:
  339. """
  340. Sets the status of the "creating new library project" http call.
  341. :param new_status: The new status
  342. """
  343. self.creating_new_project_status = new_status
  344. self.creatingNewProjectStatusChanged.emit(int(new_status))
  345. @pyqtProperty(int, fset = setCreatingNewProjectStatus, notify = creatingNewProjectStatusChanged)
  346. def creatingNewProjectStatus(self) -> int:
  347. return int(self.creating_new_project_status)
  348. @staticmethod
  349. def _onEngineCreated() -> None:
  350. qmlRegisterUncreatableType(DFRetrievalStatus, "DigitalFactory", 1, 0, "RetrievalStatus", "Could not create RetrievalStatus enum type")
  351. def _applicationInitializationFinished(self) -> None:
  352. self._supported_file_types = self._application.getInstance().getMeshFileHandler().getSupportedFileTypesRead()
  353. # Although Cura supports these, it's super confusing in this context to show them.
  354. for extension in ["jpg", "jpeg", "png", "bmp", "gif"]:
  355. if extension in self._supported_file_types:
  356. del self._supported_file_types[extension]
  357. @pyqtSlot()
  358. def openSelectedFiles(self) -> None:
  359. """ Downloads, then opens all files selected in the Qt frontend open dialog.
  360. """
  361. temp_dir = tempfile.mkdtemp()
  362. if temp_dir is None or temp_dir == "":
  363. Logger.error("Digital Library: Couldn't create temporary directory to store to-be downloaded files.")
  364. return
  365. if self._selected_project_idx < 0 or len(self._selected_file_indices) < 1:
  366. Logger.error("Digital Library: No project or no file selected on open action.")
  367. return
  368. to_erase_on_done_set = {
  369. os.path.join(temp_dir, self._file_model.getItem(i)["fileName"]).replace('\\', '/')
  370. for i in self._selected_file_indices}
  371. def onLoadedCallback(filename_done: str) -> None:
  372. filename_done = os.path.join(temp_dir, filename_done).replace('\\', '/')
  373. with self._erase_temp_files_lock:
  374. if filename_done in to_erase_on_done_set:
  375. try:
  376. os.remove(filename_done)
  377. to_erase_on_done_set.remove(filename_done)
  378. if len(to_erase_on_done_set) < 1 and os.path.exists(temp_dir):
  379. os.rmdir(temp_dir)
  380. except (IOError, OSError) as ex:
  381. Logger.error("Can't erase temporary (in) {0} because {1}.", temp_dir, str(ex))
  382. # Save the project id to make sure it will be preselected the next time the user opens the save dialog
  383. CuraApplication.getInstance().getCurrentWorkspaceInformation().setEntryToStore("digital_factory", "library_project_id", library_project_id)
  384. # Disconnect the signals so that they are not fired every time another (project) file is loaded
  385. app.fileLoaded.disconnect(onLoadedCallback)
  386. app.workspaceLoaded.disconnect(onLoadedCallback)
  387. app = CuraApplication.getInstance()
  388. app.fileLoaded.connect(onLoadedCallback) # fired when non-project files are loaded
  389. app.workspaceLoaded.connect(onLoadedCallback) # fired when project files are loaded
  390. project_name = self._project_model.getItem(self._selected_project_idx)["displayName"]
  391. for file_index in self._selected_file_indices:
  392. file_item = self._file_model.getItem(file_index)
  393. file_name = file_item["fileName"]
  394. download_url = file_item["downloadUrl"]
  395. library_project_id = file_item["libraryProjectId"]
  396. self._openSelectedFile(temp_dir, project_name, file_name, download_url)
  397. def _openSelectedFile(self, temp_dir: str, project_name: str, file_name: str, download_url: str) -> None:
  398. """ Downloads, then opens, the single specified file.
  399. :param temp_dir: The already created temporary directory where the files will be stored.
  400. :param project_name: Name of the project the file belongs to (used for error reporting).
  401. :param file_name: Name of the file to be downloaded and opened (used for error reporting).
  402. :param download_url: This url will be downloaded, then the downloaded file will be opened in Cura.
  403. """
  404. if not download_url:
  405. Logger.log("e", "No download url for file '{}'".format(file_name))
  406. return
  407. progress_message = Message(text = "{0}/{1}".format(project_name, file_name), dismissable = False, lifetime = 0,
  408. progress = 0, title = "Downloading...")
  409. progress_message.setProgress(0)
  410. progress_message.show()
  411. def progressCallback(rx: int, rt: int) -> None:
  412. progress_message.setProgress(math.floor(rx * 100.0 / rt))
  413. def finishedCallback(reply: QNetworkReply) -> None:
  414. progress_message.hide()
  415. try:
  416. with open(os.path.join(temp_dir, file_name), "wb+") as temp_file:
  417. bytes_read = reply.read(self.DISK_WRITE_BUFFER_SIZE)
  418. while bytes_read:
  419. temp_file.write(bytes_read)
  420. bytes_read = reply.read(self.DISK_WRITE_BUFFER_SIZE)
  421. CuraApplication.getInstance().processEvents()
  422. temp_file_name = temp_file.name
  423. except IOError as ex:
  424. Logger.logException("e", "Can't write Digital Library file {0}/{1} download to temp-directory {2}.",
  425. ex, project_name, file_name, temp_dir)
  426. getBackwardsCompatibleMessage(
  427. text = "Failed to write to temporary file for '{}'.".format(file_name),
  428. title = "File-system error",
  429. message_type_str="ERROR",
  430. lifetime = 10
  431. ).show()
  432. return
  433. CuraApplication.getInstance().readLocalFile(
  434. QUrl.fromLocalFile(temp_file_name), add_to_recent_files = False)
  435. def errorCallback(reply: QNetworkReply, error: QNetworkReply.NetworkError, p = project_name,
  436. f = file_name) -> None:
  437. progress_message.hide()
  438. Logger.error("An error {0} {1} occurred while downloading {2}/{3}".format(str(error), str(reply), p, f))
  439. getBackwardsCompatibleMessage(
  440. text = "Failed Digital Library download for '{}'.".format(f),
  441. title = "Network error {}".format(error),
  442. message_type_str="ERROR",
  443. lifetime = 10
  444. ).show()
  445. download_manager = HttpRequestManager.getInstance()
  446. download_manager.get(download_url, callback = finishedCallback, download_progress_callback = progressCallback,
  447. error_callback = errorCallback, scope = UltimakerCloudScope(CuraApplication.getInstance()))
  448. def setHasPreselectedProject(self, new_has_preselected_project: bool) -> None:
  449. if not new_has_preselected_project:
  450. # The preselected project was the only one in the model, at index 0, so when we set the has_preselected_project to
  451. # false, we also need to clean it from the projects model
  452. self._project_model.clearProjects()
  453. self.setSelectedProjectIndex(-1)
  454. self._api.getProjectsFirstPage(search_filter = self._project_filter, on_finished = self._onGetProjectsFirstPageFinished, failed = self._onGetProjectsFailed)
  455. self._api.checkUserCanCreateNewLibraryProject(callback = self.setCanCreateNewLibraryProject)
  456. self.setRetrievingProjectsStatus(RetrievalStatus.InProgress)
  457. self._has_preselected_project = new_has_preselected_project
  458. self.preselectedProjectChanged.emit()
  459. @pyqtProperty(bool, fset = setHasPreselectedProject, notify = preselectedProjectChanged)
  460. def hasPreselectedProject(self) -> bool:
  461. return self._has_preselected_project
  462. def setCanCreateNewLibraryProject(self, can_create_new_library_project: bool) -> None:
  463. self._user_account_can_create_new_project = can_create_new_library_project
  464. self.userCanCreateNewLibraryProjectChanged.emit(self._user_account_can_create_new_project)
  465. @pyqtProperty(bool, fset = setCanCreateNewLibraryProject, notify = userCanCreateNewLibraryProjectChanged)
  466. def userAccountCanCreateNewLibraryProject(self) -> bool:
  467. return self._user_account_can_create_new_project
  468. @pyqtSlot(str, "QStringList")
  469. def saveFileToSelectedProject(self, filename: str, formats: List[str]) -> None:
  470. """
  471. Function triggered whenever the Save button is pressed.
  472. :param filename: The name (without the extension) that will be used for the files
  473. :param formats: List of the formats the scene will be exported to. Can include 3mf, ufp, or both
  474. """
  475. if self._selected_project_idx == -1:
  476. Logger.log("e", "No DF Library project is selected.")
  477. return
  478. if filename == "":
  479. Logger.log("w", "The file name cannot be empty.")
  480. getBackwardsCompatibleMessage(
  481. text = "Cannot upload file with an empty name to the Digital Library",
  482. title = "Empty file name provided",
  483. message_type_str = "ERROR",
  484. lifetime = 0
  485. ).show()
  486. return
  487. self._saveFileToSelectedProjectHelper(filename, formats)
  488. def _saveFileToSelectedProjectHelper(self, filename: str, formats: List[str]) -> None:
  489. # Indicate we have started sending a job.
  490. self.uploadStarted.emit()
  491. library_project_id = self._project_model.items[self._selected_project_idx]["libraryProjectId"]
  492. library_project_name = self._project_model.items[self._selected_project_idx]["displayName"]
  493. # Use the file upload manager to export and upload the 3mf and/or ufp files to the DF Library project
  494. self.file_upload_manager = DFFileExportAndUploadManager(file_handlers = self.file_handlers, nodes = cast(List[SceneNode], self.nodes),
  495. library_project_id = library_project_id,
  496. library_project_name = library_project_name,
  497. file_name = filename, formats = formats,
  498. on_upload_error = self.uploadFileError.emit,
  499. on_upload_success = self.uploadFileSuccess.emit,
  500. on_upload_finished = self.uploadFileFinished.emit,
  501. on_upload_progress = self.uploadFileProgress.emit)
  502. self.file_upload_manager.start()
  503. # Save the project id to make sure it will be preselected the next time the user opens the save dialog
  504. self._current_workspace_information.setEntryToStore("digital_factory", "library_project_id", library_project_id)
  505. @pyqtProperty(str, notify = projectCreationErrorTextChanged)
  506. def projectCreationErrorText(self) -> str:
  507. return self._project_creation_error_text