ios/chrome/browser/signin/gaia_auth_fetcher_ios_private.h

   1 // Copyright 2015 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 IOS_CHROME_BROWSER_SIGNIN_GAIA_AUTH_FETCHER_IOS_PRIVATE_H_
   6 #define IOS_CHROME_BROWSER_SIGNIN_GAIA_AUTH_FETCHER_IOS_PRIVATE_H_
   7
   8 #import <Webkit/Webkit.h>
   9
  10 #import "base/mac/scoped_nsobject.h"
  11 #include "base/macros.h"
  12 #include "ios/web/public/active_state_manager.h"
  13
  14 class GaiaAuthFetcherIOS;
  15 class GURL;
  16
  17 namespace web {
  18 class BrowserState;
  19 }
  20
  21 // Navigation delegate attached to a WKWebView used for URL fetches.
  22 @interface GaiaAuthFetcherNavigationDelegate : NSObject<WKNavigationDelegate>
  23 @end
  24
  25 // Bridge between the GaiaAuthFetcherIOS and the webview (and its navigation
  26 // delegate) used to actually do the network fetch.
  27 class GaiaAuthFetcherIOSBridge : web::ActiveStateManager::Observer {
  28  public:
  29   GaiaAuthFetcherIOSBridge(GaiaAuthFetcherIOS* fetcher,
  30                            web::BrowserState* browser_state);
  31   virtual ~GaiaAuthFetcherIOSBridge();
  32
  33   // Starts a network fetch.
  34   // * |url| is the URL to fetch.
  35   // * |headers| are the HTTP headers to add to the request.
  36   // * |body| is the HTTP body to add to the request. If not empty, the fetch
  37   //   will be a POST request.
  38   void Fetch(const GURL& url,
  39              const std::string& headers,
  40              const std::string& body);
  41
  42   // Cancels the current fetch.
  43   void Cancel();
  44
  45   // Informs the bridge of the success of the URL fetch.
  46   // * |data| is the body of the HTTP response.
  47   // URLFetchSuccess and URLFetchFailure are no-op if one of them was already
  48   // called.
  49   void URLFetchSuccess(const std::string& data);
  50
  51   // Informs the bridge of the failure of the URL fetch.
  52   // * |is_cancelled| whether the fetch failed because it was cancelled.
  53   // URLFetchSuccess and URLFetchFailure are no-op if one of them was already
  54   // called.
  55   void URLFetchFailure(bool is_cancelled);
  56
  57  private:
  58   friend class GaiaAuthFetcherIOSTest;
  59
  60   // A network request that needs to be fetched.
  61   struct Request {
  62     Request();
  63     Request(const GURL& url,
  64             const std::string& headers,
  65             const std::string& body);
  66     // Whether the request is pending (i.e. awaiting to be processed or
  67     // currently being processed).
  68     bool pending;
  69     // URL to fetch.
  70     GURL url;
  71     // HTTP headers to add to the request.
  72     std::string headers;
  73     // HTTP body to add to the request.
  74     std::string body;
  75   };
  76
  77   // Fetches the pending request if it exists.
  78   void FetchPendingRequest();
  79   // Finishes the pending request and cleans up its associated state. Returns
  80   // the URL of the request.
  81   GURL FinishPendingRequest();
  82
  83   // Returns the cached WKWebView if it exists, or creates one if necessary.
  84   // Can return nil if the browser state is not active.
  85   WKWebView* GetWKWebView();
  86   // Actually creates a WKWebView. Virtual for testing.
  87   virtual WKWebView* CreateWKWebView();
  88   // Stops any page loading in the WKWebView currently in use and releases it.
  89   void ResetWKWebView();
  90
  91   // ActiveStateManager::Observer implementation.
  92   void OnActive() override;
  93   void OnInactive() override;
  94
  95   // Browser state associated with the bridge, used to create WKWebViews.
  96   web::BrowserState* browser_state_;
  97   // Fetcher owning this bridge.
  98   GaiaAuthFetcherIOS* fetcher_;
  99   // Request currently processed by the bridge.
 100   Request request_;
 101   // Navigation delegate of |web_view_| that informs the bridge of relevant
 102   // navigation events.
 103   base::scoped_nsobject<GaiaAuthFetcherNavigationDelegate> navigation_delegate_;
 104   // Web view used to do the network requests.
 105   base::scoped_nsobject<WKWebView> web_view_;
 106
 107   DISALLOW_COPY_AND_ASSIGN(GaiaAuthFetcherIOSBridge);
 108 };
 109
 110 #endif  // IOS_CHROME_BROWSER_SIGNIN_GAIA_AUTH_FETCHER_IOS_PRIVATE_H_