Introduce the ThrottleManager

components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.cc

Index: components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.cc
diff --git a/components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.cc b/components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.cc
new file mode 100644
index 0000000000000000000000000000000000000000..9a2a6802d5f190ad4c0c35ab3b50d2e9f8089428
--- /dev/null
+++ b/components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.cc
@@ -0,0 +1,196 @@
+// Copyright 2017 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.
+
+#include "components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.h"
+
+#include "base/bind.h"
+#include "base/logging.h"
+#include "base/memory/ptr_util.h"
+#include "components/subresource_filter/content/browser/activation_state_computing_navigation_throttle.h"
+#include "components/subresource_filter/content/browser/async_document_subresource_filter.h"
+#include "components/subresource_filter/content/browser/subframe_navigation_filtering_throttle.h"
+#include "content/public/browser/navigation_handle.h"
+#include "content/public/browser/render_frame_host.h"
+#include "content/public/browser/web_contents.h"
+#include "net/base/net_errors.h"
+
+namespace subresource_filter {
+
+bool ContentSubresourceFilterThrottleManager::Delegate::
+    ShouldSuppressActivation(content::NavigationHandle* navigation_handle) {
+  return false;
+}
+
+ContentSubresourceFilterThrottleManager::
+    ContentSubresourceFilterThrottleManager(
+        Delegate* delegate,
+        VerifiedRulesetDealer::Handle* dealer_handle,
+        content::WebContents* web_contents)
+    : content::WebContentsObserver(web_contents),
+      dealer_handle_(dealer_handle),
+      delegate_(delegate),
+      weak_ptr_factory_(this) {}
+
+ContentSubresourceFilterThrottleManager::
+    ~ContentSubresourceFilterThrottleManager() {}
+
+void ContentSubresourceFilterThrottleManager::NotifyPageActivationComputed(
+    content::NavigationHandle* navigation_handle,
+    const ActivationState& activation_state) {
+  DCHECK(navigation_handle->IsInMainFrame());
+  DCHECK(!navigation_handle->HasCommitted());
+  auto it = ongoing_activation_throttles_.find(navigation_handle);
+  if (it != ongoing_activation_throttles_.end()) {
+    it->second->NotifyPageActivationWithRuleset(EnsureRulesetHandle(),
+                                                activation_state);
+  }
+}
+
+void ContentSubresourceFilterThrottleManager::RenderFrameDeleted(
+    content::RenderFrameHost* frame_host) {
+  activated_frame_hosts_.erase(frame_host);
+  DestroyRulesetHandleIfNoLongerUsed();
+}
+
+// Pull the AsyncDocumentSubresourceFilter and its associated ActivationState
+// out of the activation state computing throttle. Store it for later filtering
+// of subframe navigations.
+void ContentSubresourceFilterThrottleManager::ReadyToCommitNavigation(
+    content::NavigationHandle* navigation_handle) {
+  auto throttle = ongoing_activation_throttles_.find(navigation_handle);
+  if (throttle == ongoing_activation_throttles_.end())
+    return;
+
+  // Some browser-initiated navigations (like about:blank) do not go through
+  // WillProcessResponse, and won't receive valid filters or activation states.
+  AsyncDocumentSubresourceFilter* filter = throttle->second->filter();
+  if (!filter || navigation_handle->GetNetErrorCode() != net::OK ||

[engedy, 2017/03/20 18:58:14]

nit: Can |filter| really be false for the reason above?  I would have imagined
that no throttles are created for these special navigations when no throttles
are consulted. So the only reason for a non-existent filter would be no
page-level activation or failed/cancelled navigation.

[Charlie Harrison, 2017/03/20 20:02:56]

I can't reproduce this now, as NavigationSimulator is not robust to synchronous
navigations. I am pretty sure I needed this when I was using the test navigation
handle methods. It is possible that this was not accurate of real world code
paths.

However, since we now use filter existence as a proxy for some flavor of enabled
ActivationState, we don't need the comment anymore. 

+      delegate_->ShouldSuppressActivation(navigation_handle)) {
+    return;
+  }
+
+  DCHECK_NE(ActivationLevel::DISABLED,
+            filter->activation_state().activation_level);
+
+  filter->set_first_disallowed_load_callback(base::Bind(

[engedy, 2017/03/20 18:58:14]

nit: Could we set this later once we have taken ownership of the filter?

[Charlie Harrison, 2017/03/20 20:02:56]

Done.

+      &ContentSubresourceFilterThrottleManager::MaybeCallFirstDisallowedLoad,
+      weak_ptr_factory_.GetWeakPtr()));
+  throttle->second->WillSendActivationToRenderer();
+  // TODO(csharrison): Send an IPC to the renderer.
+}
+
+void ContentSubresourceFilterThrottleManager::DidFinishNavigation(
+    content::NavigationHandle* navigation_handle) {
+  // Do nothing if the navigation finished in the same document. Just make sure
+  // to not leak throttle pointers.
+  if (!navigation_handle->HasCommitted() ||
+      navigation_handle->IsSameDocument()) {
+    ongoing_activation_throttles_.erase(navigation_handle);
+    return;
+  }
+
+  auto throttle = ongoing_activation_throttles_.find(navigation_handle);
+  std::unique_ptr<AsyncDocumentSubresourceFilter> filter;
+  if (throttle != ongoing_activation_throttles_.end()) {
+    filter = throttle->second->ReleaseFilter();
+    ongoing_activation_throttles_.erase(throttle);
+  }
+
+  // Make sure |activated_frame_hosts_| is updated or cleaned up depending on
+  // this navigation's activation state.
+  content::RenderFrameHost* frame_host =
+      navigation_handle->GetRenderFrameHost();
+  if (filter) {
+    activated_frame_hosts_[frame_host] = std::move(filter);
+  } else {
+    activated_frame_hosts_.erase(frame_host);
+  }
+
+  if (navigation_handle->IsInMainFrame())
+    current_committed_load_has_notified_disallowed_load_ = false;
+  DestroyRulesetHandleIfNoLongerUsed();
+}
+
+void ContentSubresourceFilterThrottleManager::MaybeAppendNavigationThrottles(
+    content::NavigationHandle* navigation_handle,
+    std::vector<std::unique_ptr<content::NavigationThrottle>>* throttles) {
+  DCHECK(!navigation_handle->IsSameDocument());
+  if (auto filtering_throttle =
+          MaybeCreateSubframeNavigationFilteringThrottle(navigation_handle)) {
+    throttles->push_back(std::move(filtering_throttle));
+  }
+  if (auto activation_throttle =
+          MaybeCreateActivationStateComputingThrottle(navigation_handle)) {
+    ongoing_activation_throttles_[navigation_handle] =
+        activation_throttle.get();
+    throttles->push_back(std::move(activation_throttle));
+  }
+}
+
+std::unique_ptr<SubframeNavigationFilteringThrottle>
+ContentSubresourceFilterThrottleManager::
+    MaybeCreateSubframeNavigationFilteringThrottle(
+        content::NavigationHandle* navigation_handle) {
+  if (navigation_handle->IsInMainFrame())
+    return nullptr;
+  AsyncDocumentSubresourceFilter* parent_filter =
+      GetParentFrameFilter(navigation_handle);
+  return parent_filter ? base::MakeUnique<SubframeNavigationFilteringThrottle>(
+                             navigation_handle, parent_filter)
+                       : nullptr;
+}
+
+std::unique_ptr<ActivationStateComputingNavigationThrottle>
+ContentSubresourceFilterThrottleManager::
+    MaybeCreateActivationStateComputingThrottle(
+        content::NavigationHandle* navigation_handle) {
+  // Main frames: create unconditionally.
+  if (navigation_handle->IsInMainFrame()) {
+    return ActivationStateComputingNavigationThrottle::CreateForMainFrame(
+        navigation_handle);
+  }
+
+  // Subframes: create only for frames with activated parents.
+  AsyncDocumentSubresourceFilter* parent_filter =
+      GetParentFrameFilter(navigation_handle);
+  if (!parent_filter)
+    return nullptr;
+  DCHECK(ruleset_handle_);
+  return ActivationStateComputingNavigationThrottle::CreateForSubframe(
+      navigation_handle, ruleset_handle_.get(),
+      parent_filter->activation_state());
+}
+
+AsyncDocumentSubresourceFilter*
+ContentSubresourceFilterThrottleManager::GetParentFrameFilter(
+    content::NavigationHandle* child_frame_navigation) {
+  DCHECK(!child_frame_navigation->IsInMainFrame());
+  content::RenderFrameHost* parent = web_contents()->FindFrameByFrameTreeNodeId(
+      child_frame_navigation->GetParentFrameTreeNodeId());
+  DCHECK(parent);
+  auto it = activated_frame_hosts_.find(parent);
+  return it == activated_frame_hosts_.end() ? nullptr : it->second.get();
+}
+
+void ContentSubresourceFilterThrottleManager::MaybeCallFirstDisallowedLoad() {
+  if (current_committed_load_has_notified_disallowed_load_)
+    return;
+  delegate_->OnFirstSubresourceLoadDisallowed();
+  current_committed_load_has_notified_disallowed_load_ = true;
+}
+
+VerifiedRuleset::Handle*
+ContentSubresourceFilterThrottleManager::EnsureRulesetHandle() {
+  if (!ruleset_handle_)
+    ruleset_handle_ = base::MakeUnique<VerifiedRuleset::Handle>(dealer_handle_);
+  return ruleset_handle_.get();
+}
+
+void ContentSubresourceFilterThrottleManager::
+    DestroyRulesetHandleIfNoLongerUsed() {
+  if (activated_frame_hosts_.size() == 0)

[engedy, 2017/03/20 18:58:14]

Can it happen that |activated_frame_hosts| is empty, yet there are
|ongoing_activation_throttles_| using the ruleset?

[Charlie Harrison, 2017/03/20 20:02:56]

This is pretty tricky. I think we're ok here but I'd prefer to code defensively,
so I am modifying this to not release the handle if there are activation
throttles.

My reasoning: The manager is per web-contents. For us to be using a ruleset in
the webcontents at all, the top level page must be activated. Thus, we can only
reach 0 activated_frame_hosts when the top frame goes away. In this case, we
shouldn't have any ongoing activation throttles.

However, I do not feel totally comfortable with this reasoning, especially with
calling this in RenderFrameDeleted(). It feels fragile to assume that navigation
handles will always be torn down before the top RenderFrameHost goes away. 

+    ruleset_handle_.reset();
+}
+
+}  // namespace subresource_filter