Home | History | Annotate | Download | only in net
      1 // Copyright (c) 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_H_
      6 #define CHROME_RENDERER_NET_NET_ERROR_HELPER_H_
      7 
      8 #include <string>
      9 
     10 #include "chrome/common/net/net_error_info.h"
     11 #include "content/public/renderer/render_view_observer.h"
     12 #include "third_party/WebKit/public/platform/WebURLError.h"
     13 
     14 namespace base {
     15 class DictionaryValue;
     16 }
     17 
     18 namespace WebKit {
     19 class WebFrame;
     20 }
     21 
     22 // Listens for NetErrorInfo messages from the NetErrorTabHelper on the
     23 // browser side and updates the error page with more details (currently, just
     24 // DNS probe results) if/when available.
     25 class NetErrorHelper : public content::RenderViewObserver {
     26  public:
     27   explicit NetErrorHelper(content::RenderView* render_view);
     28   virtual ~NetErrorHelper();
     29 
     30   // RenderViewObserver implementation.
     31   virtual void DidStartProvisionalLoad(WebKit::WebFrame* frame) OVERRIDE;
     32   virtual void DidFailProvisionalLoad(
     33       WebKit::WebFrame* frame,
     34       const WebKit::WebURLError& error) OVERRIDE;
     35   virtual void DidCommitProvisionalLoad(
     36       WebKit::WebFrame* frame,
     37       bool is_new_navigation) OVERRIDE;
     38   virtual void DidFinishLoad(WebKit::WebFrame* frame) OVERRIDE;
     39 
     40   // IPC::Listener implementation.
     41   virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
     42 
     43   // Examines |frame| and |error| to see if this is an error worthy of a DNS
     44   // probe.  If it is, initializes |error_strings| based on |error|,
     45   // |is_failed_post|, and |locale| with suitable strings and returns true.
     46   // If not, returns false, in which case the caller should look up error
     47   // strings directly using LocalizedError::GetNavigationErrorStrings.
     48   static bool GetErrorStringsForDnsProbe(
     49       WebKit::WebFrame* frame,
     50       const WebKit::WebURLError& error,
     51       bool is_failed_post,
     52       const std::string& locale,
     53       base::DictionaryValue* error_strings);
     54 
     55  protected:
     56   // These methods handle tracking the actual state of the page; this allows
     57   // unit-testing of the state tracking without having to mock out WebFrames
     58   // and such.
     59   void OnStartLoad(bool is_main_frame, bool is_error_page);
     60   void OnFailLoad(bool is_main_frame, bool is_dns_error);
     61   void OnCommitLoad(bool is_main_frame);
     62   void OnFinishLoad(bool is_main_frame);
     63 
     64   void OnNetErrorInfo(int status);
     65 
     66   // |UpdateErrorPage| is virtual so it can be mocked out in the unittest.
     67   virtual void UpdateErrorPage();
     68 
     69   // The last DnsProbeStatus received from the browser.
     70   chrome_common_net::DnsProbeStatus last_probe_status_;
     71 
     72  private:
     73   WebKit::WebURLError GetUpdatedError() const;
     74 
     75   // Whether the last provisional load started was for an error page.
     76   bool last_start_was_error_page_;
     77 
     78   // Whether the last provisional load failure failed with a DNS error.
     79   bool last_fail_was_dns_error_;
     80 
     81   // Ideally, this would be simply "last_commit_was_dns_error_page_".
     82   //
     83   // Unfortunately, that breaks if two DNS errors occur in a row; after the
     84   // second failure, but before the second page commits, the helper can receive
     85   // probe results.  If all it knows is that the last commit was a DNS error
     86   // page, it will cheerfully forward the results for the second probe to the
     87   // first page.
     88   //
     89   // Thus, the semantics of this flag are a little weird.  It is set whenever
     90   // a DNS error page commits, and cleared whenever any other page commits,
     91   // but it is also cleared whenever a DNS error occurs, to prevent the race
     92   // described above.
     93   bool forwarding_probe_results_;
     94 
     95   // The last main frame error seen by the helper.
     96   WebKit::WebURLError last_error_;
     97 
     98   bool is_failed_post_;
     99 };
    100 
    101 #endif  // CHROME_RENDERER_NET_NET_ERROR_HELPER_H_
    102