Improve localization framework.

[lgpl/argeo-commons.git] / org.argeo.cms / src / org / argeo / cms / LocaleUtils.java

diff --git a/org.argeo.cms/src/org/argeo/cms/LocaleUtils.java b/org.argeo.cms/src/org/argeo/cms/LocaleUtils.java
index 24ca3558c7dcc57ae657cd445b2de509669de6ce..8101563d95e9fee6bbe3c4c6d51510206e5c0cc1 100644 (file)
--- a/org.argeo.cms/src/org/argeo/cms/LocaleUtils.java
+++ b/org.argeo.cms/src/org/argeo/cms/LocaleUtils.java
@@ -8,40 +8,70 @@ import java.util.ResourceBundle;
 
 import javax.security.auth.Subject;
 
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 import org.argeo.cms.auth.CurrentUser;
 
 /** Utilities simplifying the development of localization enums. */
 public class LocaleUtils {
+       final static String DEFAULT_OSGI_l10N_BUNDLE = "/OSGI-INF/l10n/bundle";
+
+       private final static Log log = LogFactory.getLog(LocaleUtils.class);
+
+       private final static ThreadLocal<Locale> threadLocale = new ThreadLocal<>();
+
+       public static void setThreadLocale(Locale locale) {
+               threadLocale.set(locale);
+       }
+
+       public static String local(Localized localized) {
+               return local(localized.name(), localized.getClass().getClassLoader());
+       }
+
+       public static String local(Localized localized, Locale locale) {
+               if (localized.name() == null) // untranslated
+                       return localized.local(locale);
+               return local(localized.name(), locale, localized.getClass().getClassLoader());
+       }
+
+       @Deprecated
        public static String local(Enum<?> en) {
-               return local(en, getCurrentLocale(), "/OSGI-INF/l10n/bundle");
+               return local(en, getCurrentLocale(), DEFAULT_OSGI_l10N_BUNDLE);
        }
 
+       @Deprecated
        public static String local(Enum<?> en, Locale locale) {
-               return local(en, locale, "/OSGI-INF/l10n/bundle");
+               return local(en, locale, DEFAULT_OSGI_l10N_BUNDLE);
        }
 
+       @Deprecated
        public static String local(Enum<?> en, Locale locale, String resource) {
                return local(en, locale, resource, en.getClass().getClassLoader());
        }
 
+       @Deprecated
        public static String local(Enum<?> en, Locale locale, String resource, ClassLoader classLoader) {
                return local(en.name(), locale, resource, classLoader);
        }
 
        public static String local(String key, ClassLoader classLoader) {
-               return local(key, getCurrentLocale(), "/OSGI-INF/l10n/bundle", classLoader);
+               return local(key, getCurrentLocale(), DEFAULT_OSGI_l10N_BUNDLE, classLoader);
        }
 
        public static String local(String key, Locale locale, ClassLoader classLoader) {
-               return local(key, locale, "/OSGI-INF/l10n/bundle", classLoader);
+               return local(key, locale, DEFAULT_OSGI_l10N_BUNDLE, classLoader);
        }
 
+       /** Where the search for a message is actually performed. */
        public static String local(String key, Locale locale, String resource, ClassLoader classLoader) {
                ResourceBundle rb = ResourceBundle.getBundle(resource, locale, classLoader);
                assert key.length() > 2;
                if (isLocaleKey(key))
                        key = key.substring(1);
-               return rb.getString(key);
+               if (rb.containsKey(key))
+                       return rb.getString(key);
+               else // for simple cases, the key will actually be the English word
+                       return key;
        }
 
        public static boolean isLocaleKey(String str) {
@@ -51,23 +81,39 @@ public class LocaleUtils {
                        return false;
        }
 
-       public static String lead(String raw, Locale locale) {
+       /** Lead transformation on the translated string. */
+       public static String toLead(String raw, Locale locale) {
                return raw.substring(0, 1).toUpperCase(locale) + raw.substring(1);
        }
 
+       public static String lead(Localized localized, ClassLoader classLoader) {
+               Locale locale = getCurrentLocale();
+               if (localized.name() == null)// untranslated
+                       return toLead(localized.local(locale), locale);
+               return toLead(local(localized.name(), getCurrentLocale(), DEFAULT_OSGI_l10N_BUNDLE, classLoader), locale);
+       }
+
        public static String lead(Localized localized) {
                return lead(localized, getCurrentLocale());
        }
 
        public static String lead(Localized localized, Locale locale) {
-               return lead(localized.local(locale).toString(), locale);
+               return toLead(local(localized, locale), locale);
        }
 
        static Locale getCurrentLocale() {
+               Locale currentLocale = null;
                if (Subject.getSubject(AccessController.getContext()) != null)
-                       return CurrentUser.locale();
-               else
-                       return Locale.getDefault();
+                       currentLocale = CurrentUser.locale();
+               else if (threadLocale.get() != null) {
+                       currentLocale = threadLocale.get();
+               }
+               if (log.isTraceEnabled())
+                       log.trace("Thread #" + Thread.currentThread().getId() + " " + Thread.currentThread().getName() + " locale: "
+                                       + currentLocale);
+               if (currentLocale == null)
+                       throw new IllegalStateException("No locale found");
+               return currentLocale;
                // return UiContext.getLocale();
                // FIXME look into Subject or settings
                // return Locale.getDefault();