Componentize SafeBrowsingBlockingPage for WebView use

components/safe_browsing/base_safe_browsing_blocking_page.h

+// Copyright 2017 The Chromium Authors. All rights reserved.

[meacer, 2017/01/10 21:18:21]

nit: I wonder if this class could be renamed to SafeBrowsingBlockingPage and its
Chrome implementation could be ChromeSafeBrowsingBlockingPage? That way, the
WebView implementation would be AwSafeBrowsingBlockingPage. That seems more
consistent with the rest of the codebase.

Same goes for BaseSafeBrowsingUIManager.

[Jialiu Lin, 2017/01/11 00:50:06]

Since it is already in the safe_browsing namespace, I'll rename this class to
BaseBlockingPage and BaseSafeBrowsingUIManager to BaseUIManager. 

[Jialiu Lin, 2017/01/11 00:50:06]

Renamed to BaseBlockingPage and BaseUIManager accordingly. Thanks!

+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+//
+// Base class for managing the SafeBrowsing interstitial pages.
+#ifndef COMPONENTS_SAFE_BROWSING_BASE_SAFE_BROWSING_BLOCKING_PAGE_H_
+#define COMPONENTS_SAFE_BROWSING_BASE_SAFE_BROWSING_BLOCKING_PAGE_H_
+
+#include <map>
+#include <string>
+#include <vector>
+
+#include "base/macros.h"
+#include "components/safe_browsing/base_ui_manager.h"
+#include "components/security_interstitials/content/security_interstitial_page.h"
+#include "components/security_interstitials/core/safe_browsing_error_ui.h"
+#include "content/public/browser/interstitial_page_delegate.h"
+#include "url/gurl.h"
+
+namespace history {
+class HistoryService;
+}
+
+namespace safe_browsing {
+
+class BaseSafeBrowsingBlockingPage

[vakh (use Gerrit instead), 2017/01/10 20:44:26]

Since this is already in the safe_browsing namespace and in
components/safe_browsing, we can drop SafeBrowsing from the name. That would
also make it consistent with the other class names in
components/safe_browsing_db.

[meacer, 2017/01/10 21:18:21]

nit: Documentation

[Jialiu Lin, 2017/01/11 00:50:06]

Done.

+    : public security_interstitials::SecurityInterstitialPage {
+ public:
+  typedef security_interstitials::UnsafeResource UnsafeResource;
+  typedef security_interstitials::SafeBrowsingErrorUI SafeBrowsingErrorUI;
+  typedef std::vector<UnsafeResource> UnsafeResourceList;
+  typedef std::map<content::WebContents*, UnsafeResourceList> UnsafeResourceMap;

[vakh (use Gerrit instead), 2017/01/10 20:44:26]

Do we need the map to be sorted? If not, we can use std::unordered_set

[Jialiu Lin, 2017/01/11 00:50:06]

Done.

+
+  ~BaseSafeBrowsingBlockingPage() override;
+
+  // Creates a blocking page. Use ShowBlockingPage if you don't need to access
+  // the blocking page directly.
+  static BaseSafeBrowsingBlockingPage* CreateBlockingPage(
+      BaseSafeBrowsingUIManager* ui_manager,

[vakh (use Gerrit instead), 2017/01/10 20:44:26]

Ideally this should also have been called BaseUIManager but let's do that later.
The redundancy has no value.

[Jialiu Lin, 2017/01/11 00:50:06]

Sure, renamed BaseUIManager as well. 

+      content::WebContents* web_contents,
+      const GURL& main_frame_url,
+      const UnsafeResource& unsafe_resource);
+
+  // Shows a blocking page warning the user about phishing/malware for a
+  // specific resource.
+  // You can call this method several times, if an interstitial is already
+  // showing, the new one will be queued and displayed if the user decides
+  // to proceed on the currently showing interstitial.
+  static void ShowBlockingPage(BaseSafeBrowsingUIManager* ui_manager,
+                               const UnsafeResource& resource);
+
+  // Returns true if the passed |unsafe_resources| is blocking the load of
+  // the main page.
+  static bool IsMainPageLoadBlocked(const UnsafeResourceList& unsafe_resources);
+
+  // InterstitialPageDelegate method:
+  void OnProceed() override;
+  void OnDontProceed() override;
+  void CommandReceived(const std::string& command) override;
+
+ protected:
+  // Don't instantiate this class directly, use ShowBlockingPage instead.
+  BaseSafeBrowsingBlockingPage(
+      BaseSafeBrowsingUIManager* ui_manager,
+      content::WebContents* web_contents,
+      const GURL& main_frame_url,
+      const UnsafeResourceList& unsafe_resources,
+      std::unique_ptr<
+          security_interstitials::SecurityInterstitialControllerClient>
+          controller_client,
+      SafeBrowsingErrorUI::SBErrorDisplayOptions* display_options);
+
+  // SecurityInterstitialPage methods:
+  bool ShouldCreateNewNavigation() const override;
+  void PopulateInterstitialStrings(
+      base::DictionaryValue* load_time_data) override;
+
+  // Called when the interstitial is going away. Intentionally do nothing in
+  // this base class. Overrided by SafeBrowsingBlockingPage class.
+  virtual 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();
+
+  static std::string GetMetricPrefix(
+      const UnsafeResourceList& unsafe_resources,
+      SafeBrowsingErrorUI::SBInterstitialReason interstitial_reason);
+
+  static std::string GetExtraMetricsSuffix(
+      const UnsafeResourceList& unsafe_resources);
+
+  static SafeBrowsingErrorUI::SBInterstitialReason GetInterstitialReason(
+      const UnsafeResourceList& unsafe_resources);
+
+  // For reporting back user actions.
+  BaseSafeBrowsingUIManager* ui_manager_;
+
+  // For displaying safe browsing interstitial.
+  std::unique_ptr<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 entry should not be removed.
+  int navigation_entry_index_to_remove_;
+
+  // The list of unsafe resources this page is warning about.
+  UnsafeResourceList unsafe_resources_;
+
+  bool proceeded_;

[vakh (use Gerrit instead), 2017/01/10 20:44:27]

Please add a comment explaining the purpose.

[Jialiu Lin, 2017/01/11 00:50:06]

Done.

+
+  // Which type of Safe Browsing interstitial this is.
+  SafeBrowsingErrorUI::SBInterstitialReason interstitial_reason_;
+
+ private:
+  static std::unique_ptr<
+      security_interstitials::SecurityInterstitialControllerClient>
+  CreateControllerClient(content::WebContents* web_contents,
+                         const UnsafeResourceList& unsafe_resources,
+                         history::HistoryService* history_service,
+                         const std::string& app_locale,
+                         const GURL& default_safe_page);
+
+  static const SafeBrowsingErrorUI::SBErrorDisplayOptions
+  CreateDefaultDisplayOptions(const UnsafeResourceList& unsafe_resources);
+
+  DISALLOW_COPY_AND_ASSIGN(BaseSafeBrowsingBlockingPage);
+};
+
+}  // namespace safe_browsing
+
+#endif  // COMPONENTS_SAFE_BROWSING_BASE_SAFE_BROWSING_BLOCKING_PAGE_H_