show in red incorrect properties in settings.ini

Author: lcaouen

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

@@ -7,10 +7,25 @@
  *******************************************************************************/
 package org.phoebus.framework.preferences;
 
+import java.io.BufferedReader;
+import java.io.ByteArrayInputStream;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
 import java.io.OutputStream;
 import java.io.OutputStreamWriter;
 import java.io.Writer;
+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.prefs.Preferences;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 /** Write preferences in property file format
  *  @author Kay Kasemir
@@ -33,34 +48,116 @@ public static void save(final OutputStream stream) throws Exception
     {
         try
         (
+        	
             final OutputStreamWriter out = new OutputStreamWriter(stream);
         )
         {
-            out.append("# Preference settings\n");
-            out.append("# Format:\n");
-            out.append("# the.package.name/key=value\n");
-            listSettings(out, Preferences.userRoot());
-            out.append("# End.\n");
+            out.append("# Preference settings<br/>\n");
+            out.append("# Format:<br/>\n");
+            out.append("# the.package.name/key=value<br/>\n");
+            listSettings(getAllPropertyKeys(), out, Preferences.userRoot());
+            out.append("# End.<br/>\n");
             out.flush();
         }
     }
 
-    private static void listSettings(final Writer out, final Preferences node) throws Exception
+    private static void listSettings(Map<String, String> allKeysWithPackages, final Writer out, final Preferences node) throws Exception
     {
         for (String key : node.keys())
-            formatSetting(out, node, key);
+            formatSetting(allKeysWithPackages, out, node, key);
         for (String child : node.childrenNames())
-            listSettings(out, node.node(child));
+            listSettings(allKeysWithPackages, out, node.node(child));
     }
 
-    private static void formatSetting(final Writer out, final Preferences node, final String key) throws Exception
+    private static void formatSetting(Map<String, String> allKeysWithPackages, final Writer out, final Preferences node, final String key) throws Exception
     {
         final String path = node.absolutePath();
-        out.append(path.substring(1).replace('/', '.'))
-           .append('/')
-           .append(key)
+        String fullKey = path.substring(1).replace('/', '.') + '/' + key;
+        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)
            .append('=')
            .append(node.get(key, ""))
-           .append('\n');
+           .append("<br/>\n");
+        if (bNotFound) out.append("</div>");
     }
+    
+    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"));
+
+        while (tokenizer.hasMoreTokens()) {
+            String path = tokenizer.nextToken();
+            File file = new File(path);
+
+            if (path.endsWith(".jar")) {
+                try (JarFile jarFile = new JarFile(file)) {
+                    Enumeration<JarEntry> entries = jarFile.entries();
+
+                    while (entries.hasMoreElements()) {
+                        JarEntry entry = entries.nextElement();
+                        String entryName = entry.getName();
+
+                        if (entryName.endsWith("preferences.properties")) {
+                            parsePropertiesWithPackage(
+                                jarFile.getInputStream(entry),
+                                entryName,
+                                allKeysWithPackages
+                            );
+                        }
+                    }
+                } catch (IOException e) {
+                    System.err.println("Error opening JAR : " + path);
+                    e.printStackTrace();
+                }
+            }
+        }
+
+        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");
+                    }
+                }
+
+                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();
+            }
+        }
 }

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

@@ -42,6 +42,7 @@
 import javafx.scene.image.Image;
 import javafx.scene.layout.Priority;
 import javafx.scene.layout.VBox;
+import javafx.scene.web.WebView;
 
 /** Menu entry to open 'about'
  *  @author Kay Kasemir
@@ -204,12 +205,15 @@ private Node createDetailSection()
             logger.log(Level.WARNING, "Cannot list preferences", ex);
         }
 
-        area = new TextArea(prefs_buf.toString());
-        area.setEditable(false);
+        WebView webView = new WebView();
+        String content = "<html><body>";
+        content += prefs_buf.toString();
+        content += "</body></html>";
+        webView.getEngine().loadContent(content);
 
-        VBox.setVgrow(area, Priority.ALWAYS);
+        VBox.setVgrow(webView, Priority.ALWAYS);
 
-        final Tab prefs = new Tab(Messages.HelpAboutPrefs, area);
+        final Tab prefs = new Tab(Messages.HelpAboutPrefs, webView);
 
         final TabPane tabs = new TabPane(apps, envs, props, prefs);
         return tabs;