Merge 253787 "[GCM] Make sure GCM checkout logic is invoked when..."

chrome/browser/services/gcm/gcm_profile_service.h

 // Copyright (c) 2013 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.
 
 #ifndef CHROME_BROWSER_SERVICES_GCM_GCM_PROFILE_SERVICE_H_
 #define CHROME_BROWSER_SERVICES_GCM_GCM_PROFILE_SERVICE_H_
 
 #include <map>
 
 #include "base/basictypes.h"
@@ skipping 29 matching lines @@
 
 // Acts as a bridge between GCM API and GCMClient layer. It is profile based.
 class GCMProfileService : public BrowserContextKeyedService,
                           public content::NotificationObserver {
  public:
   typedef base::Callback<void(const std::string& registration_id,
                               GCMClient::Result result)> RegisterCallback;
   typedef base::Callback<void(const std::string& message_id,
                               GCMClient::Result result)> SendCallback;
 
+  enum GCMEnabledState {
+    // GCM is always enabled. GCMClient will always load and connect with GCM.
+    ALWAYS_ENABLED,
+    // GCM is only enabled for apps. GCMClient will start to load and connect
+    // with GCM only when GCM API is used.
+    ENABLED_FOR_APPS,
+    // GCM is always disabled. GCMClient will never load and connect with GCM.
+    ALWAYS_DISABLED
+  };
+
   // For testing purpose.
   class TestingDelegate {
    public:
     virtual GCMEventRouter* GetEventRouter() const = 0;
   };
 
-  // Returns true if the GCM support is enabled.
-  static bool IsGCMEnabled(Profile* profile);
+  // Returns the GCM enabled state.
+  static GCMEnabledState GetGCMEnabledState(Profile* profile);
 
   // Register profile-specific prefs for GCM.
   static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
 
   explicit GCMProfileService(Profile* profile);
   virtual ~GCMProfileService();
 
   void Initialize(scoped_ptr<GCMClientFactory> gcm_client_factory);
 
   // Registers |sender_id| for an app. A registration ID will be returned by
@@ skipping 13 matching lines @@
   // |app_id|: application ID.
   // |receiver_id|: registration ID of the receiver party.
   // |message|: message to be sent.
   // |callback|: to be called once the asynchronous operation is done.
   virtual void Send(const std::string& app_id,
                     const std::string& receiver_id,
                     const GCMClient::OutgoingMessage& message,
                     SendCallback callback);
 
   // For testing purpose.
+  GCMClient* GetGCMClientForTesting() const;
+
   void set_testing_delegate(TestingDelegate* testing_delegate) {
     testing_delegate_ = testing_delegate;
   }
 
- protected:
-  // Flag that could be set by the testing code to enable GCM. Otherwise,
-  // tests from official build will fail.
-  static bool enable_gcm_for_testing_;
-
  private:
   friend class GCMProfileServiceTestConsumer;
 
   class DelayedTaskController;
   class IOWorker;
 
   struct RegistrationInfo {
     RegistrationInfo();
     ~RegistrationInfo();
     bool IsValid() const;
 
     std::vector<std::string> sender_ids;
     std::string registration_id;
   };
 
   // Overridden from content::NotificationObserver:
   virtual void Observe(int type,
                        const content::NotificationSource& source,
                        const content::NotificationDetails& details) OVERRIDE;
 
-  // Checks in with GCM by creating and initializing GCMClient when the profile
-  // has been signed in.
-  void CheckIn(const std::string& username);
+  // Ensures that the GCMClient is loaded and the GCM check-in is done when
+  // the profile was signed in.
+  void EnsureLoaded();
 
   // Checks out of GCM when the profile has been signed out. This will erase
   // all the cached and persisted data.
   void CheckOut();
 
   // Resets the GCMClient instance. This is called when the profile is being
   // destroyed.
   void ResetGCMClient();
 
   // Ensures that the app is ready for GCM functions and events.
@@ skipping 15 matching lines @@
                         GCMClient::Result result);
   void SendFinished(const std::string& app_id,
                     const std::string& message_id,
                     GCMClient::Result result);
   void MessageReceived(const std::string& app_id,
                        GCMClient::IncomingMessage message);
   void MessagesDeleted(const std::string& app_id);
   void MessageSendError(const std::string& app_id,
                         const std::string& message_id,
                         GCMClient::Result result);
-  void FinishInitializationOnUI(bool ready);
   void GCMClientReady();
 
   // Returns the event router to fire the event for the given app.
   GCMEventRouter* GetEventRouter(const std::string& app_id) const;
 
   // Used to persist the IDs of registered apps.
   void ReadRegisteredAppIDs();
   void WriteRegisteredAppIDs();
 
   // Used to persist registration info into the app's state store.
   void DeleteRegistrationInfo(const std::string& app_id);
   void WriteRegistrationInfo(const std::string& app_id);
   void ReadRegistrationInfo(const std::string& app_id);
   void ReadRegistrationInfoFinished(const std::string& app_id,
                                     scoped_ptr<base::Value> value);
   bool ParsePersistedRegistrationInfo(scoped_ptr<base::Value> value,
                                       RegistrationInfo* registration_info);
 
   // Returns the key used to identify the registration info saved into the
   // app's state store. Used for testing purpose.
   static const char* GetPersistentRegisterKeyForTesting();
 
   // The profile which owns this object.
   Profile* profile_;
 
-  // Used to creat the GCMClient instance.
-  scoped_ptr<GCMClientFactory> gcm_client_factory_;
-
   // Flag to indicate if GCMClient is ready.
   bool gcm_client_ready_;
 
   // The username of the signed-in profile.
   std::string username_;
 
   content::NotificationRegistrar registrar_;
 
   scoped_ptr<DelayedTaskController> delayed_task_controller_;
 
@@ skipping 20 matching lines @@
 
   // Used to pass a weak pointer to the IO worker.
   base::WeakPtrFactory<GCMProfileService> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(GCMProfileService);
 };
 
 }  // namespace gcm
 
 #endif  // CHROME_BROWSER_SERVICES_GCM_GCM_PROFILE_SERVICE_H_