Generalize validation of developer input for Web Notifications

Source/modules/notifications/Notification.h

 /*
  * 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 25 matching lines @@
 #include "core/dom/ActiveDOMObject.h"
 #include "modules/EventTargetModules.h"
 #include "modules/ModulesExport.h"
 #include "modules/notifications/NotificationAction.h"
 #include "modules/vibration/NavigatorVibration.h"
 #include "platform/AsyncMethodRunner.h"
 #include "platform/heap/Handle.h"
 #include "platform/text/TextDirection.h"
 #include "platform/weborigin/KURL.h"
 #include "public/platform/WebVector.h"
-#include "public/platform/modules/notifications/WebNotificationAction.h"
+#include "public/platform/modules/notifications/WebNotificationData.h"
 #include "public/platform/modules/notifications/WebNotificationDelegate.h"
 #include "public/platform/modules/notifications/WebNotificationPermission.h"
 #include "wtf/PassOwnPtr.h"
 #include "wtf/PassRefPtr.h"
 #include "wtf/RefCounted.h"
 #include "wtf/RefPtr.h"
 
 namespace blink {
 
 class ExecutionContext;
 class NotificationOptions;
 class NotificationPermissionCallback;
 class ScriptState;
 class ScriptValue;
 class UnsignedLongOrUnsignedLongSequence;
-struct WebNotificationData;
 
 class MODULES_EXPORT Notification final : public RefCountedGarbageCollectedEventTargetWithInlineData<Notification>, public ActiveDOMObject, public WebNotificationDelegate {
     REFCOUNTED_GARBAGE_COLLECTED_EVENT_TARGET(Notification);
     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(Notification);
     DEFINE_WRAPPERTYPEINFO();
 public:
     // Used for JavaScript instantiations of the Notification object. Will automatically schedule for
-    // the notification to be displayed to the user.
+    // the notification to be displayed to the user when the developer-provided data is valid.
     static Notification* create(ExecutionContext*, const String& title, const NotificationOptions&, ExceptionState&);
 
     // Used for embedder-created Notification objects. Will initialize the Notification's state as showing.
     static Notification* create(ExecutionContext*, int64_t persistentId, const WebNotificationData&);
 
     ~Notification() override;
 
     void close();
 
     DEFINE_ATTRIBUTE_EVENT_LISTENER(click);
     DEFINE_ATTRIBUTE_EVENT_LISTENER(show);
     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
     DEFINE_ATTRIBUTE_EVENT_LISTENER(close);
 
     // WebNotificationDelegate implementation.
     void dispatchShowEvent() override;
     void dispatchClickEvent() override;
     void dispatchErrorEvent() override;
     void dispatchCloseEvent() override;
 
-    String title() const { return m_title; }
-    String dir() const { return m_dir; }
-    String lang() const { return m_lang; }
-    String body() const { return m_body; }
-    String tag() const { return m_tag; }
-    String icon() const { return m_iconUrl; }
-    const NavigatorVibration::VibrationPattern& vibrate(bool& isNull) const;
-    bool silent() const { return m_silent; }
-    ScriptValue data(ScriptState*) const;
-    const HeapVector<NotificationAction>& actions() const { return m_actions; }
-
-    TextDirection direction() const;
-    KURL iconURL() const { return m_iconUrl; }
-    SerializedScriptValue* serializedData() const { return m_serializedData.get(); }
+    String title() const;
+    String dir() const;
+    String lang() const;
+    String body() const;
+    String tag() const;
+    String icon() const;
+    NavigatorVibration::VibrationPattern vibrate(bool& isNull) const;
+    bool silent() const;
+    ScriptValue data(ScriptState*);
+    HeapVector<NotificationAction> actions() const;

[johnme, 2015/08/03 15:41:36]

does returning a new HeapVector each time affect whether the sequence is the
same object / is immutable?

[Peter Beverloo, 2015/08/03 17:29:30]

It affects whether it returns the same object. Since we haven't shipped this yet
I'd rather solve it together with the data and vibration pattern above (we need
to cache these values).

 
     static String permissionString(WebNotificationPermission);
     static String permission(ExecutionContext*);
     static WebNotificationPermission checkPermission(ExecutionContext*);
     static ScriptPromise requestPermission(ScriptState*, NotificationPermissionCallback*);
 
     static size_t maxActions();
 
-    static void actionsToWebActions(const HeapVector<NotificationAction>& actions, WebVector<WebNotificationAction>* webActions);
-
     // EventTarget interface.
     ExecutionContext* executionContext() const final { return ActiveDOMObject::executionContext(); }
     const AtomicString& interfaceName() const override;
 
     // ActiveDOMObject interface.
     void stop() override;
     bool hasPendingActivity() const override;
 
     DECLARE_VIRTUAL_TRACE();
 
 protected:
     // EventTarget interface.
     bool dispatchEventInternal(PassRefPtrWillBeRawPtr<Event>) final;
 
 private:
-    static void webActionsToActions(const WebVector<WebNotificationAction>& webActions, HeapVector<NotificationAction>* actions);
-
-    Notification(const String& title, ExecutionContext*);
+    Notification(ExecutionContext*, const WebNotificationData&);
 
     void scheduleShow();
 
     // Calling show() may start asynchronous operation. If this object has
     // a V8 wrapper, hasPendingActivity() prevents the wrapper from being
     // collected while m_state is Showing, and so this instance stays alive
     // until the operation completes. Otherwise, you need to hold a ref on this
     // instance until the operation completes.
     void show();
 
-    void setDir(const String& dir) { m_dir = dir; }
-    void setLang(const String& lang) { m_lang = lang; }
-    void setBody(const String& body) { m_body = body; }
-    void setIconUrl(KURL iconUrl) { m_iconUrl = iconUrl; }
-    void setTag(const String& tag) { m_tag = tag; }
-    void setVibrate(const NavigatorVibration::VibrationPattern& vibrate) { m_vibrate = vibrate; }
-    void setSilent(bool silent) { m_silent = silent; }
-    void setSerializedData(PassRefPtr<SerializedScriptValue> data) { m_serializedData = data; }
-    void setActions(const HeapVector<NotificationAction>& actions) { m_actions = actions; }
-
     void setPersistentId(int64_t persistentId) { m_persistentId = persistentId; }
 
-    String m_title;
-    String m_dir;
-    String m_lang;
-    String m_body;
-    String m_tag;
-    NavigatorVibration::VibrationPattern m_vibrate;
-    bool m_silent;
+private:
+    WebNotificationData m_data;
+
     RefPtr<SerializedScriptValue> m_serializedData;
-    HeapVector<NotificationAction> m_actions;
-
-    KURL m_iconUrl;
 
     // Notifications can either be bound to the page, which means they're identified by
     // their delegate, or persistent, which means they're identified by a persistent Id
     // given to us by the embedder. This influences how we close the notification.
     int64_t m_persistentId;
 
     enum NotificationState {
         NotificationStateIdle,
         NotificationStateShowing,
         NotificationStateClosing,
         NotificationStateClosed
     };
 
     // Only to be used by the Notification::create() method when notifications were created
     // by the embedder rather than by Blink.
     void setState(NotificationState state) { m_state = state; }
 
     NotificationState m_state;
 
     AsyncMethodRunner<Notification> m_asyncRunner;
 };
 
 } // namespace blink
 
 #endif // Notification_h