Implement support for notification.vibrate

chrome/android/java/src/org/chromium/chrome/browser/notifications/NotificationUIManager.java

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package org.chromium.chrome.browser.notifications;
 
 import android.app.Notification;
 import android.app.NotificationManager;
 import android.app.PendingIntent;
 import android.content.Context;
@@ skipping 272 matching lines @@
             URI uri = new URI(parts[1]);
             if (uri.getHost() != null) return parts[1];
         } catch (URISyntaxException e) {
             Log.e(TAG, "Expected to find a valid url in the notification tag extra.", e);
             return null;
         }
         return null;
     }
 
     /**
+     * Generates the notfiication defaults from vibratePattern's size and silent.
+     *
+     * Use the system's default ringtone, vibration and indicator lights unless the notification
+     * has been marked as being silent, for example because it's low priority.

[Peter Beverloo, 2015/05/01 17:17:59]

"for example because it's low priority." -> we don't support priority, so please
don't add that here.

[Sanghyun Park, 2015/05/04 07:00:43]

Done.

+     * If a vibration pattern is set, the notification should use the provided pattern
+     * rather than the defaulting to system settings.
+     *
+     * @param vibratePatternLength Vibration pattern's size for the Notification.
+     * @param silent Whether the default sound, vibration and lights should be suppressed.
+     * @return The generated notification's default value.
+     *         Returns 0 if silent is true.

[Peter Beverloo, 2015/05/01 17:17:59]

No need for lines 303-306 in the description, one can read the code.

[Sanghyun Park, 2015/05/04 07:00:43]

Okay, I'll remove these lines.

+     *         Returns Notification.DEFAULT_ALL if silent is false and vibration's length is 0.
+     *         Returns Notification.DEFAULT_ALL & ~Notification.DEFAULT_VIBRATE
+     *         if silent is false and vibration's length is greater than 0.
+    */
+    @VisibleForTesting
+    static int makeDefaults(int vibratePatternLength, boolean silent) {
+        assert silent && vibratePatternLength == 0;
+
+        if (silent) return 0;
+
+        int defaults = Notification.DEFAULT_ALL;
+        if (vibratePatternLength > 0) {
+            defaults &= ~Notification.DEFAULT_VIBRATE;
+        }
+        return defaults;
+    }
+
+    /**
+     * Generates the vibration pattern used in Android notification.
+     *
+     * In Android platform, the first value indicates the number of

[Peter Beverloo, 2015/05/01 17:17:59]

nit: the linebreaks are kind of odd in this comment.

What about:

     * Android takes a long array where the first entry indicates the number of
milliseconds to wait
     * prior to starting the vibration, whereas Chrome follows the syntax of the
Web Vibration API.

[Sanghyun Park, 2015/05/04 07:00:44]

Done.

+     * milliseconds to wait before turning the vibrator on unlike Blink.
+     * So, we need to insert any value at the beginning of vibrate value.
+     *
+     * @param vibratePattern Vibration pattern for the Notification.

[Peter Beverloo, 2015/05/01 17:17:59]

--> Vibration pattern following the Web Vibration API syntax.

[Sanghyun Park, 2015/05/04 07:00:43]

Done.

+     * @return The generated vibration pattern for Android.

[Peter Beverloo, 2015/05/01 17:17:59]

--> Vibration pattern following the Android syntax.

[Sanghyun Park, 2015/05/04 07:00:43]

Done.

+    */
+    @VisibleForTesting
+    static long[] makeVibratePattern(int[] vibratePattern) {
+        long[] pattern = new long[vibratePattern.length + 1];
+        for (int i = 0; i < vibratePattern.length; ++i) {
+            pattern[i + 1] = vibratePattern[i];
+        }
+        return pattern;
+    }
+
+    /**
      * Displays a notification with the given details.
      *
      * @param persistentNotificationId The persistent id of the notification.
      * @param origin Full text of the origin, including the protocol, owning this notification.
      * @param tag A string identifier for this notification. If the tag is not empty, the new
      *            notification will replace the previous notification with the same tag and origin,
      *            if present. If no matching previous notification is present, the new one will just
      *            be added.
      * @param title Title to be displayed in the notification.
      * @param body Message to be displayed in the notification. Will be trimmed to one line of
      *             text by the Android notification system.
      * @param icon Icon to be displayed in the notification. When this isn't a valid Bitmap, a
      *             default icon will be generated instead.
+     * @param vibratePattern Vibration pattern for the Notification.

[Peter Beverloo, 2015/05/01 17:17:59]

--> Vibration pattern following the Web Vibration syntax.

[Sanghyun Park, 2015/05/04 07:00:43]

Done.

      * @param silent Whether the default sound, vibration and lights should be suppressed.
+     * @see https://developer.android.com/reference/android/app/Notification.html
      */
     @CalledByNative
     private void displayNotification(long persistentNotificationId, String origin, String tag,
-            String title, String body, Bitmap icon, boolean silent) {
+            String title, String body, Bitmap icon, int[] vibratePattern, boolean silent) {

[Peter Beverloo, 2015/05/01 17:17:59]

nit: rename this to vibrationPattern?

[Sanghyun Park, 2015/05/04 07:00:43]

Done.

         if (icon == null || icon.getWidth() == 0) {
             icon = getIconGenerator().generateIconForUrl(origin, true);
         }
 
         Resources res = mAppContext.getResources();
 
         // The data used to make each intent unique according to the rules of Intent#filterEquals.
         // Without this, the pending intents derived from them may be reused, because extras are
         // not taken into account for the filterEquals comparison.
         Uri intentData = Uri.parse(origin).buildUpon().fragment(
@@ skipping 19 matching lines @@
                         NotificationConstants.ACTION_CLICK_NOTIFICATION,
                         persistentNotificationId, origin, tag, intentData))
                 .setDeleteIntent(getPendingIntent(
                         NotificationConstants.ACTION_CLOSE_NOTIFICATION,
                         persistentNotificationId, origin, tag, intentData))
                 .addAction(R.drawable.settings_cog,
                            res.getString(R.string.page_info_site_settings_button),
                            pendingSettingsIntent)
                 .setSubText(origin);
 
-        // Use the system's default ringtone, vibration and indicator lights unless the notification
-        // has been marked as being silent, for example because it's low priority.
-        if (!silent) notificationBuilder.setDefaults(Notification.DEFAULT_ALL);
+        notificationBuilder.setDefaults(makeDefaults(vibratePattern.length, silent));
+        if (vibratePattern.length > 0) {
+            notificationBuilder.setVibrate(makeVibratePattern(vibratePattern));
+        }
 
         String platformTag = makePlatformTag(persistentNotificationId, origin, tag);
         mNotificationManager.notify(platformTag, PLATFORM_ID, notificationBuilder.build());
     }
 
     /**
      * Ensures the existance of an icon generator, which is created lazily.
      *
      * @return The icon generator which can be used.
      */
@@ skipping 73 matching lines @@
                                           origin, tag);
     }
 
     private static native void nativeInitializeNotificationUIManager();
 
     private native boolean nativeOnNotificationClicked(long nativeNotificationUIManagerAndroid,
             long persistentNotificationId, String origin, String tag);
     private native boolean nativeOnNotificationClosed(long nativeNotificationUIManagerAndroid,
             long persistentNotificationId, String origin, String tag);
 }