src/jalview/util/MessageManager.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.util;
  22
  23 import java.text.MessageFormat;
  24 import java.util.HashSet;
  25 import java.util.Locale;
  26 import java.util.ResourceBundle;
  27 import java.util.ResourceBundle.Control;
  28 import java.util.Set;
  29
  30 import org.apache.log4j.Logger;
  31
  32 /**
  33  *
  34  * @author David Roldan Martinez
  35  * @author Thomas Abeel
  36  *
  37  *
  38  */
  39 public class MessageManager
  40 {
  41
  42   // BH 2018 switched to org.apache.llog4j.Logger
  43
  44   private static ResourceBundle rb;
  45
  46   private static Logger log = Logger
  47           .getLogger(MessageManager.class.getCanonicalName());
  48
  49   private static Locale loc;
  50
  51   private static Set<String> reportedMissing = new HashSet<>();
  52
  53   static
  54   {
  55     try
  56     {
  57       /* Localize Java dialogs */
  58       loc = Locale.getDefault();
  59       // Locale.setDefault(loc);
  60       /* Getting messages for GV */
  61       log.info("Getting messages for lang: " + loc);
  62       Control control = Control.getControl(Control.FORMAT_PROPERTIES);
  63       rb = ResourceBundle.getBundle("lang.Messages", loc, control);
  64       // if (log.isLoggable(Level.FINEST))
  65       // {
  66       // // this might take a while, so we only do it if it will be shown
  67       // log.info("Language keys: " + rb.keySet()); // was FINEST
  68       // }
  69     } catch (Exception q)
  70     {
  71       log.warn("Exception when initting Locale for i18n messages\n"
  72               + q.getMessage());
  73       q.printStackTrace();
  74     } catch (Error v)
  75     {
  76       log.warn("Error when initting Locale for i18n messages\n"
  77               + v.getMessage());
  78       v.printStackTrace();
  79     }
  80
  81   }
  82
  83   public static String getString(String key)
  84   {
  85     String value = "[missing key] " + key;
  86     try
  87     {
  88       value = rb.getString(key);
  89     } catch (Exception e)
  90     {
  91       String msg = "I18N missing: " + loc + "\t" + key;
  92           logWarning(key, msg);
  93     }
  94     return value;
  95   }
  96
  97   public static Locale getLocale()
  98   {
  99     return loc;
 100   }
 101
 102   public static String formatMessage(String key, Object... params)
 103   {
 104     return MessageFormat.format(getString(key), params);
 105   }
 106
 107   public static String formatMessage(String key, String[] params)
 108   {
 109     return MessageFormat.format(getString(key), (Object[]) params);
 110   }
 111
 112   /**
 113    * Looks up and returns a key given a root and a human-readable(ish) name that
 114    * when combined might resolve to an i18n string. If the key doesn't resolve,
 115    * then name is returned. Use this for programmatically constructed keys that
 116    * have a human readable alternative used in the program (e.g. BLOSUM62 and
 117    * label.score_blosum62).
 118    *
 119    * @param keyroot
 120    * @param name
 121    * @return
 122    */
 123   public static String getStringOrReturn(String keyroot, String name)
 124   {
 125     String smkey = keyroot + name.toLowerCase().replaceAll(" ", "");
 126     try
 127     {
 128       name = rb.getString(smkey);
 129     } catch (Exception x)
 130     {
 131       String msg = "I18N missing key with root " + keyroot + ": " + loc + "\t"
 132                           + smkey;
 133           logWarning(smkey, msg);
 134     }
 135     return name;
 136   }
 137
 138   /**
 139    * Logs missing keys (each key once only per run)
 140    *
 141    * @param key
 142    * @param msg
 143    */
 144   private static void logWarning(String key, String msg)
 145   {
 146         if (!reportedMissing.contains(key))
 147         {
 148       reportedMissing.add(key);
 149           log.info(msg);
 150         }
 151   }
 152 }