Merge pull request #1350 from OneSignal/feat/set_language_for_3.X.X

Feature App-defined Language implementation backported to 3.X.X version

Author: jkasten2

OneSignalSDK/onesignal/src/main/java/com/onesignal/NotificationChannelManager.java

@@ -39,6 +39,8 @@
 import android.support.annotation.RequiresApi;
 import android.support.v4.app.NotificationManagerCompat;
 
+import com.onesignal.language.LanguageContext;
+
 import org.json.JSONArray;
 import org.json.JSONException;
 import org.json.JSONObject;
@@ -113,9 +115,9 @@ private static String createChannel(Context context, NotificationManager notific
       JSONObject payloadWithText = channelPayload;
       if (channelPayload.has("langs")) {
          JSONObject langList = channelPayload.getJSONObject("langs");
-         String deviceLanguage = OSUtils.getCorrectedLanguage();
-         if (langList.has(deviceLanguage))
-            payloadWithText = langList.optJSONObject(deviceLanguage);
+         String language = LanguageContext.getInstance().getLanguage();
+         if (langList.has(language))
+            payloadWithText = langList.optJSONObject(language);
       }
 
       String channel_name = payloadWithText.optString("nm", "Miscellaneous");

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSInAppMessageController.java

@@ -9,6 +9,7 @@
 
 import com.onesignal.OSDynamicTriggerController.OSDynamicTriggerControllerObserver;
 import com.onesignal.OneSignalRestClient.ResponseHandler;
+import com.onesignal.language.LanguageContext;
 
 import org.json.JSONArray;
 import org.json.JSONException;
@@ -34,6 +35,7 @@ class OSInAppMessageController implements OSDynamicTriggerControllerObserver, OS
     public static final String IN_APP_MESSAGES_JSON_KEY = "in_app_messages";
     private static final String OS_SAVE_IN_APP_MESSAGE = "OS_SAVE_IN_APP_MESSAGE";
     private static final Object LOCK = new Object();
+    private final LanguageContext languageContext;
 
     OSTriggerController triggerController;
     private OSSystemConditionController systemConditionController;
@@ -70,14 +72,15 @@ class OSInAppMessageController implements OSDynamicTriggerControllerObserver, OS
     Date lastTimeInAppDismissed = null;
     private int htmlNetworkRequestAttemptCount = 0;
 
-    protected OSInAppMessageController(OneSignalDbHelper dbHelper) {
+    protected OSInAppMessageController(OneSignalDbHelper dbHelper, LanguageContext languageContext) {
         messages = new ArrayList<>();
         dismissedMessages = OSUtils.newConcurrentSet();
         messageDisplayQueue = new ArrayList<>();
         impressionedMessages = OSUtils.newConcurrentSet();
         clickedClickIds = OSUtils.newConcurrentSet();
         triggerController = new OSTriggerController(this);
         systemConditionController = new OSSystemConditionController(this);
+        this.languageContext = languageContext;
 
         Set<String> tempDismissedSet = OneSignalPrefs.getStringSet(
                 OneSignalPrefs.PREFS_ONESIGNAL,
@@ -209,16 +212,16 @@ private void evaluateInAppMessages() {
         }
     }
 
-    private static @Nullable String variantIdForMessage(@NonNull OSInAppMessage message) {
-        String languageIdentifier = OSUtils.getCorrectedLanguage();
+    private @Nullable String variantIdForMessage(@NonNull OSInAppMessage message) {
+        String language = languageContext.getLanguage();
 
         for (String variant : PREFERRED_VARIANT_ORDER) {
             if (!message.variants.containsKey(variant))
                 continue;
 
             HashMap<String, String> variantMap = message.variants.get(variant);
-            if (variantMap.containsKey(languageIdentifier))
-                return variantMap.get(languageIdentifier);
+            if (variantMap.containsKey(language))
+                return variantMap.get(language);
             return variantMap.get("default");
         }
 
@@ -655,7 +658,7 @@ public void run() {
         OneSignal.onesignalLog(OneSignal.LOG_LEVEL.DEBUG, "persistInAppMessageForRedisplay: " + message.toString() + " with msg array data: " + redisplayedInAppMessages.toString());
     }
 
-    private static @Nullable
+    private @Nullable
     String htmlPathForMessage(OSInAppMessage message) {
         String variantId = variantIdForMessage(message);
 

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSInAppMessageControllerFactory.java

@@ -29,21 +29,23 @@
 
 import android.os.Build;
 
+import com.onesignal.language.LanguageContext;
+
 class OSInAppMessageControllerFactory {
 
     private static final Object LOCK = new Object();
 
     private OSInAppMessageController controller;
 
-    public OSInAppMessageController getController(OneSignalDbHelper dbHelper) {
+    public OSInAppMessageController getController(OneSignalDbHelper dbHelper, LanguageContext languageContext) {
         if (controller == null) {
             synchronized (LOCK) {
                 if (controller == null) {
                     // Make sure only Android 4.4 devices and higher can use IAMs
                     if (Build.VERSION.SDK_INT <= Build.VERSION_CODES.JELLY_BEAN_MR2)
-                        controller = new OSInAppMessageDummyController(null);
+                        controller = new OSInAppMessageDummyController(null, languageContext);
                     else
-                        controller = new OSInAppMessageController(dbHelper);
+                        controller = new OSInAppMessageController(dbHelper, languageContext);
                 }
             }
         }

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSInAppMessageDummyController.java

@@ -3,6 +3,8 @@
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
 
+import com.onesignal.language.LanguageContext;
+
 import org.json.JSONArray;
 import org.json.JSONException;
 import org.json.JSONObject;
@@ -17,8 +19,8 @@ class OSInAppMessageDummyController extends OSInAppMessageController {
      * This is a dummy controller that will be used for Android 4.3 and older devices
      * All methods should be overridden and as empty as possible (few return exceptions)
      */
-    OSInAppMessageDummyController(OneSignalDbHelper dbHelper) {
-        super(dbHelper);
+    OSInAppMessageDummyController(OneSignalDbHelper dbHelper, LanguageContext languageContext) {
+        super(dbHelper, languageContext);
     }
 
     @Override

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSUtils.java

@@ -60,7 +60,6 @@
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.Iterator;
-import java.util.Locale;
 import java.util.Set;
 import java.util.UUID;
 import java.util.concurrent.ConcurrentHashMap;
@@ -437,24 +436,6 @@ static String getResourceString(Context context, String key, String defaultStr)
       return defaultStr;
    }
 
-   static String getCorrectedLanguage() {
-      String lang = Locale.getDefault().getLanguage();
-
-      // https://github.com/OneSignal/OneSignal-Android-SDK/issues/64
-      if (lang.equals("iw"))
-         return "he";
-      if (lang.equals("in"))
-         return "id";
-      if (lang.equals("ji"))
-         return "yi";
-
-      // https://github.com/OneSignal/OneSignal-Android-SDK/issues/98
-      if (lang.equals("zh"))
-         return lang + "-" + Locale.getDefault().getCountry();
-
-      return lang;
-   }
-
    static boolean isValidEmail(String email) {
       if (email == null)
          return false;

OneSignalSDK/onesignal/src/main/java/com/onesignal/OneSignal.java

@@ -49,6 +49,9 @@
 import com.onesignal.influence.OSTrackerFactory;
 import com.onesignal.influence.model.OSInfluence;
 import com.onesignal.outcomes.OSOutcomeEventsFactory;
+import com.onesignal.language.LanguageContext;
+import com.onesignal.language.LanguageProviderAppDefined;
+import com.onesignal.language.LanguageProviderDevice;
 
 import org.json.JSONArray;
 import org.json.JSONException;
@@ -416,6 +419,8 @@ static Activity getCurrentActivity() {
    private static String userId = null, emailId = null;
    private static int subscribableStatus;
 
+   private static LanguageContext languageContext = null;
+
    // Is the init() of OneSignal SDK finished yet
    private static boolean initDone;
    static boolean isInitDone() {
@@ -460,7 +465,7 @@ public void onSessionEnding(@NonNull List<OSInfluence> lastInfluences) {
 
    private static OSInAppMessageControllerFactory inAppMessageControllerFactory = new OSInAppMessageControllerFactory();
    static OSInAppMessageController getInAppMessageController() {
-      return inAppMessageControllerFactory.getController(getDBHelperInstance());
+      return inAppMessageControllerFactory.getController(getDBHelperInstance(), languageContext);
    }
    private static OSLogger logger = new OSLogWrapper();
    private static OneSignalAPIClient apiClient = new OneSignalRestClientWrapper();
@@ -647,6 +652,9 @@ public static void setAppContext(@NonNull Context context) {
       ActivityLifecycleListener.registerActivityLifecycleCallbacks((Application)appContext);
 
       if (wasAppContextNull) {
+         // Initialize languageContext
+         languageContext = new LanguageContext(preferences);
+
          if (outcomeEventsFactory == null)
             outcomeEventsFactory = new OSOutcomeEventsFactory(logger, apiClient, getDBHelperInstance(), preferences);
 
@@ -1394,7 +1402,7 @@ private static void registerUserTask() throws JSONException {
       }
       deviceInfo.put("device_os", Build.VERSION.RELEASE);
       deviceInfo.put("timezone", getTimeZoneOffset());
-      deviceInfo.put("language", OSUtils.getCorrectedLanguage());
+      deviceInfo.put("language", languageContext.getLanguage());
       deviceInfo.put("sdk", VERSION);
       deviceInfo.put("sdk_type", sdkType);
       deviceInfo.put("android_package", packageName);
@@ -1569,6 +1577,36 @@ public void run() {
       emailLogout.run();
    }
 
+   public static void setLanguage(@NonNull final String language) {
+      Runnable runSetLanguage = new Runnable() {
+         @Override
+         public void run() {
+            LanguageProviderAppDefined languageProviderAppDefined = new LanguageProviderAppDefined(preferences);
+            languageProviderAppDefined.setLanguage(language);
+            languageContext.setStrategy(languageProviderAppDefined);
+
+            try {
+               JSONObject deviceInfo = new JSONObject();
+               deviceInfo.put("language", languageContext.getLanguage());
+               OneSignalStateSynchronizer.updateDeviceInfo(deviceInfo);
+            } catch (JSONException exception) {
+               exception.printStackTrace();
+            }
+         }
+      };
+
+      // If either the app context is null or the waiting queue isn't done (to preserve operation order)
+      if (appContext == null || shouldRunTaskThroughQueue()) {
+         addTaskToQueue(new PendingTaskRunnable(runSetLanguage));
+         return;
+      }
+
+      if (shouldLogUserPrivacyConsentErrorMessageForMethodName("setLanguage()"))
+         return;
+
+      runSetLanguage.run();
+   }
+
    public static void setExternalUserId(@NonNull final String externalId) {
       setExternalUserId(externalId, null, null);
    }

OneSignalSDK/onesignal/src/main/java/com/onesignal/language/LanguageContext.java

@@ -0,0 +1,41 @@
+package com.onesignal.language;
+
+import android.support.annotation.NonNull;
+import android.util.Log;
+
+import com.onesignal.OSSharedPreferences;
+
+import static com.onesignal.language.LanguageProviderAppDefined.PREFS_OS_LANGUAGE;
+
+/*
+The Interface implements a getter and setter for the Language Provider.
+It defaults to the device defined Language unless a language override is set.
+ */
+public class LanguageContext {
+    private LanguageProvider strategy;
+    private static LanguageContext instance = null;
+
+    public static LanguageContext getInstance() {
+        return instance;
+    }
+
+    public LanguageContext(OSSharedPreferences preferences) {
+        instance = this;
+        String languageAppDefined = preferences.getString(preferences.getPreferencesName(), PREFS_OS_LANGUAGE, null);
+        if (languageAppDefined != null) {
+            this.strategy = new LanguageProviderAppDefined(preferences);
+        }
+        else {
+            this.strategy = new LanguageProviderDevice();
+        }
+    }
+
+    public void setStrategy(LanguageProvider strategy) {
+        this.strategy = strategy;
+    }
+
+    @NonNull
+    public String getLanguage() {
+        return strategy.getLanguage();
+    }
+}

OneSignalSDK/onesignal/src/main/java/com/onesignal/language/LanguageProvider.java

@@ -0,0 +1,8 @@
+package com.onesignal.language;
+
+import android.support.annotation.NonNull;
+
+public interface LanguageProvider {
+    @NonNull
+    String getLanguage();
+}

OneSignalSDK/onesignal/src/main/java/com/onesignal/language/LanguageProviderAppDefined.java

@@ -0,0 +1,28 @@
+package com.onesignal.language;
+import android.support.annotation.NonNull;
+
+import com.onesignal.OSSharedPreferences;
+
+public class LanguageProviderAppDefined implements LanguageProvider {
+    public static final String PREFS_OS_LANGUAGE = "PREFS_OS_LANGUAGE";
+
+    private static final String DEFAULT_LANGUAGE = "en";
+    private final OSSharedPreferences preferences;
+
+    public LanguageProviderAppDefined(OSSharedPreferences preferences) {
+        this.preferences = preferences;
+    }
+
+    public void setLanguage(String language) {
+        preferences.saveString(
+                preferences.getPreferencesName(),
+                PREFS_OS_LANGUAGE,
+                language);
+    }
+
+    @NonNull
+    public String getLanguage() {
+        return preferences.getString(
+                preferences.getPreferencesName(), PREFS_OS_LANGUAGE, DEFAULT_LANGUAGE);
+    }
+}

OneSignalSDK/onesignal/src/main/java/com/onesignal/language/LanguageProviderDevice.java

@@ -0,0 +1,35 @@
+package com.onesignal.language;
+
+import android.support.annotation.NonNull;
+
+import java.util.Locale;
+
+public class LanguageProviderDevice implements LanguageProvider {
+    private static final String HEBREW_INCORRECT = "iw";
+    private static final String HEBREW_CORRECTED = "he";
+    private static final String INDONESIAN_INCORRECT = "in";
+    private static final String INDONESIAN_CORRECTED = "id";
+    private static final String YIDDISH_INCORRECT = "ji";
+    private static final String YIDDISH_CORRECTED = "yi";
+    private static final String CHINESE = "zh";
+
+    @NonNull
+    public String getLanguage() {
+        String language = Locale.getDefault().getLanguage();
+
+        switch (language) {
+            // https://github.com/OneSignal/OneSignal-Android-SDK/issues/64
+            case HEBREW_INCORRECT:
+                return HEBREW_CORRECTED;
+            case INDONESIAN_INCORRECT:
+                return INDONESIAN_CORRECTED;
+            case YIDDISH_INCORRECT:
+                return YIDDISH_CORRECTED;
+            // https://github.com/OneSignal/OneSignal-Android-SDK/issues/98
+            case CHINESE:
+                return language + "-" + Locale.getDefault().getCountry();
+            default:
+                return language;
+        }
+    }
+}