improvements to Locale changing in app

src/info/guardianproject/util/Languages.java

@@ -1,10 +1,14 @@
-
 package info.guardianproject.util;
 
+import android.annotation.SuppressLint;
+import android.annotation.TargetApi;
 import android.app.Activity;
+import android.content.ContextWrapper;
+import android.content.Intent;
 import android.content.res.AssetManager;
 import android.content.res.Configuration;
 import android.content.res.Resources;
+import android.os.Build;
 import android.text.TextUtils;
 import android.util.DisplayMetrics;
 
@@ -16,11 +20,9 @@ import java.util.Set;
 import java.util.TreeMap;
 
 public class Languages {
-    private static final String TAG = "Languages";
+    public static final String TAG = "Languages";
-    private static Languages singleton;
+
-    private static Map<String, String> tmpMap = new TreeMap<String, String>();
+    public static final Locale defaultLocale;
-    private static Map<String, String> nameMap;
-    public static final String USE_SYSTEM_DEFAULT = "";
     public static final Locale TIBETAN = new Locale("bo");
     static final Locale localesToTest[] = {
             Locale.ENGLISH, Locale.FRENCH, Locale.GERMAN,
@@ -50,65 +52,139 @@ public class Languages {
             new Locale("uz"), new Locale("vi"), new Locale("zu"),
     };
 
-    private Languages(Activity activity, int resId, String defaultString) {
+    private static final String USE_SYSTEM_DEFAULT = "";
+    private static final String defaultString = "Use System Default";
+
+    private static Locale locale;
+    private static Languages singleton;
+    private static Class<?> clazz;
+    private static int resId;
+    private static Map<String, String> tmpMap = new TreeMap<String, String>();
+    private static Map<String, String> nameMap;
+
+    static {
+        defaultLocale = Locale.getDefault();
+    }
+
+    private Languages(Activity activity) {
         AssetManager assets = activity.getAssets();
         Configuration config = activity.getResources().getConfiguration();
-        DisplayMetrics metrics = new DisplayMetrics();
+        // Resources() requires DisplayMetrics, but they are only needed for drawables
-        activity.getWindowManager().getDefaultDisplay().getMetrics(metrics);
+        DisplayMetrics ignored = new DisplayMetrics();
+        activity.getWindowManager().getDefaultDisplay().getMetrics(ignored);
         Resources resources;
         Set<Locale> localeSet = new LinkedHashSet<Locale>();
         for (Locale locale : localesToTest) {
             config.locale = locale;
-            resources = new Resources(assets, metrics, config);
+            resources = new Resources(assets, ignored, config);
             if (!TextUtils.equals(defaultString, resources.getString(resId))
                     || locale.equals(Locale.ENGLISH))
                 localeSet.add(locale);
         }
         for (Locale locale : localeSet) {
             if (locale.equals(TIBETAN)) {
-                // include English name for devices that don't support Tibetan
+                // include English name for devices without Tibetan font support
-                // font
                 tmpMap.put(TIBETAN.getLanguage(), "Tibetan བོད་སྐད།"); // Tibetan
             } else if (locale.equals(Locale.SIMPLIFIED_CHINESE)) {
-                tmpMap.put(Locale.SIMPLIFIED_CHINESE.toString(), "中文 (中国)"); // Chinese
+                tmpMap.put(Locale.SIMPLIFIED_CHINESE.toString(), "中文 (中国)"); // Chinese (China)
-                                                                             // (China)
             } else if (locale.equals(Locale.TRADITIONAL_CHINESE)) {
-                tmpMap.put(Locale.TRADITIONAL_CHINESE.toString(), "中文 (台灣)"); // Chinese
+                tmpMap.put(Locale.TRADITIONAL_CHINESE.toString(), "中文 (台灣)"); // Chinese (Taiwan)
-                                                                              // (Taiwan)
             } else {
                 tmpMap.put(locale.getLanguage(), locale.getDisplayLanguage(locale));
             }
         }
-        // TODO implement this completely, the menu item works, but doesn't work
+
-        // properly
         /* USE_SYSTEM_DEFAULT is a fake one for displaying in a chooser menu. */
-        // localeSet.add(null);
+        localeSet.add(null);
-        // tmpMap.put(USE_SYSTEM_DEFAULT,
+        tmpMap.put(USE_SYSTEM_DEFAULT, activity.getString(resId));
-        // activity.getString(R.string.use_system_default));
         nameMap = Collections.unmodifiableMap(tmpMap);
     }
 
     /**
      * Get the instance of {@link Languages} to work with, providing the
-     * {@link Activity} that is will be working as part of. This uses the
+     * {@link Activity} that is will be working as part of, as well as the
-     * provided string resource {@code resId} find the supported translations:
+     * {@code resId} that has the exact string "Use System Default",
-     * if an included translation has a translated string that matches that
+     * i.e. {@code R.string.use_system_default}.
-     * {@code resId}, i.e. {@code R.string.menu_settings}, then that language
+     * <p/>
-     * will be included as a supported language.
+     * That string resource {@code resId} is also used to find the supported
+     * translations: if an included translation has a translated string that
+     * matches that {@code resId}, then that language will be included as a
+     * supported language.
      *
-     * @param activity the {@link Activity} this is working as part of
+     * @param clazz the {@link Class} of the default {@code Activity},
-     * @param resId the string resource ID to test, e.g.
+     *              usually the main {@code Activity} from where the
-     *            {@code R.string.menu_settings}
+     *              Settings is launched from.
-     * @param defaultString the string resource in the default language, e.g.
+     * @param resId the string resource ID to for the string "Use System Default",
-     *            {@code "Settings"}
+     *              e.g. {@code R.string.use_system_default}
      * @return
      */
-    public static Languages get(Activity activity, int resId, String defaultString) {
+    public static void setup(Class<?> clazz, int resId) {
-        if (singleton == null)
+        if (Languages.clazz == null) {
-            singleton = new Languages(activity, resId, defaultString);
+            Languages.clazz = clazz;
+            Languages.resId = resId;
+        } else {
+            throw new RuntimeException("Languages singleton was already initialized, duplicate call to Languages.setup()!");
+        }
+    }
+
+    /**
+     * Get the singleton to work with.
+     *
+     * @param activity the {@link Activity} this is working as part of
+     * @return
+     */
+    public static Languages get(Activity activity) {
+        if (singleton == null) {
+            singleton = new Languages(activity);
+        }
         return singleton;
     }
 
+    //@TargetApi(Build.VERSION_CODES.JELLY_BEAN_MR1)
+    @SuppressLint("NewApi")
+	public static void setLanguage(final ContextWrapper contextWrapper, String language, boolean refresh) {
+        if (locale != null && TextUtils.equals(locale.getLanguage(), language) && (!refresh)) {
+            return; // already configured
+        } else if (language == null || language == USE_SYSTEM_DEFAULT) {
+            locale = defaultLocale;
+        } else {
+            /* handle locales with the country in it, i.e. zh_CN, zh_TW, etc */
+            String localeSplit[] = language.split("_");
+            if (localeSplit.length > 1) {
+                locale = new Locale(localeSplit[0], localeSplit[1]);
+            } else {
+                locale = new Locale(language);
+            }
+        }
+
+        final Resources resources = contextWrapper.getBaseContext().getResources();
+        Configuration config = resources.getConfiguration();
+        if (Build.VERSION.SDK_INT >= 17) {
+            config.setLocale(locale);
+        } else {
+            config.locale = locale;
+        }
+        resources.updateConfiguration(config, resources.getDisplayMetrics());
+        Locale.setDefault(locale);
+
+    }
+
+    /**
+     * Force reload the {@link Activity to make language changes take effect.}
+     *
+     * @param activity the {@code Activity} to force reload
+     */
+    public static void forceChangeLanguage(Activity activity) {
+        Intent intent = activity.getIntent();
+        if (intent == null) // when launched as LAUNCHER
+            return;
+        intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
+        activity.finish();
+        activity.overridePendingTransition(0, 0);
+        activity.startActivity(intent);
+        activity.overridePendingTransition(0, 0);
+    }
+
     /**
      * Return the name of the language based on the locale.
      *

src/org/torproject/android/OrbotApp.java

@@ -39,7 +39,8 @@ public class OrbotApp extends Application implements OrbotConstants
         super.onCreate();
         Prefs.setContext(this);
 
-        setNewLocale(Prefs.getDefaultLocale());
+        Languages.setup(OrbotMainActivity.class, R.string.menu_settings);
+        Languages.setLanguage(this, Prefs.getDefaultLocale(), true);
 
         appBinHome = getDir(TorServiceConstants.DIRECTORY_TOR_BINARY,Application.MODE_PRIVATE);
         appCacheHome = getDir(TorServiceConstants.DIRECTORY_TOR_DATA,Application.MODE_PRIVATE);
@@ -60,38 +61,7 @@ public class OrbotApp extends Application implements OrbotConstants
     public void onConfigurationChanged(Configuration newConfig) {
         super.onConfigurationChanged(newConfig);
         Log.i(TAG, "onConfigurationChanged " + newConfig.locale.getLanguage());
-        setNewLocale(Prefs.getDefaultLocale());
+        Languages.setLanguage(this, Prefs.getDefaultLocale(), true);
-    }
-
-    @TargetApi(Build.VERSION_CODES.JELLY_BEAN_MR1)
-    public void setNewLocale(String language) {
-        if (TextUtils.isEmpty(language))
-            return;
-
-        if (locale != null && TextUtils.equals(locale.getLanguage(), language))
-            return; // already configured
-
-        /* handle locales with the country in it, i.e. zh_CN, zh_TW, etc */
-        String localeSplit[] = language.split("_");
-        if (localeSplit.length > 1)
-            locale = new Locale(localeSplit[0], localeSplit[1]);
-        else
-            locale = new Locale(language);
-        Configuration config = getResources().getConfiguration();
-        if (Build.VERSION.SDK_INT >= 17)
-            config.setLocale(locale);
-        else
-            config.locale = locale;
-        getResources().updateConfiguration(config, getResources().getDisplayMetrics());
-
-        /*
-         * Set the preference after setting the locale in case something goes
-         * wrong. If setting the locale causes an Exception, it should be set in
-         * the preferences, otherwise ChatSecure will be stuck in a crash loop.
-         */
-        Prefs.setDefaultLocale(language);
-        Log.i(TAG, "setNewLocale complete: locale: " + locale.getLanguage()
-                + " Locale.getDefault: " + Locale.getDefault().getLanguage());
     }
 	
     public static void forceChangeLanguage(Activity activity) {
@@ -106,6 +76,6 @@ public class OrbotApp extends Application implements OrbotConstants
     }
 
     public static Languages getLanguages(Activity activity) {
-        return Languages.get(activity, R.string.menu_settings, "Settings");
+        return Languages.get(activity);
     }
 }

src/org/torproject/android/settings/SettingsPreferences.java

@@ -56,7 +56,7 @@ public class SettingsPreferences
 
         prefLocale = (ListPreference) findPreference("pref_default_locale");
         prefLocale.setOnPreferenceClickListener(this);
-        Languages languages = Languages.get(this, R.string.menu_settings, "Settings");
+        Languages languages = Languages.get(this);
         prefLocale.setEntries(languages.getAllNames());
         prefLocale.setEntryValues(languages.getSupportedLocales());
         prefLocale.setOnPreferenceChangeListener(new OnPreferenceChangeListener() {
@@ -71,7 +71,7 @@ public class SettingsPreferences
                     String lang = settings.getString("pref_default_locale",
                             Locale.getDefault().getLanguage());
                     OrbotApp app = (OrbotApp) getApplication();
-                    app.setNewLocale(language);
+                    Languages.setLanguage(app, language, true);
                     lang = settings.getString("pref_default_locale",
                             Locale.getDefault().getLanguage());
                     OrbotApp.forceChangeLanguage(SettingsPreferences.this);