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 final static Logger log = Logger
  47           .getLogger(MessageManager.class.getCanonicalName());
  48
  49   private final static Locale loc;
  50
  51   private final static Set<String> reportedMissing = new HashSet<>();
  52
  53   static
  54   {
  55     loc = Locale.getDefault();
  56     try
  57     {
  58       /* Getting messages for GV */
  59       log.info("Getting messages for lang: " + loc);
  60       Control control = Control.getControl(Control.FORMAT_PROPERTIES);
  61       rb = ResourceBundle.getBundle("lang.Messages", loc, control);
  62       // if (log.isLoggable(Level.FINEST))
  63       // {
  64       // // this might take a while, so we only do it if it will be shown
  65       // log.info("Language keys: " + rb.keySet()); // was FINEST
  66       // }
  67     } catch (Exception q)
  68     {
  69       log.warn("Exception when initting Locale for i18n messages\n"
  70               + q.getMessage());
  71       q.printStackTrace();
  72     } catch (Error v)
  73     {
  74       log.warn("Error when initting Locale for i18n messages\n"
  75               + v.getMessage());
  76       v.printStackTrace();
  77     }
  78
  79   }
  80
  81   public static String getString(String key)
  82   {
  83     String value = "[missing key] " + key;
  84     try
  85     {
  86       value = rb.getString(key);
  87     } catch (Exception e)
  88     {
  89       String msg = "I18N missing: " + loc + "\t" + key;
  90           logWarning(key, msg);
  91     }
  92     return value;
  93   }
  94
  95   public static Locale getLocale()
  96   {
  97     return loc;
  98   }
  99
 100   public static String formatMessage(String key, Object... params)
 101   {
 102     return MessageFormat.format(getString(key), params);
 103   }
 104
 105   public static String formatMessage(String key, String[] params)
 106   {
 107     return MessageFormat.format(getString(key), (Object[]) params);
 108   }
 109
 110   /**
 111    * Looks up and returns a key given a root and a human-readable(ish) name that
 112    * when combined might resolve to an i18n string. If the key doesn't resolve,
 113    * then name is returned. Use this for programmatically constructed keys that
 114    * have a human readable alternative used in the program (e.g. BLOSUM62 and
 115    * label.score_blosum62).
 116    *
 117    * @param keyroot
 118    * @param name
 119    * @return
 120    */
 121   public static String getStringOrReturn(String keyroot, String name)
 122   {
 123     String smkey = keyroot + name.toLowerCase().replaceAll(" ", "");
 124     try
 125     {
 126       name = rb.getString(smkey);
 127     } catch (Exception x)
 128     {
 129       String msg = "I18N missing key with root " + keyroot + ": " + loc + "\t"
 130                           + smkey;
 131           logWarning(smkey, msg);
 132     }
 133     return name;
 134   }
 135
 136   /**
 137    * Logs missing keys (each key once only per run)
 138    *
 139    * @param key
 140    * @param msg
 141    */
 142   private static void logWarning(String key, String msg)
 143   {
 144         if (!reportedMissing.contains(key))
 145         {
 146       reportedMissing.add(key);
 147           log.info(msg);
 148         }
 149   }
 150 }