Componentizing SafeBrowsingBlockingPage Part 1

chrome/browser/safe_browsing/safe_browsing_blocking_page.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 //
 // Classes for managing the SafeBrowsing interstitial pages.
 //
 // When a user is about to visit a page the SafeBrowsing system has deemed to
 // be malicious, either as malware or a phishing page, we show an interstitial
 // page with some options (go back, continue) to give the user a chance to avoid
 // the harmful page.
@@ skipping 22 matching lines @@
 #include <vector>
 
 #include <stdint.h>
 
 #include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/task/cancelable_task_tracker.h"
 #include "chrome/browser/interstitials/chrome_metrics_helper.h"
 #include "chrome/browser/interstitials/security_interstitial_page.h"
 #include "chrome/browser/safe_browsing/ui_manager.h"
+#include "components/security_interstitials/core/safe_browsing_error_ui.h"
 #include "content/public/browser/interstitial_page_delegate.h"
 #include "url/gurl.h"
 
 namespace safe_browsing {
 
 class SafeBrowsingBlockingPageFactory;
 class ThreatDetails;
 
 class SafeBrowsingBlockingPage : public SecurityInterstitialPage {
  public:
   typedef security_interstitials::UnsafeResource UnsafeResource;
+  typedef security_interstitials::SafeBrowsingErrorUI SafeBrowsingErrorUI;
   typedef std::vector<UnsafeResource> UnsafeResourceList;
   typedef std::map<content::WebContents*, UnsafeResourceList> UnsafeResourceMap;
 
   // Interstitial type, used in tests.
   static content::InterstitialPageDelegate::TypeID kTypeForTesting;
 
   ~SafeBrowsingBlockingPage() override;
 
   // Creates a blocking page. Use ShowBlockingPage if you don't need to access
   // the blocking page directly.
@@ skipping 21 matching lines @@
   void OnProceed() override;
   void OnDontProceed() override;
   void CommandReceived(const std::string& command) override;
   void OverrideRendererPrefs(content::RendererPreferences* prefs) override;
   content::InterstitialPageDelegate::TypeID GetTypeForTesting() const override;
 
   // Checks the threat type to decide if we should report ThreatDetails.
   static bool ShouldReportThreatDetails(SBThreatType threat_type);
 
  protected:
+  friend class SafeBrowsingBlockingPageFactoryImpl;
   friend class SafeBrowsingBlockingPageTest;
-  FRIEND_TEST_ALL_PREFIXES(SafeBrowsingBlockingPageTest,
-                           ProceedThenDontProceed);
-  FRIEND_TEST_ALL_PREFIXES(SafeBrowsingBlockingPageTest,
-                           MalwareReportsDisabled);
-  FRIEND_TEST_ALL_PREFIXES(SafeBrowsingBlockingPageTest,
-                           MalwareReportsToggling);
-  FRIEND_TEST_ALL_PREFIXES(SafeBrowsingBlockingPageTest,
-                           ExtendedReportingNotShownOnSecurePage);
+  FRIEND_TEST_ALL_PREFIXES(
+      SafeBrowsingBlockingPageTest,
+      ProceedThenDontProceed);
+  FRIEND_TEST_ALL_PREFIXES(
+      SafeBrowsingBlockingPageTest,
+      MalwareReportsDisabled);
+  FRIEND_TEST_ALL_PREFIXES(
+      SafeBrowsingBlockingPageTest,
+      MalwareReportsToggling);
+  FRIEND_TEST_ALL_PREFIXES(
+      SafeBrowsingBlockingPageTest,
+      ExtendedReportingNotShownOnSecurePage);
+  FRIEND_TEST_ALL_PREFIXES(
+      SafeBrowsingBlockingPageTest,
+      MalwareReportsTransitionDisabled);
   FRIEND_TEST_ALL_PREFIXES(
       SafeBrowsingBlockingPageTest,
       ExtendedReportingNotShownOnSecurePageWithSecureSubresource);
   FRIEND_TEST_ALL_PREFIXES(
       SafeBrowsingBlockingPageTest,
       ExtendedReportingNotShownOnSecurePageWithInsecureSubresource);
   FRIEND_TEST_ALL_PREFIXES(
       SafeBrowsingBlockingPageTest,
       ExtendedReportingOnInsecurePageWithSecureSubresource);
   FRIEND_TEST_ALL_PREFIXES(
@@ skipping 12 matching lines @@
   bool ShouldCreateNewNavigation() const override;
   void PopulateInterstitialStrings(
       base::DictionaryValue* load_time_data) override;
 
   // After a safe browsing interstitial where the user opted-in to the
   // report but clicked "proceed anyway", we delay the call to
   // ThreatDetails::FinishCollection() by this much time (in
   // milliseconds), in order to get data from the blocked resource itself.
   int64_t threat_details_proceed_delay_ms_;
 
-  FRIEND_TEST_ALL_PREFIXES(SafeBrowsingBlockingPageTest,
-                           MalwareReportsTransitionDisabled);
-
   // Checks if we should even show the threat details option. For example, we
   // don't show it in incognito mode.
   bool CanShowThreatDetailsOption();
 
   // Called when the insterstitial is going away. If there is a
   // pending threat details object, we look at the user's
   // preferences, and if the option to send threat details is
   // enabled, the report is scheduled to be sent on the |ui_manager_|.
   void FinishThreatDetails(int64_t delay_ms, bool did_proceed, int num_visits);
 
   // A list of SafeBrowsingUIManager::UnsafeResource for a tab that the user
   // should be warned about.  They are queued when displaying more than one
   // interstitial at a time.
   static UnsafeResourceMap* GetUnsafeResourcesMap();
 
   // Returns true if the passed |unsafe_resources| is blocking the load of
   // the main page.
   static bool IsMainPageLoadBlocked(
       const UnsafeResourceList& unsafe_resources);
 
-  friend class SafeBrowsingBlockingPageFactoryImpl;
-
   // For reporting back user actions.
   SafeBrowsingUIManager* ui_manager_;
 
-  // True if the interstitial is blocking the main page because it is on one
-  // of our lists.  False if a subresource is being blocked, or in the case of
-  // client-side detection where the interstitial is shown after page load
-  // finishes.
-  bool is_main_frame_load_blocked_;
+  // For displaying safe browsing interstitial.
+  std::unique_ptr<security_interstitials::SafeBrowsingErrorUI> sb_error_ui_;
 
   // The URL of the main frame that caused the warning.
   GURL main_frame_url_;
 
   // The index of a navigation entry that should be removed when DontProceed()
   // is invoked, -1 if not entry should be removed.
   int navigation_entry_index_to_remove_;
 
   // The list of unsafe resources this page is warning about.
   UnsafeResourceList unsafe_resources_;
 
   // A ThreatDetails object that we start generating when the
   // blocking page is shown. The object will be sent when the warning
   // is gone (if the user enables the feature).
   scoped_refptr<ThreatDetails> threat_details_;
 
   bool proceeded_;
 
   // Which type of Safe Browsing interstitial this is.
-  enum SBInterstitialReason {
-    SB_REASON_MALWARE,
-    SB_REASON_HARMFUL,
-    SB_REASON_PHISHING,
-  };
-  SBInterstitialReason interstitial_reason_;
+  SafeBrowsingErrorUI::SBInterstitialReason interstitial_reason_;
 
   // The factory used to instantiate SafeBrowsingBlockingPage objects.
   // Useful for tests, so they can provide their own implementation of
   // SafeBrowsingBlockingPage.
   static SafeBrowsingBlockingPageFactory* factory_;
 
  private:
-  // Fills the passed dictionary with the values to be passed to the template
-  // when creating the HTML.
-  void PopulateExtendedReportingOption(base::DictionaryValue* load_time_data);
-  void PopulateMalwareLoadTimeData(base::DictionaryValue* load_time_data);
-  void PopulateHarmfulLoadTimeData(base::DictionaryValue* load_time_data);
-  void PopulatePhishingLoadTimeData(base::DictionaryValue* load_time_data);
-
-  static std::string GetMetricPrefix(const UnsafeResourceList& unsafe_resources,
-                                     SBInterstitialReason interstitial_reason);
+  static std::string GetMetricPrefix(
+      const UnsafeResourceList& unsafe_resources,
+      SafeBrowsingErrorUI::SBInterstitialReason interstitial_reason);
   static std::string GetExtraMetricsSuffix(
       const UnsafeResourceList& unsafe_resources);
-  static std::string GetRapporPrefix(SBInterstitialReason interstitial_reason);
-  static std::string GetDeprecatedRapporPrefix(
-      SBInterstitialReason interstitial_reason);
   static std::string GetSamplingEventName(
-      SBInterstitialReason interstitial_reason);
+      SafeBrowsingErrorUI::SBInterstitialReason interstitial_reason);
 
-  static SBInterstitialReason GetInterstitialReason(
+  static SafeBrowsingErrorUI::SBInterstitialReason GetInterstitialReason(
       const UnsafeResourceList& unsafe_resources);
 
   static std::unique_ptr<ChromeMetricsHelper> CreateMetricsHelper(
       content::WebContents* web_contents,
       const UnsafeResourceList& unsafe_resources);
 
   DISALLOW_COPY_AND_ASSIGN(SafeBrowsingBlockingPage);
 };
 
 // Factory for creating SafeBrowsingBlockingPage.  Useful for tests.
 class SafeBrowsingBlockingPageFactory {
  public:
   virtual ~SafeBrowsingBlockingPageFactory() { }
 
   virtual SafeBrowsingBlockingPage* CreateSafeBrowsingPage(
       SafeBrowsingUIManager* ui_manager,
       content::WebContents* web_contents,
       const GURL& main_frame_url,
       const SafeBrowsingBlockingPage::UnsafeResourceList& unsafe_resources) = 0;
 };
 
 }  // namespace safe_browsing
 
 #endif  // CHROME_BROWSER_SAFE_BROWSING_SAFE_BROWSING_BLOCKING_PAGE_H_