ConfigItem: add locale support
[fanfix.git] / src / be / nikiroo / utils / resources / TransBundle.java
1 package be.nikiroo.utils.resources;
2
3 import java.io.File;
4 import java.io.IOException;
5 import java.io.Writer;
6 import java.util.LinkedList;
7 import java.util.List;
8 import java.util.Locale;
9 import java.util.regex.Pattern;
10
11 /**
12 * This class manages a translation-dedicated Bundle.
13 * <p>
14 * Two special cases are handled for the used enum:
15 * <ul>
16 * <li>NULL will always will return an empty {@link String}</li>
17 * <li>DUMMY will return "[DUMMY]" (maybe with a suffix and/or "NOUTF")</li>
18 * </ul>
19 *
20 * @param <E>
21 * the enum to use to get values out of this class
22 *
23 * @author niki
24 */
25 public class TransBundle<E extends Enum<E>> extends Bundle<E> {
26 private boolean utf = true;
27 private Locale locale;
28 private boolean defaultLocale = false;
29
30 /**
31 * Create a translation service with the default language.
32 *
33 * @param type
34 * a runtime instance of the class of E
35 * @param name
36 * the name of the {@link Bundles}
37 */
38 public TransBundle(Class<E> type, Enum<?> name) {
39 this(type, name, (Locale) null);
40 }
41
42 /**
43 * Create a translation service for the given language (will fall back to
44 * the default one i not found).
45 *
46 * @param type
47 * a runtime instance of the class of E
48 * @param name
49 * the name of the {@link Bundles}
50 * @param language
51 * the language to use, can be NULL for default
52 */
53 public TransBundle(Class<E> type, Enum<?> name, String language) {
54 super(type, name, null);
55 setLocale(language);
56 }
57
58 /**
59 * Create a translation service for the given language (will fall back to
60 * the default one i not found).
61 *
62 * @param type
63 * a runtime instance of the class of E
64 * @param name
65 * the name of the {@link Bundles}
66 * @param language
67 * the language to use, can be NULL for default
68 */
69 public TransBundle(Class<E> type, Enum<?> name, Locale language) {
70 super(type, name, null);
71 setLocale(language);
72 }
73
74 /**
75 * Translate the given id into user text.
76 *
77 * @param stringId
78 * the ID to translate
79 * @param values
80 * the values to insert instead of the place holders in the
81 * translation
82 *
83 * @return the translated text with the given value where required or NULL
84 * if not found (not present in the resource file)
85 */
86 public String getString(E stringId, Object... values) {
87 return getStringX(stringId, "", values);
88 }
89
90 /**
91 * Translate the given id into user text.
92 *
93 * @param stringId
94 * the ID to translate
95 * @param values
96 * the values to insert instead of the place holders in the
97 * translation
98 *
99 * @return the translated text with the given value where required or NULL
100 * if not found (not present in the resource file)
101 */
102 public String getStringNOUTF(E stringId, Object... values) {
103 return getStringX(stringId, "NOUTF", values);
104 }
105
106 /**
107 * Translate the given id suffixed with the runtime value "_suffix" (that
108 * is, "_" and suffix) into user text.
109 *
110 * @param stringId
111 * the ID to translate
112 * @param values
113 * the values to insert instead of the place holders in the
114 * translation
115 * @param suffix
116 * the runtime suffix
117 *
118 * @return the translated text with the given value where required or NULL
119 * if not found (not present in the resource file)
120 */
121 public String getStringX(E stringId, String suffix, Object... values) {
122 E id = stringId;
123 String result = "";
124
125 String key = id.name()
126 + ((suffix == null || suffix.isEmpty()) ? "" : "_"
127 + suffix.toUpperCase());
128
129 if (!isUnicode()) {
130 if (containsKey(key + "_NOUTF")) {
131 key += "_NOUTF";
132 }
133 }
134
135 if ("NULL".equals(id.name().toUpperCase())) {
136 result = "";
137 } else if ("DUMMY".equals(id.name().toUpperCase())) {
138 result = "[" + key.toLowerCase() + "]";
139 } else if (containsKey(key)) {
140 result = getString(key, null);
141 } else {
142 result = null;
143 }
144
145 if (values != null && values.length > 0 && result != null) {
146 return String.format(locale, result, values);
147 }
148
149 return result;
150 }
151
152 /**
153 * Check if unicode characters should be used.
154 *
155 * @return TRUE to allow unicode
156 */
157 public boolean isUnicode() {
158 return utf;
159 }
160
161 /**
162 * Allow or disallow unicode characters in the program.
163 *
164 * @param utf
165 * TRUE to allow unuciode, FALSE to only allow ASCII characters
166 */
167 public void setUnicode(boolean utf) {
168 this.utf = utf;
169 }
170
171 /**
172 * Return all the languages known by the program for this bundle.
173 *
174 * @return the known language codes
175 */
176 public List<String> getKnownLanguages() {
177 return getKnownLanguages(keyType);
178 }
179
180 /**
181 * The current language (which can be the default one, but NOT NULL).
182 *
183 * @return the language, not NULL
184 */
185 public Locale getLocale() {
186 return locale;
187 }
188
189 /**
190 * The current language (which can be the default one, but NOT NULL).
191 *
192 * @return the language, not NULL, in a display format (fr-BE, en-GB, es,
193 * de...)
194 */
195 public String getLocaleString() {
196 String lang = locale.getLanguage();
197 String country = locale.getCountry();
198 if (country != null && !country.isEmpty()) {
199 return lang + "-" + country;
200 }
201 return lang;
202 }
203
204 /**
205 * Initialise the translation mappings for the given language.
206 *
207 * @param language
208 * the language to initialise, in the form "en-GB" or "fr" for
209 * instance
210 */
211 private void setLocale(String language) {
212 setLocale(getLocaleFor(language));
213 }
214
215 /**
216 * Initialise the translation mappings for the given language.
217 *
218 * @param language
219 * the language to initialise, or NULL for default
220 */
221 private void setLocale(Locale language) {
222 if (language != null) {
223 defaultLocale = false;
224 locale = language;
225 } else {
226 defaultLocale = true;
227 locale = Locale.getDefault();
228 }
229
230 setBundle(keyType, locale, false);
231 }
232
233 @Override
234 public void reload(boolean resetToDefault) {
235 setBundle(keyType, locale, resetToDefault);
236 }
237
238 @Override
239 public String getString(E id) {
240 return getString(id, (Object[]) null);
241 }
242
243 /**
244 * Create/update the .properties files for each supported language and for
245 * the default language.
246 * <p>
247 * Note: this method is <b>NOT</b> thread-safe.
248 *
249 * @param path
250 * the path where the .properties files are
251 *
252 * @throws IOException
253 * in case of IO errors
254 */
255 @Override
256 public void updateFile(String path) throws IOException {
257 String prev = locale.getLanguage();
258 Object status = takeSnapshot();
259
260 // default locale
261 setLocale((Locale) null);
262 if (prev.equals(Locale.getDefault().getLanguage())) {
263 // restore snapshot if default locale = current locale
264 restoreSnapshot(status);
265 }
266 super.updateFile(path);
267
268 for (String lang : getKnownLanguages()) {
269 setLocale(lang);
270 if (lang.equals(prev)) {
271 restoreSnapshot(status);
272 }
273 super.updateFile(path);
274 }
275
276 setLocale(prev);
277 restoreSnapshot(status);
278 }
279
280 @Override
281 protected File getUpdateFile(String path) {
282 String code = locale.toString();
283 File file = null;
284 if (!defaultLocale && code.length() > 0) {
285 file = new File(path, keyType.name() + "_" + code + ".properties");
286 } else {
287 // Default properties file:
288 file = new File(path, keyType.name() + ".properties");
289 }
290
291 return file;
292 }
293
294 @Override
295 protected void writeHeader(Writer writer) throws IOException {
296 String code = locale.toString();
297 String name = locale.getDisplayCountry(locale);
298
299 if (name.length() == 0) {
300 name = locale.getDisplayLanguage(locale);
301 }
302
303 if (name.length() == 0) {
304 name = "default";
305 }
306
307 if (code.length() > 0) {
308 name = name + " (" + code + ")";
309 }
310
311 name = (name + " " + getBundleDisplayName()).trim();
312
313 writer.write("# " + name + " translation file (UTF-8)\n");
314 writer.write("# \n");
315 writer.write("# Note that any key can be doubled with a _NOUTF suffix\n");
316 writer.write("# to use when the NOUTF env variable is set to 1\n");
317 writer.write("# \n");
318 writer.write("# Also, the comments always refer to the key below them.\n");
319 writer.write("# \n");
320 }
321
322 @Override
323 protected void writeValue(Writer writer, E id) throws IOException {
324 super.writeValue(writer, id);
325
326 String name = id.name() + "_NOUTF";
327 if (containsKey(name)) {
328 String value = getString(name, null);
329 boolean set = isSet(id, false);
330 writeValue(writer, name, value, set);
331 }
332 }
333
334 /**
335 * Return the {@link Locale} representing the given language.
336 *
337 * @param language
338 * the language to initialise, in the form "en-GB" or "fr" for
339 * instance
340 *
341 * @return the corresponding {@link Locale} or NULL if it is not known
342 */
343 static private Locale getLocaleFor(String language) {
344 Locale locale;
345
346 if (language == null || language.trim().isEmpty()) {
347 return null;
348 }
349
350 language = language.replaceAll("_", "-");
351 String lang = language;
352 String country = null;
353 if (language.contains("-")) {
354 lang = language.split("-")[0];
355 country = language.split("-")[1];
356 }
357
358 if (country != null)
359 locale = new Locale(lang, country);
360 else
361 locale = new Locale(lang);
362
363 return locale;
364 }
365
366 /**
367 * Return all the languages known by the program.
368 *
369 * @param name
370 * the enumeration on which we translate
371 *
372 * @return the known language codes
373 */
374 static protected List<String> getKnownLanguages(Enum<?> name) {
375 List<String> resources = new LinkedList<String>();
376
377 String regex = ".*" + name.name() + "[_a-zA-Za]*\\.properties$";
378
379 for (String res : TransBundle_ResourceList.getResources(Pattern
380 .compile(regex))) {
381 String resource = res;
382 int index = resource.lastIndexOf('/');
383 if (index >= 0 && index < (resource.length() - 1))
384 resource = resource.substring(index + 1);
385 if (resource.startsWith(name.name())) {
386 resource = resource.substring(0, resource.length()
387 - ".properties".length());
388 resource = resource.substring(name.name().length());
389 if (resource.startsWith("_")) {
390 resource = resource.substring(1);
391 resources.add(resource);
392 }
393 }
394 }
395
396 return resources;
397 }
398 }