chrome/browser/profiles/profile_downloader.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_PROFILES_PROFILE_DOWNLOADER_H_
   6 #define CHROME_BROWSER_PROFILES_PROFILE_DOWNLOADER_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/gtest_prod_util.h"
  12 #include "base/memory/scoped_ptr.h"
  13 #include "base/strings/string16.h"
  14 #include "chrome/browser/image_decoder.h"
  15 #include "components/signin/core/browser/account_tracker_service.h"
  16 #include "google_apis/gaia/oauth2_token_service.h"
  17 #include "net/url_request/url_fetcher_delegate.h"
  18 #include "third_party/skia/include/core/SkBitmap.h"
  19 #include "url/gurl.h"
  20
  21 class ProfileDownloaderDelegate;
  22 class OAuth2AccessTokenFetcher;
  23
  24 namespace net {
  25 class URLFetcher;
  26 }  // namespace net
  27
  28 // Downloads user profile information. The profile picture is decoded in a
  29 // sandboxed process.
  30 class ProfileDownloader : public net::URLFetcherDelegate,
  31                           public ImageDecoder::ImageRequest,
  32                           public OAuth2TokenService::Observer,
  33                           public OAuth2TokenService::Consumer,
  34                           public AccountTrackerService::Observer {
  35  public:
  36   enum PictureStatus {
  37     PICTURE_SUCCESS,
  38     PICTURE_FAILED,
  39     PICTURE_DEFAULT,
  40     PICTURE_CACHED,
  41   };
  42
  43   explicit ProfileDownloader(ProfileDownloaderDelegate* delegate);
  44   ~ProfileDownloader() override;
  45
  46   // Starts downloading profile information if the necessary authorization token
  47   // is ready. If not, subscribes to token service and starts fetching if the
  48   // token is available. Should not be called more than once.
  49   virtual void Start();
  50
  51   // Starts downloading profile information if the necessary authorization token
  52   // is ready. If not, subscribes to token service and starts fetching if the
  53   // token is available. Should not be called more than once.
  54   virtual void StartForAccount(const std::string& account_id);
  55
  56   // On successful download this returns the hosted domain of the user.
  57   virtual base::string16 GetProfileHostedDomain() const;
  58
  59   // On successful download this returns the full name of the user. For example
  60   // "Pat Smith".
  61   virtual base::string16 GetProfileFullName() const;
  62
  63   // On successful download this returns the given name of the user. For example
  64   // if the name is "Pat Smith", the given name is "Pat".
  65   virtual base::string16 GetProfileGivenName() const;
  66
  67   // On successful download this returns G+ locale preference of the user.
  68   virtual std::string GetProfileLocale() const;
  69
  70   // On successful download this returns the profile picture of the user.
  71   // For users with no profile picture set (that is, they have the default
  72   // profile picture) this will return an Null bitmap.
  73   virtual SkBitmap GetProfilePicture() const;
  74
  75   // Gets the profile picture status.
  76   virtual PictureStatus GetProfilePictureStatus() const;
  77
  78   // Gets the URL for the profile picture. This can be cached so that the same
  79   // picture is not downloaded multiple times. This value should only be used
  80   // when the picture status is PICTURE_SUCCESS.
  81   virtual std::string GetProfilePictureURL() const;
  82
  83  private:
  84   friend class ProfileDownloaderTest;
  85   FRIEND_TEST_ALL_PREFIXES(ProfileDownloaderTest, AccountInfoReady);
  86   FRIEND_TEST_ALL_PREFIXES(ProfileDownloaderTest, AccountInfoNotReady);
  87   FRIEND_TEST_ALL_PREFIXES(ProfileDownloaderTest, DefaultURL);
  88
  89   void FetchImageData();
  90
  91   // Overriden from net::URLFetcherDelegate:
  92   void OnURLFetchComplete(const net::URLFetcher* source) override;
  93
  94   // Overriden from ImageDecoder::ImageRequest:
  95   void OnImageDecoded(const SkBitmap& decoded_image) override;
  96   void OnDecodeImageFailed() override;
  97
  98   // Overriden from OAuth2TokenService::Observer:
  99   void OnRefreshTokenAvailable(const std::string& account_id) override;
 100
 101   // Overriden from OAuth2TokenService::Consumer:
 102   void OnGetTokenSuccess(const OAuth2TokenService::Request* request,
 103                          const std::string& access_token,
 104                          const base::Time& expiration_time) override;
 105   void OnGetTokenFailure(const OAuth2TokenService::Request* request,
 106                          const GoogleServiceAuthError& error) override;
 107
 108
 109   // Implementation of AccountTrackerService::Observer.
 110   void OnAccountUpdated(
 111       const AccountTrackerService::AccountInfo& info) override;
 112
 113   // Returns true if the image url is url of the default profile picture.
 114   static bool IsDefaultProfileImageURL(const std::string& url);
 115
 116   // Issues the first request to get user profile image.
 117   void StartFetchingImage();
 118
 119   // Gets the authorization header.
 120   const char* GetAuthorizationHeader() const;
 121
 122   // Starts fetching OAuth2 access token. This is needed before the GAIA info
 123   // can be downloaded.
 124   void StartFetchingOAuth2AccessToken();
 125
 126   ProfileDownloaderDelegate* delegate_;
 127   std::string account_id_;
 128   std::string auth_token_;
 129   scoped_ptr<net::URLFetcher> profile_image_fetcher_;
 130   scoped_ptr<OAuth2TokenService::Request> oauth2_access_token_request_;
 131   AccountTrackerService::AccountInfo account_info_;
 132   SkBitmap profile_picture_;
 133   PictureStatus picture_status_;
 134   AccountTrackerService* account_tracker_service_;
 135   bool waiting_for_account_info_;
 136
 137   DISALLOW_COPY_AND_ASSIGN(ProfileDownloader);
 138 };
 139
 140 #endif  // CHROME_BROWSER_PROFILES_PROFILE_DOWNLOADER_H_