[GCM] Adding basic G-services handling

google_apis/gcm/gcm_client_impl.cc

 // 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.
 
 #include "google_apis/gcm/gcm_client_impl.h"
 
 #include "base/bind.h"
 #include "base/files/file_path.h"
 #include "base/logging.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop/message_loop.h"
 #include "base/metrics/histogram.h"
 #include "base/sequenced_task_runner.h"
+#include "base/strings/string_number_conversions.h"
 #include "base/time/default_clock.h"
 #include "google_apis/gcm/base/mcs_message.h"
 #include "google_apis/gcm/base/mcs_util.h"
 #include "google_apis/gcm/engine/checkin_request.h"
 #include "google_apis/gcm/engine/connection_factory_impl.h"
 #include "google_apis/gcm/engine/gcm_store_impl.h"
 #include "google_apis/gcm/engine/mcs_client.h"
 #include "google_apis/gcm/protocol/mcs.pb.h"
 #include "net/http/http_network_session.h"
 #include "net/url_request/url_request_context.h"
@@ skipping 43 matching lines @@
   SEND_ERROR,        // Error sending a message.
 };
 
 // MCS endpoints. SSL Key pinning is done automatically due to the *.google.com
 // pinning rule.
 // Note: modifying the endpoints will affect the ability to compare the
 // GCM.CurrentEnpoint histogram across versions.
 const char kMCSEndpointMain[] = "https://mtalk.google.com:5228";
 const char kMCSEndpointFallback[] = "https://mtalk.google.com:443";
 
+const char kCheckinIntervalKey[] = "checkin_interval";
+const int64 kDefaultCheckinInterval = 172800LL;  // seconds = 2 days.
+const char kDeleteSettingPrefix[] = "delete_";
 const int kMaxRegistrationRetries = 5;
 const char kMessageTypeDataMessage[] = "gcm";
 const char kMessageTypeDeletedMessagesKey[] = "deleted_messages";
 const char kMessageTypeKey[] = "message_type";
 const char kMessageTypeSendErrorKey[] = "send_error";
 const char kSendErrorMessageIdKey[] = "google.message_id";
 const char kSendMessageFromValue[] = "gcm@chrome.com";
 const int64 kDefaultUserSerialNumber = 0LL;
 
 GCMClient::Result ToGCMClientResult(MCSClient::MessageSendStatus status) {
@@ skipping 118 matching lines @@
 
   if (!result->success) {
     ResetState();
     return;
   }
 
   registrations_ = result->registrations;
 
   device_checkin_info_.android_id = result->device_android_id;
   device_checkin_info_.secret = result->device_security_token;
+  gservices_settings_ = result->gservices_settings;
   InitializeMCSClient(result.Pass());
   if (!device_checkin_info_.IsValid()) {
     device_checkin_info_.Reset();
     state_ = INITIAL_DEVICE_CHECKIN;
-    StartCheckin(device_checkin_info_);
+    StartCheckin();
     return;
+  } else {
+    SchedulePeriodicCheckin(result->last_checkin_time);
   }
 
   OnReady();
 }
 
 void GCMClientImpl::InitializeMCSClient(
     scoped_ptr<GCMStore::LoadResult> result) {
   std::vector<GURL> endpoints;
   endpoints.push_back(GURL(kMCSEndpointMain));
   endpoints.push_back(GURL(kMCSEndpointFallback));
@@ skipping 43 matching lines @@
   DCHECK(device_checkin_info_.IsValid());
   mcs_client_->Login(device_checkin_info_.android_id,
                      device_checkin_info_.secret);
 }
 
 void GCMClientImpl::ResetState() {
   state_ = UNINITIALIZED;
   // TODO(fgorski): reset all of the necessart objects and start over.
 }
 
-void GCMClientImpl::StartCheckin(const CheckinInfo& checkin_info) {
+void GCMClientImpl::StartCheckin() {
   checkin_request_.reset(
       new CheckinRequest(base::Bind(&GCMClientImpl::OnCheckinCompleted,
                                     weak_ptr_factory_.GetWeakPtr()),
                          kDefaultBackoffPolicy,
                          chrome_build_proto_,
-                         checkin_info.android_id,
-                         checkin_info.secret,
+                         device_checkin_info_.android_id,
+                         device_checkin_info_.secret,
                          account_ids_,
                          url_request_context_getter_));
   checkin_request_->Start();
 }
 
-void GCMClientImpl::OnCheckinCompleted(uint64 android_id,
-                                       uint64 security_token) {
+void GCMClientImpl::SchedulePeriodicCheckin(
+    const base::Time& last_checkin_time) {
+  base::TimeDelta time_to_next_checkin =
+      last_checkin_time + GetCheckinInterval() - clock_->Now();
+  if (time_to_next_checkin < base::TimeDelta::FromSeconds(0LL))
+    time_to_next_checkin = base::TimeDelta::FromSeconds(0LL);
+  base::MessageLoop::current()->PostDelayedTask(
+      FROM_HERE,
+      base::Bind(&GCMClientImpl::StartCheckin,
+                 weak_ptr_factory_.GetWeakPtr()),
+      time_to_next_checkin);
+}
+
+base::TimeDelta GCMClientImpl::GetCheckinInterval() {
+  GServicesSettingsMap::const_iterator iter =
+      gservices_settings_.find(kCheckinIntervalKey);
+  int64 checkin_interval_sec = kDefaultCheckinInterval;
+  if (iter != gservices_settings_.end())
+    base::StringToInt64(iter->second, &checkin_interval_sec);
+  return base::TimeDelta::FromSeconds(checkin_interval_sec);
+}
+
+void GCMClientImpl::OnCheckinCompleted(
+    const checkin_proto::AndroidCheckinResponse& checkin_response) {
   checkin_request_.reset();
 
-  CheckinInfo checkin_info;
-  checkin_info.android_id = android_id;
-  checkin_info.secret = security_token;
-
-  if (!checkin_info.IsValid()) {
-    // TODO(fgorski): I don't think a retry here will help, we should probalby
+  if (!checkin_response.has_android_id() ||
+      !checkin_response.has_security_token()) {
+    // TODO(fgorski): I don't think a retry here will help, we should probably
     // start over. By checking in with (0, 0).
     return;
   }
 
+  CheckinInfo checkin_info;
+  checkin_info.android_id = checkin_response.android_id();
+  checkin_info.secret = checkin_response.security_token();
+
   if (state_ == INITIAL_DEVICE_CHECKIN) {
     OnFirstTimeDeviceCheckinCompleted(checkin_info);
   } else {
     DCHECK_EQ(READY, state_);
     if (device_checkin_info_.android_id != checkin_info.android_id ||
         device_checkin_info_.secret != checkin_info.secret) {
       ResetState();
-    } else {
-      // TODO(fgorski): Reset the checkin timer.
     }
   }
+
+  if (device_checkin_info_.IsValid()) {
+    UpdateGServicesSettings(checkin_response);
+    SchedulePeriodicCheckin(clock_->Now());
+  }
 }
 
 void GCMClientImpl::SetDeviceCredentialsCallback(bool success) {
   // TODO(fgorski): This is one of the signals that store needs a rebuild.
   DCHECK(success);
 }
 
 void GCMClientImpl::UpdateRegistrationCallback(bool success) {
   // TODO(fgorski): This is one of the signals that store needs a rebuild.
   DCHECK(success);
@@ skipping 325 matching lines @@
       send_error_details.additional_data.find(kSendErrorMessageIdKey);
   if (iter != send_error_details.additional_data.end()) {
     send_error_details.message_id = iter->second;
     send_error_details.additional_data.erase(iter);
   }
 
   delegate_->OnMessageSendError(data_message_stanza.category(),
                                 send_error_details);
 }
 
+void GCMClientImpl::UpdateGServicesSettings(
+    const checkin_proto::AndroidCheckinResponse& checkin_response) {
+  std::vector<std::string> settings_to_remove;
+  std::map<std::string, std::string> settings_to_add;
+
+  // Check if we are only dealing with a diff of settings or full update.

[jianli, 2014/03/31 17:45:35]

Per the comment in checkin.proto:
  // 2.  If 'settings_diff' is true, then 'delete_setting' contains
  // the keys to delete, and 'setting' contains only keys to be added
  // or for which the value has changed.  All other keys in the
  // current table should be left untouched.  If 'settings_diff' is
  // absent, don't touch the existing gservices table.

it seems that we should remove the keys per 'delete_setting' when
'settings_diff' is true; also 'setting' could contain keys for which the value
has changed. I do not see these got handled here.

The code flow here is kind of hard to understand. Could we introduce 3-state
enum:
  DIFFENCE_UPDATE
  FULL_UPDATE
  ADD_ONLY

[fgorski, 2014/03/31 21:50:08]

In v2 of the protocol settings_diff is not used and that is what we are going
with right now. I've updated the code.

+  bool settings_diff = false;
+  if (checkin_response.has_settings_diff()) {
+    if (checkin_response.settings_diff()) {
+      settings_diff = true;
+    } else {
+      for (GServicesSettingsMap::const_iterator it =
+               gservices_settings_.begin();
+           it != gservices_settings_.end(); ++it) {
+        settings_to_remove.push_back(it->first);
+      }
+      gservices_settings_.clear();
+    }
+  }
+
+  for (int i = 0; i < checkin_response.setting_size(); ++i) {
+    std::string name = checkin_response.setting(i).name();
+    // When the settings_diff is set to true in the protobuf, the entries that
+    // start from "delete_" are meant to be removing the settings.
+    if (settings_diff && name.find(kDeleteSettingPrefix) == 0) {
+      name = name.substr(arraysize(kDeleteSettingPrefix) - 1);
+      GServicesSettingsMap::iterator iter = gservices_settings_.find(name);
+      if (iter != gservices_settings_.end()) {
+        settings_to_remove.push_back(name);
+        gservices_settings_.erase(iter);
+      }
+    } else {
+      std::string value = checkin_response.setting(i).value();
+      gservices_settings_[name] = value;
+      settings_to_add[name] = value;
+    }
+  }
+
+  gcm_store_->UpdateGServicesSettings(
+      settings_to_remove,
+      settings_to_add,
+      clock_->Now(),
+      base::Bind(&GCMClientImpl::UpdateGServicesSettingsCallback,
+                 weak_ptr_factory_.GetWeakPtr()));
+}
+
+void GCMClientImpl::UpdateGServicesSettingsCallback(bool success) {
+  DCHECK(success);
+}
+
 }  // namespace gcm