[GCM] Adding basic G-services handling

google_apis/gcm/gcm_client_impl.h

 // Copyright 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 GOOGLE_APIS_GCM_GCM_CLIENT_IMPL_H_
 #define GOOGLE_APIS_GCM_GCM_CLIENT_IMPL_H_
 
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/compiler_specific.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/weak_ptr.h"
 #include "base/stl_util.h"
 #include "google_apis/gcm/base/mcs_message.h"
 #include "google_apis/gcm/engine/gcm_store.h"
 #include "google_apis/gcm/engine/mcs_client.h"
 #include "google_apis/gcm/engine/registration_request.h"
 #include "google_apis/gcm/engine/unregistration_request.h"
 #include "google_apis/gcm/gcm_client.h"
-#include "google_apis/gcm/protocol/android_checkin.pb.h"
+#include "google_apis/gcm/protocol/checkin.pb.h"
 #include "net/base/net_log.h"
 #include "net/url_request/url_request_context_getter.h"
 
 class GURL;
 
 namespace base {
 class Clock;
 }  // namespace base
 
 namespace net {
 class HttpNetworkSession;
 }  // namespace net
 
 namespace gcm {
 
 class CheckinRequest;
 class ConnectionFactory;
 class GCMClientImplTest;
 
+// Map with GServices settings.
+// TODO(fgorski): Extract services handling to a separate struct/class.
+typedef std::map<std::string, std::string> GServicesSettingsMap;
+
 // Helper class for building GCM internals. Allows tests to inject fake versions
 // as necessary.
 class GCM_EXPORT GCMInternalsBuilder {
  public:
   GCMInternalsBuilder();
   virtual ~GCMInternalsBuilder();
 
   virtual scoped_ptr<base::Clock> BuildClock();
   virtual scoped_ptr<MCSClient> BuildMCSClient(
       const std::string& version,
@@ skipping 103 matching lines @@
   void OnFirstTimeDeviceCheckinCompleted(const CheckinInfo& checkin_info);
   // Starts a login on mcs_client_.
   void StartMCSLogin();
   // Resets state to before initialization.
   void ResetState();
   // Sets state to ready. This will initiate the MCS login and notify the
   // delegates.
   void OnReady();
 
   // Starts a first time device checkin.
-  void StartCheckin(const CheckinInfo& checkin_info);
-  // Completes the device checkin request.
-  // |android_id| and |security_token| are expected to be non-zero or an error
-  // is triggered. Function also cleans up the pending checkin.
-  void OnCheckinCompleted(uint64 android_id,
-                          uint64 security_token);
+  void StartCheckin();
+  // Completes the device checkin request by parsing the |checkin_response|.
+  // Function also cleans up the pending checkin.
+  void OnCheckinCompleted(
+      const checkin_proto::AndroidCheckinResponse& checkin_response);
+  // Schedules next device checkin, based on |last_checkin_time| and
+  // checkin_interval specified in GServices settings.
+  void SchedulePeriodicCheckin(const base::Time& last_checkin_time);
 
   // Callback for persisting device credentials in the |gcm_store_|.
   void SetDeviceCredentialsCallback(bool success);
 
   // Callback for persisting registration info in the |gcm_store_|.
   void UpdateRegistrationCallback(bool success);
 
   // Completes the registration request.
   void OnRegisterCompleted(const std::string& app_id,
                            const std::vector<std::string>& sender_ids,
@@ skipping 15 matching lines @@
   void HandleIncomingDataMessage(
       const mcs_proto::DataMessageStanza& data_message_stanza,
       MessageData& message_data);
 
   // Fires OnMessageSendError event on the delegate of this calss, based on the
   // details in |data_message_stanza| and |message_data|.
   void HandleIncomingSendError(
       const mcs_proto::DataMessageStanza& data_message_stanza,
       MessageData& message_data);
 
+  // Updates the GServicesSettings based on the |checkin_response|.

[Nicolas Zea, 2014/04/01 21:42:14]

Mention that it assumes base::Time::Now() is the checkin time.

[fgorski, 2014/04/02 18:23:00]

Done.

+  void UpdateGServicesSettings(
+      const checkin_proto::AndroidCheckinResponse& checkin_response);
+  // Completes the G-services settings update request.
+  void UpdateGServicesSettingsCallback(bool success);
+
+  // Calculates the Checkin interval based on the services settings or defaults
+  // to a sensible value. Virtual for testing.
+  virtual base::TimeDelta GetCheckinInterval() const;
+
   // Builder for the GCM internals (mcs client, etc.).
   scoped_ptr<GCMInternalsBuilder> internals_builder_;
 
   // State of the GCM Client Implementation.
   State state_;
 
   Delegate* delegate_;
 
   // Device checkin info (android ID and security token used by device).
   CheckinInfo device_checkin_info_;
 
   // Clock used for timing of retry logic. Passed in for testing. Owned by
   // GCMClientImpl.
   scoped_ptr<base::Clock> clock_;
 
   // Information about the chrome build.
   // TODO(fgorski): Check if it can be passed in constructor and made const.
   checkin_proto::ChromeBuildProto chrome_build_proto_;
 
   // Persistent data store for keeping device credentials, messages and user to
   // serial number mappings.
   scoped_ptr<GCMStore> gcm_store_;
 
   scoped_refptr<net::HttpNetworkSession> network_session_;
   net::BoundNetLog net_log_;
   scoped_ptr<ConnectionFactory> connection_factory_;
   scoped_refptr<net::URLRequestContextGetter> url_request_context_getter_;
 
+  // Map with GServices settings, such us checkin_interval, checkin_url, etc.
+  GServicesSettingsMap gservices_settings_;
+
+  // Digest of the |gservices_settings|.
+  std::string gservices_digest_;
+
   // Controls receiving and sending of packets and reliable message queueing.
   scoped_ptr<MCSClient> mcs_client_;
 
   scoped_ptr<CheckinRequest> checkin_request_;
   std::vector<std::string> account_ids_;
 
   // Cached registration info.
   RegistrationInfoMap registrations_;
 
   // Currently pending registration requests. GCMClientImpl owns the
@@ skipping 10 matching lines @@
 
   // Factory for creating references in callbacks.
   base::WeakPtrFactory<GCMClientImpl> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(GCMClientImpl);
 };
 
 }  // namespace gcm
 
 #endif  // GOOGLE_APIS_GCM_GCM_CLIENT_IMPL_H_