Merge pull request #1334 from OneSignal/feat/set_language

Feature app-defined language implementation

Author: jkasten2

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

@@ -40,6 +40,8 @@
 import androidx.annotation.RequiresApi;
 import androidx.core.app.NotificationManagerCompat;
 
+import com.onesignal.language.LanguageContext;
+
 import org.json.JSONArray;
 import org.json.JSONException;
 import org.json.JSONObject;
@@ -116,9 +118,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

@@ -8,6 +8,7 @@
 
 import com.onesignal.OSDynamicTriggerController.OSDynamicTriggerControllerObserver;
 import com.onesignal.OneSignalRestClient.ResponseHandler;
+import com.onesignal.language.LanguageContext;
 
 import org.json.JSONArray;
 import org.json.JSONException;
@@ -39,6 +40,7 @@ class OSInAppMessageController extends OSBackgroundManager implements OSDynamicT
 
     private final OSLogger logger;
     private final OSTaskController taskController;
+    private final LanguageContext languageContext;
 
     private OSSystemConditionController systemConditionController;
     private OSInAppMessageRepository inAppMessageRepository;
@@ -87,7 +89,7 @@ class OSInAppMessageController extends OSBackgroundManager implements OSDynamicT
     Date lastTimeInAppDismissed = null;
     private int htmlNetworkRequestAttemptCount = 0;
 
-    protected OSInAppMessageController(OneSignalDbHelper dbHelper, OSTaskController controller, OSLogger logger) {
+    protected OSInAppMessageController(OneSignalDbHelper dbHelper, OSTaskController controller, OSLogger logger, LanguageContext languageContext) {
         taskController = controller;
         messages = new ArrayList<>();
         dismissedMessages = OSUtils.newConcurrentSet();
@@ -97,6 +99,7 @@ protected OSInAppMessageController(OneSignalDbHelper dbHelper, OSTaskController
         clickedClickIds = OSUtils.newConcurrentSet();
         triggerController = new OSTriggerController(this);
         systemConditionController = new OSSystemConditionController(this);
+        this.languageContext = languageContext;
         this.logger = logger;
 
         Set<String> tempDismissedSet = OneSignalPrefs.getStringSet(
@@ -285,15 +288,15 @@ public void run() {
     }
 
     private @Nullable String variantIdForMessage(@NonNull OSInAppMessage message) {
-        String languageIdentifier = OSUtils.getCorrectedLanguage();
+        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");
         }
 

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, OSTaskController taskController, OSLogger logger) {
+    public OSInAppMessageController getController(OneSignalDbHelper dbHelper, OSTaskController taskController, OSLogger logger, 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, taskController, logger);
+                        controller = new OSInAppMessageDummyController(null, taskController, logger, languageContext);
                     else
-                        controller = new OSInAppMessageController(dbHelper, taskController, logger);
+                        controller = new OSInAppMessageController(dbHelper, taskController, logger, languageContext);
                 }
             }
         }

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

@@ -3,6 +3,8 @@
 import androidx.annotation.NonNull;
 import androidx.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, OSTaskController taskController, OSLogger logger) {
-        super(dbHelper, taskController, logger);
+    OSInAppMessageDummyController(OneSignalDbHelper dbHelper, OSTaskController taskController, OSLogger logger, LanguageContext languageContext) {
+        super(dbHelper, taskController, logger, languageContext);
     }
 
     @Override

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

@@ -13,6 +13,7 @@ class OSTaskRemoteController extends OSTaskController {
     static final String LOGOUT_EMAIL = "logoutEmail()";
     static final String SYNC_HASHED_EMAIL = "syncHashedEmail()";
     static final String SET_EXTERNAL_USER_ID = "setExternalUserId()";
+    static final String SET_LANGUAGE = "setLanguage()";
     static final String SET_SUBSCRIPTION = "setSubscription()";
     static final String PROMPT_LOCATION = "promptLocation()";
     static final String IDS_AVAILABLE = "idsAvailable()";
@@ -39,6 +40,7 @@ class OSTaskRemoteController extends OSTaskController {
             LOGOUT_EMAIL,
             SYNC_HASHED_EMAIL,
             SET_EXTERNAL_USER_ID,
+            SET_LANGUAGE,
             SET_SUBSCRIPTION,
             PROMPT_LOCATION,
             IDS_AVAILABLE,

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

@@ -62,7 +62,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;
@@ -440,24 +439,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

@@ -47,6 +47,8 @@
 
 import com.onesignal.influence.data.OSTrackerFactory;
 import com.onesignal.influence.domain.OSInfluence;
+import com.onesignal.language.LanguageContext;
+import com.onesignal.language.LanguageProviderAppDefined;
 import com.onesignal.outcomes.data.OSOutcomeEventsFactory;
 
 import org.json.JSONArray;
@@ -368,6 +370,8 @@ static Activity getCurrentActivity() {
    private static String smsId = null;
    private static int subscribableStatus = Integer.MAX_VALUE;
 
+   private static LanguageContext languageContext = null;
+
    static OSRemoteNotificationReceivedHandler remoteNotificationReceivedHandler;
    static OSNotificationWillShowInForegroundHandler notificationWillShowInForegroundHandler;
    static OSNotificationOpenedHandler notificationOpenedHandler;
@@ -418,7 +422,7 @@ public void onSessionEnding(@NonNull List<OSInfluence> lastInfluences) {
 
    private static OSInAppMessageControllerFactory inAppMessageControllerFactory = new OSInAppMessageControllerFactory();
    static OSInAppMessageController getInAppMessageController() {
-      return inAppMessageControllerFactory.getController(getDBHelperInstance(), taskController, getLogger());
+      return inAppMessageControllerFactory.getController(getDBHelperInstance(), taskController, getLogger(), languageContext);
    }
    private static OSTime time = new OSTimeImpl();
    private static OSRemoteParamController remoteParamController = new OSRemoteParamController();
@@ -823,6 +827,9 @@ private static void setupContextListeners(boolean wasAppContextNull) {
 
       // Do work here that should only happen once or at the start of a new lifecycle
       if (wasAppContextNull) {
+         // Set Language Context to null
+         languageContext = new LanguageContext(preferences);
+
          // Prefs require a context to save
          // If the previous state of appContext was null, kick off write in-case it was waiting
          OneSignalPrefs.startDelayedWrite();
@@ -1414,7 +1421,7 @@ private static void registerUserTask() throws JSONException {
       deviceInfo.put("device_os", Build.VERSION.RELEASE);
       deviceInfo.put("timezone", getTimeZoneOffset());
       deviceInfo.put("timezone_id", getTimeZoneId());
-      deviceInfo.put("language", OSUtils.getCorrectedLanguage());
+      deviceInfo.put("language", languageContext.getLanguage());
       deviceInfo.put("sdk", VERSION);
       deviceInfo.put("sdk_type", sdkType);
       deviceInfo.put("android_package", packageName);
@@ -1653,6 +1660,36 @@ public void run() {
       OneSignalStateSynchronizer.logoutEmail();
    }
 
+   public static void setLanguage(@NonNull final String language) {
+      if (taskRemoteController.shouldQueueTaskForInit(OSTaskRemoteController.SET_LANGUAGE)) {
+         logger.error("Waiting for remote params. " +
+                 "Moving " + OSTaskRemoteController.SET_LANGUAGE + " operation to a pending task queue.");
+         taskRemoteController.addTaskToQueue(new Runnable() {
+            @Override
+            public void run() {
+               logger.debug("Running " + OSTaskRemoteController.SET_LANGUAGE + " operation from pending task queue.");
+               setLanguage(language);
+            }
+         });
+         return;
+      }
+
+      if (shouldLogUserPrivacyConsentErrorMessageForMethodName(OSTaskRemoteController.SET_LANGUAGE))
+         return;
+
+      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();
+      }
+   }
+
    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,40 @@
+package com.onesignal.language;
+
+import androidx.annotation.NonNull;
+
+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 androidx.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 androidx.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);
+    }
+}