Coverage Report

Coverage Report - org.crosswire.common.util.Translations

Classes in this File

Line Coverage

Branch Coverage

Complexity

Translations

0/76

0/34

2.846

 /**
  * Distribution License:
  * JSword is free software; you can redistribute it and/or modify it under
  * the terms of the GNU Lesser General Public License, version 2.1 or later
  * as published by the Free Software Foundation. This program is distributed
  * in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  * See the GNU Lesser General Public License for more details.
  *
  * The License is available on the internet at:
  *      http://www.gnu.org/copyleft/lgpl.html
  * or by writing to:
  *      Free Software Foundation, Inc.
  *      59 Temple Place - Suite 330
  *      Boston, MA 02111-1307, USA
  *
  * © CrossWire Bible Society, 2005 - 2016
  *
  */
 package org.crosswire.common.util;
 
 import java.io.IOException;
 import java.net.URI;
 import java.net.URL;
 import java.util.Locale;
 import java.util.Map;
 
 import org.crosswire.common.config.ChoiceFactory;
 import org.slf4j.LoggerFactory;
 
 /**
  * Translations provides a list of locales that BibleDesktop has been translated
  * into.
  * 
  * @see gnu.lgpl.License The GNU Lesser General Public License for details.
  * @author DM Smith
  */
 public final class Translations {
     /**
      * Singleton classes have private constructors.
      */
     private Translations() {
         try {
             loadSupportedTranslations();
             PropertyMap props = ResourceUtil.getProperties(getClass());
             translation = props.get(TRANSLATION_KEY);
             if (translation == null || translation.length() == 0) {
                 // check for a match against language and country
                 // This pertains to zh_TW and zh_CN
                 for (int i = 0; i < translations.length; i++) {
                     Locale supportedLocale = new Locale(translations[i]);
                     if (supportedLocale.getLanguage().equals(originalLocale.getLanguage()) && supportedLocale.getCountry().equals(originalLocale.getCountry())) {
                         translation = translations[i];
                         return;
                     }
                 }
 
                 // check for a match against just language
                 for (int i = 0; i < translations.length; i++) {
                     Locale supportedLocale = new Locale(translations[i]);
                     if (supportedLocale.getLanguage().equals(originalLocale.getLanguage())) {
                         translation = translations[i];
                         return;
                     }
                 }
 
                 // if we don't have a matching locale then just use the default.
                 translation = DEFAULT_TRANSLATION;
             }
         } catch (IOException e) {
             translation = DEFAULT_TRANSLATION;
         }
     }
 
     /**
      * All access to Translations is through this single instance.
      * 
      * @return the singleton instance
      */
     public static Translations instance() {
         return instance;
     }
 
     /**
      * Gets a listing of all the translations that Bible Desktop supports.
      * 
      * @return an string array of translations in locale friendly names.
      */
     public PropertyMap getSupported() {
         loadSupportedTranslations();
 
         // I18N(DMS) Collate these according to the current locale, putting the
         // current locale's locale first.
         PropertyMap names = new PropertyMap();
 
         for (int i = 0; i < translations.length; i++) {
             names.put(translations[i], toString(translations[i]));
         }
 
         return names;
     }
 
     /**
      * Get the locale for the current translation.
      * 
      * @return the translation's locale
      */
     public Locale getCurrentLocale() {
         // If there is no particular translation, then return the default
         // locale.
         if (translation == null || DEFAULT_TRANSLATION.equals(translation)) {
             return DEFAULT_LOCALE;
         }
 
         // If the local consists of a language and a country then use both
         if (translation.indexOf('_') != -1) {
             String[] locale = StringUtil.split(translation, '_');
             return new Locale(locale[0], locale[1]);
         }
 
         // otherwise just use the country.
         return new Locale(translation);
     }
 
     /**
      * Get the current translation as a human readable string.
      * 
      * @return the current translation
      */
     public String getCurrent() {
         return toString(translation);
     }
 
     /**
      * Set the current translation, using human readable string.
      * 
      * @param newTranslation
      *            the translation to use
      */
     public void setCurrent(String newTranslation) {
         String found = DEFAULT_TRANSLATION;
         String currentTranslation = "";
         for (int i = 0; i < translations.length; i++) {
             String trans = translations[i];
             currentTranslation = toString(translation);
 
             if (trans.equals(newTranslation) || currentTranslation.equals(newTranslation)) {
                 found = trans;
                 break;
             }
         }
 
         try {
             translation = found;
             PropertyMap props = new PropertyMap();
             if (!DEFAULT_TRANSLATION.equals(translation)) {
                 props.put(TRANSLATION_KEY, translation);
             }
 
             URI outputURI = CWProject.instance().getWritableURI(getClass().getName(), FileUtil.EXTENSION_PROPERTIES);
             NetUtil.storeProperties(props, outputURI, "BibleDesktop UI Translation");
         } catch (IOException ex) {
             log.error("Failed to save BibleDesktop UI Translation", ex);
         }
     }
 
     /**
      * Set the locale for the program to the one the user has selected. But
      * don't set it to the default translation, so that the user's actual
      * locale, is used for Bible book names.
      * 
      * This only makes sense after config has called setCurrentTranslation.
      */
     public void setLocale() {
         Locale.setDefault(getCurrentLocale());
     }
 
     /**
      * Register this class with the common config engine.
      */
     public void register() {
         ChoiceFactory.getDataMap().put(TRANSLATION_KEY, getSupportedTranslations());
     }
 
     /**
      * Get the current translation as a human readable string.
      * 
      * @return the current translation
      */
     public static String getCurrentTranslation() {
         return Translations.instance().getCurrent();
     }
 
     /**
      * Set the current translation, using human readable string.
      * 
      * @param newTranslation
      *            the translation to use
      */
     public static void setCurrentTranslation(String newTranslation) {
         Translations.instance().setCurrent(newTranslation);
     }
 
     /**
      * Gets a listing of all the translations that Bible Desktop supports.
      * 
      * @return an string array of translations in locale friendly names.
      */
     public static Map<String, String> getSupportedTranslations() {
         return Translations.instance().getSupported();
     }
 
     /**
      * Get a list of the supported translations
      */
     private void loadSupportedTranslations() {
         if (translations == null) {
             try {
                 URL index = ResourceUtil.getResource(Translations.class, "translations.txt");
                 translations = NetUtil.listByIndexFile(NetUtil.toURI(index));
             } catch (IOException ex) {
                 translations = new String[0];
             }
         }
     }
 
     public String toString(String translationCode) {
         StringBuilder currentTranslation = new StringBuilder(Languages.getName(translationCode));
 
         if (translationCode.indexOf('_') != -1) {
             String[] locale = StringUtil.split(translationCode, '_');
             currentTranslation.append(", ");
             currentTranslation.append(Countries.getCountry(locale[1]));
         }
 
         return currentTranslation.toString();
     }
 
     /**
      * The key used in config.xml
      */
     private static final String TRANSLATION_KEY = "translation-codes";
 
     /**
      * The default translation, if the user has not chosen anything else.
      */
     public static final String DEFAULT_TRANSLATION = "en";
 
     /**
      * The default Locale, it the user has not chosen anything else.
      */
     public static final Locale DEFAULT_LOCALE = Locale.ENGLISH;
 
     /**
      * The translation that BibleDesktop should use.
      */
     private String translation;
 
     /**
      * List of available translations.
      */
     private String[] translations;
 
     /**
      * The locale that the program starts with. This needs to precede
      * "instance."
      */
     private static Locale originalLocale = Locale.getDefault();
 
     private static Translations instance = new Translations();
 
     /**
      * The log stream
      */
     private static final org.slf4j.Logger log = LoggerFactory.getLogger(Translations.class);
 }

1		/**
2		* Distribution License:
3		* JSword is free software; you can redistribute it and/or modify it under
4		* the terms of the GNU Lesser General Public License, version 2.1 or later
5		* as published by the Free Software Foundation. This program is distributed
6		* in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
7		* the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
8		* See the GNU Lesser General Public License for more details.
9		*
10		* The License is available on the internet at:
11		* http://www.gnu.org/copyleft/lgpl.html
12		* or by writing to:
13		* Free Software Foundation, Inc.
14		* 59 Temple Place - Suite 330
15		* Boston, MA 02111-1307, USA
16		*
17		* © CrossWire Bible Society, 2005 - 2016
18		*
19		*/
20		package org.crosswire.common.util;
21
22		import java.io.IOException;
23		import java.net.URI;
24		import java.net.URL;
25		import java.util.Locale;
26		import java.util.Map;
27
28		import org.crosswire.common.config.ChoiceFactory;
29		import org.slf4j.LoggerFactory;
30
31		/**
32		* Translations provides a list of locales that BibleDesktop has been translated
33		* into.
34		*
35		* @see gnu.lgpl.License The GNU Lesser General Public License for details.
36		* @author DM Smith
37		*/
38		public final class Translations {
39		/**
40		* Singleton classes have private constructors.
41		*/
42	0	private Translations() {
43		try {
44	0	loadSupportedTranslations();
45	0	PropertyMap props = ResourceUtil.getProperties(getClass());
46	0	translation = props.get(TRANSLATION_KEY);
47	0	if (translation == null \|\| translation.length() == 0) {
48		// check for a match against language and country
49		// This pertains to zh_TW and zh_CN
50	0	for (int i = 0; i < translations.length; i++) {
51	0	Locale supportedLocale = new Locale(translations[i]);
52	0	if (supportedLocale.getLanguage().equals(originalLocale.getLanguage()) && supportedLocale.getCountry().equals(originalLocale.getCountry())) {
53	0	translation = translations[i];
54	0	return;
55		}
56		}
57
58		// check for a match against just language
59	0	for (int i = 0; i < translations.length; i++) {
60	0	Locale supportedLocale = new Locale(translations[i]);
61	0	if (supportedLocale.getLanguage().equals(originalLocale.getLanguage())) {
62	0	translation = translations[i];
63	0	return;
64		}
65		}
66
67		// if we don't have a matching locale then just use the default.
68	0	translation = DEFAULT_TRANSLATION;
69		}
70	0	} catch (IOException e) {
71	0	translation = DEFAULT_TRANSLATION;
72	0	}
73	0	}
74
75		/**
76		* All access to Translations is through this single instance.
77		*
78		* @return the singleton instance
79		*/
80		public static Translations instance() {
81	0	return instance;
82		}
83
84		/**
85		* Gets a listing of all the translations that Bible Desktop supports.
86		*
87		* @return an string array of translations in locale friendly names.
88		*/
89		public PropertyMap getSupported() {
90	0	loadSupportedTranslations();
91
92		// I18N(DMS) Collate these according to the current locale, putting the
93		// current locale's locale first.
94	0	PropertyMap names = new PropertyMap();
95
96	0	for (int i = 0; i < translations.length; i++) {
97	0	names.put(translations[i], toString(translations[i]));
98		}
99
100	0	return names;
101		}
102
103		/**
104		* Get the locale for the current translation.
105		*
106		* @return the translation's locale
107		*/
108		public Locale getCurrentLocale() {
109		// If there is no particular translation, then return the default
110		// locale.
111	0	if (translation == null \|\| DEFAULT_TRANSLATION.equals(translation)) {
112	0	return DEFAULT_LOCALE;
113		}
114
115		// If the local consists of a language and a country then use both
116	0	if (translation.indexOf('_') != -1) {
117	0	String[] locale = StringUtil.split(translation, '_');
118	0	return new Locale(locale[0], locale[1]);
119		}
120
121		// otherwise just use the country.
122	0	return new Locale(translation);
123		}
124
125		/**
126		* Get the current translation as a human readable string.
127		*
128		* @return the current translation
129		*/
130		public String getCurrent() {
131	0	return toString(translation);
132		}
133
134		/**
135		* Set the current translation, using human readable string.
136		*
137		* @param newTranslation
138		* the translation to use
139		*/
140		public void setCurrent(String newTranslation) {
141	0	String found = DEFAULT_TRANSLATION;
142	0	String currentTranslation = "";
143	0	for (int i = 0; i < translations.length; i++) {
144	0	String trans = translations[i];
145	0	currentTranslation = toString(translation);
146
147	0	if (trans.equals(newTranslation) \|\| currentTranslation.equals(newTranslation)) {
148	0	found = trans;
149	0	break;
150		}
151		}
152
153		try {
154	0	translation = found;
155	0	PropertyMap props = new PropertyMap();
156	0	if (!DEFAULT_TRANSLATION.equals(translation)) {
157	0	props.put(TRANSLATION_KEY, translation);
158		}
159
160	0	URI outputURI = CWProject.instance().getWritableURI(getClass().getName(), FileUtil.EXTENSION_PROPERTIES);
161	0	NetUtil.storeProperties(props, outputURI, "BibleDesktop UI Translation");
162	0	} catch (IOException ex) {
163	0	log.error("Failed to save BibleDesktop UI Translation", ex);
164	0	}
165	0	}
166
167		/**
168		* Set the locale for the program to the one the user has selected. But
169		* don't set it to the default translation, so that the user's actual
170		* locale, is used for Bible book names.
171		*
172		* This only makes sense after config has called setCurrentTranslation.
173		*/
174		public void setLocale() {
175	0	Locale.setDefault(getCurrentLocale());
176	0	}
177
178		/**
179		* Register this class with the common config engine.
180		*/
181		public void register() {
182	0	ChoiceFactory.getDataMap().put(TRANSLATION_KEY, getSupportedTranslations());
183	0	}
184
185		/**
186		* Get the current translation as a human readable string.
187		*
188		* @return the current translation
189		*/
190		public static String getCurrentTranslation() {
191	0	return Translations.instance().getCurrent();
192		}
193
194		/**
195		* Set the current translation, using human readable string.
196		*
197		* @param newTranslation
198		* the translation to use
199		*/
200		public static void setCurrentTranslation(String newTranslation) {
201	0	Translations.instance().setCurrent(newTranslation);
202	0	}
203
204		/**
205		* Gets a listing of all the translations that Bible Desktop supports.
206		*
207		* @return an string array of translations in locale friendly names.
208		*/
209		public static Map<String, String> getSupportedTranslations() {
210	0	return Translations.instance().getSupported();
211		}
212
213		/**
214		* Get a list of the supported translations
215		*/
216		private void loadSupportedTranslations() {
217	0	if (translations == null) {
218		try {
219	0	URL index = ResourceUtil.getResource(Translations.class, "translations.txt");
220	0	translations = NetUtil.listByIndexFile(NetUtil.toURI(index));
221	0	} catch (IOException ex) {
222	0	translations = new String[0];
223	0	}
224		}
225	0	}
226
227		public String toString(String translationCode) {
228	0	StringBuilder currentTranslation = new StringBuilder(Languages.getName(translationCode));
229
230	0	if (translationCode.indexOf('_') != -1) {
231	0	String[] locale = StringUtil.split(translationCode, '_');
232	0	currentTranslation.append(", ");
233	0	currentTranslation.append(Countries.getCountry(locale[1]));
234		}
235
236	0	return currentTranslation.toString();
237		}
238
239		/**
240		* The key used in config.xml
241		*/
242		private static final String TRANSLATION_KEY = "translation-codes";
243
244		/**
245		* The default translation, if the user has not chosen anything else.
246		*/
247		public static final String DEFAULT_TRANSLATION = "en";
248
249		/**
250		* The default Locale, it the user has not chosen anything else.
251		*/
252	0	public static final Locale DEFAULT_LOCALE = Locale.ENGLISH;
253
254		/**
255		* The translation that BibleDesktop should use.
256		*/
257		private String translation;
258
259		/**
260		* List of available translations.
261		*/
262		private String[] translations;
263
264		/**
265		* The locale that the program starts with. This needs to precede
266		* "instance."
267		*/
268	0	private static Locale originalLocale = Locale.getDefault();
269
270	0	private static Translations instance = new Translations();
271
272		/**
273		* The log stream
274		*/
275	0	private static final org.slf4j.Logger log = LoggerFactory.getLogger(Translations.class);
276		}