JAL-3163 only log missing message keys once each

[jalview.git] / src / jalview / util / MessageManager.java

diff --git a/src/jalview/util/MessageManager.java b/src/jalview/util/MessageManager.java
index 3494181..2852364 100644 (file)
--- a/src/jalview/util/MessageManager.java
+++ b/src/jalview/util/MessageManager.java
@@ -21,10 +21,13 @@
 package jalview.util;
 
 import java.text.MessageFormat;
+import java.util.HashSet;
 import java.util.Locale;
 import java.util.ResourceBundle;
-import java.util.logging.Level;
-import java.util.logging.Logger;
+import java.util.ResourceBundle.Control;
+import java.util.Set;
+
+import org.apache.log4j.Logger;
 
 /**
  * 
@@ -36,6 +39,8 @@ import java.util.logging.Logger;
 public class MessageManager
 {
 
+  // BH 2018 switched to org.apache.llog4j.Logger
+
   private static ResourceBundle rb;
 
   private static Logger log = Logger
@@ -43,6 +48,8 @@ public class MessageManager
 
   private static Locale loc;
 
+  private static Set<String> reportedMissing = new HashSet<>();
+
   static
   {
     try
@@ -52,20 +59,21 @@ public class MessageManager
       // Locale.setDefault(loc);
       /* Getting messages for GV */
       log.info("Getting messages for lang: " + loc);
-      rb = ResourceBundle.getBundle("lang.Messages", loc);
-      if (log.isLoggable(Level.FINEST))
-      {
-        // this might take a while, so we only do it if it will be shown
-        log.finest("Language keys: " + rb.keySet());
-      }
+      Control control = Control.getControl(Control.FORMAT_PROPERTIES);
+      rb = ResourceBundle.getBundle("lang.Messages", loc, control);
+      // if (log.isLoggable(Level.FINEST))
+      // {
+      // // this might take a while, so we only do it if it will be shown
+      // log.info("Language keys: " + rb.keySet()); // was FINEST
+      // }
     } catch (Exception q)
     {
-      log.warning("Exception when initting Locale for i18n messages\n"
+      log.warn("Exception when initting Locale for i18n messages\n"
               + q.getMessage());
       q.printStackTrace();
     } catch (Error v)
     {
-      log.warning("Error when initting Locale for i18n messages\n"
+      log.warn("Error when initting Locale for i18n messages\n"
               + v.getMessage());
       v.printStackTrace();
     }
@@ -80,7 +88,8 @@ public class MessageManager
       value = rb.getString(key);
     } catch (Exception e)
     {
-      log.warning("I18N missing: " + loc + "\t" + key);
+      String msg = "I18N missing: " + loc + "\t" + key;
+         logWarning(key, msg);
     }
     return value;
   }
@@ -92,20 +101,20 @@ public class MessageManager
 
   public static String formatMessage(String key, Object... params)
   {
-    return MessageFormat.format(rb.getString(key), params);
+    return MessageFormat.format(getString(key), params);
   }
 
   public static String formatMessage(String key, String[] params)
   {
-    return MessageFormat.format(rb.getString(key), (Object[]) params);
+    return MessageFormat.format(getString(key), (Object[]) params);
   }
 
   /**
-   * lookup and return a key given a root and a human-readable(ish) name that
+   * Looks up and returns a key given a root and a human-readable(ish) name that
    * when combined might resolve to an i18n string. If the key doesn't resolve,
-   * then name is returned.if the key doesn't exist. Use this for
-   * programatically constructed keys that have have a human readable
-   * alternative used in the program (e.g. BLOSUM62 and label.score_blosum62)
+   * then name is returned. Use this for programmatically constructed keys that
+   * have a human readable alternative used in the program (e.g. BLOSUM62 and
+   * label.score_blosum62).
    * 
    * @param keyroot
    * @param name
@@ -119,9 +128,25 @@ public class MessageManager
       name = rb.getString(smkey);
     } catch (Exception x)
     {
-      log.finest("I18N missing key with root " + keyroot + ": " + loc + "\t"
-              + smkey);
+      String msg = "I18N missing key with root " + keyroot + ": " + loc + "\t"
+                         + smkey;
+         logWarning(smkey, msg);
     }
     return name;
   }
+
+  /**
+   * Logs missing keys (each key once only per run)
+   * 
+   * @param key
+   * @param msg
+   */
+  private static void logWarning(String key, String msg) 
+  {
+       if (!reportedMissing.contains(key))
+       {
+      reportedMissing.add(key);
+         log.info(msg);
+       }
+  }
 }