Add the vibrate attribute to the Notification object

Source/modules/notifications/Notification.cpp

 /*
  * Copyright (C) 2013 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 33 matching lines @@
 #include "core/frame/UseCounter.h"
 #include "modules/notifications/NotificationOptions.h"
 #include "modules/notifications/NotificationPermissionClient.h"
 #include "platform/RuntimeEnabledFeatures.h"
 #include "platform/UserGestureIndicator.h"
 #include "public/platform/Platform.h"
 #include "public/platform/WebSerializedOrigin.h"
 #include "public/platform/WebString.h"
 #include "public/platform/modules/notifications/WebNotificationData.h"
 #include "public/platform/modules/notifications/WebNotificationManager.h"
+#include "public/platform/modules/notifications/WebNotificationVibratePattern.h"
 
 namespace blink {
 namespace {
 
 WebNotificationManager* notificationManager()
 {
     return Platform::current()->notificationManager();
 }
 
 } // namespace
 
 Notification* Notification::create(ExecutionContext* context, const String& title, const NotificationOptions& options, ExceptionState& exceptionState)
 {
     // The Web Notification constructor may be disabled through a runtime feature. The
     // behavior of the constructor is changing, but not completely agreed upon yet.
     if (!RuntimeEnabledFeatures::notificationConstructorEnabled()) {
         exceptionState.throwTypeError("Illegal constructor. Use ServiceWorkerRegistration.showNotification() instead.");
         return nullptr;
     }
 
     // The Web Notification constructor may not be used in Service Worker contexts.
     if (context->isServiceWorkerGlobalScope()) {
         exceptionState.throwTypeError("Illegal constructor.");
         return nullptr;
     }
 
+    // If options’s silent is true, and options’s vibrate is present, throw a TypeError exception.

[Peter Beverloo, 2015/04/07 11:37:31]

’ -> '

[Sanghyun Park, 2015/04/08 08:00:03]

Done.

+    if (options.hasVibrate() && options.silent()) {
+        exceptionState.throwTypeError("If options's silent is true, options's vibrate should not be presented");

[Peter Beverloo, 2015/04/07 11:37:31]

"Silent notifications must not specify vibration patterns"

[Sanghyun Park, 2015/04/08 08:00:02]

Done.

+        return nullptr;
+    }
+
     RefPtr<SerializedScriptValue> data;
     if (options.hasData()) {
         data = SerializedScriptValueFactory::instance().create(options.data(), nullptr, exceptionState, options.data().isolate());
         if (exceptionState.hadException())
             return nullptr;
     }
 
     Notification* notification = new Notification(title, context);
 
     notification->setBody(options.body());
     notification->setTag(options.tag());
     notification->setLang(options.lang());
     notification->setDir(options.dir());
+    notification->setVibrate(options.vibrate());
     notification->setSilent(options.silent());
     notification->setSerializedData(data.release());
     if (options.hasIcon()) {
         KURL iconUrl = options.icon().isEmpty() ? KURL() : context->completeURL(options.icon());
         if (!iconUrl.isEmpty() && iconUrl.isValid())
             notification->setIconUrl(iconUrl);
     }
 
     String insecureOriginMessage;
     UseCounter::Feature feature = context->securityOrigin()->canAccessFeatureRequiringSecureOrigin(insecureOriginMessage)
         ? UseCounter::NotificationSecureOrigin : UseCounter::NotificationInsecureOrigin;
     UseCounter::count(context, feature);
 
     notification->scheduleShow();
     notification->suspendIfNeeded();
     return notification;
 }
 
 Notification* Notification::create(ExecutionContext* context, const String& persistentId, const WebNotificationData& data)
 {
     Notification* notification = new Notification(data.title, context);
 
     notification->setPersistentId(persistentId);
     notification->setDir(data.direction == WebNotificationData::DirectionLeftToRight ? "ltr" : "rtl");
     notification->setLang(data.lang);
     notification->setBody(data.body);
     notification->setTag(data.tag);
     notification->setSilent(data.silent);
 
+    if (data.vibrate.type == WebNotificationVibratePattern::TypeUnsignedLong) {
+        notification->setVibrate(UnsignedLongOrUnsignedLongSequence::fromUnsignedLong(data.vibrate.pattern[0]));
+    } else if (data.vibrate.type == WebNotificationVibratePattern::TypeUnsignedLongSequence) {
+        Vector<unsigned> pattern;
+        pattern.appendRange(data.vibrate.pattern.begin(), data.vibrate.pattern.end());
+        notification->setVibrate(UnsignedLongOrUnsignedLongSequence::fromUnsignedLongSequence(pattern));
+    }

[Peter Beverloo, 2015/04/07 11:37:31]

This seems overly complicated to me. We should always pass up an unsigned long
sequence to the embedder as that's how they will be using it. (Ask yourself
this: How would the embedder behave differently based on the type?)

+
     if (!data.icon.isEmpty())
         notification->setIconUrl(data.icon);
 
     if (!data.data.isEmpty()) {
         notification->setSerializedData(SerializedScriptValueFactory::instance().createFromWire(data.data));
         notification->serializedData()->registerMemoryAllocatedWithCurrentScriptContext();
     }
 
     notification->setState(NotificationStateShowing);
     notification->suspendIfNeeded();
     return notification;
 }
 
 Notification::Notification(const String& title, ExecutionContext* context)
     : ActiveDOMObject(context)
     , m_title(title)
     , m_dir("auto")
     , m_silent(false)
     , m_state(NotificationStateIdle)
     , m_asyncRunner(this, &Notification::show)
 {
     ASSERT(notificationManager());
 }
 
 Notification::~Notification()
 {
 }
 
+void Notification::vibrate(UnsignedLongOrUnsignedLongSequence& returnValue)
+{
+    if (m_vibrate.isNull())
+        return;
+
+    if (m_vibrate.isUnsignedLong())
+        returnValue.setUnsignedLong(m_vibrate.getAsUnsignedLong());
+    else
+        returnValue.setUnsignedLongSequence(m_vibrate.getAsUnsignedLongSequence());

[Peter Beverloo, 2015/04/07 11:37:31]

Ah, I see why you're doing this. This is your interpretation of the unresolved
spec issue on how to expose the "vibration" attribute back to the developer.

I don't think maintaining the single-value or sequence state is worth the added
complexity of keeping track of this distance.

Rather, we should just always return a sequence if a pattern is set, or NULL if
no pattern has been set.

[Sanghyun Park, 2015/04/08 08:00:03]

Okay, I will fix to only return sequence type.

+}
+
 void Notification::scheduleShow()
 {
     ASSERT(m_state == NotificationStateIdle);
     ASSERT(!m_asyncRunner.isActive());
 
     m_asyncRunner.runAsync();
 }
 
 void Notification::show()
 {
     ASSERT(m_state == NotificationStateIdle);
     if (Notification::checkPermission(executionContext()) != WebNotificationPermissionAllowed) {
         dispatchErrorEvent();
         return;
     }
 
     SecurityOrigin* origin = executionContext()->securityOrigin();
     ASSERT(origin);
 
     // FIXME: Do CSP checks on the associated notification icon.
     WebNotificationData::Direction dir = m_dir == "rtl" ? WebNotificationData::DirectionRightToLeft : WebNotificationData::DirectionLeftToRight;
 
     // The lifetime and availability of non-persistent notifications is tied to the page
     // they were created by, and thus the data doesn't have to be known to the embedder.
     String emptyDataAsWireString;
-    WebNotificationData notificationData(m_title, dir, m_lang, m_body, m_tag, m_iconUrl, m_silent, emptyDataAsWireString);
+    WebNotificationData notificationData(m_title, dir, m_lang, m_body, m_tag, m_iconUrl, convertFromVibrationData(m_vibrate), m_silent, emptyDataAsWireString);
     notificationManager()->show(WebSerializedOrigin(*origin), notificationData, this);
 
     m_state = NotificationStateShowing;
 }
 
 void Notification::close()
 {
     if (m_state != NotificationStateShowing)
         return;
 
@@ skipping 109 matching lines @@
 }
 
 ScriptValue Notification::data(ScriptState* scriptState) const
 {
     if (!m_serializedData)
         return ScriptValue::createNull(scriptState);
 
     return ScriptValue(scriptState, m_serializedData->deserialize(scriptState->isolate()));
 }
 
+WebNotificationVibratePattern Notification::convertFromVibrationData(const UnsignedLongOrUnsignedLongSequence& vibrate)
+{
+    WebNotificationVibratePattern::Type vibrateType = WebNotificationVibratePattern::TypeNone;
+    Vector<unsigned> vibratePattern;
+
+    if (vibrate.isUnsignedLong()) {
+        vibrateType = WebNotificationVibratePattern::TypeUnsignedLong;
+        vibratePattern.append(vibrate.getAsUnsignedLong());
+    } else if (vibrate.isUnsignedLongSequence()) {
+        vibrateType = WebNotificationVibratePattern::TypeUnsignedLongSequence;
+        vibratePattern = vibrate.getAsUnsignedLongSequence();
+    }
+
+    return WebNotificationVibratePattern(vibrateType, vibratePattern);
+}
+
+
 DEFINE_TRACE(Notification)
 {
     RefCountedGarbageCollectedEventTargetWithInlineData<Notification>::trace(visitor);
     ActiveDOMObject::trace(visitor);
 }
 
 } // namespace blink