Obfuscated Gaia ID fetcher

chrome/browser/extensions/api/push_messaging/obfuscated_gaia_id_fetcher.cc

+// Copyright (c) 2012 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 "chrome/browser/extensions/api/push_messaging/obfuscated_gaia_id_fetcher.h"
+
+#include <string>

[dcheng, 2012/08/20 21:04:13]

This is already included in the header, so it's OK to omit it here.

[Pete Williamson, 2012/08/20 22:26:45]

Done.

+#include <vector>
+
+#include "base/json/json_reader.h"
+#include "base/values.h"
+#include "chrome/common/net/gaia/google_service_auth_error.h"
+#include "net/url_request/url_fetcher.h"
+#include "net/url_request/url_request_status.h"
+
+using net::URLFetcher;
+using net::URLRequestContextGetter;
+using net::URLRequestStatus;
+
+namespace {
+
+// URL of the service to get obfuscated GAIA ID (here misnamed channel ID).
+static const char kCWSChannelServiceURL[] =
+    "https://www.googleapis.com/chromewebstore/v1.1/channels/id";
+
+static GoogleServiceAuthError CreateAuthError(URLRequestStatus status) {
+  if (status.status() == URLRequestStatus::CANCELED) {
+    return GoogleServiceAuthError(GoogleServiceAuthError::REQUEST_CANCELED);
+  } else {
+    // TODO(munjal): Improve error handling. Currently we return connection
+    // error for even application level errors. We need to either expand the
+    // GoogleServiceAuthError enum or create a new one to report better
+    // errors.
+    DLOG(WARNING) << "Server returned error: errno " << status.error();
+    return GoogleServiceAuthError::FromConnectionError(status.error());
+  }
+}
+
+// Returns a vector of scopes needed to call the API to get obfuscated gaia id.
+std::vector<std::string> GetScopes() {
+  std::vector<std::string> scopes;
+  scopes.push_back(
+      "https://www.googleapis.com/auth/chromewebstore.notification");
+  return scopes;
+}
+
+}  // namespace
+
+
+namespace extensions {
+
+ObfuscatedGaiaIdFetcher::ObfuscatedGaiaIdFetcher(
+    URLRequestContextGetter* context,
+    Delegate* delegate,
+    const std::string& refresh_token)
+    : OAuth2ApiCallFlow(context, refresh_token, std::string(), GetScopes()),
+      delegate_(delegate) {
+}
+
+ObfuscatedGaiaIdFetcher::~ObfuscatedGaiaIdFetcher() { }
+
+void ObfuscatedGaiaIdFetcher::ReportSuccess(const std::string& obfuscated_id) {
+  if (delegate_ != NULL)

[dcheng, 2012/08/20 21:04:13]

Do we need to allow NULL delegates? It doesn't look like anyone uses this
functionality, so we should probably just remove this and DCHECK() that delegate
is not NULL in the constructor.

Also the preferred style for checking null/non-null-ness of a pointer is if (p)
and if (!p)

[Pete Williamson, 2012/08/20 22:26:45]

Done.

+    delegate_->OnObfuscatedGaiaIdFetchSuccess(obfuscated_id);
+}
+
+void ObfuscatedGaiaIdFetcher::ReportFailure(
+    const GoogleServiceAuthError& error) {
+  if (delegate_ != NULL)
+    delegate_->OnObfuscatedGaiaIdFetchFailure(error);
+}
+
+GURL ObfuscatedGaiaIdFetcher::CreateApiCallUrl() {
+  return GURL(kCWSChannelServiceURL);
+}
+
+std::string ObfuscatedGaiaIdFetcher::CreateApiCallBody() {
+  // Nothing to do here, we don't need a body for this request, the URL
+  // encodes all the proper arguments.
+  return std::string();
+}
+
+void ObfuscatedGaiaIdFetcher::ProcessApiCallSuccess(
+    const net::URLFetcher* source) {
+  // TODO(munjal): Change error code paths in this method to report an
+  // internal error.
+  std::string response_body;
+  CHECK(source->GetResponseAsString(&response_body));
+
+  std::string channel_id;
+  if (ParseResponse(response_body, &channel_id))
+    ReportSuccess(channel_id);
+  else
+    ReportFailure(GoogleServiceAuthError::FromConnectionError(101));

[dcheng, 2012/08/20 21:04:13]

What does 101 mean? Is this code defined somewhere?

[Pete Williamson, 2012/08/20 22:26:45]

This came from code that I copied from oauth2_mint_token_flow.  Munjal says it
was picked arbitrarily just so that they can add more errors in the future, and
that it is good if I also use 101 here.  I added a comment explaining this.

+}
+
+void ObfuscatedGaiaIdFetcher::ProcessApiCallFailure(
+    const net::URLFetcher* source) {
+  ReportFailure(CreateAuthError(source->GetStatus()));
+}
+
+void ObfuscatedGaiaIdFetcher::ProcessNewAccessToken(
+    const std::string& obfuscated_id)  {
+  // We generate a new access token every time instead of storing the access
+  // token since access token expire every hour and we expect to get
+  // obfuscated gaia id very infrequently.
+}
+
+void ObfuscatedGaiaIdFetcher::ProcessMintAccessTokenFailure(
+    const GoogleServiceAuthError& error)  {
+  // We failed to generate the token needed to call the API to get
+  // the obfuscated user ID, so report failure to the caller.
+  ReportFailure(error);
+}
+
+// static
+bool ObfuscatedGaiaIdFetcher::ParseResponse(
+    const std::string& data, std::string* result) {
+  scoped_ptr<base::Value> value(base::JSONReader::Read(data));
+
+  if (!value.get())
+    return false;
+
+  DictionaryValue* dict = NULL;
+  if (!value->GetAsDictionary(&dict))
+    return false;
+
+  return dict->GetString("id", result);
+}
+
+}  // namespace extensions