Merge commit 'alpha/update_2_12_for_2_11_2_series_merge^2' into HEAD

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

diff --git a/src/jalview/util/MessageManager.java b/src/jalview/util/MessageManager.java
index 3dace12..5f6674c 100644 (file)
--- a/src/jalview/util/MessageManager.java
+++ b/src/jalview/util/MessageManager.java
@@ -21,11 +21,11 @@
 package jalview.util;
 
 import java.text.MessageFormat;
+import java.util.HashSet;
 import java.util.Locale;
 import java.util.ResourceBundle;
 import java.util.ResourceBundle.Control;
-//import java.util.logging.Level;
-//import java.util.logging.Logger;
+import java.util.Set;
 
 import org.apache.log4j.Logger;
 
@@ -38,16 +38,16 @@ import org.apache.log4j.Logger;
  */
 public class MessageManager
 {
-
-  // BH 2018 switched to org.apache.llog4j.Logger
-
   private static ResourceBundle rb;
 
+  // BH 2018 switched to org.apache.llog4j.Logger
   private static Logger log = Logger
           .getLogger(MessageManager.class.getCanonicalName());
 
   private static Locale loc;
 
+  private static Set<String> reportedMissing = new HashSet<>();
+
   static
   {
     try
@@ -57,8 +57,7 @@ public class MessageManager
       // Locale.setDefault(loc);
       /* Getting messages for GV */
       log.info("Getting messages for lang: " + loc);
-      Control control = Control.getControl(Control.FORMAT_PROPERTIES);
-      rb = ResourceBundle.getBundle("lang.Messages", loc, control);
+      rb = ResourceBundle.getBundle("lang.Messages", Platform.getLocaleOrNone(loc), Control.getControl(Control.FORMAT_PROPERTIES));
       // if (log.isLoggable(Level.FINEST))
       // {
       // // this might take a while, so we only do it if it will be shown
@@ -78,6 +77,13 @@ public class MessageManager
 
   }
 
+  /**
+   * Returns the resource bundle text for the given key, or if not found, the
+   * key prefixed by "[missing key]"
+   * 
+   * @param key
+   * @return
+   */
   public static String getString(String key)
   {
     String value = "[missing key] " + key;
@@ -86,7 +92,8 @@ public class MessageManager
       value = rb.getString(key);
     } catch (Exception e)
     {
-      log.warn("I18N missing: " + loc + "\t" + key);
+      String msg = "I18N missing: " + loc + "\t" + key;
+    logWarning(key, msg);
     }
     return value;
   }
@@ -96,21 +103,56 @@ public class MessageManager
     return loc;
   }
 
+  /**
+   * Returns the resource bundle text for the given key, with tokens {@code {0},
+   * {1} etc replaced by the supplied parameters. If the key is not found,
+   * returns the key and values prefixed by "[missing key]"
+   * 
+   * @param key
+   * 
+   * @return
+   */
   public static String formatMessage(String key, Object... params)
   {
-    return MessageFormat.format(getString(key), params);
+    try
+    {
+      return MessageFormat.format(rb.getString(key), params);
+    } catch (Exception e)
+    {
+      log.warn("I18N missing: " + loc + "\t" + key);
+    }
+    String value = "[missing key] " + key + "";
+    for (Object p : params)
+    {
+      value += " '" + p.toString() + "'";
+    }
+    return value;
   }
 
+  /**
+   * Returns the resource bundle text for the given key, with tokens {@code {0},
+   * {1} etc replaced by the supplied parameters. If the key is not found,
+   * returns the key and values prefixed by "[missing key]"
+   * 
+   * @param key
+   * 
+   * @return
+   */
   public static String formatMessage(String key, String[] params)
   {
-    return MessageFormat.format(getString(key), (Object[]) params);
+    return formatMessage(key, (Object[]) params);
   }
 
   /**
-   * 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. Use this for programmatically constructed keys that
-   * have a human readable alternative used in the program (e.g. BLOSUM62 and
+   * Returns resource bundle text given a root and a human-readable(ish) name
+   * that when combined might resolve to an i18n string. {@code name} is forced
+   * to lower case, with any spaces removed, and concatenated to {@code keyroot}
+   * to form a lookup key.
+   * <p>
+   * If the key doesn't resolve, then {@code name} is returned.
+   * <p>
+   * Use this for programmatically constructed keys that might have a human
+   * readable alternative used in the program (e.g. BLOSUM62 and
    * label.score_blosum62).
    * 
    * @param keyroot
@@ -119,15 +161,31 @@ public class MessageManager
    */
   public static String getStringOrReturn(String keyroot, String name)
   {
-    String smkey = keyroot + name.toLowerCase().replaceAll(" ", "");
+    String smkey = keyroot + name.toLowerCase(Locale.ROOT).replaceAll(" ", "");
     try
     {
       name = rb.getString(smkey);
     } catch (Exception x)
     {
-      log.info("I18N missing key with root " + keyroot + ": " + loc + "\t"
-              + smkey); // was FINEST
+      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);
+  }
+  }
 }