Bring forward improvements made on 2.1 branch (qzind#936)

* bring forward improvements made on 2.1 branch: - printer search - idle action controls - jetty upgrade - log4j upgrade Co-authored-by: Tres Finocchiaro <[email protected]>
zerooito · Mar 23, 2022 · 5a1a372 · 5a1a372
1 parent eb57b8c
commit 5a1a372
Show file tree

Hide file tree

Showing 37 changed files with 189 additions and 78 deletions.
diff --git a/lib/logging/log4j-api-2.17.1.jar → lib/logging/log4j-api-2.17.2.jar b/lib/logging/log4j-api-2.17.1.jar → lib/logging/log4j-api-2.17.2.jar
diff --git a/lib/logging/log4j-core-2.17.1.jar → lib/logging/log4j-core-2.17.2.jar b/lib/logging/log4j-core-2.17.1.jar → lib/logging/log4j-core-2.17.2.jar
diff --git a/lib/websocket/javax-websocket-server-impl-9.4.21.v20190926.jar b/lib/websocket/javax-websocket-server-impl-9.4.21.v20190926.jar
diff --git a/lib/websocket/javax-websocket-server-impl-9.4.45.v20220203.jar b/lib/websocket/javax-websocket-server-impl-9.4.45.v20220203.jar
diff --git a/lib/websocket/jetty-client-9.4.21.v20190926.jar b/lib/websocket/jetty-client-9.4.21.v20190926.jar
diff --git a/lib/websocket/jetty-client-9.4.45.v20220203.jar b/lib/websocket/jetty-client-9.4.45.v20220203.jar
diff --git a/lib/websocket/jetty-http-9.4.21.v20190926.jar b/lib/websocket/jetty-http-9.4.21.v20190926.jar
diff --git a/lib/websocket/jetty-http-9.4.45.v20220203.jar b/lib/websocket/jetty-http-9.4.45.v20220203.jar
diff --git a/lib/websocket/jetty-io-9.4.21.v20190926.jar b/lib/websocket/jetty-io-9.4.21.v20190926.jar
diff --git a/lib/websocket/jetty-io-9.4.45.v20220203.jar b/lib/websocket/jetty-io-9.4.45.v20220203.jar
diff --git a/lib/websocket/jetty-security-9.4.21.v20190926.jar b/lib/websocket/jetty-security-9.4.21.v20190926.jar
diff --git a/lib/websocket/jetty-security-9.4.45.v20220203.jar b/lib/websocket/jetty-security-9.4.45.v20220203.jar
diff --git a/lib/websocket/jetty-server-9.4.21.v20190926.jar b/lib/websocket/jetty-server-9.4.21.v20190926.jar
diff --git a/lib/websocket/jetty-server-9.4.45.v20220203.jar b/lib/websocket/jetty-server-9.4.45.v20220203.jar
diff --git a/lib/websocket/jetty-servlet-9.4.21.v20190926.jar b/lib/websocket/jetty-servlet-9.4.21.v20190926.jar
diff --git a/lib/websocket/jetty-servlet-9.4.45.v20220203.jar b/lib/websocket/jetty-servlet-9.4.45.v20220203.jar
diff --git a/lib/websocket/jetty-util-9.4.21.v20190926.jar b/lib/websocket/jetty-util-9.4.21.v20190926.jar
diff --git a/lib/websocket/jetty-util-9.4.45.v20220203.jar b/lib/websocket/jetty-util-9.4.45.v20220203.jar
diff --git a/...socket/websocket-api-9.4.21.v20190926.jar → ...socket/websocket-api-9.4.45.v20220203.jar b/...socket/websocket-api-9.4.21.v20190926.jar → ...socket/websocket-api-9.4.45.v20220203.jar
diff --git a/lib/websocket/websocket-client-9.4.21.v20190926.jar b/lib/websocket/websocket-client-9.4.21.v20190926.jar
diff --git a/lib/websocket/websocket-client-9.4.45.v20220203.jar b/lib/websocket/websocket-client-9.4.45.v20220203.jar
diff --git a/lib/websocket/websocket-common-9.4.21.v20190926.jar b/lib/websocket/websocket-common-9.4.21.v20190926.jar
diff --git a/lib/websocket/websocket-common-9.4.45.v20220203.jar b/lib/websocket/websocket-common-9.4.45.v20220203.jar
diff --git a/lib/websocket/websocket-server-9.4.21.v20190926.jar b/lib/websocket/websocket-server-9.4.21.v20190926.jar
diff --git a/lib/websocket/websocket-server-9.4.45.v20220203.jar b/lib/websocket/websocket-server-9.4.45.v20220203.jar
diff --git a/...et/websocket-servlet-9.4.21.v20190926.jar → ...et/websocket-servlet-9.4.45.v20220203.jar b/...et/websocket-servlet-9.4.21.v20190926.jar → ...et/websocket-servlet-9.4.45.v20220203.jar
diff --git a/src/qz/common/Constants.java b/src/qz/common/Constants.java
@@ -61,6 +61,8 @@ public class Constants {
     public static final String PREFS_HEADLESS = "tray.headless";
     public static final String PREFS_MONOCLE = "tray.monocle";
     public static final String PREFS_STRICT_MODE = "tray.strictmode";
+    public static final String PREFS_IDLE_PRINTERS = "tray.idle.printers";
+    public static final String PREFS_IDLE_JFX = "tray.idle.javafx";
 
     public static final String ALLOW_SITES_TEXT = "Permanently allowed \"%s\" to access local resources";
     public static final String BLOCK_SITES_TEXT = "Permanently blocked \"%s\" from accessing local resources";

diff --git a/src/qz/common/TrayManager.java b/src/qz/common/TrayManager.java
@@ -11,9 +11,10 @@
 package qz.common;
 
 import com.github.zafarkhaja.semver.Version;
-import org.eclipse.jetty.server.Server;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.eclipse.jetty.server.Server;
+import qz.App;
 import qz.auth.Certificate;
 import qz.auth.RequestState;
 import qz.installer.shortcut.ShortcutCreator;
@@ -34,6 +35,7 @@
 import java.io.File;
 import java.io.IOException;
 import java.util.ArrayList;
+import java.util.TimerTask;
 import java.util.concurrent.TimeUnit;
 
 /**
@@ -76,7 +78,7 @@ public class TrayManager {
     private Thread reloadThread;
 
     // Actions to run if idle after startup
-    private ArrayList<Timer> idleTimers;
+    private java.util.Timer idleTimer = new java.util.Timer();
 
     public TrayManager() {
         this(false);
@@ -91,10 +93,10 @@ public TrayManager(boolean isHeadless) {
         prefs = new PropertyHelper(FileUtilities.USER_DIR + File.separator + Constants.PREFS_FILE + ".properties");
 
         // Set strict certificate mode preference
-        Certificate.setTrustBuiltIn(!prefs.getBoolean(Constants.PREFS_STRICT_MODE, false));
+        Certificate.setTrustBuiltIn(!getPref(Constants.PREFS_STRICT_MODE, false));
 
         //headless if turned on by user or unsupported by environment
-        headless = isHeadless || prefs.getBoolean(Constants.PREFS_HEADLESS, false) || GraphicsEnvironment.isHeadless();
+        headless = isHeadless || getPref(Constants.PREFS_HEADLESS, false) || GraphicsEnvironment.isHeadless();
         if (headless) {
             log.info("Running in headless mode");
         }
@@ -198,23 +200,26 @@ public TrayManager(boolean isHeadless) {
         }
 
         // Initialize idle actions
-        idleTimers = new ArrayList<>();
-
-        // Slow to find printers the first time if a lot of printers are installed
-        performIfIdle((int)TimeUnit.SECONDS.toMillis(10), evt -> {
-            log.debug("IDLE: Performing first run of find printers");
-            PrintServiceMatcher.getNativePrinterList(false, true);
-        });
         // Slow to start JavaFX the first time
-        performIfIdle((int)TimeUnit.SECONDS.toMillis(60), evt -> {
-            log.debug("IDLE: Starting up JFX for HTML printing");
-            try {
-                WebApp.initialize();
-            }
-            catch(IOException e) {
-                log.error("Idle runner failed to preemptively start JavaFX service");
-            }
-        });
+        if (getPref(Constants.PREFS_IDLE_JFX, true)) {
+            performIfIdle((int)TimeUnit.SECONDS.toMillis(60), evt -> {
+                log.debug("IDLE: Starting up JFX for HTML printing");
+                try {
+                    WebApp.initialize();
+                }
+                catch(IOException e) {
+                    log.error("Idle runner failed to preemptively start JavaFX service");
+                }
+            });
+        }
+        // Slow to find printers the first time if a lot of printers are installed
+        // Must run after JavaFX per https://github.com/qzind/tray/issues/924
+        if (getPref(Constants.PREFS_IDLE_PRINTERS, true)) {
+            performIfIdle((int)TimeUnit.SECONDS.toMillis(120), evt -> {
+                log.debug("IDLE: Performing first run of find printers");
+                PrintServiceMatcher.getNativePrinterList(false, true);
+            });
+        }
     }
 
     /**
@@ -268,14 +273,14 @@ private void addMenuItems() {
         JCheckBoxMenuItem notificationsItem = new JCheckBoxMenuItem("Show all notifications");
         notificationsItem.setToolTipText("Shows all connect/disconnect messages, useful for debugging purposes");
         notificationsItem.setMnemonic(KeyEvent.VK_S);
-        notificationsItem.setState(prefs.getBoolean(Constants.PREFS_NOTIFICATIONS, false));
+        notificationsItem.setState(getPref(Constants.PREFS_NOTIFICATIONS, false));
         notificationsItem.addActionListener(notificationsListener);
         diagnosticMenu.add(notificationsItem);
 
         JCheckBoxMenuItem monocleItem = new JCheckBoxMenuItem("Use Monocle for HTML");
         monocleItem.setToolTipText("Use monocle platform for HTML printing (restart required)");
         monocleItem.setMnemonic(KeyEvent.VK_U);
-        monocleItem.setState(prefs.getBoolean(Constants.PREFS_MONOCLE, true));
+        monocleItem.setState(getPref(Constants.PREFS_MONOCLE, true));
         if(!SystemUtilities.hasMonocle()) {
             log.warn("Monocle engine was not detected");
             monocleItem.setEnabled(false);
@@ -458,7 +463,7 @@ public void actionPerformed(ActionEvent e) {
 
     private final ActionListener exitListener = new ActionListener() {
         public void actionPerformed(ActionEvent e) {
-            boolean showAllNotifications = prefs.getBoolean(Constants.PREFS_NOTIFICATIONS, false);
+            boolean showAllNotifications = getPref(Constants.PREFS_NOTIFICATIONS, false);
             if (!showAllNotifications || confirmDialog.prompt("Exit " + name + "?")) { exit(0); }
         }
     };
@@ -607,7 +612,7 @@ private void displayMessage(final String caption, final String text, final TrayI
         if (!headless) {
             if (tray != null) {
                 SwingUtilities.invokeLater(() -> {
-                    boolean showAllNotifications = prefs.getBoolean(Constants.PREFS_NOTIFICATIONS, false);
+                    boolean showAllNotifications = getPref(Constants.PREFS_NOTIFICATIONS, false);
                     if (showAllNotifications || level != TrayIcon.MessageType.INFO) {
                         tray.displayMessage(caption, text, level);
                     }
@@ -627,29 +632,38 @@ public void singleInstanceCheck(java.util.List<Integer> insecurePorts, Integer i
     }
 
     public boolean isMonoclePreferred() {
-        return prefs.getBoolean(Constants.PREFS_MONOCLE, true);
+        return getPref(Constants.PREFS_MONOCLE, true);
     }
 
     public boolean isHeadless() {
         return headless;
     }
 
-    private void performIfIdle(int idleQualifier, ActionListener performer) {
-        Timer timer = new Timer(idleQualifier, evt -> {
-            performer.actionPerformed(evt);
-            idleTimers.remove(evt.getSource());
-        });
-        timer.setRepeats(false);
-        timer.start();
+    /**
+     * Get boolean user pref: Searching "user", "app" and <code>System.getProperty(...)</code>.
+     */
+    private boolean getPref(String name, boolean defaultVal) {
+        return "true".equalsIgnoreCase(PrefsSearch.get(prefs, App.getTrayProperties(), name, defaultVal + ""));
+    }
 
-        idleTimers.add(timer);
+    private void performIfIdle(int idleQualifier, ActionListener performer) {
+        if (idleTimer != null) {
+            idleTimer.schedule(new TimerTask() {
+                @Override
+                public void run() {
+                    performer.actionPerformed(null);
+                }
+            }, idleQualifier);
+        } else {
+            log.warn("Idle actions have already been cleared due to activity, task not scheduled.");
+        }
     }
 
     public void voidIdleActions() {
-        if (idleTimers.size() > 0) {
+        if (idleTimer != null) {
             log.trace("Not idle, stopping any actions that haven't ran yet");
-            idleTimers.forEach(Timer::stop);
-            idleTimers.clear();
+            idleTimer.cancel();
+            idleTimer = null;
         }
     }
 

diff --git a/src/qz/printer/PrintServiceMatcher.java b/src/qz/printer/PrintServiceMatcher.java
@@ -10,11 +10,11 @@
 
 package qz.printer;
 
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.codehaus.jettison.json.JSONArray;
 import org.codehaus.jettison.json.JSONException;
 import org.codehaus.jettison.json.JSONObject;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
 import qz.printer.info.NativePrinter;
 import qz.printer.info.NativePrinterMap;
 import qz.utils.SystemUtilities;
@@ -34,8 +34,8 @@ public class PrintServiceMatcher {
     public static NativePrinterMap getNativePrinterList(boolean silent, boolean withAttributes) {
         NativePrinterMap printers = NativePrinterMap.getInstance();
         printers.putAll(PrintServiceLookup.lookupPrintServices(null, null));
-        if(!silent) log.debug("Found {} printers", printers.size());
-        if(withAttributes) printers.values().forEach(NativePrinter::getDriverAttributes);
+        if (withAttributes) { printers.values().forEach(NativePrinter::getDriverAttributes); }
+        if (!silent) { log.debug("Found {} printers", printers.size()); }
         return printers;
     }
 
@@ -47,6 +47,17 @@ public static NativePrinterMap getNativePrinterList() {
         return getNativePrinterList(false);
     }
 
+    public static NativePrinter getDefaultPrinter() {
+        PrintService defaultService = PrintServiceLookup.lookupDefaultPrintService();
+
+        NativePrinterMap printers = NativePrinterMap.getInstance();
+        if (!printers.contains(defaultService)) {
+            printers.putAll(defaultService);
+        }
+
+        return printers.get(defaultService.getName());
+    }
+
     public static String findPrinterName(String query) throws JSONException {
         NativePrinter printer = PrintServiceMatcher.matchPrinter(query);
 
@@ -67,7 +78,13 @@ public static NativePrinter matchPrinter(String printerSearch, boolean silent) {
         NativePrinter begins = null;
         NativePrinter partial = null;
 
-        if(!silent) log.debug("Searching for PrintService matching {}", printerSearch);
+        if (!silent) { log.debug("Searching for PrintService matching {}", printerSearch); }
+
+        NativePrinter defaultPrinter = getDefaultPrinter();
+        if (printerSearch.equals(defaultPrinter.getName())) {
+            if (!silent) { log.debug("Matched default printer, skipping further search"); }
+            return defaultPrinter;
+        }
 
         printerSearch = printerSearch.toLowerCase(Locale.ENGLISH);
 
@@ -132,26 +149,35 @@ public static NativePrinter matchPrinter(String printerSearch) {
         return matchPrinter(printerSearch, false);
     }
 
-    public static JSONArray getPrintersJSON() throws JSONException {
+    public static JSONArray getPrintersJSON(boolean includeDetails) throws JSONException {
         JSONArray list = new JSONArray();
 
         PrintService defaultService = PrintServiceLookup.lookupDefaultPrintService();
 
+        boolean mediaTrayCrawled = false;
+
         for(NativePrinter printer : getNativePrinterList().values()) {
             PrintService ps = printer.getPrintService().value();
             JSONObject jsonService = new JSONObject();
             jsonService.put("name", ps.getName());
-            jsonService.put("driver", printer.getDriver().value());
-            jsonService.put("connection", printer.getConnection());
-            jsonService.put("default", ps == defaultService);
 
-            for(Media m : (Media[])ps.getSupportedAttributeValues(Media.class, null, null)) {
-                if (m instanceof MediaTray) { jsonService.accumulate("trays", m.toString()); }
-            }
+            if (includeDetails) {
+                jsonService.put("driver", printer.getDriver().value());
+                jsonService.put("connection", printer.getConnection());
+                jsonService.put("default", ps == defaultService);
 
-            PrinterResolution res = printer.getResolution().value();
-            int density = -1; if (res != null) { density = res.getFeedResolution(ResolutionSyntax.DPI); }
-            jsonService.put("density", density);
+                if (!mediaTrayCrawled) {
+                    log.info("Gathering printer MediaTray information...");
+                    mediaTrayCrawled = true;
+                }
+                for(Media m : (Media[])ps.getSupportedAttributeValues(Media.class, null, null)) {
+                    if (m instanceof MediaTray) { jsonService.accumulate("trays", m.toString()); }
+                }
+
+                PrinterResolution res = printer.getResolution().value();
+                int density = -1; if (res != null) { density = res.getFeedResolution(ResolutionSyntax.DPI); }
+                jsonService.put("density", density);
+            }
 
             list.put(jsonService);
         }

diff --git a/src/qz/printer/action/WebApp.java b/src/qz/printer/action/WebApp.java
@@ -25,7 +25,6 @@
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 import qz.common.Constants;
-import qz.utils.LibUtilities;
 import qz.utils.SystemUtilities;
 import qz.ws.PrintSocketServer;
 
@@ -203,6 +202,7 @@ public static synchronized void initialize() throws IOException {
                     log.trace("Running a test snapshot to size the stage...");
                     try {
                         raster(new WebAppModel("<h1>startup</h1>", true, 0, 0, true, 2));
+                        log.trace("JFX initialized successfully");
                     }
                     catch(Throwable t) {
                         throw new IOException(t);

diff --git a/src/qz/printer/info/CupsPrinterMap.java b/src/qz/printer/info/CupsPrinterMap.java
@@ -18,9 +18,9 @@ public class CupsPrinterMap extends NativePrinterMap {
     private static final Logger log = LogManager.getLogger(CupsPrinterMap.class);
     private Map<NativePrinter, List<PrinterResolution>> resolutionMap = new HashMap<>();
 
-    public synchronized NativePrinterMap putAll(PrintService[] services) {
+    public synchronized NativePrinterMap putAll(PrintService... services) {
         ArrayList<PrintService> missing = findMissing(services);
-        if (missing.isEmpty()) return this;
+        if (missing.isEmpty()) { return this; }
 
         String output = "\n" + ShellUtilities.executeRaw(new String[] {"lpstat", "-l", "-p"});
         String[] devices = output.split("[\\r\\n]printer ");

diff --git a/src/qz/printer/info/NativePrinter.java b/src/qz/printer/info/NativePrinter.java
@@ -5,6 +5,7 @@
 import qz.utils.SystemUtilities;
 
 import javax.print.PrintService;
+import javax.print.attribute.standard.Media;
 import javax.print.attribute.standard.PrinterName;
 import javax.print.attribute.standard.PrinterResolution;
 import java.util.Arrays;
@@ -144,15 +145,6 @@ public PrinterProperty<PrintService> getPrintService() {
     }
 
     public void setPrintService(PrintService printService) {
-        // Fetch resolution, if available
-        try {
-            Object resolution = printService.getDefaultAttributeValue(PrinterResolution.class);
-            if (resolution != null) {
-                this.resolution.set((PrinterResolution)resolution);
-            }
-        } catch(IllegalArgumentException e) {
-            log.warn("Unable to obtain PrinterResolution from {}", printService.getName(), e);
-        }
         this.printService.set(printService);
     }
 
@@ -166,8 +158,18 @@ public void setResolution(PrinterResolution resolution) {
 
     public PrinterProperty<PrinterResolution> getResolution() {
         if (!resolution.isSet()) {
-            getDriverAttributes(this);
+            // Fetch resolution, if available
+            try {
+                Object resolution = printService.value().getDefaultAttributeValue(PrinterResolution.class);
+                if (resolution != null) {
+                    this.resolution.set((PrinterResolution)resolution);
+                }
+            }
+            catch(IllegalArgumentException e) {
+                log.warn("Unable to obtain PrinterResolution from {}", printService.value().getName(), e);
+            }
         }
+
         return resolution;
     }
 
@@ -187,9 +189,16 @@ public List<PrinterResolution> getResolutions() {
     }
 
     public static void getDriverAttributes(NativePrinter printer) {
+        // First, perform slow JDK operations, see issues #940, #932
+        printer.getPrintService().value().getSupportedAttributeValues(Media.class, null, null); // cached by JDK
+        printer.getResolution();
+
+        // Mark properties as "found" so we don't attempt to gather them again
         printer.driver.set();
         printer.resolution.set();
         printer.connection.set();
+
+        // Gather properties not exposed by the JDK
         NativePrinterMap.getInstance().fillAttributes(printer);
     }
 

diff --git a/src/qz/printer/info/NativePrinterMap.java b/src/qz/printer/info/NativePrinterMap.java
@@ -15,7 +15,8 @@ public abstract class NativePrinterMap extends ConcurrentHashMap<String, NativeP
 
     private static NativePrinterMap instance;
 
-    public abstract NativePrinterMap putAll(PrintService[] services);
+    public abstract NativePrinterMap putAll(PrintService... services);
+
     abstract void fillAttributes(NativePrinter printer);
 
     public static NativePrinterMap getInstance() {

diff --git a/src/qz/printer/info/WindowsPrinterMap.java b/src/qz/printer/info/WindowsPrinterMap.java
@@ -12,10 +12,10 @@
 public class WindowsPrinterMap extends NativePrinterMap {
     private static final Logger log = LogManager.getLogger(WindowsPrinterMap.class);
 
-    public synchronized NativePrinterMap putAll(PrintService[] services) {
-        for (PrintService service : findMissing(services)) {
+    public synchronized NativePrinterMap putAll(PrintService... services) {
+        for(PrintService service : findMissing(services)) {
             String name = service.getName();
-            if(name.equals("PageManager PDF Writer")) {
+            if (name.equals("PageManager PDF Writer")) {
                 log.warn("Printer \"{}\" is blacklisted, removing", name); // Per https://github.com/qzind/tray/issues/599
                 continue;
             }