mirror of
https://github.com/Ultimaker/Cura.git
synced 2025-07-07 15:07:28 -06:00
412 lines
17 KiB
Python
412 lines
17 KiB
Python
# Copyright (c) 2017 Ultimaker B.V.
|
|
# PluginBrowser is released under the terms of the LGPLv3 or higher.
|
|
|
|
from PyQt5.QtCore import QUrl, QObject, Qt, pyqtProperty, pyqtSignal, pyqtSlot
|
|
from PyQt5.QtNetwork import QNetworkAccessManager, QNetworkRequest, QNetworkReply
|
|
|
|
from UM.Application import Application
|
|
from UM.Qt.ListModel import ListModel
|
|
from UM.Logger import Logger
|
|
from UM.PluginRegistry import PluginRegistry
|
|
from UM.Qt.Bindings.PluginsModel import PluginsModel
|
|
from UM.Extension import Extension
|
|
from UM.i18n import i18nCatalog
|
|
|
|
from UM.Version import Version
|
|
from UM.Message import Message
|
|
|
|
import json
|
|
import os
|
|
import tempfile
|
|
import platform
|
|
import zipfile
|
|
import shutil
|
|
|
|
i18n_catalog = i18nCatalog("cura")
|
|
|
|
# Architecture thoughts:
|
|
# ------------------------------------------------------------------------------
|
|
# The plugin manager has 2 parts: the browser and the installer.
|
|
#
|
|
# UNINSTALLING:
|
|
# ------------------------------------------------------------------------------
|
|
# Uninstalling is done via the PluginRegistry's uninstallPlugin() method,
|
|
# supplied with a plugin_id. Uninstalling is currently done instantly so there's
|
|
# no need to use an list of "newly uninstalled plugins" but this will be needed
|
|
# in the future with more complex plugins, as well as when merging the built-in
|
|
# plugins into the plugin browser.
|
|
#
|
|
# STATUS:
|
|
# ------------------------------------------------------------------------------
|
|
# 'status' is used to keep track of installations and uninstallations. It is
|
|
# intended to replace "newly installed" and "newly uninstalled" lists. These
|
|
# lists introduce a lot of complexity if a plugin finds itself on both lists.
|
|
#
|
|
# 'status' can have several values:
|
|
# - "uninstalled"
|
|
# - "will_install"
|
|
# - "installed"
|
|
# - "will_uninstall"
|
|
#
|
|
# This is more civilized than checking if a plugin's metadata exists. It also
|
|
# means uninstalling doesn't require erasing the metadata.
|
|
#
|
|
# ACTIVE:
|
|
# ------------------------------------------------------------------------------
|
|
# Although 'active' could have been lumped with 'status', it is essentially a
|
|
# sub-status within 'installed' and 'will_uninstall'. Rather than create more
|
|
# statuses such as 'active_installed' and 'active_will_uninstall', the 'active'
|
|
# property is just a boolean used in conjunction with 'status'.
|
|
|
|
class PluginBrowser(QObject, Extension):
|
|
def __init__(self, parent=None):
|
|
super().__init__(parent)
|
|
|
|
self._api_version = 2
|
|
self._api_url = "http://software.ultimaker.com/cura/v%s/" % self._api_version
|
|
|
|
self._plugin_list_request = None
|
|
self._download_plugin_request = None
|
|
|
|
self._download_plugin_reply = None
|
|
|
|
self._network_manager = None
|
|
self._plugin_registry = Application.getInstance().getPluginRegistry()
|
|
|
|
self._plugins_metadata = []
|
|
self._plugins_model = None
|
|
|
|
self._dialog = None
|
|
self._restartDialog = None
|
|
self._download_progress = 0
|
|
|
|
self._is_downloading = False
|
|
|
|
self._request_header = [b"User-Agent",
|
|
str.encode("%s/%s (%s %s)" % (Application.getInstance().getApplicationName(),
|
|
Application.getInstance().getVersion(),
|
|
platform.system(),
|
|
platform.machine(),
|
|
)
|
|
)
|
|
]
|
|
|
|
# Installed plugins are really installed after reboot. In order to
|
|
# prevent the user from downloading the same file over and over again,
|
|
# we keep track of the upgraded plugins.
|
|
|
|
# NOTE: This will be depreciated in favor of the 'status' system.
|
|
self._newly_installed_plugin_ids = []
|
|
self._newly_uninstalled_plugin_ids = []
|
|
|
|
self._plugin_statuses = {} # type: Dict[str, str]
|
|
|
|
# variables for the license agreement dialog
|
|
self._license_dialog_plugin_name = ""
|
|
self._license_dialog_license_content = ""
|
|
self._license_dialog_plugin_file_location = ""
|
|
self._restart_dialog_message = ""
|
|
|
|
showLicenseDialog = pyqtSignal()
|
|
showRestartDialog = pyqtSignal()
|
|
pluginsMetadataChanged = pyqtSignal()
|
|
onDownloadProgressChanged = pyqtSignal()
|
|
onIsDownloadingChanged = pyqtSignal()
|
|
|
|
@pyqtSlot(result = str)
|
|
def getLicenseDialogPluginName(self):
|
|
return self._license_dialog_plugin_name
|
|
|
|
@pyqtSlot(result = str)
|
|
def getLicenseDialogPluginFileLocation(self):
|
|
return self._license_dialog_plugin_file_location
|
|
|
|
@pyqtSlot(result = str)
|
|
def getLicenseDialogLicenseContent(self):
|
|
return self._license_dialog_license_content
|
|
|
|
@pyqtSlot(result = str)
|
|
def getRestartDialogMessage(self):
|
|
return self._restart_dialog_message
|
|
|
|
def openLicenseDialog(self, plugin_name, license_content, plugin_file_location):
|
|
self._license_dialog_plugin_name = plugin_name
|
|
self._license_dialog_license_content = license_content
|
|
self._license_dialog_plugin_file_location = plugin_file_location
|
|
self.showLicenseDialog.emit()
|
|
|
|
def openRestartDialog(self, message):
|
|
self._restart_dialog_message = message
|
|
self.showRestartDialog.emit()
|
|
|
|
@pyqtProperty(bool, notify = onIsDownloadingChanged)
|
|
def isDownloading(self):
|
|
return self._is_downloading
|
|
|
|
@pyqtSlot()
|
|
def browsePlugins(self):
|
|
self._createNetworkManager()
|
|
self.requestPluginList()
|
|
|
|
if not self._dialog:
|
|
self._dialog = self._createDialog("PluginBrowser.qml")
|
|
self._dialog.show()
|
|
|
|
@pyqtSlot()
|
|
def requestPluginList(self):
|
|
Logger.log("i", "Requesting plugin list")
|
|
url = QUrl(self._api_url + "plugins")
|
|
self._plugin_list_request = QNetworkRequest(url)
|
|
self._plugin_list_request.setRawHeader(*self._request_header)
|
|
self._network_manager.get(self._plugin_list_request)
|
|
|
|
def _createDialog(self, qml_name):
|
|
Logger.log("d", "Creating dialog [%s]", qml_name)
|
|
path = os.path.join(PluginRegistry.getInstance().getPluginPath(self.getPluginId()), qml_name)
|
|
dialog = Application.getInstance().createQmlComponent(path, {"manager": self})
|
|
return dialog
|
|
|
|
def setIsDownloading(self, is_downloading):
|
|
if self._is_downloading != is_downloading:
|
|
self._is_downloading = is_downloading
|
|
self.onIsDownloadingChanged.emit()
|
|
|
|
def _onDownloadPluginProgress(self, bytes_sent, bytes_total):
|
|
if bytes_total > 0:
|
|
new_progress = bytes_sent / bytes_total * 100
|
|
self.setDownloadProgress(new_progress)
|
|
if new_progress == 100.0:
|
|
self.setIsDownloading(False)
|
|
self._download_plugin_reply.downloadProgress.disconnect(self._onDownloadPluginProgress)
|
|
|
|
# must not delete the temporary file on Windows
|
|
self._temp_plugin_file = tempfile.NamedTemporaryFile(mode = "w+b", suffix = ".curaplugin", delete = False)
|
|
location = self._temp_plugin_file.name
|
|
|
|
# write first and close, otherwise on Windows, it cannot read the file
|
|
self._temp_plugin_file.write(self._download_plugin_reply.readAll())
|
|
self._temp_plugin_file.close()
|
|
|
|
self._checkPluginLicenseOrInstall(location)
|
|
return
|
|
|
|
## Checks if the downloaded plugin ZIP file contains a license file or not.
|
|
# If it does, it will show a popup dialog displaying the license to the user. The plugin will be installed if the
|
|
# user accepts the license.
|
|
# If there is no license file, the plugin will be directory installed.
|
|
def _checkPluginLicenseOrInstall(self, file_path):
|
|
with zipfile.ZipFile(file_path, "r") as zip_ref:
|
|
plugin_id = None
|
|
for file in zip_ref.infolist():
|
|
if file.filename.endswith("/"):
|
|
plugin_id = file.filename.strip("/")
|
|
break
|
|
|
|
if plugin_id is None:
|
|
msg = i18n_catalog.i18nc("@info:status", "Failed to get plugin ID from <filename>{0}</filename>", file_path)
|
|
msg_title = i18n_catalog.i18nc("@info:tile", "Warning")
|
|
self._progress_message = Message(msg, lifetime=0, dismissable=False, title = msg_title)
|
|
return
|
|
|
|
# find a potential license file
|
|
plugin_root_dir = plugin_id + "/"
|
|
license_file = None
|
|
for f in zip_ref.infolist():
|
|
# skip directories (with file_size = 0) and files not in the plugin directory
|
|
if f.file_size == 0 or not f.filename.startswith(plugin_root_dir):
|
|
continue
|
|
file_name = os.path.basename(f.filename).lower()
|
|
file_base_name, file_ext = os.path.splitext(file_name)
|
|
if file_base_name in ["license", "licence"]:
|
|
license_file = f.filename
|
|
break
|
|
|
|
# show a dialog for user to read and accept/decline the license
|
|
if license_file is not None:
|
|
Logger.log("i", "Found license file for plugin [%s], showing the license dialog to the user", plugin_id)
|
|
license_content = zip_ref.read(license_file).decode('utf-8')
|
|
self.openLicenseDialog(plugin_id, license_content, file_path)
|
|
return
|
|
|
|
# there is no license file, directly install the plugin
|
|
self.installPlugin(file_path)
|
|
|
|
@pyqtSlot(str)
|
|
def installPlugin(self, file_path):
|
|
# Ensure that it starts with a /, as otherwise it doesn't work on windows.
|
|
if not file_path.startswith("/"):
|
|
location = "/" + file_path
|
|
else:
|
|
location = file_path
|
|
|
|
result = PluginRegistry.getInstance().installPlugin("file://" + location)
|
|
|
|
self._newly_installed_plugin_ids.append(result["id"])
|
|
self.pluginsMetadataChanged.emit()
|
|
|
|
self.openRestartDialog(result["message"])
|
|
# Application.getInstance().messageBox(i18n_catalog.i18nc("@window:title", "Plugin browser"), result["message"])
|
|
|
|
@pyqtSlot(str)
|
|
def removePlugin(self, plugin_id):
|
|
result = PluginRegistry.getInstance().uninstallPlugin(plugin_id)
|
|
|
|
self._newly_uninstalled_plugin_ids.append(result["id"])
|
|
self.pluginsMetadataChanged.emit()
|
|
|
|
Application.getInstance().messageBox(i18n_catalog.i18nc("@window:title", "Plugin browser"), result["message"])
|
|
|
|
@pyqtProperty(int, notify = onDownloadProgressChanged)
|
|
def downloadProgress(self):
|
|
return self._download_progress
|
|
|
|
def setDownloadProgress(self, progress):
|
|
if progress != self._download_progress:
|
|
self._download_progress = progress
|
|
self.onDownloadProgressChanged.emit()
|
|
|
|
@pyqtSlot(str)
|
|
def downloadAndInstallPlugin(self, url):
|
|
Logger.log("i", "Attempting to download & install plugin from %s", url)
|
|
url = QUrl(url)
|
|
self._download_plugin_request = QNetworkRequest(url)
|
|
self._download_plugin_request.setRawHeader(*self._request_header)
|
|
self._download_plugin_reply = self._network_manager.get(self._download_plugin_request)
|
|
self.setDownloadProgress(0)
|
|
self.setIsDownloading(True)
|
|
self._download_plugin_reply.downloadProgress.connect(self._onDownloadPluginProgress)
|
|
|
|
@pyqtSlot()
|
|
def cancelDownload(self):
|
|
Logger.log("i", "user cancelled the download of a plugin")
|
|
self._download_plugin_reply.abort()
|
|
self._download_plugin_reply.downloadProgress.disconnect(self._onDownloadPluginProgress)
|
|
self._download_plugin_reply = None
|
|
self._download_plugin_request = None
|
|
|
|
self.setDownloadProgress(0)
|
|
self.setIsDownloading(False)
|
|
|
|
@pyqtProperty(QObject, notify=pluginsMetadataChanged)
|
|
|
|
def pluginsModel(self):
|
|
self._plugins_model = PluginsModel()
|
|
"""
|
|
if self._plugins_model is None:
|
|
self._plugins_model = PluginsModel()
|
|
else:
|
|
self._plugins_model.clear()
|
|
items = []
|
|
for metadata in self._plugins_metadata:
|
|
items.append({
|
|
"name": metadata["label"],
|
|
"id": metadata["id"],
|
|
"version": metadata["version"],
|
|
"short_description": metadata["short_description"],
|
|
"author": metadata["author"],
|
|
"author_email": "author@gmail.com",
|
|
"status": self._checkInstallStatus(metadata["id"]),
|
|
"already_installed": self._checkAlreadyInstalled(metadata["id"]),
|
|
"file_location": metadata["file_location"],
|
|
# "active": self._checkActive(metadata["id"]),
|
|
"enabled": True,
|
|
"can_upgrade": self._checkCanUpgrade(metadata["id"], metadata["version"])
|
|
})
|
|
self._plugins_model.setItems(items)
|
|
"""
|
|
return self._plugins_model
|
|
|
|
def _checkCanUpgrade(self, id, version):
|
|
plugin_registry = Application.getInstance().getPluginRegistry()
|
|
plugin_registry = PluginRegistry.getInstance()
|
|
metadata = plugin_registry.getMetaData(id)
|
|
if metadata != {}:
|
|
if id in self._newly_installed_plugin_ids:
|
|
return False # We already updated this plugin.
|
|
current_version = Version(metadata["plugin"]["version"])
|
|
new_version = Version(version)
|
|
if new_version > current_version:
|
|
return True
|
|
return False
|
|
|
|
def _checkAlreadyInstalled(self, id):
|
|
plugin_registry = PluginRegistry.getInstance()
|
|
metadata = plugin_registry.getMetaData(id)
|
|
# We already installed this plugin, but the registry just doesn't know it yet.
|
|
if id in self._newly_installed_plugin_ids:
|
|
return True
|
|
# We already uninstalled this plugin, but the registry just doesn't know it yet:
|
|
elif id in self._newly_uninstalled_plugin_ids:
|
|
return False
|
|
elif metadata != {}:
|
|
return True
|
|
else:
|
|
return False
|
|
|
|
def _checkInstallStatus(self, plugin_id):
|
|
plugin_registry = PluginRegistry.getInstance()
|
|
|
|
# If plugin is registered, it's installed:
|
|
if plugin_id in plugin_registry._plugins:
|
|
return "installed"
|
|
else:
|
|
return "uninstalled"
|
|
|
|
def _checkEnabled(self, id):
|
|
plugin_registry = PluginRegistry.getInstance()
|
|
metadata = plugin_registry.getMetaData(id)
|
|
# if metadata != {}:
|
|
# if id in self._newly_installed_plugin_ids:
|
|
# return False # We already updated this plugin.
|
|
# current_version = Version(metadata["plugin"]["version"])
|
|
# new_version = Version(version)
|
|
# if new_version > current_version:
|
|
# return True
|
|
return False
|
|
|
|
def _onRequestFinished(self, reply):
|
|
reply_url = reply.url().toString()
|
|
if reply.error() == QNetworkReply.TimeoutError:
|
|
Logger.log("w", "Got a timeout.")
|
|
# Reset everything.
|
|
self.setDownloadProgress(0)
|
|
self.setIsDownloading(False)
|
|
if self._download_plugin_reply:
|
|
self._download_plugin_reply.downloadProgress.disconnect(self._onDownloadPluginProgress)
|
|
self._download_plugin_reply.abort()
|
|
self._download_plugin_reply = None
|
|
return
|
|
elif reply.error() == QNetworkReply.HostNotFoundError:
|
|
Logger.log("w", "Unable to reach server.")
|
|
return
|
|
|
|
if reply.operation() == QNetworkAccessManager.GetOperation:
|
|
if reply_url == self._api_url + "plugins":
|
|
try:
|
|
json_data = json.loads(bytes(reply.readAll()).decode("utf-8"))
|
|
self._plugins_metadata = json_data
|
|
self.pluginsMetadataChanged.emit()
|
|
except json.decoder.JSONDecodeError:
|
|
Logger.log("w", "Received an invalid print job state message: Not valid JSON.")
|
|
return
|
|
else:
|
|
# Ignore any operation that is not a get operation
|
|
pass
|
|
|
|
def _onNetworkAccesibleChanged(self, accessible):
|
|
if accessible == 0:
|
|
self.setDownloadProgress(0)
|
|
self.setIsDownloading(False)
|
|
if self._download_plugin_reply:
|
|
self._download_plugin_reply.downloadProgress.disconnect(self._onDownloadPluginProgress)
|
|
self._download_plugin_reply.abort()
|
|
self._download_plugin_reply = None
|
|
|
|
def _createNetworkManager(self):
|
|
if self._network_manager:
|
|
self._network_manager.finished.disconnect(self._onRequestFinished)
|
|
self._network_manager.networkAccessibleChanged.disconnect(self._onNetworkAccesibleChanged)
|
|
|
|
self._network_manager = QNetworkAccessManager()
|
|
self._network_manager.finished.connect(self._onRequestFinished)
|
|
self._network_manager.networkAccessibleChanged.connect(self._onNetworkAccesibleChanged)
|