Merge branch 'master' into major_release_4.0.0

Author: Jeasmine

OneSignalSDK.jar

@@ -24,7 +24,7 @@ class Global {
     static def POM_NAME = 'OneSignal'
     static def POM_ARTIFACT_ID = 'OneSignal'
     static def POM_PACKAGING = 'aar'
-    static def VERSION_NAME = '3.15.3'
+    static def VERSION_NAME = '3.15.4'
 
     static def GROUP_ID = 'com.onesignal'
     static def POM_DESCRIPTION = 'OneSignal Android SDK'

OneSignalSDK/onesignal/maven-push.gradle

@@ -0,0 +1,89 @@
+/**
+ * Modified MIT License
+ * <p>
+ * Copyright 2020 OneSignal
+ * <p>
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * <p>
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * <p>
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ * <p>
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package com.onesignal;
+
+import org.json.JSONException;
+import org.json.JSONObject;
+
+class ImmutableJSONObject {
+
+    private final JSONObject jsonObject;
+
+    public ImmutableJSONObject() {
+        this.jsonObject = new JSONObject();
+    }
+
+    public ImmutableJSONObject(JSONObject jsonObject) {
+        this.jsonObject = jsonObject;
+    }
+
+    public long getLong(String name) throws JSONException {
+        return jsonObject.getLong(name);
+    }
+
+    public boolean has(String name) {
+        return jsonObject.has(name);
+    }
+
+    public Object opt(String name) {
+        return jsonObject.opt(name);
+    }
+
+    public String optString(String name) {
+        return jsonObject.optString(name);
+    }
+
+    public String optString(String name, String fallback) {
+        return jsonObject.optString(name, fallback);
+    }
+
+    public boolean optBoolean(String name) {
+        return jsonObject.optBoolean(name);
+    }
+
+    public boolean optBoolean(String name, boolean fallback) {
+        return jsonObject.optBoolean(name, fallback);
+    }
+
+    public long optLong(String name) {
+        return jsonObject.optLong(name);
+    }
+
+    public int optInt(String name) {
+        return jsonObject.optInt(name);
+    }
+
+    public int optInt(String name, int fallback) {
+        return jsonObject.optInt(name, fallback);
+    }
+
+    public JSONObject optJSONObject(String name) {
+        return jsonObject.optJSONObject(name);
+    }
+
+}

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

@@ -130,7 +130,7 @@ static String toStringNE(JSONArray jsonArray) {
         return strArray + "]";
     }
 
-    static JSONObject getJSONObjectWithoutBlankValues(JSONObject jsonObject, String getKey) {
+    static JSONObject getJSONObjectWithoutBlankValues(ImmutableJSONObject jsonObject, String getKey) {
         if (!jsonObject.has(getKey))
             return null;
 

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

@@ -230,8 +230,31 @@ public static class SendTagsError {
       public String getMessage() { return message; }
    }
 
+   public enum ExternalIdErrorType {
+      REQUIRES_EXTERNAL_ID_AUTH, INVALID_OPERATION, NETWORK
+   }
+
+   public static class ExternalIdError {
+      private ExternalIdErrorType type;
+      private String message;
+
+      ExternalIdError(ExternalIdErrorType type, String message) {
+         this.type = type;
+         this.message = message;
+      }
+
+      public ExternalIdErrorType getType() {
+         return type;
+      }
+
+      public String getMessage() {
+         return message;
+      }
+   }
+
    public interface OSExternalUserIdUpdateCompletionHandler {
       void onComplete(JSONObject results);
+      void onFailure(ExternalIdError error);
    }
 
    interface OSInternalExternalUserIdUpdateCompletionHandler {
@@ -324,7 +347,7 @@ static void setInForeground(boolean inForeground) {
    private static TrackAmazonPurchase trackAmazonPurchase;
    private static TrackFirebaseAnalytics trackFirebaseAnalytics;
 
-   public static final String VERSION = "031503";
+   public static final String VERSION = "031504";
 
    private static OSLogger logger = new OSLogWrapper();
    private static FocusTimeController focusTimeController = new FocusTimeController(new OSFocusTimeProcessorFactory(), logger);
@@ -1417,33 +1440,53 @@ public void run() {
    }
 
    public static void setExternalUserId(@NonNull final String externalId) {
-      setExternalUserId(externalId, null);
+      setExternalUserId(externalId, null, null);
    }
 
    public static void setExternalUserId(@NonNull final String externalId, @Nullable final OSExternalUserIdUpdateCompletionHandler completionCallback) {
+      setExternalUserId(externalId, null, completionCallback);
+   }
+
+   public static void setExternalUserId(@NonNull final String externalId,  @Nullable final String externalIdAuthHash) {
+      setExternalUserId(externalId, externalIdAuthHash, null);
+   }
+
+   public static void setExternalUserId(@NonNull final String externalId, @Nullable final String externalIdAuthHash, @Nullable final OSExternalUserIdUpdateCompletionHandler completionCallback) {
       if (taskController.shouldQueueTaskForInit(OSTaskController.SET_EXTERNAL_USER_ID)) {
          logger.error("Waiting for remote params. " +
                  "Moving " + OSTaskController.SET_EXTERNAL_USER_ID + " operation to a pending task queue.");
          taskController.addTaskToQueue(new Runnable() {
             @Override
             public void run() {
                logger.debug("Running " + OSTaskController.SET_EXTERNAL_USER_ID + " operation from pending task queue.");
-               setExternalUserId(externalId, completionCallback);
+               setExternalUserId(externalId, externalIdAuthHash, completionCallback);
             }
          });
          return;
       }
 
-      if (shouldLogUserPrivacyConsentErrorMessageForMethodName(OSTaskController.SET_EXTERNAL_USER_ID))
+      if (shouldLogUserPrivacyConsentErrorMessageForMethodName("setExternalUserId()"))
          return;
 
       if (externalId == null) {
          logger.warning("External id can't be null, set an empty string to remove an external id");
          return;
       }
 
+      if (getRemoteParams() != null && getRemoteParams().useUserIdAuth && externalIdAuthHash == null) {
+         String errorMessage = "External Id authentication (auth token) is set to REQUIRED for this application. Please provide an auth token from your backend server or change the setting in the OneSignal dashboard.";
+         if (completionCallback != null)
+            completionCallback.onFailure(new ExternalIdError(ExternalIdErrorType.REQUIRES_EXTERNAL_ID_AUTH, errorMessage));
+         logger.error(errorMessage);
+         return;
+      }
+
+      String lowerCaseIdAuthHash = externalIdAuthHash;
+      if (lowerCaseIdAuthHash != null)
+         lowerCaseIdAuthHash = externalIdAuthHash.toLowerCase();
+
       try {
-         OneSignalStateSynchronizer.setExternalUserId(externalId, completionCallback);
+         OneSignalStateSynchronizer.setExternalUserId(externalId, lowerCaseIdAuthHash, completionCallback);
       } catch (JSONException exception) {
          String operation = externalId.equals("") ? "remove" : "set";
          logger.error("Attempted to " + operation + " external ID but encountered a JSON exception");

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

@@ -76,6 +76,7 @@ static class Params {
       String googleProjectNumber;
       boolean enterprise;
       boolean useEmailAuth;
+      boolean useUserIdAuth;
       JSONArray notificationChannels;
       boolean firebaseAnalytics;
       boolean restoreTTLFilter;
@@ -172,6 +173,7 @@ static private void processJson(String json, final @NonNull Callback callBack) {
       Params params = new Params() {{
          enterprise = responseJson.optBoolean("enterp", false);
          useEmailAuth = responseJson.optBoolean("use_email_auth", false);
+         useUserIdAuth = responseJson.optBoolean("require_user_id_auth", false);
          notificationChannels = responseJson.optJSONArray("chnl_lst");
          firebaseAnalytics = responseJson.optBoolean("fba", false);
          restoreTTLFilter = responseJson.optBoolean("restore_ttl_filter", true);

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

@@ -187,7 +187,7 @@ static void logoutEmail() {
       getEmailStateSynchronizer().logoutEmail();
    }
 
-   static void setExternalUserId(String externalId, final OneSignal.OSExternalUserIdUpdateCompletionHandler completionHandler) throws JSONException {
+   static void setExternalUserId(String externalId, String externalIdAuthHash, final OneSignal.OSExternalUserIdUpdateCompletionHandler completionHandler) throws JSONException {
       final JSONObject responses = new JSONObject();
       // Create a handler for internal usage, this is where the developers completion handler will be called,
       //  which happens once all handlers for each channel have been processed
@@ -222,11 +222,11 @@ public void run() {
          }
       };
 
-      getPushStateSynchronizer().setExternalUserId(externalId, handler);
+      getPushStateSynchronizer().setExternalUserId(externalId, externalIdAuthHash, handler);
 
       // Make sure we are only setting external user id for email when an email is actually set
       if (OneSignal.hasEmailId())
-         getEmailStateSynchronizer().setExternalUserId(externalId, handler);
+         getEmailStateSynchronizer().setExternalUserId(externalId, externalIdAuthHash, handler);
    }
 
    // This is to indicate that StateSynchronizer can start making REST API calls