2a0761603a0ec1bd2cc99adc763f600d08fa5a71
[jalview.git] / 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   private static ResourceBundle rb;
42
43   // BH 2018 switched to org.apache.llog4j.Logger
44   private static Logger log = Logger
45           .getLogger(MessageManager.class.getCanonicalName());
46
47   private static Locale loc;
48
49   private static Set<String> reportedMissing = new HashSet<>();
50
51   static
52   {
53     try
54     {
55       /* Localize Java dialogs */
56       loc = Locale.getDefault();
57       // Locale.setDefault(loc);
58       /* Getting messages for GV */
59       log.info("Getting messages for lang: " + loc);
60       rb = ResourceBundle.getBundle("lang.Messages", Platform.getLocaleOrNone(loc), Control.getControl(Control.FORMAT_PROPERTIES));
61       // if (log.isLoggable(Level.FINEST))
62       // {
63       // // this might take a while, so we only do it if it will be shown
64       // log.info("Language keys: " + rb.keySet()); // was FINEST
65       // }
66     } catch (Exception q)
67     {
68       log.warn("Exception when initting Locale for i18n messages\n"
69               + q.getMessage());
70       q.printStackTrace();
71     } catch (Error v)
72     {
73       log.warn("Error when initting Locale for i18n messages\n"
74               + v.getMessage());
75       v.printStackTrace();
76     }
77
78   }
79
80   /**
81    * Returns the resource bundle text for the given key, or if not found, the
82    * key prefixed by "[missing key]"
83    * 
84    * @param key
85    * @return
86    */
87   public static String getString(String key)
88   {
89     String value = "[missing key] " + key;
90     try
91     {
92       value = rb.getString(key);
93     } catch (Exception e)
94     {
95       String msg = "I18N missing: " + loc + "\t" + key;
96     logWarning(key, msg);
97     }
98     return value;
99   }
100
101   public static Locale getLocale()
102   {
103     return loc;
104   }
105
106   /**
107    * Returns the resource bundle text for the given key, with tokens {@code {0},
108    * {1} etc replaced by the supplied parameters. If the key is not found,
109    * returns the key and values prefixed by "[missing key]"
110    * 
111    * @param key
112    * 
113    * @return
114    */
115   public static String formatMessage(String key, Object... params)
116   {
117     try
118     {
119       return MessageFormat.format(rb.getString(key), params);
120     } catch (Exception e)
121     {
122       log.warn("I18N missing: " + loc + "\t" + key);
123     }
124     String value = "[missing key] " + key + "";
125     for (Object p : params)
126     {
127       value += " '" + p.toString() + "'";
128     }
129     return value;
130   }
131
132   /**
133    * Returns the resource bundle text for the given key, with tokens {@code {0},
134    * {1} etc replaced by the supplied parameters. If the key is not found,
135    * returns the key and values prefixed by "[missing key]"
136    * 
137    * @param key
138    * 
139    * @return
140    */
141   public static String formatMessage(String key, String[] params)
142   {
143     return formatMessage(key, (Object[]) params);
144   }
145
146   /**
147    * Returns resource bundle text given a root and a human-readable(ish) name
148    * that when combined might resolve to an i18n string. {@code name} is forced
149    * to lower case, with any spaces removed, and concatenated to {@code keyroot}
150    * to form a lookup key.
151    * <p>
152    * If the key doesn't resolve, then {@code name} is returned.
153    * <p>
154    * Use this for programmatically constructed keys that might have a human
155    * readable alternative used in the program (e.g. BLOSUM62 and
156    * label.score_blosum62).
157    * 
158    * @param keyroot
159    * @param name
160    * @return
161    */
162   public static String getStringOrReturn(String keyroot, String name)
163   {
164     String smkey = keyroot + name.toLowerCase().replaceAll(" ", "");
165     try
166     {
167       name = rb.getString(smkey);
168     } catch (Exception x)
169     {
170       String msg = "I18N missing key with root " + keyroot + ": " + loc + "\t"
171               + smkey;
172     logWarning(smkey, msg);
173     }
174     return name;
175   }
176
177   /**
178    * Logs missing keys (each key once only per run)
179    * 
180    * @param key
181    * @param msg
182    */
183   private static void logWarning(String key, String msg) 
184   {
185   if (!reportedMissing.contains(key))
186   {
187       reportedMissing.add(key);
188     log.info(msg);
189   }
190   }
191 }