Merge pull request #4218 from wordpress-mobile/issue/1176-ringtone-preference-for-notification-sound

issue/1176 allow user to use custom notification sound.

Author: daniloercoli

WordPress/src/main/java/org/wordpress/android/GCMMessageService.java

@@ -69,8 +69,8 @@ public class GCMMessageService extends GcmListenerService {
     private static final String PUSH_TYPE_PUSH_AUTH = "push_auth";
 
     // Add to the analytics properties map a subset of the push notification payload.
-    private static String[] propertiesToCopyIntoAnalytics = { PUSH_ARG_NOTE_ID, PUSH_ARG_TYPE, "blog_id", "post_id",
-            "comment_id" };
+    private static String[] propertiesToCopyIntoAnalytics = {PUSH_ARG_NOTE_ID, PUSH_ARG_TYPE, "blog_id", "post_id",
+            "comment_id"};
 
     private void synchronizedHandleDefaultPush(String from, @NonNull Bundle data) {
         // sActiveNotificationsMap being static, we can't just synchronize the method
@@ -295,9 +295,16 @@ private void showNotificationForBuilder(NotificationCompat.Builder builder, Cont
         boolean shouldPlaySound = prefs.getBoolean("wp_pref_notification_sound", false);
         boolean shouldVibrate = prefs.getBoolean("wp_pref_notification_vibrate", false);
         boolean shouldBlinkLight = prefs.getBoolean("wp_pref_notification_light", false);
-        if (shouldPlaySound) {
-            builder.setSound(Uri.parse("android.resource://" + getPackageName() + "/" + R.raw.notification));
+        String notificationSound = prefs.getString("wp_pref_custom_notification_sound", null); //"" if None is selected
+
+
+        // use default sound if the legacy sound preference was ON but the custom sound was not selected (null)
+        if (shouldPlaySound && notificationSound == null) {
+            builder.setSound(Uri.parse("content://settings/system/notification_sound"));
+        } else if (!TextUtils.isEmpty(notificationSound)) {
+            builder.setSound(Uri.parse(notificationSound));
         }
+
         if (shouldVibrate) {
             builder.setVibrate(new long[]{500, 500, 500});
         }
@@ -475,7 +482,7 @@ public static synchronized void bumpPushNotificationsTappedAllAnalytics() {
     }
 
     private static void bumpPushNotificationsAnalytics(Stat stat, Bundle noteBundle,
-                                                                    Map<String, Object> properties) {
+                                                       Map<String, Object> properties) {
         // Bump Analytics for PNs if "Show notifications" setting is checked (default). Skip otherwise.
         if (!NotificationsUtils.isNotificationsEnabled(WordPress.getContext())) {
             return;
@@ -486,9 +493,9 @@ private static void bumpPushNotificationsAnalytics(Stat stat, Bundle noteBundle,
 
         String notificationID = noteBundle.getString(PUSH_ARG_NOTE_ID, "");
         if (!TextUtils.isEmpty(notificationID)) {
-            for (String currentPropertyToCopy: propertiesToCopyIntoAnalytics) {
+            for (String currentPropertyToCopy : propertiesToCopyIntoAnalytics) {
                 if (noteBundle.containsKey(currentPropertyToCopy)) {
-                    properties.put("push_notification_" + currentPropertyToCopy,  noteBundle.get(currentPropertyToCopy));
+                    properties.put("push_notification_" + currentPropertyToCopy, noteBundle.get(currentPropertyToCopy));
                 }
             }
             SharedPreferences preferences = PreferenceManager.getDefaultSharedPreferences(WordPress.getContext());

WordPress/src/main/res/raw/notification.mp3

@@ -46,7 +46,7 @@
     <string name="hide">Hide</string>
     <string name="select_all">Select all</string>
     <string name="deselect_all">Deselect all</string>
-    <string name="notification_sound">Play notification sound</string>
+    <string name="notification_sound">Notification sound</string>
     <string name="notification_vibrate">Vibrate</string>
     <string name="notification_blink">Blink notification light</string>
     <string name="sure_to_remove_account">Remove this site?</string>

WordPress/src/main/res/values/strings.xml

@@ -2,20 +2,23 @@
 <PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android"
                   android:key="wp_pref_notifications_root">
     <PreferenceCategory
-        android:title="@string/your_sites"
-        android:key="@string/pref_notification_blogs">
+        android:key="@string/pref_notification_blogs"
+        android:title="@string/your_sites">
     </PreferenceCategory>
     <PreferenceCategory
-        android:title="@string/notifications_other"
-        android:key="@string/pref_notification_other_category">
-        <PreferenceScreen android:key="@string/pref_notification_other_blogs"
-            android:title="@string/notifications_comments_other_blogs" />
+        android:key="@string/pref_notification_other_category"
+        android:title="@string/notifications_other">
+        <PreferenceScreen
+            android:key="@string/pref_notification_other_blogs"
+            android:title="@string/notifications_comments_other_blogs"/>
     </PreferenceCategory>
-    <PreferenceCategory android:title="@string/notifications_sights_and_sounds"
-        android:key="@string/pref_notification_sights_sounds">
-        <SwitchPreference
-            android:defaultValue="false"
-            android:key="wp_pref_notification_sound"
+    <PreferenceCategory
+        android:key="@string/pref_notification_sights_sounds"
+        android:title="@string/notifications_sights_and_sounds">
+        <RingtonePreference
+            android:key="wp_pref_custom_notification_sound"
+            android:ringtoneType="notification"
+            android:showDefault="true"
             android:title="@string/notification_sound"/>
         <SwitchPreference
             android:defaultValue="false"