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.
5 #ifndef CHROME_BROWSER_NET_NET_ERROR_TAB_HELPER_H_
6 #define CHROME_BROWSER_NET_NET_ERROR_TAB_HELPER_H_
8 #include "base/basictypes.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"
18 namespace chrome_browser_net {
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> {
29 TESTING_FORCE_DISABLED,
33 typedef base::Callback<void(chrome_common_net::DnsProbeStatus)>
34 DnsProbeStatusSnoopCallback;
36 virtual ~NetErrorTabHelper();
38 static void set_state_for_testing(TestingState testing_state);
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;
48 // content::WebContentsObserver implementation.
49 virtual void DidStartNavigationToPendingEntry(
51 content::NavigationController::ReloadType reload_type) OVERRIDE;
53 virtual void DidStartProvisionalLoadForFrame(
54 content::RenderFrameHost* render_frame_host,
55 const GURL& validated_url,
57 bool is_iframe_srcdoc) OVERRIDE;
59 virtual void DidCommitProvisionalLoadForFrame(
60 content::RenderFrameHost* render_frame_host,
62 content::PageTransition transition_type) OVERRIDE;
64 virtual void DidFailProvisionalLoad(
65 content::RenderFrameHost* render_frame_host,
66 const GURL& validated_url,
68 const base::string16& error_description) OVERRIDE;
71 // |contents| is the WebContents of the tab this NetErrorTabHelper is
73 explicit NetErrorTabHelper(content::WebContents* contents);
74 virtual void StartDnsProbe();
75 virtual void SendInfo();
76 void OnDnsProbeFinished(chrome_common_net::DnsProbeStatus result);
78 chrome_common_net::DnsProbeStatus dns_probe_status() const {
79 return dns_probe_status_;
83 friend class content::WebContentsUserData<NetErrorTabHelper>;
85 void OnMainFrameDnsError();
87 void InitializePref(content::WebContents* contents);
88 bool ProbesAllowed() const;
90 base::WeakPtrFactory<NetErrorTabHelper> weak_factory_;
92 // True if the last provisional load that started was for an error page.
95 // True if the helper has seen a main frame page load fail with a DNS error,
96 // but has not yet seen a new page commit successfully afterwards.
97 bool dns_error_active_;
99 // True if the helper has seen an error page commit while |dns_error_active_|
100 // is true. (This should never be true if |dns_error_active_| is false.)
101 bool dns_error_page_committed_;
103 // The status of a DNS probe that may or may not have started or finished.
104 // Since the renderer can change out from under the helper (in cross-process
105 // navigations), it re-sends the status whenever an error page commits.
106 chrome_common_net::DnsProbeStatus dns_probe_status_;
108 // Optional callback for browser test to snoop on outgoing NetErrorInfo IPCs.
109 DnsProbeStatusSnoopCallback dns_probe_status_snoop_callback_;
111 // "Use a web service to resolve navigation errors" preference is required
113 BooleanPrefMember resolve_errors_with_web_service_;
115 DISALLOW_COPY_AND_ASSIGN(NetErrorTabHelper);
118 } // namespace chrome_browser_net
120 #endif // CHROME_BROWSER_NET_NET_ERROR_TAB_HELPER_H_