chrome/browser/services/gcm/push_messaging_service_impl.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_SERVICES_GCM_PUSH_MESSAGING_SERVICE_IMPL_H_
   6 #define CHROME_BROWSER_SERVICES_GCM_PUSH_MESSAGING_SERVICE_IMPL_H_
   7
   8 #include "base/compiler_specific.h"
   9 #include "base/memory/weak_ptr.h"
  10 #include "components/content_settings/core/browser/content_settings_observer.h"
  11 #include "components/content_settings/core/common/content_settings.h"
  12 #include "components/gcm_driver/gcm_app_handler.h"
  13 #include "components/gcm_driver/gcm_client.h"
  14 #include "content/public/browser/push_messaging_service.h"
  15 #include "content/public/common/push_messaging_status.h"
  16 #include "third_party/WebKit/public/platform/modules/push_messaging/WebPushPermissionStatus.h"
  17
  18 class Profile;
  19
  20 namespace user_prefs {
  21 class PrefRegistrySyncable;
  22 }
  23
  24 namespace gcm {
  25
  26 class GCMProfileService;
  27 class PushMessagingApplicationId;
  28
  29 class PushMessagingServiceImpl : public content::PushMessagingService,
  30                                  public GCMAppHandler,
  31                                  public content_settings::Observer {
  32  public:
  33   // Register profile-specific prefs for GCM.
  34   static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
  35
  36   // If any Service Workers are using push, starts GCM and adds an app handler.
  37   static void InitializeForProfile(Profile* profile);
  38
  39   PushMessagingServiceImpl(GCMProfileService* gcm_profile_service,
  40                            Profile* profile);
  41   ~PushMessagingServiceImpl() override;
  42
  43   // GCMAppHandler implementation.
  44   void ShutdownHandler() override;
  45   void OnMessage(const std::string& app_id,
  46                  const GCMClient::IncomingMessage& message) override;
  47   void OnMessagesDeleted(const std::string& app_id) override;
  48   void OnSendError(
  49       const std::string& app_id,
  50       const GCMClient::SendErrorDetails& send_error_details) override;
  51   void OnSendAcknowledged(const std::string& app_id,
  52                           const std::string& message_id) override;
  53   bool CanHandle(const std::string& app_id) const override;
  54
  55   // content::PushMessagingService implementation:
  56   GURL GetPushEndpoint() override;
  57   void RegisterFromDocument(
  58       const GURL& requesting_origin,
  59       int64 service_worker_registration_id,
  60       const std::string& sender_id,
  61       int renderer_id,
  62       int render_frame_id,
  63       bool user_visible_only,
  64       const content::PushMessagingService::RegisterCallback& callback) override;
  65   void RegisterFromWorker(
  66       const GURL& requesting_origin,
  67       int64 service_worker_registration_id,
  68       const std::string& sender_id,
  69       const content::PushMessagingService::RegisterCallback& callback) override;
  70   void Unregister(
  71       const GURL& requesting_origin,
  72       int64 service_worker_registration_id,
  73       const std::string& sender_id,
  74       bool retry_on_failure,
  75       const content::PushMessagingService::UnregisterCallback&) override;
  76   blink::WebPushPermissionStatus GetPermissionStatus(
  77       const GURL& requesting_origin,
  78       const GURL& embedding_origin) override;
  79
  80   // content_settings::Observer implementation.
  81   void OnContentSettingChanged(const ContentSettingsPattern& primary_pattern,
  82                                const ContentSettingsPattern& secondary_pattern,
  83                                ContentSettingsType content_type,
  84                                std::string resource_identifier) override;
  85
  86   void SetProfileForTesting(Profile* profile);
  87
  88  private:
  89   // A registration is pending until it has succeeded or failed.
  90   void IncreasePushRegistrationCount(int add, bool is_pending);
  91   void DecreasePushRegistrationCount(int subtract, bool was_pending);
  92
  93   // OnMessage methods ---------------------------------------------------------
  94
  95   void DeliverMessageCallback(const std::string& app_id_guid,
  96                               const GURL& requesting_origin,
  97                               int64 service_worker_registration_id,
  98                               const GCMClient::IncomingMessage& message,
  99                               content::PushDeliveryStatus status);
 100
 101   // Developers are required to display a Web Notification in response to an
 102   // incoming push message in order to clarify to the user that something has
 103   // happened in the background. When they forget to do so, display a default
 104   // notification on their behalf.
 105   void RequireUserVisibleUX(const GURL& requesting_origin,
 106                             int64 service_worker_registration_id);
 107   void DidGetNotificationsShown(
 108       const GURL& requesting_origin,
 109       int64 service_worker_registration_id,
 110       bool notification_shown,
 111       bool notification_needed,
 112       const std::string& data,
 113       bool success,
 114       bool not_found);
 115
 116   // Register methods ----------------------------------------------------------
 117
 118   void RegisterEnd(
 119       const content::PushMessagingService::RegisterCallback& callback,
 120       const std::string& registration_id,
 121       content::PushRegistrationStatus status);
 122
 123   void DidRegister(
 124       const PushMessagingApplicationId& application_id,
 125       const content::PushMessagingService::RegisterCallback& callback,
 126       const std::string& registration_id,
 127       GCMClient::Result result);
 128
 129   void DidRequestPermission(
 130       const PushMessagingApplicationId& application_id,
 131       const std::string& sender_id,
 132       const content::PushMessagingService::RegisterCallback& callback,
 133       ContentSetting content_setting);
 134
 135   // Unregister methods --------------------------------------------------------
 136
 137   void Unregister(const std::string& app_id_guid,
 138                   const std::string& sender_id,
 139                   bool retry_on_failure,
 140                   const content::PushMessagingService::UnregisterCallback&);
 141
 142   void DidUnregister(const std::string& app_id_guid,
 143                      bool retry_on_failure,
 144                      const content::PushMessagingService::UnregisterCallback&,
 145                      GCMClient::Result result);
 146
 147   // OnContentSettingChanged methods -------------------------------------------
 148
 149   void UnregisterBecausePermissionRevoked(const PushMessagingApplicationId& id,
 150                                           const std::string& sender_id,
 151                                           bool success, bool not_found);
 152
 153   // Helper methods ------------------------------------------------------------
 154
 155   // Checks if a given origin is allowed to use Push.
 156   bool HasPermission(const GURL& origin);
 157
 158   GCMProfileService* gcm_profile_service_;  // It owns us.
 159
 160   Profile* profile_;  // It owns our owner.
 161
 162   int push_registration_count_;
 163   int pending_push_registration_count_;
 164
 165   base::WeakPtrFactory<PushMessagingServiceImpl> weak_factory_;
 166
 167   DISALLOW_COPY_AND_ASSIGN(PushMessagingServiceImpl);
 168 };
 169
 170 }  // namespace gcm
 171
 172 #endif  // CHROME_BROWSER_SERVICES_GCM_PUSH_MESSAGING_SERVICE_IMPL_H_