chrome/renderer/net/net_error_helper_core.h

   1 // Copyright 2013 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_RENDERER_NET_NET_ERROR_HELPER_CORE_H_
   6 #define CHROME_RENDERER_NET_NET_ERROR_HELPER_CORE_H_
   7
   8 #include <string>
   9
  10 #include "base/memory/weak_ptr.h"
  11 #include "chrome/common/net/net_error_info.h"
  12 #include "url/gurl.h"
  13
  14 namespace blink {
  15 struct WebURLError;
  16 }
  17
  18 // Class that contains the logic for how the NetErrorHelper.  This allows for
  19 // testing the logic without a RenderView or WebFrame, which are difficult to
  20 // mock, and for testing races which are impossible to reliably reproduce
  21 // with real RenderViews or WebFrames.
  22 class NetErrorHelperCore {
  23  public:
  24   enum FrameType {
  25     MAIN_FRAME,
  26     SUB_FRAME,
  27   };
  28
  29   enum PageType {
  30     NON_ERROR_PAGE,
  31     ERROR_PAGE,
  32   };
  33
  34   // The Delegate handles all interaction with the RenderView, WebFrame, and
  35   // the network, as well as the generation of error pages.
  36   class Delegate {
  37    public:
  38     // Generates an error page's HTML for the given error.
  39     virtual void GenerateLocalizedErrorPage(const blink::WebURLError& error,
  40                                             bool is_failed_post,
  41                                             std::string* html) const = 0;
  42
  43     // Loads the given HTML in the main frame for use as an error page.
  44     virtual void LoadErrorPageInMainFrame(const std::string& html,
  45                                           const GURL& failed_url) = 0;
  46
  47     // Updates the currently displayed error page with a new error code.  The
  48     // currently displayed error page must have finished loading, and must have
  49     // been generated by a call to GenerateLocalizedErrorPage.
  50     virtual void UpdateErrorPage(const blink::WebURLError& error,
  51                                  bool is_failed_post) = 0;
  52
  53     // Fetches an error page and calls into OnErrorPageFetched when done.  Any
  54     // previous fetch must either be canceled or finished before calling.  Can't
  55     // be called synchronously after a previous fetch completes.
  56     virtual void FetchErrorPage(const GURL& url) = 0;
  57
  58     // Cancels an error page fetch.  Does nothing if no fetch is ongoing.
  59     virtual void CancelFetchErrorPage() = 0;
  60
  61    protected:
  62     virtual ~Delegate() {}
  63   };
  64
  65   explicit NetErrorHelperCore(Delegate* delegate);
  66   ~NetErrorHelperCore();
  67
  68   // Examines |frame| and |error| to see if this is an error worthy of a DNS
  69   // probe.  If it is, initializes |error_strings| based on |error|,
  70   // |is_failed_post|, and |locale| with suitable strings and returns true.
  71   // If not, returns false, in which case the caller should look up error
  72   // strings directly using LocalizedError::GetNavigationErrorStrings.
  73   //
  74   // Updates the NetErrorHelper with the assumption the page will be loaded
  75   // immediately.
  76   void GetErrorHTML(FrameType frame_type,
  77                     const blink::WebURLError& error,
  78                     bool is_failed_post,
  79                     std::string* error_html);
  80
  81   // These methods handle tracking the actual state of the page.
  82   void OnStartLoad(FrameType frame_type, PageType page_type);
  83   void OnCommitLoad(FrameType frame_type);
  84   void OnFinishLoad(FrameType frame_type);
  85   void OnStop();
  86
  87   // Called when an error page have has been retrieved over the network.  |html|
  88   // must be an empty string on error.
  89   void OnAlternateErrorPageFetched(const std::string& html);
  90
  91   // Notifies |this| that network error information from the browser process
  92   // has been received.
  93   void OnNetErrorInfo(chrome_common_net::DnsProbeStatus status);
  94
  95   void set_alt_error_page_url(const GURL& alt_error_page_url) {
  96     alt_error_page_url_ = alt_error_page_url;
  97   }
  98
  99  private:
 100   struct ErrorPageInfo;
 101
 102   // Updates the currently displayed error page with a new error based on the
 103   // most recently received DNS probe result.  The page must have finished
 104   // loading before this is called.
 105   void UpdateErrorPage();
 106
 107   void GenerateLocalErrorPage(
 108       FrameType frame_type,
 109       const blink::WebURLError& error,
 110       bool is_failed_post,
 111       std::string* error_html);
 112
 113   blink::WebURLError GetUpdatedError(const blink::WebURLError& error) const;
 114
 115   Delegate* delegate_;
 116
 117   // The last DnsProbeStatus received from the browser.
 118   chrome_common_net::DnsProbeStatus last_probe_status_;
 119
 120   // Information for the provisional / "pre-provisional" error page.  NULL when
 121   // there's no page pending, or the pending page is not an error page.
 122   scoped_ptr<ErrorPageInfo> pending_error_page_info_;
 123
 124   // Information for the committed error page.  NULL when the committed page is
 125   // not an error page.
 126   scoped_ptr<ErrorPageInfo> committed_error_page_info_;
 127
 128   GURL alt_error_page_url_;
 129 };
 130
 131 #endif  // CHROME_RENDERER_NET_NET_ERROR_HELPER_CORE_H_