Push API: Require user visible notification, else show auto notification

chrome/browser/services/gcm/push_messaging_service_impl.cc

 // 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.
 
 #include "chrome/browser/services/gcm/push_messaging_service_impl.h"
 
 #include <vector>
 
 #include "base/bind.h"
 #include "base/command_line.h"
 #include "base/prefs/pref_service.h"
 #include "base/strings/string_util.h"
+#include "base/strings/utf_string_conversions.h"
+#include "chrome/browser/browser_process.h"
+#include "chrome/browser/notifications/notification_ui_manager.h"

[Peter Beverloo, 2015/01/09 19:48:05]

This include isn't used.

[johnme, 2015/01/09 19:52:32]

It's used by the following line:

int notification_count = g_browser_process->notification_ui_manager()->
      GetAllIdsByProfileAndSourceOrigin(profile_, application_id.origin).size();

+#include "chrome/browser/notifications/platform_notification_service_impl.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/services/gcm/gcm_profile_service.h"
 #include "chrome/browser/services/gcm/gcm_profile_service_factory.h"
 #include "chrome/browser/services/gcm/push_messaging_application_id.h"
 #include "chrome/browser/services/gcm/push_messaging_constants.h"
 #include "chrome/browser/services/gcm/push_messaging_permission_context.h"
 #include "chrome/browser/services/gcm/push_messaging_permission_context_factory.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/pref_names.h"
+#include "chrome/grit/generated_resources.h"
+#include "components/content_settings/core/browser/host_content_settings_map.h"
+#include "components/content_settings/core/common/content_settings_types.h"

[Peter Beverloo, 2015/01/09 19:48:05]

nit: these two includes don't seem to be used?

[johnme, 2015/01/09 19:52:32]

Done.

 #include "components/content_settings/core/common/permission_request_id.h"
 #include "components/gcm_driver/gcm_driver.h"
 #include "components/pref_registry/pref_registry_syncable.h"
 #include "content/public/browser/browser_context.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/web_contents.h"
+#include "content/public/common/child_process_host.h"
+#include "content/public/common/platform_notification_data.h"
+#include "third_party/skia/include/core/SkBitmap.h"
+#include "ui/base/l10n/l10n_util.h"
 
 namespace gcm {
 
 namespace {
 const int kMaxRegistrations = 1000000;
 
 blink::WebPushPermissionStatus ToPushPermission(ContentSetting setting) {
   switch (setting) {
     case CONTENT_SETTING_ALLOW:
       return blink::WebPushPermissionStatusGranted;
@@ skipping 107 matching lines @@
   // {
   //     "registration_ids": ["FOO", "BAR"],
   //     "data": {
   //         "data": "BAZ",
   //     },
   //     "delay_while_idle": true,
   // }
   // TODO(johnme): Make sure this is clearly documented for developers.
   PushMessagingApplicationId application_id =
       PushMessagingApplicationId::Parse(app_id);
-  DCHECK(application_id.IsValid());
   GCMClient::MessageData::const_iterator it = message.data.find("data");
   if (application_id.IsValid() && it != message.data.end()) {
     if (!HasPermission(application_id.origin)) {
       // The |origin| lost push permission. We need to unregister and drop this
       // message.
       Unregister(application_id, UnregisterCallback());
       return;
     }
 
     const std::string& data = it->second;
@@ skipping 19 matching lines @@
 
 void PushMessagingServiceImpl::DeliverMessageCallback(
     const PushMessagingApplicationId& application_id,
     const GCMClient::IncomingMessage& message,
     content::PushDeliveryStatus status) {
   // TODO(mvanouwerkerk): UMA logging.
   // TODO(mvanouwerkerk): Show a warning in the developer console of the
   // Service Worker corresponding to app_id (and/or on an internals page).
   // TODO(mvanouwerkerk): Is there a way to recover from failure?
   switch (status) {
+    // Call RequireUserVisibleUX if the message was delivered to the Service
+    // Worker JS, even if the website's event handler failed (to prevent sites
+    // deliberately failing in order to avoid having to show notifications).
     case content::PUSH_DELIVERY_STATUS_SUCCESS:
+    case content::PUSH_DELIVERY_STATUS_EVENT_WAITUNTIL_REJECTED:
+      RequireUserVisibleUX(application_id);
+      break;
     case content::PUSH_DELIVERY_STATUS_INVALID_MESSAGE:
     case content::PUSH_DELIVERY_STATUS_SERVICE_WORKER_ERROR:
-    case content::PUSH_DELIVERY_STATUS_EVENT_WAITUNTIL_REJECTED:
       break;
     case content::PUSH_DELIVERY_STATUS_NO_SERVICE_WORKER:
       Unregister(application_id, UnregisterCallback());
       break;
   }
 }
 
+void PushMessagingServiceImpl::RequireUserVisibleUX(
+    const PushMessagingApplicationId& application_id) {
+#if defined(ENABLE_NOTIFICATIONS)
+  // TODO(johnme): Add test.
+  // TODO(johnme): Relax this heuristic slightly.
+  int notification_count = g_browser_process->notification_ui_manager()->
+      GetAllIdsByProfileAndSourceOrigin(profile_, application_id.origin).size();
+  if (notification_count > 0)
+    return;
+
+  // If we haven't returned yet, the site failed to show a notification, so we
+  // will show a generic notification. See https://crbug.com/437277
+  // TODO(johnme): The generic notification should probably automatically close
+  // itself when the next push message arrives?
+  content::PlatformNotificationData notification_data;
+  // TODO(johnme): Switch to FormatOriginForDisplay from crbug.com/402698
+  notification_data.title = l10n_util::GetStringFUTF16(
+      IDS_PUSH_MESSAGING_GENERIC_NOTIFICATION_TITLE,
+      base::UTF8ToUTF16(origin.host()));
+  notification_data.direction =
+      content::PlatformNotificationData::NotificationDirectionLeftToRight;
+  notification_data.body =
+      l10n_util::GetStringUTF16(IDS_PUSH_MESSAGING_GENERIC_NOTIFICATION_BODY);
+  notification_data.tag =
+      base::ASCIIToUTF16("user_visible_auto_notification");
+  notification_data.icon = GURL();  // TODO(johnme): Better icon?
+  PlatformNotificationServiceImpl::GetInstance()->DisplayPersistentNotification(
+      profile_,
+      application_id.service_worker_registration_id,
+      application_id.origin,
+      SkBitmap() /* icon */,
+      notification_data,
+      content::ChildProcessHost::kInvalidUniqueID /* render_process_id */);
+#endif
+}
+
 void PushMessagingServiceImpl::OnMessagesDeleted(const std::string& app_id) {
   // TODO(mvanouwerkerk): Fire push error event on the Service Worker
   // corresponding to app_id.
 }
 
 void PushMessagingServiceImpl::OnSendError(
     const std::string& app_id,
     const GCMClient::SendErrorDetails& send_error_details) {
   NOTREACHED() << "The Push API shouldn't have sent messages upstream";
 }
@@ skipping 242 matching lines @@
 }
 
 void PushMessagingServiceImpl::AddAppHandlerIfNecessary() {
   if (gcm_profile_service_->driver()->GetAppHandler(
           kPushMessagingApplicationIdPrefix) != this)
     gcm_profile_service_->driver()->AddAppHandler(
         kPushMessagingApplicationIdPrefix, this);
 }
 
 }  // namespace gcm