GCM Registration Request implementation

google_apis/gcm/engine/registration_request.cc

+// 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.
+
+#include "google_apis/gcm/engine/registration_request.h"
+
+#include "base/bind.h"
+#include "base/message_loop/message_loop.h"
+#include "base/strings/string_number_conversions.h"
+#include "base/values.h"
+#include "net/base/escape.h"
+#include "net/http/http_request_headers.h"
+#include "net/http/http_status_code.h"
+#include "net/url_request/url_fetcher.h"
+#include "net/url_request/url_request_context_getter.h"
+#include "net/url_request/url_request_status.h"
+#include "url/gurl.h"
+
+namespace gcm {
+
+namespace {
+
+const char kRegistrationURL[] =
+    "https://android.clients.google.com/c2dm/register3";
+const char kRegistrationDataFormat[] = "application/x-www-form-urlencoded";

[jianli, 2014/01/10 23:23:47]

nit: kRegistrationRequestContentType

[fgorski, 2014/01/11 00:10:36]

Done.

+
+// Request constants.
+const char kLoginHeader[] = "AidLogin";
+
+const char kAppIdKey[] = "app";
+const char kSenderKey[] = "sender";
+const char kCertKey[] = "cert";
+const char kDeviceIdKey[] = "device";
+const long kMaxSenders = 100;
+const char kUserSerialNumberKey[] = "device_user_id";
+const char kUserAndroidIdKey[] = "X-GOOG.USER_AID";
+
+// Response constants.
+const char kTokenPrefix[] = "token=";
+
+void BuildFormEncoding(const std::string& key,
+                       const std::string& value,
+                       std::string* out) {
+  if (!out->empty())
+    out->append("&");
+  out->append(key + "=" + net::EscapeUrlEncodedData(value, true));
+}
+
+}  // namespace
+
+RegistrationRequest::Parameters::Parameters(
+    const RegistrationCallback& callback,
+    uint64 android_id,
+    uint64 security_token,
+    uint64 user_android_id,
+    int64 user_serial_number,
+    const std::string& app_id,
+    const std::string& cert,
+    const std::vector<std::string>& sender_ids)
+    : callback(callback),
+      android_id(android_id),
+      security_token(security_token),
+      user_android_id(user_android_id),
+      user_serial_number(user_serial_number),
+      app_id(app_id),
+      cert(cert),
+      sender_ids(sender_ids) {}
+
+RegistrationRequest::Parameters::~Parameters() {}
+
+RegistrationRequest::RegistrationRequest(
+    const Parameters& parameters,
+    scoped_refptr<net::URLRequestContextGetter> request_context_getter)
+    : parameters_(parameters),
+      request_context_getter_(request_context_getter) {}
+
+RegistrationRequest::~RegistrationRequest() {}
+
+void RegistrationRequest::Start() {
+  DCHECK(!parameters_.callback.is_null());
+  DCHECK(parameters_.android_id != 0UL);
+  DCHECK(parameters_.security_token != 0UL);
+  DCHECK(!parameters_.cert.empty());
+  DCHECK(0 < parameters_.sender_ids.size() &&
+         parameters_.sender_ids.size() <= kMaxSenders);
+
+  DCHECK(!url_fetcher_.get());
+  url_fetcher_.reset(net::URLFetcher::Create(
+      GURL(kRegistrationURL), net::URLFetcher::POST, this));
+  url_fetcher_->SetRequestContext(request_context_getter_);
+
+  std::string android_id = base::Uint64ToString(parameters_.android_id);
+  std::string auth_header =
+      std::string(net::HttpRequestHeaders::kAuthorization) + ": " +
+      kLoginHeader + " " + android_id + ":" +
+      base::Uint64ToString(parameters_.security_token);
+  url_fetcher_->SetExtraRequestHeaders(auth_header);
+
+  std::string body;
+  BuildFormEncoding(kAppIdKey, parameters_.app_id, &body);
+  BuildFormEncoding(kCertKey, parameters_.cert, &body);
+  BuildFormEncoding(kDeviceIdKey, android_id, &body);
+
+  std::string senders;
+  for (std::vector<std::string>::const_iterator iter =
+           parameters_.sender_ids.begin();
+       iter != parameters_.sender_ids.end();
+       ++iter) {
+    if (!senders.empty())
+      senders.append(",");

[jianli, 2014/01/10 23:23:47]

What if one sender is empty or ","? Do we need so have some sort of validation
in GcmRegisterFunction::DoWork?

[fgorski, 2014/01/11 00:10:36]

We already have validation upstream, but I see no reason not to add a DCHECK
here.

+    senders.append(net::EscapeUrlEncodedData(*iter, true));
+  }
+  BuildFormEncoding(kSenderKey, senders, &body);
+
+  if (parameters_.user_serial_number != 0) {
+    DCHECK(parameters_.user_android_id != 0);
+    BuildFormEncoding(kUserSerialNumberKey,
+                      base::IntToString(parameters_.user_serial_number),
+                      &body);
+    BuildFormEncoding(kUserAndroidIdKey,
+                      base::Uint64ToString(parameters_.user_android_id),
+                      &body);
+  }
+
+  DVLOG(1) << "Registration request: " << body;
+  url_fetcher_->SetUploadData(kRegistrationDataFormat, body);
+
+  DVLOG(1) << "Performing registration for: " << parameters_.app_id;
+  url_fetcher_->Start();
+}
+
+void RegistrationRequest::OnURLFetchComplete(const net::URLFetcher* source) {
+  std::string response;
+  if (!source->GetStatus().is_success() ||
+      source->GetResponseCode() != net::HTTP_OK ||
+      !source->GetResponseAsString(&response)) {
+    // TODO(fgoski): Introduce retry logic.
+    LOG(ERROR) << "Failed to get registration response.";
+    parameters_.callback.Run("");
+    return;
+  }
+
+  DVLOG(1) << "Parsing registration response: " << response;
+  size_t token_pos = response.find(kTokenPrefix);
+  std::string token;
+  if (token_pos != std::string::npos)
+    token = response.substr(token_pos + strlen(kTokenPrefix));
+  else
+    LOG(ERROR) << "Failed to extract token.";
+  parameters_.callback.Run(token);
+}
+
+}  // namespace gcm