[GCM] Check-in with signed in accounts associates device to user

components/gcm_driver/gcm_client_impl.h

 // 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.
 
 #ifndef COMPONENTS_GCM_DRIVER_GCM_CLIENT_IMPL_H_
 #define COMPONENTS_GCM_DRIVER_GCM_CLIENT_IMPL_H_
 
 #include <map>
+#include <set>
 #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 "components/gcm_driver/gcm_client.h"
 #include "components/gcm_driver/gcm_stats_recorder_impl.h"
 #include "google_apis/gcm/base/mcs_message.h"
@@ skipping 75 matching lines @@
   virtual void CheckOut() OVERRIDE;
   virtual void Register(const std::string& app_id,
                         const std::vector<std::string>& sender_ids) OVERRIDE;
   virtual void Unregister(const std::string& app_id) OVERRIDE;
   virtual void Send(const std::string& app_id,
                     const std::string& receiver_id,
                     const OutgoingMessage& message) OVERRIDE;
   virtual void SetRecording(bool recording) OVERRIDE;
   virtual void ClearActivityLogs() OVERRIDE;
   virtual GCMStatistics GetStatistics() const OVERRIDE;
+  virtual void SetAccountsForCheckin(
+      const std::map<std::string, std::string>& account_tokens) OVERRIDE;
 
   // GCMStatsRecorder::Delegate implemenation.
   virtual void OnActivityRecorded() OVERRIDE;
 
   // ConnectionFactory::ConnectionListener implementation.
   virtual void OnConnected(const GURL& current_server,
                            const net::IPEndPoint& ip_endpoint) OVERRIDE;
   virtual void OnDisconnected() OVERRIDE;
 
  private:
   // State representation of the GCMClient.
   // Any change made to this enum should have corresponding change in the
   // GetStateString(...) function.
   enum State {
     // Uninitialized.
     UNINITIALIZED,
     // Initialized,
     INITIALIZED,
     // GCM store loading is in progress.
     LOADING,
     // Initial device checkin is in progress.
     INITIAL_DEVICE_CHECKIN,
     // Ready to accept requests.
     READY,
   };
 
-  // The check-in info for the user. Returned by the server.
+  // The check-in info for the device.
   struct CheckinInfo {
-    CheckinInfo() : android_id(0), secret(0) {}
+    CheckinInfo();
+    ~CheckinInfo();
     bool IsValid() const { return android_id != 0 && secret != 0; }
-    void Reset() {
-      android_id = 0;
-      secret = 0;
-    }
+    void SnapshotCheckinAccounts();

[Nicolas Zea, 2014/07/16 20:53:54]

Hmm, I wonder if this struct is becoming complex enough to merit being a class,
with explicit setter functions.

[fgorski, 2014/07/17 03:35:35]

Ack. Lemme do a separate patch for that, there is a few things I want to move
around (e.g. last_checkin_time, check  if account was removed, so on.)

TODO added.

+    void Reset();
 
+    // Android ID of the device as assigned by the server.
     uint64 android_id;
+    // Security token of the device as assigned by the server.
     uint64 secret;
+    // True if accounts where already provided through SetAccountsForCheckin(),

[Nicolas Zea, 2014/07/16 20:53:54]

nit: where -> were

[fgorski, 2014/07/17 03:35:35]

Done.

+    // or when |last_checkin_accounts| was loaded as empty.
+    bool accounts_set;
+    // Map of account email addresses and OAuth2 tokens that will be sent to the
+    // checkin server on a next checkin.
+    std::map<std::string, std::string> account_tokens;
+    // As set of accounts last checkin was completed with.
+    std::set<std::string> last_checkin_accounts;
   };
 
   // Collection of pending registration requests. Keys are app IDs, while values
   // are pending registration requests to obtain a registration ID for
   // requesting application.
   typedef std::map<std::string, RegistrationRequest*>
       PendingRegistrationRequests;
 
   // Collection of pending unregistration requests. Keys are app IDs, while
   // values are pending unregistration requests to disable the registration ID
@@ skipping 41 matching lines @@
 
   // Callback passed to GCMStore::SetGServicesSettings.
   void SetGServicesSettingsCallback(bool success);
 
   // Schedules next periodic device checkin and makes sure there is at most one
   // pending checkin at a time. This function is meant to be called after a
   // successful checkin.
   void SchedulePeriodicCheckin();
   // Gets the time until next checkin.
   base::TimeDelta GetTimeToNextCheckin() const;
-  // Callback for setting last checkin time in the |gcm_store_|.
-  void SetLastCheckinTimeCallback(bool success);
+  // Callback for setting last checkin information in the |gcm_store_|.
+  void SetLastCheckinInfoCallback(bool success);
 
   // 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 84 matching lines @@
 
   // Factory for creating references in callbacks.
   base::WeakPtrFactory<GCMClientImpl> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(GCMClientImpl);
 };
 
 }  // namespace gcm
 
 #endif  // COMPONENTS_GCM_DRIVER_GCM_CLIENT_IMPL_H_