Printer status special character support

src/qz/printer/info/NativePrinterMap.java

@@ -2,9 +2,11 @@
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import qz.printer.PrintServiceMatcher;
 import qz.utils.SystemUtilities;
 
 import javax.print.PrintService;
+import javax.print.attribute.standard.PrinterName;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
@@ -29,15 +31,15 @@ public static NativePrinterMap getInstance() {
         return instance;
     }
 
-    public String getPrinterId(String description) {
+    public String lookupPrinterId(String description) {
         for(Map.Entry<String,NativePrinter> entry : entrySet()) {
             NativePrinter info = entry.getValue();
-            if (info.getDescription().equals(description)) {
+            if (description.equals(info.getPrintService().value().getName())) {
                 return entry.getKey();
             }
         }
         log.warn("Could not find printerId for " + description);
-        return description;
+        return null;
     }
 
     public ArrayList<PrintService> findMissing(PrintService[] services) {

src/qz/printer/status/CupsStatusHandler.java

@@ -1,8 +1,11 @@
 package qz.printer.status;
 
+import org.apache.commons.lang3.StringEscapeUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.eclipse.jetty.server.Request;
 import org.eclipse.jetty.server.handler.AbstractHandler;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import javax.servlet.ServletException;
 import javax.servlet.http.HttpServletRequest;
@@ -12,6 +15,7 @@
 import javax.xml.stream.XMLStreamConstants;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.events.Characters;
+import javax.xml.stream.events.EndElement;
 import javax.xml.stream.events.StartElement;
 import javax.xml.stream.events.XMLEvent;
 import java.io.IOException;
@@ -20,6 +24,7 @@
  * Created by kyle on 4/27/17.
  */
 public class CupsStatusHandler extends AbstractHandler {
+    private static final Logger log = LoggerFactory.getLogger(CupsStatusHandler.class);
 
     private static String lastGuid;
 
@@ -48,18 +53,25 @@ private void parseXML(XMLEventReader eventReader) throws XMLStreamException {
                 case XMLStreamConstants.START_ELEMENT:
                     StartElement startElement = event.asStartElement();
                     String qName = startElement.getName().getLocalPart();
-                    if ("description".equalsIgnoreCase(qName)) {
+                    //This is the description of the rss message, NOT the description of the printer
+                    if ("description".equalsIgnoreCase(startElement.getName().getLocalPart())) {
                         isDescription = true;
+                        description = "";
                     }
                     if ("guid".equalsIgnoreCase(qName)) {
                         isGuid = true;
                     }
                     break;
+                case XMLStreamConstants.END_ELEMENT:
+                    EndElement endElement = event.asEndElement();
+                    if ("description".equalsIgnoreCase(endElement.getName().getLocalPart())) {
+                        isDescription = false;
+                    }
+                    break;
                 case XMLStreamConstants.CHARACTERS:
                     Characters characters = event.asCharacters();
                     if (isDescription) {
-                        description = characters.getData();
-                        isDescription = false;
+                        description += characters.getData();
                     }
                     if (isGuid) {
                         String guid = characters.getData();
@@ -73,6 +85,7 @@ private void parseXML(XMLEventReader eventReader) throws XMLStreamException {
                         } else {
                             String printerName = StringUtils.substringBeforeLast(description, "\"");
                             printerName = StringUtils.substringAfter(printerName, "\"");
+                            printerName = StringEscapeUtils.unescapeXml(printerName);
                             if (!printerName.isEmpty() && StatusMonitor.isListeningTo(printerName)) {
                                 StatusMonitor.statusChanged(CupsUtils.getStatuses(printerName));
                             }

src/qz/printer/status/CupsUtils.java

@@ -1,17 +1,13 @@
 package qz.printer.status;
 
 import com.sun.jna.Pointer;
-import org.codehaus.jettison.json.JSONArray;
 import org.eclipse.jetty.util.URIUtil;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import qz.printer.status.Cups.IPP;
-import qz.utils.PrintingUtilities;
-import qz.utils.ShellUtilities;
 
 import java.net.URI;
 import java.util.ArrayList;
-import java.util.HashMap;
 
 /**
  * Created by kyle on 5/17/17.

src/qz/printer/status/PrinterStatus.java

@@ -1,8 +1,11 @@
 package qz.printer.status;
 
+import qz.printer.info.NativePrinterMap;
+
 import java.util.Locale;
 
 import static qz.printer.status.PrinterStatusType.*;
+import static qz.utils.SystemUtilities.isMac;
 
 /**
  * Created by kyle on 7/7/17.
@@ -11,6 +14,7 @@ public class PrinterStatus {
 
     public PrinterStatusType type;
     public String issuingPrinterName;
+    public String issuingPrinterDescription;
     public String cupsString;
 
 
@@ -21,6 +25,7 @@ public PrinterStatus(PrinterStatusType type, String issuingPrinterName) {
     public PrinterStatus(PrinterStatusType type, String issuingPrinterName, String cupsString) {
         this.type = type;
         this.issuingPrinterName = issuingPrinterName;
+        this.issuingPrinterDescription = issuingPrinterName;
         this.cupsString = cupsString;
     }
 
@@ -54,7 +59,7 @@ public static PrinterStatus getFromCupsString(String reason, String issuingPrint
     }
 
     public String toString() {
-        String returnString = type.getName() + ": Level " + type.getSeverity() + ", StatusCode " + type.getCode() + ", From " + issuingPrinterName;
+        String returnString = type.getName() + ": Level " + type.getSeverity() + ", StatusCode " + type.getCode() + ", From " + issuingPrinterDescription;
         if (!cupsString.isEmpty()) {
             returnString += ", CUPS string " + cupsString;
         }

src/qz/printer/status/StatusMonitor.java

@@ -7,12 +7,17 @@
 import org.eclipse.jetty.util.MultiMap;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import qz.printer.PrintServiceMatcher;
+import qz.printer.info.NativePrinter;
 import qz.printer.info.NativePrinterMap;
 import qz.utils.SystemUtilities;
 import qz.ws.SocketConnection;
 
+import javax.print.PrintService;
+import javax.print.PrintServiceLookup;
 import java.util.*;
 
+import static qz.utils.SystemUtilities.isMac;
 import static qz.utils.SystemUtilities.isWindows;
 
 /**
@@ -40,7 +45,7 @@ public synchronized static boolean launchNotificationThreads() {
                 notificationThread.start();
             }
         }
-        //cull threads that don't have associated printers
+        //interrupt threads that don't have associated printers
         for(Map.Entry<String,Thread> e : notificationThreadCollection.entrySet()) {
             if (!printerNameList.contains(e.getKey())) {
                 e.getValue().interrupt();
@@ -80,20 +85,28 @@ public synchronized static boolean startListening(SocketConnection connection, J
                 clientPrinterConnections.add(ALL_PRINTERS, connection);
             }
         } else {  //listen to specific printer(s)
-            for(int i = 0; i < printerNames.length(); i++) {
+            for (int i = 0; i < printerNames.length(); i++) {
                 String printerName = printerNames.getString(i);
                 if (SystemUtilities.isMac()) {
-                    // Since 2.0: Mac printers use Description; Find by CUPS ID
-                    printerName = NativePrinterMap.getInstance().getPrinterId(printerName);
+                    // Since 2.0: Mac printers use descriptions as printer names; Find CUPS ID by Description
+                    printerName = NativePrinterMap.getInstance().lookupPrinterId(printerName);
+                    // Handle edge-case where printer was recently renamed/added
+                    if (printerName == null) {
+                        // Call PrintServiceLookup.lookupPrintServices again
+                        PrintServiceMatcher.getNativePrinterList();
+
+                        // FIXME: How do we know we got description from the command line yet?
+                        printerName = NativePrinterMap.getInstance().lookupPrinterId(printerNames.getString(i));
+
+                    }
                 }
                 if (printerName == null || "".equals(printerName)) {
                     throw new IllegalArgumentException();
                 }
-
-                if (!clientPrinterConnections.containsKey(printerNames.getString(i))) {
-                    clientPrinterConnections.add(printerNames.getString(i), connection);
-                } else if (!clientPrinterConnections.getValues(printerNames.getString(i)).contains(connection)) {
-                    clientPrinterConnections.add(printerNames.getString(i), connection);
+                if (!clientPrinterConnections.containsKey(printerName)) {
+                    clientPrinterConnections.add(printerName, connection);
+                } else if (!clientPrinterConnections.getValues(printerName).contains(connection)) {
+                    clientPrinterConnections.add(printerName, connection);
                 }
             }
         }
@@ -165,6 +178,14 @@ public synchronized static boolean isListeningTo(String PrinterName) {
     public synchronized static void statusChanged(PrinterStatus[] statuses) {
         HashSet<SocketConnection> connections = new HashSet<>();
         for(PrinterStatus ps : statuses) {
+            if (isMac()) {
+                //On MacOS the description is used as the printer name
+                NativePrinter nativePrinter = PrintServiceMatcher.matchPrinter(ps.issuingPrinterName);
+                if (nativePrinter != null) {
+                    //If the printer description is missing from the map (usually because the printer was deleted), use the cups id instead
+                    ps.issuingPrinterDescription = nativePrinter.getPrintService().value().getName();
+                }
+            }
             if (clientPrinterConnections.containsKey(ps.issuingPrinterName)) {
                 connections.addAll(clientPrinterConnections.get(ps.issuingPrinterName));
             }

src/qz/printer/status/StatusSession.java

@@ -21,7 +21,7 @@ public void statusChanged (PrinterStatus printerStatus) {
 
     private StreamEvent createStatusStream(PrinterStatus status) {
         return new StreamEvent(StreamEvent.Stream.PRINTER, StreamEvent.Type.ACTION)
-                .withData("printerName", status.issuingPrinterName)
+                .withData("printerName", status.issuingPrinterDescription)
                 .withData("statusCode", status.type.getCode())
                 .withData("statusText", status.type.getName())
                 .withData("severity", status.type.getSeverity())