Create a new AccountTrackerService

components/signin/core/browser/account_tracker_service.cc

+// 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.
+
+#include "components/signin/core/browser/account_tracker_service.h"
+
+#include "base/debug/trace_event.h"
+#include "base/prefs/pref_service.h"
+#include "base/prefs/scoped_user_pref_update.h"
+#include "base/strings/utf_string_conversions.h"
+#include "components/signin/core/browser/signin_manager.h"
+#include "google_apis/gaia/gaia_auth_util.h"
+#include "google_apis/gaia/gaia_constants.h"
+#include "google_apis/gaia/gaia_oauth_client.h"
+#include "google_apis/gaia/oauth2_token_service.h"
+#include "net/url_request/url_request_context_getter.h"
+
+namespace {
+
+const char kAccountKeyPath[] = "account_id";
+const char kAccountEmailPath[] = "email";
+const char kAccountGaiaPath[] = "gaia";
+
+}
+
+class AccountInfoFetcher : public OAuth2TokenService::Consumer,
+                           public gaia::GaiaOAuthClient::Delegate {
+ public:
+  AccountInfoFetcher(OAuth2TokenService* token_service,
+                     net::URLRequestContextGetter* request_context_getter,
+                     AccountTrackerService* service,
+                     const std::string& account_id);
+  virtual ~AccountInfoFetcher();
+
+  const std::string& account_id() { return account_id_; }
+
+  void Start();
+
+  // OAuth2TokenService::Consumer implementation.
+  virtual void OnGetTokenSuccess(const OAuth2TokenService::Request* request,
+                                 const std::string& access_token,
+                                 const base::Time& expiration_time) OVERRIDE;
+  virtual void OnGetTokenFailure(const OAuth2TokenService::Request* request,
+                                 const GoogleServiceAuthError& error) OVERRIDE;
+
+  // gaia::GaiaOAuthClient::Delegate implementation.
+  virtual void OnGetUserInfoResponse(
+      scoped_ptr<base::DictionaryValue> user_info) OVERRIDE;
+  virtual void OnOAuthError() OVERRIDE;
+  virtual void OnNetworkError(int response_code) OVERRIDE;
+
+ private:
+  OAuth2TokenService* token_service_;
+  net::URLRequestContextGetter* request_context_getter_;
+  AccountTrackerService* service_;
+  const std::string account_id_;
+
+  scoped_ptr<OAuth2TokenService::Request> login_token_request_;
+  scoped_ptr<gaia::GaiaOAuthClient> gaia_oauth_client_;
+};
+
+AccountInfoFetcher::AccountInfoFetcher(
+    OAuth2TokenService* token_service,
+    net::URLRequestContextGetter* request_context_getter,
+    AccountTrackerService* service,
+    const std::string& account_id)
+    : OAuth2TokenService::Consumer("gaia_account_tracker"),
+      token_service_(token_service),
+      request_context_getter_(request_context_getter),
+      service_(service),
+      account_id_(account_id) {
+  TRACE_EVENT_ASYNC_BEGIN1(
+      "AccountTrackerService", "AccountIdFetcher", this,
+      "account_id", account_id);
+}
+
+AccountInfoFetcher::~AccountInfoFetcher() {
+  TRACE_EVENT_ASYNC_END0("AccountTrackerService", "AccountIdFetcher", this);
+}
+
+void AccountInfoFetcher::Start() {
+  OAuth2TokenService::ScopeSet scopes;
+  scopes.insert(GaiaConstants::kGoogleUserInfoEmail);
+  scopes.insert(GaiaConstants::kGoogleUserInfoProfile);
+  login_token_request_ = token_service_->StartRequest(
+      account_id_, scopes, this);
+}
+
+void AccountInfoFetcher::OnGetTokenSuccess(
+    const OAuth2TokenService::Request* request,
+    const std::string& access_token,
+    const base::Time& expiration_time) {
+  TRACE_EVENT_ASYNC_STEP_PAST0(
+      "AccountTrackerService", "AccountIdFetcher", this, "OnGetTokenSuccess");
+  DCHECK_EQ(request, login_token_request_.get());
+
+  gaia_oauth_client_.reset(new gaia::GaiaOAuthClient(request_context_getter_));
+
+  const int kMaxRetries = 3;
+  gaia_oauth_client_->GetUserInfo(access_token, kMaxRetries, this);
+}
+
+void AccountInfoFetcher::OnGetTokenFailure(
+    const OAuth2TokenService::Request* request,
+    const GoogleServiceAuthError& error) {
+  TRACE_EVENT_ASYNC_STEP_PAST1("AccountTrackerService",
+                               "AccountIdFetcher",
+                               this,
+                               "OnGetTokenFailure",
+                               "google_service_auth_error",
+                               error.ToString());
+  LOG(ERROR) << "OnGetTokenFailure: " << error.ToString();
+  DCHECK_EQ(request, login_token_request_.get());
+  service_->OnUserInfoFetchFailure(this);
+}
+
+void AccountInfoFetcher::OnGetUserInfoResponse(
+    scoped_ptr<base::DictionaryValue> user_info) {
+  TRACE_EVENT_ASYNC_STEP_PAST1("AccountTrackerService",
+                               "AccountIdFetcher",
+                               this,
+                               "OnGetUserInfoResponse",
+                               "account_id",
+                               account_id_);
+  service_->OnUserInfoFetchSuccess(this, user_info.get());
+}
+
+void AccountInfoFetcher::OnOAuthError() {
+  TRACE_EVENT_ASYNC_STEP_PAST0(
+      "AccountTrackerService", "AccountIdFetcher", this, "OnOAuthError");
+  LOG(ERROR) << "OnOAuthError";
+  service_->OnUserInfoFetchFailure(this);
+}
+
+void AccountInfoFetcher::OnNetworkError(int response_code) {
+  TRACE_EVENT_ASYNC_STEP_PAST1("AccountTrackerService",
+                               "AccountIdFetcher",
+                               this,
+                               "OnNetworkError",
+                               "response_code",
+                               response_code);
+  LOG(ERROR) << "OnNetworkError " << response_code;
+  service_->OnUserInfoFetchFailure(this);
+}
+
+
+const char AccountTrackerService::kAccountInfoPref[] = "account_info";
+
+AccountTrackerService::AccountTrackerService()
+    : token_service_(NULL),
+      pref_service_(NULL),
+      shutdown_called_(false) {
+}
+
+AccountTrackerService::~AccountTrackerService() {
+  DCHECK(shutdown_called_);
+}
+
+void AccountTrackerService::Initialize(
+    OAuth2TokenService* token_service,
+    PrefService* pref_service,
+    net::URLRequestContextGetter* request_context_getter) {
+  DCHECK(token_service);
+  DCHECK(!token_service_);
+  DCHECK(pref_service);
+  DCHECK(!pref_service_);
+  token_service_ = token_service;
+  pref_service_ = pref_service;
+  request_context_getter_ = request_context_getter;
+  token_service_->AddObserver(this);
+  LoadFromPrefs();
+  LoadFromTokenService();
+}
+
+void AccountTrackerService::Shutdown() {
+  shutdown_called_ = true;
+  STLDeleteValues(&user_info_requests_);
+  token_service_->RemoveObserver(this);
+}
+
+void AccountTrackerService::AddObserver(Observer* observer) {
+  observer_list_.AddObserver(observer);
+}
+
+void AccountTrackerService::RemoveObserver(Observer* observer) {
+  observer_list_.RemoveObserver(observer);
+}
+
+bool AccountTrackerService::IsAllUserInfoFetched() const {
+  return user_info_requests_.empty();
+}
+
+std::vector<AccountTrackerService::AccountInfo>
+AccountTrackerService::GetAccounts() const {
+  std::vector<AccountInfo> accounts;
+
+  for (std::map<std::string, AccountState>::const_iterator it =
+           accounts_.begin();
+       it != accounts_.end();
+       ++it) {
+    const AccountState& state = it->second;
+    accounts.push_back(state.info);
+  }
+  return accounts;
+}
+
+AccountTrackerService::AccountInfo AccountTrackerService::GetAccountInfo(
+    const std::string& account_id) {
+  if (ContainsKey(accounts_, account_id))
+    return accounts_[account_id].info;
+
+  return AccountInfo();
+}
+
+AccountTrackerService::AccountInfo
+AccountTrackerService::FindAccountInfoByGaiaId(
+    const std::string& gaia_id) {
+  for (std::map<std::string, AccountState>::const_iterator it =
+           accounts_.begin();
+       it != accounts_.end();
+       ++it) {
+    const AccountState& state = it->second;
+    if (state.info.gaia == gaia_id) {
+      return state.info;

[guohui, 2014/08/20 18:05:23]

nits: no need for {}

[Roger Tawa OOO till Jul 10th, 2014/08/21 01:30:17]

Done.

+    }
+  }
+
+  return AccountInfo();
+}
+
+AccountTrackerService::AccountInfo
+AccountTrackerService::FindAccountInfoByEmail(
+    const std::string& email) {
+  for (std::map<std::string, AccountState>::const_iterator it =
+           accounts_.begin();
+       it != accounts_.end();
+       ++it) {
+    const AccountState& state = it->second;
+    if (gaia::AreEmailsSame(state.info.email, email)) {
+      return state.info;

[guohui, 2014/08/20 18:05:23]

nits: no need for {}

[Roger Tawa OOO till Jul 10th, 2014/08/21 01:30:16]

Done.

+    }
+  }
+
+  return AccountInfo();
+}
+
+void AccountTrackerService::OnRefreshTokenAvailable(
+    const std::string& account_id) {
+  TRACE_EVENT1("AccountTrackerService",
+               "AccountTracker::OnRefreshTokenAvailable",
+               "account_id",
+               account_id);
+  DVLOG(1) << "AVAILABLE " << account_id;
+
+  StartTrackingAccount(account_id);
+  AccountState& state = accounts_[account_id];
+
+  if (state.info.gaia.empty()) {
+    StartFetchingUserInfo(account_id);
+  } else {
+    NotifyAccountUpdated(state);

[guohui, 2014/08/20 18:05:23]

why do we notify account updated here? It seems here the account info is not
changed.

[Roger Tawa OOO till Jul 10th, 2014/08/21 01:30:16]

Oops, correct.  That's a left over from when the code was sending notifications
when the sign in state of an account changed.

+  }
+}
+
+void AccountTrackerService::OnRefreshTokenRevoked(
+    const std::string& account_id) {
+  TRACE_EVENT1("AccountTrackerService",
+               "AccountTracker::OnRefreshTokenRevoked",
+               "account_id",
+               account_id);
+
+  DVLOG(1) << "REVOKED " << account_id;
+  StopTrackingAccount(account_id);
+}
+
+void AccountTrackerService::NotifyAccountUpdated(const AccountState& state) {
+  DCHECK(!state.info.gaia.empty());
+  FOR_EACH_OBSERVER(
+      Observer, observer_list_, OnAccountUpdated(state.info));
+}
+
+void AccountTrackerService::NotifyAccountRemoved(const AccountState& state) {
+  DCHECK(!state.info.gaia.empty());
+  FOR_EACH_OBSERVER(
+      Observer, observer_list_, OnAccountRemoved(state.info));

[guohui, 2014/08/20 18:05:23]

what is the purpose of OnAccountRemoved? It is fired when refresh token is
revoked or when user info fetcher failed. The later may occur because of network
issues. Do we really want to remove an account for those transient issues?

[Roger Tawa OOO till Jul 10th, 2014/08/21 01:30:16]

Good point.  Should not remove if fetcher fails.  Will need to figure out
if/when to retry on failure.

+}
+
+void AccountTrackerService::StartTrackingAccount(
+    const std::string& account_id) {
+  if (!ContainsKey(accounts_, account_id)) {
+    DVLOG(1) << "StartTracking " << account_id;
+    AccountState state;
+    state.info.account_id = account_id;
+    accounts_.insert(make_pair(account_id, state));
+  }
+}
+
+void AccountTrackerService::StopTrackingAccount(const std::string& account_id) {
+  DVLOG(1) << "StopTracking " << account_id;
+  if (ContainsKey(accounts_, account_id)) {
+    AccountState& state = accounts_[account_id];
+    RemoveFromPrefs(state);
+    if (!state.info.gaia.empty())
+      NotifyAccountRemoved(state);
+
+    accounts_.erase(account_id);
+  }
+
+  if (ContainsKey(user_info_requests_, account_id))
+    DeleteFetcher(user_info_requests_[account_id]);
+}
+
+void AccountTrackerService::StartFetchingUserInfo(
+    const std::string& account_id) {
+  if (ContainsKey(user_info_requests_, account_id))
+    DeleteFetcher(user_info_requests_[account_id]);
+
+  DVLOG(1) << "StartFetching " << account_id;
+  AccountInfoFetcher* fetcher =
+      new AccountInfoFetcher(token_service_,
+                             request_context_getter_.get(),
+                             this,
+                             account_id);
+  user_info_requests_[account_id] = fetcher;
+  fetcher->Start();
+}
+
+void AccountTrackerService::OnUserInfoFetchSuccess(
+    AccountInfoFetcher* fetcher,
+    const base::DictionaryValue* user_info) {
+  const std::string& account_id = fetcher->account_id();
+  DCHECK(ContainsKey(accounts_, account_id));
+  AccountState& state = accounts_[account_id];
+
+  std::string gaia_id;
+  std::string email;
+  if (user_info->GetString("id", &gaia_id) &&
+      user_info->GetString("email", &email)) {
+    state.info.gaia = gaia_id;
+    state.info.email = email;
+
+    NotifyAccountUpdated(state);
+    SaveToPrefs(state);
+  }
+  DeleteFetcher(fetcher);
+}
+
+void AccountTrackerService::OnUserInfoFetchFailure(
+    AccountInfoFetcher* fetcher) {
+  LOG(WARNING) << "Failed to get UserInfo for " << fetcher->account_id();
+  std::string account_id = fetcher->account_id();
+  DeleteFetcher(fetcher);
+  StopTrackingAccount(account_id);
+}
+
+void AccountTrackerService::DeleteFetcher(AccountInfoFetcher* fetcher) {
+  DVLOG(1) << "DeleteFetcher " << fetcher->account_id();
+  const std::string& account_id = fetcher->account_id();
+  DCHECK(ContainsKey(user_info_requests_, account_id));
+  DCHECK_EQ(fetcher, user_info_requests_[account_id]);
+  user_info_requests_.erase(account_id);
+  delete fetcher;
+}
+
+void AccountTrackerService::LoadFromPrefs() {
+  const base::ListValue* list = pref_service_->GetList(kAccountInfoPref);
+  for (size_t i = 0; i < list->GetSize(); ++i) {
+    const base::DictionaryValue* dict;
+    if (list->GetDictionary(i, &dict)) {
+      base::string16 value;
+      if (dict->GetString(kAccountKeyPath, &value)) {
+        std::string account_id = base::UTF16ToUTF8(value);
+        StartTrackingAccount(account_id);
+        AccountState& state = accounts_[account_id];
+
+        if (dict->GetString(kAccountGaiaPath, &value))
+          state.info.gaia = base::UTF16ToUTF8(value);
+        if (dict->GetString(kAccountEmailPath, &value))
+          state.info.email = base::UTF16ToUTF8(value);

[guohui, 2014/08/20 18:05:23]

should we notify account updated here?

[Roger Tawa OOO till Jul 10th, 2014/08/21 01:30:16]

Yes, but only if gaiaid is not empty.

+      }
+    }
+  }
+}
+
+void AccountTrackerService::SaveToPrefs(const AccountState& state) {
+  if (!pref_service_)
+    return;
+
+  base::DictionaryValue* dict = NULL;
+  base::string16 account_id_16 = base::UTF8ToUTF16(state.info.account_id);
+  ListPrefUpdate update(pref_service_, kAccountInfoPref);
+  for(size_t i = 0; i < update->GetSize(); ++i, dict = NULL) {
+    if (update->GetDictionary(i, &dict)) {
+      base::string16 value;
+      if (dict->GetString(kAccountKeyPath, &value) && value == account_id_16)
+        break;
+    }
+  }
+
+  if (!dict) {
+    dict = new base::DictionaryValue();
+    update->Append(dict);  // |update| takes ownership.
+    dict->SetString(kAccountKeyPath, account_id_16);
+  }
+
+  dict->SetString(kAccountEmailPath, state.info.email);
+  dict->SetString(kAccountGaiaPath, state.info.gaia);
+}
+
+void AccountTrackerService::RemoveFromPrefs(const AccountState& state) {
+  if (!pref_service_)
+    return;
+
+  base::string16 account_id_16 = base::UTF8ToUTF16(state.info.account_id);
+  ListPrefUpdate update(pref_service_, kAccountInfoPref);
+  for(size_t i = 0; i < update->GetSize(); ++i) {
+    base::DictionaryValue* dict = NULL;
+    if (update->GetDictionary(i, &dict)) {
+      base::string16 value;
+      if (dict->GetString(kAccountKeyPath, &value) && value == account_id_16) {
+        update->Remove(i, NULL);
+        break;
+      }
+    }
+  }
+}
+
+void AccountTrackerService::LoadFromTokenService() {
+  std::vector<std::string> accounts = token_service_->GetAccounts();
+  for (std::vector<std::string>::const_iterator it = accounts.begin();
+       it != accounts.end(); ++it) {
+    OnRefreshTokenAvailable(*it);
+  }
+}