Index: components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.h |
diff --git a/components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.h b/components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.h |
new file mode 100644 |
index 0000000000000000000000000000000000000000..26ac0ef9944f1398e7e8f545342d54c391342bc5 |
--- /dev/null |
+++ b/components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.h |
@@ -0,0 +1,133 @@ |
+// 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. |
+ |
+#ifndef COMPONENTS_SUBRESOURCE_FILTER_CONTENT_BROWSER_CONTENT_SUBRESOURCE_FILTER_THROTTLE_MANAGER_H_ |
+#define COMPONENTS_SUBRESOURCE_FILTER_CONTENT_BROWSER_CONTENT_SUBRESOURCE_FILTER_THROTTLE_MANAGER_H_ |
+ |
+#include <memory> |
+#include <unordered_map> |
+ |
+#include "base/macros.h" |
+#include "base/memory/weak_ptr.h" |
+#include "components/subresource_filter/content/browser/verified_ruleset_dealer.h" |
+#include "components/subresource_filter/core/common/activation_state.h" |
+#include "content/public/browser/web_contents_observer.h" |
+ |
+namespace content { |
+class NavigationHandle; |
+class NavigationThrottle; |
+class RenderFrameHost; |
+} // namespace content |
+ |
+namespace subresource_filter { |
+ |
+class AsyncDocumentSubresourceFilter; |
+class ActivationStateComputingNavigationThrottle; |
+ |
+// Simple struct which contains useful information regarding a frame's |
+// activation. This includes its DocumentSubresourceFilter, as well as its |
+// ActivationState. |
+struct FrameActivationInfo { |
engedy
2017/02/20 15:58:13
nit: Can the definition of this struct be moved to
Charlie Harrison
2017/03/01 00:02:58
Let me just move the ActivationState into ADSF in
|
+ FrameActivationInfo(); |
+ ~FrameActivationInfo(); |
+ std::unique_ptr<AsyncDocumentSubresourceFilter> subresource_filter; |
+ ActivationState activation_state; |
+}; |
+ |
+class ContentSubresourceFilterThrottleManager |
engedy
2017/02/20 15:58:13
nit: Let's describe what this is in a comment!
Charlie Harrison
2017/03/01 00:02:59
Done.
|
+ : public content::WebContentsObserver { |
+ public: |
+ // It is expected that the Delegate outlives |this|, and manages the lifetime |
+ // of this class. |
+ class Delegate { |
+ public: |
+ // The embedder may be interested in displaying UI to the user when the |
+ // first load is disallowed for a given page load. |
+ virtual void OnFirstSubresourceLoadDisallowed() {} |
+ |
+ // Let the delegate have the last word when it comes to activation. It might |
+ // have a specific whitelist. |
+ virtual bool ShouldVetoActivation( |
engedy
2017/02/20 15:58:13
nit: s/Veto/Suppress/, my understanding is that a
Charlie Harrison
2017/03/01 00:02:58
Done.
|
+ content::NavigationHandle* navigation_handle); |
+ }; |
+ |
+ ContentSubresourceFilterThrottleManager( |
+ Delegate* delegate, |
+ VerifiedRulesetDealer::Handle* dealer_handle, |
+ content::WebContents* web_contents); |
+ ~ContentSubresourceFilterThrottleManager() override; |
+ |
+ // Must be called during a navigation, before the corresponding throttle in |
engedy
2017/02/20 15:58:13
Let's make this interface less implementation-orie
Charlie Harrison
2017/03/01 00:02:58
Done.
|
+ // |ongoing_activation_throttles_| reaches WillProcessResponse. |
+ void NotifyPageActivationComputed( |
+ content::NavigationHandle* activated_navigation, |
engedy
2017/02/20 15:58:13
nit: s/activated_navigation/navigation/, it's not
Charlie Harrison
2017/03/01 00:02:56
I s/activated_navigation/navigation_handle/
|
+ const ActivationState& activation_state); |
+ |
+ // content::WebContentsObserver: |
engedy
2017/02/20 15:58:13
Could we make these protected?
Charlie Harrison
2017/03/01 00:02:58
Done.
|
+ void RenderFrameDeleted(content::RenderFrameHost* frame_host) override; |
+ void ReadyToCommitNavigation( |
+ content::NavigationHandle* navigation_handle) override; |
+ void DidFinishNavigation( |
+ content::NavigationHandle* navigation_handle) override; |
+ |
+ void MaybeAppendNavigationThrottles( |
engedy
2017/02/20 15:58:13
nit: Given this is the public API of this class, a
Charlie Harrison
2017/03/01 00:02:58
Done, I mentioned that in fact there are no orderi
engedy
2017/03/10 17:36:20
Sounds good.
|
+ content::NavigationHandle* navigation_handle, |
+ std::vector<std::unique_ptr<content::NavigationThrottle>>* throttles); |
+ |
+ private: |
+ std::unique_ptr<content::NavigationThrottle> |
+ MaybeCreateSubframeNavigationFilteringThrottle( |
+ content::NavigationHandle* navigation_handle); |
+ std::unique_ptr<content::NavigationThrottle> |
+ MaybeCreateActivationStateComputingThrottle( |
+ content::NavigationHandle* navigation_handle); |
+ |
+ FrameActivationInfo* GetFrameActivationInfoForChildNavigation( |
+ content::NavigationHandle* child_frame_navigation); |
+ |
+ // Calls OnFirstSubresourceLoadDisallowed on the Delegate at most once per |
+ // committed load. |
engedy
2017/02/20 15:58:13
nit: once per committed, non-same-page navigation
Charlie Harrison
2017/03/01 00:02:58
Done.
|
+ // TODO(csharrison): Ensure IPCs from the renderer go through this path when |
+ // they disallow subresource loads. |
+ void MaybeCallFirstDisallowedLoad(); |
+ |
+ VerifiedRuleset::Handle* EnsureRulesetHandle(); |
+ void DestroyRulesetHandleIfNecessary(); |
engedy
2017/02/20 15:58:13
nit: s/Necessary/NoLongerUsed/
Charlie Harrison
2017/03/01 00:02:58
Done.
|
+ |
+ // Map of all RenderFrameHosts that are currently activated, and their |
engedy
2017/02/20 15:58:13
Phrasing nit: For each RenderFrameHost where the l
Charlie Harrison
2017/03/01 00:02:58
Done.
|
+ // associated ActivationState and AsyncDocumentSubresourceFilters. |
+ std::unordered_map<content::RenderFrameHost*, |
+ std::unique_ptr<FrameActivationInfo>> |
+ activated_frame_hosts_; |
+ |
+ // For each ongoing navigation that requires activation state computation, |
+ // keeps track of the throttle that is carrying out that computation, so that |
+ // the result can be retrieved when the navigation is ready to commit. |
+ std::unordered_map<content::NavigationHandle*, |
+ ActivationStateComputingNavigationThrottle*> |
+ ongoing_activation_throttles_; |
+ |
+ // Lazily instantiated in EnsureRulesetHandle when the first page level |
+ // activation is triggered. Will go away when there are no more activated |
+ // RenderFrameHosts (i.e. activated_frame_hosts_ is empty). |
+ std::unique_ptr<VerifiedRuleset::Handle> ruleset_handle_; |
+ |
+ // True if the current committed main frame load in this WebContents has |
+ // notified the delegate that a subresource was disallowed. The callback |
+ // should only be called at most once per main frame load. |
+ bool current_committed_load_has_notified_disallowed_load_ = false; |
+ |
+ // These members outlive this class. |
+ VerifiedRulesetDealer::Handle* dealer_handle_; |
+ Delegate* delegate_; |
+ |
+ base::WeakPtrFactory<ContentSubresourceFilterThrottleManager> |
+ weak_ptr_factory_; |
+ |
+ DISALLOW_COPY_AND_ASSIGN(ContentSubresourceFilterThrottleManager); |
+}; |
+ |
+} // namespace subresource_filter |
+ |
+#endif // COMPONENTS_SUBRESOURCE_FILTER_CONTENT_BROWSER_CONTENT_SUBRESOURCE_FILTER_THROTTLE_MANAGER_H_ |