Add a mode to OAuth2MintTokenFlow that fetches the messages to show to the user.

chrome/common/net/gaia/oauth2_mint_token_flow.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/common/net/gaia/oauth2_mint_token_flow.h"
 
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/bind.h"
 #include "base/command_line.h"
+#include "base/json/json_reader.h"
 #include "base/message_loop.h"
+#include "base/string_util.h"
+#include "base/stringprintf.h"
+#include "base/values.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/net/gaia/gaia_urls.h"
 #include "chrome/common/net/gaia/google_service_auth_error.h"
+#include "content/public/common/url_fetcher.h"
+#include "net/base/escape.h"
+#include "net/url_request/url_request_context_getter.h"
+#include "net/url_request/url_request_status.h"
 
+using content::URLFetcher;
 using net::URLRequestContextGetter;
+using net::URLRequestStatus;
 
 namespace {
 
+static const char kForceValueFalse[] = "false";
+static const char kForceValueTrue[] = "true";
+static const char kResponseTypeValueNone[] = "none";
+static const char kResponseTypeValueToken[] = "token";
+
+static const char kOAuth2IssueTokenBodyFormat[] =
+    "force=%s"
+    "&response_type=%s"
+    "&scope=%s"
+    "&client_id=%s"
+    "&origin=%s";
+static const char kIssueAdviceKey[] = "issueAdvice";
+static const char kIssueAdviceValueAuto[] = "auto";
+static const char kIssueAdviceValueConsent[] = "consent";
+static const char kAccessTokenKey[] = "token";
+static const char kConsentKey[] = "consent";
+static const char kScopesKey[] = "scopes";
+static const char kDescriptionKey[] = "description";
+static const char kDetailKey[] = "detail";
+static const char kDetailSeparators[] = "\n";
+
+static GoogleServiceAuthError CreateAuthError(URLRequestStatus status) {
+  CHECK(!status.is_success());
+  if (status.status() == URLRequestStatus::CANCELED) {
+    return GoogleServiceAuthError(GoogleServiceAuthError::REQUEST_CANCELED);
+  } else {
+    DLOG(WARNING) << "Could not reach Google Accounts servers: errno "
+                  << status.error();
+    return GoogleServiceAuthError::FromConnectionError(status.error());
+  }
+}
+
 OAuth2MintTokenFlow::InterceptorForTests* g_interceptor_for_tests = NULL;
 
 }  // namespace
 
 // static
 void OAuth2MintTokenFlow::SetInterceptorForTests(
     OAuth2MintTokenFlow::InterceptorForTests* interceptor) {
   CHECK(CommandLine::ForCurrentProcess()->HasSwitch(switches::kTestType));
   CHECK(NULL == g_interceptor_for_tests);  // Only one at a time.
   g_interceptor_for_tests = interceptor;
 }
 
 OAuth2MintTokenFlow::OAuth2MintTokenFlow(
     URLRequestContextGetter* context,
-    Delegate* delegate)
-    : context_(context),
+    Delegate* delegate,
+    const Parameters& parameters)
+    : OAuth2ApiCallFlow(
+          context, parameters.login_refresh_token,
+          "", std::vector<std::string>()),
+      context_(context),
       delegate_(delegate),
-      state_(INITIAL) {
+      parameters_(parameters) {
 }
 
 OAuth2MintTokenFlow::~OAuth2MintTokenFlow() { }
 
-void OAuth2MintTokenFlow::Start(
-    const std::string& login_refresh_token,
-    const std::string& extension_id,
-    const std::string& client_id,
-    const std::vector<std::string>& scopes) {
-  login_refresh_token_ = login_refresh_token;
-  extension_id_ = extension_id;
-  client_id_ = client_id;
-  scopes_ = scopes;
-
+void OAuth2MintTokenFlow::Start() {
   if (g_interceptor_for_tests) {
     std::string auth_token;
     GoogleServiceAuthError error = GoogleServiceAuthError::None();
 
     // We use PostTask, instead of calling the delegate directly, because the
     // message loop will run a few times before we notify the delegate in the
     // real implementation.
     if (g_interceptor_for_tests->DoIntercept(this, &auth_token, &error)) {
       MessageLoop::current()->PostTask(
           FROM_HERE,
           base::Bind(&OAuth2MintTokenFlow::Delegate::OnMintTokenSuccess,
                      base::Unretained(delegate_), auth_token));
     } else {
       MessageLoop::current()->PostTask(
           FROM_HERE,
           base::Bind(&OAuth2MintTokenFlow::Delegate::OnMintTokenFailure,
                      base::Unretained(delegate_), error));
     }
     return;
   }
 
-  BeginGetLoginAccessToken();
+  OAuth2ApiCallFlow::Start();
 }
 
-void OAuth2MintTokenFlow::OnGetTokenSuccess(
-    const std::string& access_token) {
-  login_access_token_ = access_token;
-  EndGetLoginAccessToken(NULL);
-}
-
-void OAuth2MintTokenFlow::OnGetTokenFailure(
-    const GoogleServiceAuthError& error) {
-  EndGetLoginAccessToken(&error);
-}
-
-void OAuth2MintTokenFlow::BeginGetLoginAccessToken() {
-  CHECK_EQ(INITIAL, state_);
-  state_ = FETCH_LOGIN_ACCESS_TOKEN_STARTED;
-
-  oauth2_access_token_fetcher_.reset(CreateAccessTokenFetcher());
-  oauth2_access_token_fetcher_->Start(
-      GaiaUrls::GetInstance()->oauth2_chrome_client_id(),
-      GaiaUrls::GetInstance()->oauth2_chrome_client_secret(),
-      login_refresh_token_,
-      std::vector<std::string>());
-}
-
-void OAuth2MintTokenFlow::EndGetLoginAccessToken(
-    const GoogleServiceAuthError* error) {
-  CHECK_EQ(FETCH_LOGIN_ACCESS_TOKEN_STARTED, state_);
-  if (!error) {
-    state_ = FETCH_LOGIN_ACCESS_TOKEN_DONE;
-    BeginMintAccessToken();
-  } else {
-    state_ = ERROR_STATE;
-    ReportFailure(*error);
+void OAuth2MintTokenFlow::ReportSuccess(const std::string& access_token) {
+  if (delegate_) {
+    delegate_->OnMintTokenSuccess(access_token);
   }
 }
 
-void OAuth2MintTokenFlow::OnMintTokenSuccess(
-    const std::string& access_token) {
-  app_access_token_ = access_token;
-  EndMintAccessToken(NULL);
-}
-void OAuth2MintTokenFlow::OnMintTokenFailure(
-    const GoogleServiceAuthError& error) {
-  EndMintAccessToken(&error);
-}
-
-void OAuth2MintTokenFlow::BeginMintAccessToken() {
-  CHECK_EQ(FETCH_LOGIN_ACCESS_TOKEN_DONE, state_);
-  state_ = MINT_ACCESS_TOKEN_STARTED;
-
-  oauth2_mint_token_fetcher_.reset(CreateMintTokenFetcher());
-  oauth2_mint_token_fetcher_->Start(
-      login_access_token_,
-      client_id_,
-      scopes_,
-      extension_id_);
-}
-
-void OAuth2MintTokenFlow::EndMintAccessToken(
-    const GoogleServiceAuthError* error) {
-  CHECK_EQ(MINT_ACCESS_TOKEN_STARTED, state_);
-
-  if (!error) {
-    state_ = MINT_ACCESS_TOKEN_DONE;
-    ReportSuccess();
-  } else {
-    state_ = ERROR_STATE;
-    ReportFailure(*error);
-  }
-}
-
-void OAuth2MintTokenFlow::ReportSuccess() {
-  CHECK_EQ(MINT_ACCESS_TOKEN_DONE, state_);
-
+void OAuth2MintTokenFlow::ReportSuccess(const IssueAdviceInfo& issue_advice) {
   if (delegate_) {
-    delegate_->OnMintTokenSuccess(app_access_token_);
+    delegate_->OnIssueAdviceSuccess(issue_advice);
   }
 }
 
 void OAuth2MintTokenFlow::ReportFailure(
     const GoogleServiceAuthError& error) {
-  CHECK_EQ(ERROR_STATE, state_);
-
   if (delegate_) {
     delegate_->OnMintTokenFailure(error);
   }
 }
 
-OAuth2AccessTokenFetcher* OAuth2MintTokenFlow::CreateAccessTokenFetcher() {
-  return new OAuth2AccessTokenFetcher(this, context_);
+GURL OAuth2MintTokenFlow::CreateApiCallUrl() {
+  return GURL(GaiaUrls::GetInstance()->oauth2_issue_token_url());
 }
 
-OAuth2MintTokenFetcher* OAuth2MintTokenFlow::CreateMintTokenFetcher() {
-  return new OAuth2MintTokenFetcher(this, context_, "OAuth2MintTokenFlow");
+std::string OAuth2MintTokenFlow::CreateApiCallBody() {
+  const char* force_value =
+      (parameters_.mode == MODE_MINT_TOKEN_FORCE ||
+       parameters_.mode == MODE_RECORD_GRANT)
+          ? kForceValueTrue : kForceValueFalse;
+  const char* response_type_value =
+      (parameters_.mode == MODE_MINT_TOKEN_NO_FORCE ||
+       parameters_.mode == MODE_MINT_TOKEN_FORCE)
+          ? kResponseTypeValueToken : kResponseTypeValueNone;
+  return StringPrintf(
+      kOAuth2IssueTokenBodyFormat,
+      net::EscapeUrlEncodedData(force_value, true).c_str(),
+      net::EscapeUrlEncodedData(response_type_value, true).c_str(),
+      net::EscapeUrlEncodedData(
+          JoinString(parameters_.scopes, ' '), true).c_str(),
+      net::EscapeUrlEncodedData(parameters_.client_id, true).c_str(),
+      net::EscapeUrlEncodedData(parameters_.extension_id, true).c_str());
 }
+
+void OAuth2MintTokenFlow::ProcessApiCallSuccess(
+    const content::URLFetcher* source) {
+  // TODO(munjal): Change error code paths in this method to report an
+  // internal error.
+  scoped_ptr<base::DictionaryValue> dict(ParseResponse(source));
+  if (!dict.get()) {
+    ReportFailure(GoogleServiceAuthError::FromConnectionError(101));
+    return;
+  }
+  std::string issue_advice;
+  if (!dict->GetString(kIssueAdviceKey, &issue_advice)) {
+    ReportFailure(GoogleServiceAuthError::FromConnectionError(101));
+    return;
+  }
+  if (issue_advice == kIssueAdviceValueConsent) {
+    IssueAdviceInfo issue_advice;
+    if (ParseIssueAdviceResponse(dict.get(), &issue_advice))
+      ReportSuccess(issue_advice);
+    else
+      ReportFailure(GoogleServiceAuthError::FromConnectionError(101));
+  } else {
+    std::string access_token;
+    if (ParseMintTokenResponse(dict.get(), &access_token))
+      ReportSuccess(access_token);
+    else
+      ReportFailure(GoogleServiceAuthError::FromConnectionError(101));
+  }
+}
+
+void OAuth2MintTokenFlow::ProcessApiCallFailure(
+    const content::URLFetcher* source) {
+  ReportFailure(CreateAuthError(source->GetStatus()));
+}
+void OAuth2MintTokenFlow::ProcessNewAccessToken(
+    const std::string& access_token) {
+  // We don't currently store new access tokens. We generate one every time.
+  // So we have nothing to do here.
+  return;
+}
+void OAuth2MintTokenFlow::ProcessMintAccessTokenFailure(
+    const GoogleServiceAuthError& error) {
+  ReportFailure(error);
+}
+
+// static
+base::DictionaryValue* OAuth2MintTokenFlow::ParseResponse(
+    const URLFetcher* url_fetcher) {
+  CHECK(url_fetcher);
+  std::string response_body;
+  url_fetcher->GetResponseAsString(&response_body);
+  base::JSONReader reader;

[jstritar, 2012/04/11 19:14:29]

Do we need to be parsing this in a sandboxed utility process? I think this is OK
since we're getting this from a google domain over HTTPS.

[Munjal (Google), 2012/04/11 19:37:55]

I don't think we need sandboxing here. There is already a ton of code in
net/gaia that parses responses from various Google endpoints into JSON. None of
them use sandboxing.

+  scoped_ptr<base::Value> value(reader.Read(response_body, false));
+  DictionaryValue* result = NULL;
+  if (!value.get() || !value->GetAsDictionary(&result))
+    return NULL;
+
+  value.release();
+  return result;
+}
+
+// static
+bool OAuth2MintTokenFlow::ParseMintTokenResponse(
+    const base::DictionaryValue* dict, std::string* access_token) {
+  CHECK(dict);
+  CHECK(access_token);
+  return dict->GetString(kAccessTokenKey, access_token);
+}
+
+// static
+bool OAuth2MintTokenFlow::ParseIssueAdviceResponse(
+    const base::DictionaryValue* dict, IssueAdviceInfo* issue_advice) {
+  CHECK(dict);
+  CHECK(issue_advice);
+
+  base::DictionaryValue* consent_dict = NULL;
+  if (!dict->GetDictionary(kConsentKey, &consent_dict))
+    return false;
+
+  base::ListValue* scopes_list = NULL;
+  if (!consent_dict->GetList(kScopesKey, &scopes_list))
+    return false;
+
+  bool success = true;
+  for (size_t index = 0; index < scopes_list->GetSize(); ++index) {
+    base::DictionaryValue* scopes_entry = NULL;
+    if (!scopes_list->GetDictionary(index, &scopes_entry)) {

[jstritar, 2012/04/11 19:14:29]

Not required, but you could compact this a bit by defining all the variables at
once and combining the ifs:

base::DictionaryValue* scopes_entry = NULL;
IssueAdviceInfoEntry entry;
std::string detail;
if (!scopes_list->GetDictionary(index, &scopes_entry) ||
    !scopes_entry->GetString(kDescriptionKey, &entry.description) ||
    !scopes_entry->GetString(kDetailKey, &detail)) {
  success = false;
  break;
}

[Munjal (Google), 2012/04/11 19:37:55]

Done.

I like it. I think I have a tendency to do it separately since sometimes we need
to log separate messages or report different error code. But in this case that
is not true.

+      success = false;
+      break;
+    }
+    IssueAdviceInfoEntry entry;
+    if (!scopes_entry->GetString(kDescriptionKey, &entry.description)) {
+      success = false;
+      break;
+    }
+    std::string detail;
+    if (!scopes_entry->GetString(kDetailKey, &detail)) {
+      success = false;
+      break;
+    }
+
+    Tokenize(detail, kDetailSeparators, &entry.details);
+    issue_advice->push_back(entry);
+  }
+
+  if (!success)
+    issue_advice->clear();
+
+  return success;
+}