chrome/browser/net/net_error_tab_helper.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_NET_NET_ERROR_TAB_HELPER_H_
   6 #define CHROME_BROWSER_NET_NET_ERROR_TAB_HELPER_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/bind.h"
  10 #include "base/compiler_specific.h"
  11 #include "base/memory/weak_ptr.h"
  12 #include "base/prefs/pref_member.h"
  13 #include "chrome/browser/net/dns_probe_service.h"
  14 #include "chrome/common/net/net_error_info.h"
  15 #include "content/public/browser/web_contents_observer.h"
  16 #include "content/public/browser/web_contents_user_data.h"
  17
  18 namespace chrome_browser_net {
  19
  20 // A TabHelper that monitors loads for certain types of network errors and
  21 // does interesting things with them.  Currently, starts DNS probes using the
  22 // DnsProbeService whenever a page fails to load with a DNS-related error.
  23 class NetErrorTabHelper
  24     : public content::WebContentsObserver,
  25       public content::WebContentsUserData<NetErrorTabHelper> {
  26  public:
  27   enum TestingState {
  28     TESTING_DEFAULT,
  29     TESTING_FORCE_DISABLED,
  30     TESTING_FORCE_ENABLED
  31   };
  32
  33   typedef base::Callback<void(chrome_common_net::DnsProbeStatus)>
  34       DnsProbeStatusSnoopCallback;
  35
  36   virtual ~NetErrorTabHelper();
  37
  38   static void set_state_for_testing(TestingState testing_state);
  39
  40   // Sets a callback that will be called immediately after the helper sends
  41   // a NetErrorHelper IPC.  (Used by the DNS probe browser test to know when to
  42   // check the error page for updates, instead of polling.)
  43   void set_dns_probe_status_snoop_callback_for_testing(
  44       const DnsProbeStatusSnoopCallback& dns_probe_status_snoop_callback) {
  45     dns_probe_status_snoop_callback_ = dns_probe_status_snoop_callback;
  46   }
  47
  48   // content::WebContentsObserver implementation.
  49   virtual void DidStartProvisionalLoadForFrame(
  50       int64 frame_id,
  51       int64 parent_frame_id,
  52       bool is_main_frame,
  53       const GURL& validated_url,
  54       bool is_error_page,
  55       bool is_iframe_srcdoc,
  56       content::RenderViewHost* render_view_host) OVERRIDE;
  57
  58   virtual void DidCommitProvisionalLoadForFrame(
  59       int64 frame_id,
  60       const base::string16& frame_unique_name,
  61       bool is_main_frame,
  62       const GURL& url,
  63       content::PageTransition transition_type,
  64       content::RenderViewHost* render_view_host) OVERRIDE;
  65
  66   virtual void DidFailProvisionalLoad(
  67       int64 frame_id,
  68       const base::string16& frame_unique_name,
  69       bool is_main_frame,
  70       const GURL& validated_url,
  71       int error_code,
  72       const base::string16& error_description,
  73       content::RenderViewHost* render_view_host) OVERRIDE;
  74
  75  protected:
  76   // |contents| is the WebContents of the tab this NetErrorTabHelper is
  77   // attached to.
  78   explicit NetErrorTabHelper(content::WebContents* contents);
  79   virtual void StartDnsProbe();
  80   virtual void SendInfo();
  81   void OnDnsProbeFinished(chrome_common_net::DnsProbeStatus result);
  82
  83   chrome_common_net::DnsProbeStatus dns_probe_status() const {
  84     return dns_probe_status_;
  85   }
  86
  87  private:
  88   friend class content::WebContentsUserData<NetErrorTabHelper>;
  89
  90   void OnMainFrameDnsError();
  91
  92   void InitializePref(content::WebContents* contents);
  93   bool ProbesAllowed() const;
  94
  95   base::WeakPtrFactory<NetErrorTabHelper> weak_factory_;
  96
  97   // True if the last provisional load that started was for an error page.
  98   bool is_error_page_;
  99
 100   // True if the helper has seen a main frame page load fail with a DNS error,
 101   // but has not yet seen a new page commit successfully afterwards.
 102   bool dns_error_active_;
 103
 104   // True if the helper has seen an error page commit while |dns_error_active_|
 105   // is true.  (This should never be true if |dns_error_active_| is false.)
 106   bool dns_error_page_committed_;
 107
 108   // The status of a DNS probe that may or may not have started or finished.
 109   // Since the renderer can change out from under the helper (in cross-process
 110   // navigations), it re-sends the status whenever an error page commits.
 111   chrome_common_net::DnsProbeStatus dns_probe_status_;
 112
 113   // Optional callback for browser test to snoop on outgoing NetErrorInfo IPCs.
 114   DnsProbeStatusSnoopCallback dns_probe_status_snoop_callback_;
 115
 116   // "Use a web service to resolve navigation errors" preference is required
 117   // to allow probes.
 118   BooleanPrefMember resolve_errors_with_web_service_;
 119
 120   DISALLOW_COPY_AND_ASSIGN(NetErrorTabHelper);
 121 };
 122
 123 }  // namespace chrome_browser_net
 124
 125 #endif  // CHROME_BROWSER_NET_NET_ERROR_TAB_HELPER_H_