load properties from manifest + escape html tags + monospace font

Author: lcaouen

core/framework/src/main/java/org/phoebus/framework/preferences/PropertyPreferenceWriter.java

@@ -16,13 +16,15 @@
 import java.io.OutputStream;
 import java.io.OutputStreamWriter;
 import java.io.Writer;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.Enumeration;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Properties;
-import java.util.StringTokenizer;
 import java.util.jar.JarEntry;
 import java.util.jar.JarFile;
+import java.util.jar.Manifest;
 import java.util.prefs.Preferences;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -48,13 +50,13 @@ public static void save(final OutputStream stream) throws Exception
     {
         try
         (
-        	
             final OutputStreamWriter out = new OutputStreamWriter(stream);
         )
         {
             out.append("# Preference settings<br/>\n");
             out.append("# Format:<br/>\n");
             out.append("# the.package.name/key=value<br/>\n");
+            out.append("<div style='color: red; font-weight: bold'># key=value in red are incorrect properties</div><br/>\n");
             listSettings(getAllPropertyKeys(), out, Preferences.userRoot());
             out.append("# End.<br/>\n");
             out.flush();
@@ -76,9 +78,9 @@ private static void formatSetting(Map<String, String> allKeysWithPackages, final
         String keyFound = allKeysWithPackages.get(fullKey);
         boolean bNotFound = keyFound == null ? true : false;
         if (bNotFound) out.append("<div style='color: red; font-weight: bold'>");
-        out.append(fullKey)
+        out.append(escapeHtml(fullKey))
            .append('=')
-           .append(node.get(key, ""))
+           .append(escapeHtml(node.get(key, "")))
            .append("<br/>\n");
         if (bNotFound) out.append("</div>");
     }
@@ -88,13 +90,14 @@ private static Map<String, String> getAllPropertyKeys() throws Exception
         Map<String, String> allKeysWithPackages = new HashMap<>();
 
     	String classpath = System.getProperty("java.class.path");
-        StringTokenizer tokenizer = new StringTokenizer(classpath, System.getProperty("path.separator"));
+        String[] jars = classpath.split(System.getProperty("path.separator"));
 
-        while (tokenizer.hasMoreTokens()) {
-            String path = tokenizer.nextToken();
-            File file = new File(path);
+        if (jars.length == 1) jars = getAllJarFromManifest(jars[0]);
 
-            if (path.endsWith(".jar")) {
+        for (String jarEntry : jars) {
+            File file = new File(jarEntry);
+
+            if (jarEntry.endsWith(".jar")) {
                 try (JarFile jarFile = new JarFile(file)) {
                     Enumeration<JarEntry> entries = jarFile.entries();
 
@@ -111,7 +114,7 @@ private static Map<String, String> getAllPropertyKeys() throws Exception
                         }
                     }
                 } catch (IOException e) {
-                    System.err.println("Error opening JAR : " + path);
+                    System.err.println("Error opening JAR : " + jarEntry);
                     e.printStackTrace();
                 }
             }
@@ -120,44 +123,79 @@ private static Map<String, String> getAllPropertyKeys() throws Exception
         return allKeysWithPackages;
 	}
 
-    private static void parsePropertiesWithPackage(
-            InputStream inputStream,
-            String fileName,
-            Map<String, String> allKeysWithPackages
-        ) {
-            Properties props = new Properties();
-            String packageName = null;
-
-            try (BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream))) {
-                String line;
-                StringBuilder content = new StringBuilder();
-
-                while ((line = reader.readLine()) != null) {
-                    line = line.trim();
-                    if (line.startsWith("#") && line.contains("Package")) {
-                        // Find package name
-                        Pattern pattern = Pattern.compile("#\\s*Package\\s+([^\\s]+)");
-                        Matcher matcher = pattern.matcher(line);
-                        if (matcher.find()) {
-                            packageName = matcher.group(1);
-                        }
-                    } else if (!line.startsWith("#")) {
-                        content.append(line).append("\n");
+    private static String[] getAllJarFromManifest(String jarPath) {
+    	String[] jars = new String[0];
+        File jarFile = new File(jarPath);
+
+        try (JarFile jar = new JarFile(jarFile)) {
+            Manifest manifest = jar.getManifest();
+
+            if (manifest != null) {
+                String classPath = manifest.getMainAttributes().getValue("Class-Path");
+
+                if (classPath != null && !classPath.isEmpty()) {
+                    jars = classPath.split(" ");
+
+                    for (int iJar = 0; iJar < jars.length; iJar++) {
+                        Path fullPath = Paths.get(jarFile.getParent()).resolve(jars[iJar]);
+                    	jars[iJar] = fullPath.toString();
                     }
+                } else {
+                    System.err.println("No Class-Path found in MANIFEST.MF.");
                 }
+            } else {
+                System.err.println("MANIFEST.MF not found in the JAR.");
+            }
+        } catch (IOException e) {
+            System.err.println("Error when reading the jar : " + jarPath);
+            e.printStackTrace();
+        }
+        
+        return jars;
+    }
+    
+    private static void parsePropertiesWithPackage(InputStream inputStream, String fileName, Map<String, String> allKeysWithPackages) {
+        Properties props = new Properties();
+        String packageName = null;
 
-                if (content.length() > 0) {
-                    props.load(new ByteArrayInputStream(content.toString().getBytes()));
-                }
+        try (BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream))) {
+            String line;
+            StringBuilder content = new StringBuilder();
 
-                // properties found
-                for (String key : props.stringPropertyNames()) {
-                    String prefixedKey = (packageName != null) ? packageName + "/" + key : key;
-                    allKeysWithPackages.put(prefixedKey, props.getProperty(key));
+            while ((line = reader.readLine()) != null) {
+                line = line.trim();
+                if (line.startsWith("#") && line.contains("Package")) {
+                    // Find package name
+                    Pattern pattern = Pattern.compile("#\\s*Package\\s+([^\\s]+)");
+                    Matcher matcher = pattern.matcher(line);
+                    if (matcher.find()) {
+                        packageName = matcher.group(1);
+                    }
+                } else if (!line.startsWith("#")) {
+                    content.append(line).append("\n");
                 }
-            } catch (IOException e) {
-                System.err.println("Error when reading file " + fileName);
-                e.printStackTrace();
             }
+
+            if (content.length() > 0) {
+                props.load(new ByteArrayInputStream(content.toString().getBytes()));
+            }
+
+            // properties found
+            for (String key : props.stringPropertyNames()) {
+                String prefixedKey = (packageName != null) ? packageName + "/" + key : key;
+                allKeysWithPackages.put(prefixedKey, props.getProperty(key));
+            }
+        } catch (IOException e) {
+            System.err.println("Error when reading file " + fileName);
+            e.printStackTrace();
         }
+    }
+
+    private static String escapeHtml(String input) {
+        return input.replace("&", "&amp;")
+                   .replace("<", "&lt;")
+                   .replace(">", "&gt;")
+                   .replace("\"", "&quot;")
+                   .replace("'", "&#39;");
+    }
 }

core/ui/src/main/java/org/phoebus/ui/help/OpenAbout.java

@@ -206,7 +206,9 @@ private Node createDetailSection()
         }
 
         WebView webView = new WebView();
-        String content = "<html><body>";
+        String content = "<html><head><style>" +
+        	    "body {font-family: monospace;}" +
+        	    "</style></head><body>";
         content += prefs_buf.toString();
         content += "</body></html>";
         webView.getEngine().loadContent(content);