Merge pull request #3 from Ultimaker/feature_manual_instances

Add support for manual instances

NetworkPrinterOutputDevicePlugin.py

@@ -5,8 +5,13 @@ from zeroconf import Zeroconf, ServiceBrowser, ServiceStateChange, ServiceInfo
 from UM.Logger import Logger
 from UM.Signal import Signal, signalemitter
 from UM.Application import Application
+from UM.Preferences import Preferences
+
+from PyQt5.QtNetwork import QNetworkRequest, QNetworkAccessManager, QNetworkReply
+from PyQt5.QtCore import QUrl
 
 import time
+import json
 
 ##      This plugin handles the connection detection & creation of output device objects for the UM3 printer.
 #       Zero-Conf is used to detect printers, which are saved in a dict.
@@ -19,6 +24,12 @@ class NetworkPrinterOutputDevicePlugin(OutputDevicePlugin):
         self._browser = None
         self._printers = {}
 
+        self._api_version = "1"
+        self._api_prefix = "/api/v" + self._api_version + "/"
+
+        self._network_manager = QNetworkAccessManager()
+        self._network_manager.finished.connect(self._onNetworkRequestFinished)
+
         # List of old printer names. This is used to ensure that a refresh of zeroconf does not needlessly forces
         # authentication requests.
         self._old_printers = []
@@ -28,6 +39,11 @@ class NetworkPrinterOutputDevicePlugin(OutputDevicePlugin):
         self.removePrinterSignal.connect(self.removePrinter)
         Application.getInstance().globalContainerStackChanged.connect(self.reCheckConnections)
 
+        # Get list of manual printers from preferences
+        self._preferences = Preferences.getInstance()
+        self._preferences.addPreference("um3networkprinting/manual_instances", "") #  A comma-separated list of ip adresses or hostnames
+        self._manual_instances = self._preferences.getValue("um3networkprinting/manual_instances").split(",")
+
     addPrinterSignal = Signal()
     removePrinterSignal = Signal()
     printerListChanged = Signal()
@@ -49,6 +65,62 @@ class NetworkPrinterOutputDevicePlugin(OutputDevicePlugin):
         self._zero_conf = Zeroconf()
         self._browser = ServiceBrowser(self._zero_conf, u'_ultimaker._tcp.local.', [self._onServiceChanged])
 
+        # Look for manual instances from preference
+        for address in self._manual_instances:
+            if address:
+                self.addManualPrinter(address)
+
+    def addManualPrinter(self, address):
+        if address not in self._manual_instances:
+            self._manual_instances.append(address)
+            self._preferences.setValue("um3networkprinting/manual_instances", ",".join(self._manual_instances))
+
+        name = address
+        instance_name = "manual:%s" % address
+        properties = { b"name": name.encode("utf-8"), b"manual": b"true", b"incomplete": b"true" }
+
+        if instance_name not in self._printers:
+            # Add a preliminary printer instance
+            self.addPrinter(instance_name, address, properties)
+
+        self.checkManualPrinter(address)
+
+    def removeManualPrinter(self, key, address = None):
+        if key in self._printers:
+            if not address:
+                address = self._printers[key].ipAddress
+            self.removePrinter(key)
+
+        if address in self._manual_instances:
+            self._manual_instances.remove(address)
+            self._preferences.setValue("um3networkprinting/manual_instances", ",".join(self._manual_instances))
+
+    def checkManualPrinter(self, address):
+        # Check if a printer exists at this address
+        # If a printer responds, it will replace the preliminary printer created above
+        url = QUrl("http://" + address + self._api_prefix + "system")
+        name_request = QNetworkRequest(url)
+        self._network_manager.get(name_request)
+
+    ##  Handler for all requests that have finished.
+    def _onNetworkRequestFinished(self, reply):
+        reply_url = reply.url().toString()
+        status_code = reply.attribute(QNetworkRequest.HttpStatusCodeAttribute)
+
+        if reply.operation() == QNetworkAccessManager.GetOperation:
+            if "system" in reply_url:  # Name returned from printer.
+                if status_code == 200:
+                    system_info = json.loads(bytes(reply.readAll()).decode("utf-8"))
+                    address = reply.url().host()
+                    name = ("%s (%s)" % (system_info["name"], address))
+
+                    instance_name = "manual:%s" % address
+                    properties = { b"name": name.encode("utf-8"), b"firmware_version": system_info["firmware"].encode("utf-8"), b"manual": b"true" }
+                    if instance_name in self._printers:
+                        # Only replace the printer if it is still in the list of (manual) printers
+                        self.removePrinter(instance_name)
+                        self.addPrinter(instance_name, address, properties)
+
     ##  Stop looking for devices on network.
     def stop(self):
         if self._zero_conf is not None:
@@ -72,7 +144,7 @@ class NetworkPrinterOutputDevicePlugin(OutputDevicePlugin):
 
     ##  Because the model needs to be created in the same thread as the QMLEngine, we use a signal.
     def addPrinter(self, name, address, properties):
-        printer = NetworkPrinterOutputDevice.NetworkPrinterOutputDevice(name, address, properties)
+        printer = NetworkPrinterOutputDevice.NetworkPrinterOutputDevice(name, address, properties, self._api_prefix)
         self._printers[printer.getKey()] = printer
         global_container_stack = Application.getInstance().getGlobalContainerStack()
         if global_container_stack and printer.getKey() == global_container_stack.getMetaDataEntry("um_network_key"):