Merge pull request #214 from OneSignal/permission_and_subscription_observers

* Added new permission and subscription observers
   - Includes addPermissionObserver and addSubscriptionObserver
* Added getPermissionSubscriptionState
* Badges are cleared and no longer set if user disables notifications in Settings.
* Added unsubscribeWhenNotificationsAreDisabled option

Author: jkasten2

OneSignalSDK/onesignal/consumer-proguard-rules.pro

@@ -8,6 +8,25 @@
 -keep public interface android.app.OnActivityPausedListener {*;}
 -keep class com.onesignal.ActivityLifecycleListenerCompat** {*;}
 
+-keep class com.onesignal.OSSubscriptionState {
+    void changed(com.onesignal.OSPermissionState);
+}
+
+-keep class com.onesignal.OSPermissionChangedInternalObserver {
+    void changed(com.onesignal.OSPermissionState);
+}
+
+-keep class com.onesignal.OSSubscriptionChangedInternalObserver {
+    void changed(com.onesignal.OSSubscriptionState);
+}
+
+-keep class ** implements com.onesignal.OSPermissionObserver {
+    void onOSPermissionChanged(com.onesignal.OSPermissionStateChanges);
+}
+
+-keep class ** implements com.onesignal.OSSubscriptionObserver {
+    void onOSSubscriptionChanged(com.onesignal.OSSubscriptionStateChanges);
+}
 
 -keep class com.onesignal.shortcutbadger.impl.AdwHomeBadger { <init>(...); }
 -keep class com.onesignal.shortcutbadger.impl.ApexHomeBadger { <init>(...); }

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

@@ -41,7 +41,7 @@ class BadgeCountUpdater {
    // Cache for manifest setting.
    private static int badgesEnabled = -1;
 
-   private static boolean isBadgesEnabled(Context context) {
+   private static boolean areBadgeSettingsEnabled(Context context) {
       if (badgesEnabled != -1)
          return (badgesEnabled == 1);
 
@@ -57,9 +57,13 @@ private static boolean isBadgesEnabled(Context context) {
 
       return (badgesEnabled == 1);
    }
+   
+   private static boolean areBadgesEnabled(Context context) {
+      return areBadgeSettingsEnabled(context) && OSUtils.areNotificationsEnabled(context);
+   }
 
    static void update(SQLiteDatabase readableDb, Context context) {
-      if (!isBadgesEnabled(context))
+      if (!areBadgesEnabled(context))
          return;
 
       Cursor cursor = readableDb.query(
@@ -79,7 +83,7 @@ static void update(SQLiteDatabase readableDb, Context context) {
    }
 
    static void updateCount(int count, Context context) {
-      if (!isBadgesEnabled(context))
+      if (!areBadgeSettingsEnabled(context))
          return;
 
       // Can throw if badges are not support on the device.

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

@@ -0,0 +1,105 @@
+/**
+ * Modified MIT License
+ *
+ * Copyright 2017 OneSignal
+ *
+ * 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:
+ *
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ *
+ * 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 java.lang.ref.WeakReference;
+import java.lang.reflect.Method;
+import java.util.ArrayList;
+import java.util.List;
+
+class OSObservable<ObserverType, StateType> {
+   private String methodName;
+   private List<Object> observers;
+   private boolean fireOnMainThread;
+   
+   OSObservable(String methodName, boolean fireOnMainThread) {
+      this.methodName = methodName;
+      this.fireOnMainThread = fireOnMainThread;
+      observers = new ArrayList<>();
+   }
+   
+   void addObserver(ObserverType observer) {
+      observers.add(new WeakReference<>(observer));
+   }
+   
+   void addObserverStrong(ObserverType observer){
+      observers.add(observer);
+   }
+   
+   void removeObserver(ObserverType observer) {
+      for(int i = 0; i < observers.size(); i++) {
+         Object anObserver = ((WeakReference)observers.get(i)).get();
+         if (anObserver.equals(observer)) {
+            observers.remove(i);
+            break;
+         }
+      }
+   }
+   
+   boolean notifyChange(final StateType state) {
+      boolean notified = false;
+      
+      for(Object observer : observers) {
+         final Object strongRefObserver;
+         if (observer instanceof WeakReference)
+            strongRefObserver = ((WeakReference)observer).get();
+         else
+            strongRefObserver = observer;
+         
+         if (strongRefObserver != null) {
+            try {
+               Class<?> clazz = strongRefObserver.getClass();
+               final Method method = clazz.getDeclaredMethod(methodName, state.getClass());
+               method.setAccessible(true);
+               if (fireOnMainThread) {
+                  OSUtils.runOnMainUIThread(
+                     new Runnable() {
+                        @Override
+                        public void run() {
+                           try {
+                              method.invoke(strongRefObserver, state);
+                           }
+                           catch (Throwable t) {
+                              t.printStackTrace();
+                           }
+                        }
+                     });
+                  
+               }
+               else
+                  method.invoke(strongRefObserver, state);
+               notified = true;
+            } catch (Throwable t) {
+               t.printStackTrace();
+            }
+         }
+      }
+      
+      return notified;
+   }
+}

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

@@ -0,0 +1,58 @@
+/**
+ * Modified MIT License
+ *
+ * Copyright 2017 OneSignal
+ *
+ * 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:
+ *
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ *
+ * 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;
+
+class OSPermissionChangedInternalObserver {
+   void changed(OSPermissionState state) {
+      handleInternalChanges(state);
+      fireChangesToPublicObserver(state);
+   }
+   
+   static void handleInternalChanges(OSPermissionState state) {
+      if (!state.getEnabled())
+         BadgeCountUpdater.updateCount(0, OneSignal.appContext);
+      OneSignalStateSynchronizer.setPermission(OneSignal.areNotificationsEnabledForSubscribedState());
+   }
+   
+   // Handles firing a public facing PermissionStateChangesObserver
+   //    1. Generates a OSPermissionStateChanges object and sets to and from states
+   //    2. Persists acknowledgement
+   //      - Prevents duplicated events
+   //      - Notifies if changes were made outside of the app
+   static void fireChangesToPublicObserver(OSPermissionState state) {
+      OSPermissionStateChanges stateChanges = new OSPermissionStateChanges();
+      stateChanges.from = OneSignal.lastPermissionState;
+      stateChanges.to = (OSPermissionState)state.clone();
+      
+      boolean hasReceiver = OneSignal.getPermissionStateChangesObserver().notifyChange(stateChanges);
+      if (hasReceiver) {
+         OneSignal.lastPermissionState = (OSPermissionState)state.clone();
+         OneSignal.lastPermissionState.persistAsFrom();
+      }
+   }
+}

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

@@ -0,0 +1,32 @@
+/**
+ * Modified MIT License
+ *
+ * Copyright 2017 OneSignal
+ *
+ * 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:
+ *
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ *
+ * 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;
+
+public interface OSPermissionObserver {
+   void onOSPermissionChanged(OSPermissionStateChanges stateChanges);
+}

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

@@ -0,0 +1,89 @@
+/**
+ * Modified MIT License
+ *
+ * Copyright 2017 OneSignal
+ *
+ * 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:
+ *
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ *
+ * 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 android.content.SharedPreferences;
+
+import static com.onesignal.OneSignal.appContext;
+import static com.onesignal.OneSignal.getGcmPreferences;
+
+public class OSPermissionState implements Cloneable {
+   
+   OSObservable<Object, OSPermissionState> observable;
+   
+   OSPermissionState(boolean asFrom) {
+      // Java 8 method reference can be used in the future with Android Studio 2.4.0
+      //   OSPermissionChangedInternalObserver::changed
+      observable = new OSObservable<>("changed", false);
+      
+      if (asFrom) {
+         final SharedPreferences prefs = getGcmPreferences(appContext);
+         enabled = prefs.getBoolean("ONESIGNAL_ACCEPTED_NOTIFICATION_LAST", false);
+      }
+      else
+         refreshAsTo();
+   }
+   
+   private boolean enabled;
+   
+   void refreshAsTo() {
+      setEnabled(OSUtils.areNotificationsEnabled(appContext));
+   }
+   
+   public boolean getEnabled() {
+      return enabled;
+   }
+   
+   private void setEnabled(boolean set) {
+      boolean changed = enabled != set;
+      enabled = set;
+      if (changed)
+         observable.notifyChange(this);
+   }
+   
+   void persistAsFrom() {
+      final SharedPreferences prefs = getGcmPreferences(appContext);
+      SharedPreferences.Editor editor = prefs.edit();
+      editor.putBoolean("ONESIGNAL_ACCEPTED_NOTIFICATION_LAST", enabled);
+      editor.commit();
+   }
+   
+   boolean compare(OSPermissionState from) {
+      return enabled != from.enabled;
+   }
+   
+   protected Object clone() {
+      try {
+         return super.clone();
+      } catch (Throwable t) {}
+      return null;
+   }
+   
+   
+   // FUTURE: Can add a list of categories here for Android O.
+}

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

@@ -0,0 +1,40 @@
+/**
+ * Modified MIT License
+ *
+ * Copyright 2017 OneSignal
+ *
+ * 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:
+ *
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ *
+ * 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;
+
+public class OSPermissionStateChanges {
+   OSPermissionState to, from;
+   
+   public OSPermissionState getTo() {
+      return to;
+   }
+   
+   public OSPermissionState getFrom() {
+      return from;
+   }
+}