Changeset 106592 in webkit

Timestamp:

Feb 2, 2012 2:16:14 PM (12 years ago)

Author:

jonlee@apple.com

Message:

Clear shown notifications when context is no longer active
​https://bugs.webkit.org/show_bug.cgi?id=77363
<rdar://problem/10568907>

Reviewed by Darin Adler.

Source/WebCore:

• notifications/NotificationPresenter.h: Add new virtual function to clear notifications

associated with a given execution context. By default the notifications are left alone, as
before. Individual implementations can override to allow notifications to clear them.

• notifications/NotificationCenter.cpp:

(WebCore::NotificationCenter::disconnectFrame): When disconnecting the page from the frame, we
call clearNotifications().

• page/Frame.cpp:

(WebCore::Frame::pageDestroyed): When the page is destroyed, tell the DOM window to reset notifications.

Source/WebKit/win:

• WebCoreSupport/WebDesktopNotificationsDelegate.h:

(WebDesktopNotificationsDelegate): Add previously missing virtual functions.

• WebCoreSupport/WebDesktopNotificationsDelegate.cpp:

(WebDesktopNotificationsDelegate::notificationControllerDestroyed):
(WebDesktopNotificationsDelegate::cancelRequestsForPermission):

Source/WebKit2:

• WebProcess/WebCoreSupport/WebNotificationClient.cpp:

(WebKit::WebNotificationClient::clearNotifications): Forward the call to
WebNotificationManager.

• WebProcess/WebCoreSupport/WebNotificationClient.h:

(WebNotificationClient):

• WebProcess/Notifications/WebNotificationManager.h: Add an additional map that maps

all notifications associated with a given ScriptExecutionContext instance.

• WebProcess/Notifications/WebNotificationManager.cpp:

(WebKit::WebNotificationManager::show): Create a map entry for the notification's
context if it doesn't exist already, and note that notification's ID. Also, correct
the return value of show() if notifications are not enabled, to return false.
(WebKit::WebNotificationManager::didCloseNotifications): When the notification is closed,
we remove that notification from the map.
(WebKit::WebNotificationManager::clearNotifications): Use the map entry for the given
context, and pass that along to the proxy so that all of the notifications with those IDs
can be cleared. In the meantime, we remove that context's map entry.

• UIProcess/Notifications/WebNotificationManagerProxy.messages.in: New ClearNotifications()

message.

• UIProcess/Notifications/WebNotificationManagerProxy.h:
• UIProcess/Notifications/WebNotificationManagerProxy.cpp:

(WebKit::WebNotificationManagerProxy::clearNotifications): Forward the call to the provider.
Then remove this proxy's entries for the given notification IDs.

• UIProcess/Notifications/WebNotificationProvider.cpp:

(WebKit::WebNotificationProvider::clearNotifications): Convert the vector of IDs to a mutable
array.

• UIProcess/Notifications/WebNotificationProvider.h:

(WebNotificationProvider):

• UIProcess/API/C/WKNotificationProvider.h: Add WK API to tell the platform to clear the notifications.

Remove the #if guard since they already exist in WebNotificationManager functions:

• WebProcess/WebCoreSupport/WebNotificationClient.cpp:

(WebKit::WebNotificationClient::show):
(WebKit::WebNotificationClient::cancel):
(WebKit::WebNotificationClient::notificationObjectDestroyed):

Location:

trunk/Source

Files:

• WebCore/ChangeLog (modified) (1 diff)
• WebCore/notifications/NotificationCenter.cpp (modified) (1 diff)
• WebCore/notifications/NotificationPresenter.h (modified) (1 diff)
• WebCore/page/Frame.cpp (modified) (1 diff)
• WebKit/win/ChangeLog (modified) (1 diff)
• WebKit/win/WebCoreSupport/WebDesktopNotificationsDelegate.cpp (modified) (2 diffs)
• WebKit/win/WebCoreSupport/WebDesktopNotificationsDelegate.h (modified) (1 diff)
• WebKit2/ChangeLog (modified) (1 diff)
• WebKit2/UIProcess/API/C/WKNotificationProvider.h (modified) (2 diffs)
• WebKit2/UIProcess/Notifications/WebNotificationManagerProxy.cpp (modified) (1 diff)
• WebKit2/UIProcess/Notifications/WebNotificationManagerProxy.h (modified) (1 diff)
• WebKit2/UIProcess/Notifications/WebNotificationManagerProxy.messages.in (modified) (1 diff)
• WebKit2/UIProcess/Notifications/WebNotificationProvider.cpp (modified) (2 diffs)
• WebKit2/UIProcess/Notifications/WebNotificationProvider.h (modified) (2 diffs)
• WebKit2/WebProcess/Notifications/WebNotificationManager.cpp (modified) (4 diffs)
• WebKit2/WebProcess/Notifications/WebNotificationManager.h (modified) (2 diffs)
• WebKit2/WebProcess/WebCoreSupport/WebNotificationClient.cpp (modified) (2 diffs)
• WebKit2/WebProcess/WebCoreSupport/WebNotificationClient.h (modified) (1 diff)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2012-02-02  Jon Lee  <jonlee@apple.com>
+
+        Clear shown notifications when context is no longer active
+        https://bugs.webkit.org/show_bug.cgi?id=77363
+        <rdar://problem/10568907>
+
+        Reviewed by Darin Adler.
+
+        * notifications/NotificationPresenter.h: Add new virtual function to clear notifications
+        associated with a given execution context. By default the notifications are left alone, as
+        before. Individual implementations can override to allow notifications to clear them.
+
+        * notifications/NotificationCenter.cpp:
+        (WebCore::NotificationCenter::disconnectFrame): When disconnecting the page from the frame, we
+        call clearNotifications().
+        * page/Frame.cpp:
+        (WebCore::Frame::pageDestroyed): When the page is destroyed, tell the DOM window to reset notifications.
+
 2012-02-02  Anders Carlsson  <andersca@apple.com>
 

trunk/Source/WebCore/notifications/NotificationCenter.cpp

@@ -67 +67 @@
         return;
     m_notificationPresenter->cancelRequestsForPermission(scriptExecutionContext());
+    m_notificationPresenter->clearNotifications(scriptExecutionContext());
     m_notificationPresenter = 0;
 }

trunk/Source/WebCore/notifications/NotificationPresenter.h

@@ -58 +58 @@
     virtual void cancel(Notification*) = 0;
 
+    // When the user closes a page, or quits the client application, all of the page's
+    // associated notifications are cleared.
+    virtual void clearNotifications(ScriptExecutionContext*) { }
+    
     // Informs the presenter that a Notification object has been destroyed
     // (such as by a page transition). The presenter may continue showing

trunk/Source/WebCore/page/Frame.cpp

@@ -669 +669 @@
     if (m_domWindow) {
         m_domWindow->resetGeolocation();
+#if ENABLE(NOTIFICATIONS)
+        m_domWindow->resetNotifications();
+#endif
         m_domWindow->pageDestroyed();
     }

trunk/Source/WebKit/win/ChangeLog

@@ +1 @@
+2012-02-02  Jon Lee  <jonlee@apple.com>
+
+        Clear shown notifications when context is no longer active
+        https://bugs.webkit.org/show_bug.cgi?id=77363
+        <rdar://problem/10568907>
+
+        Reviewed by Darin Adler.
+
+        * WebCoreSupport/WebDesktopNotificationsDelegate.h:
+        (WebDesktopNotificationsDelegate): Add previously missing virtual functions.
+        * WebCoreSupport/WebDesktopNotificationsDelegate.cpp:
+        (WebDesktopNotificationsDelegate::notificationControllerDestroyed):
+        (WebDesktopNotificationsDelegate::cancelRequestsForPermission):
+
 2012-02-01  Anders Carlsson  <andersca@apple.com>
 

trunk/Source/WebKit/win/WebCoreSupport/WebDesktopNotificationsDelegate.cpp

@@ -166 +166 @@
 }
 
+void WebDesktopNotificationsDelegate::notificationControllerDestroyed()
+{
+}
+
 void WebDesktopNotificationsDelegate::requestPermission(SecurityOrigin* origin, PassRefPtr<VoidCallback> callback)
 {
@@ -171 +175 @@
     if (hasNotificationDelegate())
         notificationDelegate()->requestNotificationPermission(org);
+}
+
+void WebDesktopNotificationsDelegate::cancelRequestsForPermission(ScriptExecutionContext* context)
+{
 }
 

trunk/Source/WebKit/win/WebCoreSupport/WebDesktopNotificationsDelegate.h

@@ -50 +50 @@
     virtual void cancel(WebCore::Notification* object);
     virtual void notificationObjectDestroyed(WebCore::Notification* object);
+    virtual void notificationControllerDestroyed();
     virtual void requestPermission(WebCore::SecurityOrigin* origin, PassRefPtr<WebCore::VoidCallback> callback);
+    virtual void cancelRequestsForPermission(WebCore::ScriptExecutionContext*);
     virtual WebCore::NotificationPresenter::Permission checkPermission(const KURL& url);
 

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2012-02-02  Jon Lee  <jonlee@apple.com>
+
+        Clear shown notifications when context is no longer active
+        https://bugs.webkit.org/show_bug.cgi?id=77363
+        <rdar://problem/10568907>
+
+        Reviewed by Darin Adler.
+
+        * WebProcess/WebCoreSupport/WebNotificationClient.cpp:
+        (WebKit::WebNotificationClient::clearNotifications): Forward the call to
+        WebNotificationManager.
+        * WebProcess/WebCoreSupport/WebNotificationClient.h:
+        (WebNotificationClient):
+
+        * WebProcess/Notifications/WebNotificationManager.h: Add an additional map that maps
+        all notifications associated with a given ScriptExecutionContext instance.
+        * WebProcess/Notifications/WebNotificationManager.cpp:
+        (WebKit::WebNotificationManager::show): Create a map entry for the notification's
+        context if it doesn't exist already, and note that notification's ID. Also, correct
+        the return value of show() if notifications are not enabled, to return false.
+        (WebKit::WebNotificationManager::didCloseNotifications): When the notification is closed,
+        we remove that notification from the map.
+        (WebKit::WebNotificationManager::clearNotifications): Use the map entry for the given
+        context, and pass that along to the proxy so that all of the notifications with those IDs
+        can be cleared. In the meantime, we remove that context's map entry.
+
+        * UIProcess/Notifications/WebNotificationManagerProxy.messages.in: New ClearNotifications()
+        message.
+        * UIProcess/Notifications/WebNotificationManagerProxy.h:
+        * UIProcess/Notifications/WebNotificationManagerProxy.cpp:
+        (WebKit::WebNotificationManagerProxy::clearNotifications): Forward the call to the provider.
+        Then remove this proxy's entries for the given notification IDs.
+
+        * UIProcess/Notifications/WebNotificationProvider.cpp:
+        (WebKit::WebNotificationProvider::clearNotifications): Convert the vector of IDs to a mutable
+        array.
+        * UIProcess/Notifications/WebNotificationProvider.h:
+        (WebNotificationProvider):
+
+        * UIProcess/API/C/WKNotificationProvider.h: Add WK API to tell the platform to clear the notifications.
+
+        Remove the #if guard since they already exist in WebNotificationManager functions:
+        * WebProcess/WebCoreSupport/WebNotificationClient.cpp:
+        (WebKit::WebNotificationClient::show):
+        (WebKit::WebNotificationClient::cancel):
+        (WebKit::WebNotificationClient::notificationObjectDestroyed):
+
 2012-02-02  Anders Carlsson  <andersca@apple.com>
 

trunk/Source/WebKit2/UIProcess/API/C/WKNotificationProvider.h

@@ -39 +39 @@
 typedef void (*WKNotificationProviderRemoveNotificationManagerCallback)(WKNotificationManagerRef manager, const void* clientInfo);
 typedef WKDictionaryRef (*WKNotificationProviderNotificationPermissionsCallback)(const void* clientInfo);
+typedef void (*WKNotificationProviderClearNotificationsCallback)(WKArrayRef notificationIDs, const void* clientInfo);
 
 struct WKNotificationProvider {
@@ -49 +50 @@
     WKNotificationProviderRemoveNotificationManagerCallback               removeNotificationManager;
     WKNotificationProviderNotificationPermissionsCallback                 notificationPermissions;
+    WKNotificationProviderClearNotificationsCallback                      clearNotifications;
 };
 typedef struct WKNotificationProvider WKNotificationProvider;

trunk/Source/WebKit2/UIProcess/Notifications/WebNotificationManagerProxy.cpp

@@ -112 +112 @@
 }
 
+void WebNotificationManagerProxy::clearNotifications(const Vector<uint64_t>& notificationIDs)
+{
+    m_provider.clearNotifications(notificationIDs);
+    size_t count = notificationIDs.size();
+    for (size_t i = 0; i < count; ++i)
+        m_notifications.remove(notificationIDs[i]);
+}
+
 void WebNotificationManagerProxy::providerDidShowNotification(uint64_t notificationID)
 {

trunk/Source/WebKit2/UIProcess/Notifications/WebNotificationManagerProxy.h

@@ -81 +81 @@
     void cancel(uint64_t notificationID);
     void didDestroyNotification(uint64_t notificationID);
+    void clearNotifications(const Vector<uint64_t>& notificationIDs);
 
     typedef HashMap<uint64_t, RefPtr<WebNotification> > WebNotificationMap;

trunk/Source/WebKit2/UIProcess/Notifications/WebNotificationManagerProxy.messages.in

@@ -24 +24 @@
     Cancel(uint64_t notificationID);
     DidDestroyNotification(uint64_t notificationID);
+    ClearNotifications(Vector<uint64_t> notificationIDs);
 }

trunk/Source/WebKit2/UIProcess/Notifications/WebNotificationProvider.cpp

@@ -28 +28 @@
 
 #include "ImmutableDictionary.h"
+#include "MutableArray.h"
 #include "WKAPICast.h"
 #include "WebNotification.h"
 #include "WebNotificationManagerProxy.h"
+#include "WebNumber.h"
 #include "WebSecurityOrigin.h"
 
@@ -59 +61 @@
 }
 
+void WebNotificationProvider::clearNotifications(const Vector<uint64_t>& notificationIDs)
+{
+    if (!m_client.clearNotifications)
+        return;
+
+    RefPtr<MutableArray> arrayIDs = MutableArray::create();
+    size_t count = notificationIDs.size();
+    arrayIDs->reserveCapacity(count);
+    for (size_t i = 0; i < count; ++i)
+        arrayIDs->append(WebUInt64::create(notificationIDs[i]).leakRef());
+
+    m_client.clearNotifications(toAPI(arrayIDs.get()), m_client.clientInfo);
+}
+
 void WebNotificationProvider::addNotificationManager(WebNotificationManagerProxy* manager)
 {

trunk/Source/WebKit2/UIProcess/Notifications/WebNotificationProvider.h

@@ -30 +30 @@
 #include "WKNotificationProvider.h"
 #include <wtf/Forward.h>
+#include <wtf/Vector.h>
 
 namespace WebKit {
@@ -44 +45 @@
     void cancel(WebNotification*);
     void didDestroyNotification(WebNotification*);
+    void clearNotifications(const Vector<uint64_t>& notificationIDs);
 
     void addNotificationManager(WebNotificationManagerProxy*);

trunk/Source/WebKit2/WebProcess/Notifications/WebNotificationManager.cpp

@@ -34 +34 @@
 #include "WebNotificationManagerProxyMessages.h"
 #include "WebPageProxyMessages.h"
+#include <WebCore/Document.h>
 #include <WebCore/Notification.h>
 #include <WebCore/Page.h>
@@ -114 +115 @@
     m_notificationIDMap.set(notificationID, notification);
     
+    NotificationContextMap::iterator it = m_notificationContextMap.find(notification->scriptExecutionContext());
+    if (it == m_notificationContextMap.end()) {
+        pair<NotificationContextMap::iterator, bool> addedPair = m_notificationContextMap.add(notification->scriptExecutionContext(), Vector<uint64_t>());
+        it = addedPair.first;
+    }
+    it->second.append(notificationID);
+    
     m_process->connection()->send(Messages::WebPageProxy::ShowNotification(notification->contents().title, notification->contents().body, notification->scriptExecutionContext()->securityOrigin()->toString(), notificationID), page->pageID());
-#endif
     return true;
+#else
+    return false;
+#endif
 }
 
@@ -130 +140 @@
     
     m_process->connection()->send(Messages::WebNotificationManagerProxy::Cancel(notificationID), page->pageID());
+#endif
+}
+
+void WebNotificationManager::clearNotifications(WebCore::ScriptExecutionContext* context, WebPage* page)
+{
+#if ENABLE(NOTIFICATIONS)
+    NotificationContextMap::iterator it = m_notificationContextMap.find(context);
+    if (it == m_notificationContextMap.end())
+        return;
+    
+    m_process->connection()->send(Messages::WebNotificationManagerProxy::ClearNotifications(it->second), page->pageID());
+    m_notificationContextMap.remove(it);
 #endif
 }
@@ -186 +208 @@
             continue;
 
+        NotificationContextMap::iterator it = m_notificationContextMap.find(notification->scriptExecutionContext());
+        ASSERT(it != m_notificationContextMap.end());
+        size_t index = it->second.find(notificationID);
+        ASSERT(index != notFound);
+        it->second.remove(index);
+
         notification->dispatchCloseEvent();
     }

trunk/Source/WebKit2/WebProcess/Notifications/WebNotificationManager.h

@@ -60 +60 @@
     bool show(WebCore::Notification*, WebPage*);
     void cancel(WebCore::Notification*, WebPage*);
+    void clearNotifications(WebCore::ScriptExecutionContext*, WebPage*);
     // This callback comes from WebCore, not messaged from the UI process.
     void didDestroyNotification(WebCore::Notification*, WebPage*);
@@ -87 +88 @@
     NotificationIDMap m_notificationIDMap;
     
+    typedef HashMap<RefPtr<WebCore::ScriptExecutionContext>, Vector<uint64_t> > NotificationContextMap;
+    NotificationContextMap m_notificationContextMap;
+    
     HashMap<String, bool> m_permissionsMap;
 #endif

trunk/Source/WebKit2/WebProcess/WebCoreSupport/WebNotificationClient.cpp

@@ -33 +33 @@
 #include "WebPage.h"
 #include "WebProcess.h"
-#include <WebCore/NotImplemented.h>
 #include <WebCore/ScriptExecutionContext.h>
 
@@ -51 +50 @@
 bool WebNotificationClient::show(Notification* notification)
 {
-#if ENABLE(NOTIFICATIONS)
     return WebProcess::shared().notificationManager().show(notification, m_page);
-#else
-    notImplemented();
-    return false;
-#endif
 }
 
 void WebNotificationClient::cancel(Notification* notification)
 {
-#if ENABLE(NOTIFICATIONS)
     WebProcess::shared().notificationManager().cancel(notification, m_page);
-#else
-    notImplemented();
-#endif
+}
+
+void WebNotificationClient::clearNotifications(ScriptExecutionContext* context)
+{
+    WebProcess::shared().notificationManager().clearNotifications(context, m_page);
 }
 
 void WebNotificationClient::notificationObjectDestroyed(Notification* notification)
 {
-#if ENABLE(NOTIFICATIONS)
     WebProcess::shared().notificationManager().didDestroyNotification(notification, m_page);
-#else
-    UNUSED_PARAM(notification);
-    notImplemented();
-#endif
 }
 

trunk/Source/WebKit2/WebProcess/WebCoreSupport/WebNotificationClient.h

@@ -48 +48 @@
     virtual bool show(WebCore::Notification*) OVERRIDE;
     virtual void cancel(WebCore::Notification*) OVERRIDE;
+    virtual void clearNotifications(WebCore::ScriptExecutionContext*) OVERRIDE;
     virtual void notificationObjectDestroyed(WebCore::Notification*) OVERRIDE;
     virtual void notificationControllerDestroyed() OVERRIDE;