blob: 821d4ca4870d80cd9cd364eb2ee8c8cbc890be25 [file] [log] [blame]
// Copyright 2016 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 CHROME_BROWSER_SUBRESOURCE_FILTER_CHROME_SUBRESOURCE_FILTER_CLIENT_H_
#define CHROME_BROWSER_SUBRESOURCE_FILTER_CHROME_SUBRESOURCE_FILTER_CLIENT_H_
#include <memory>
#include <set>
#include <string>
#include <vector>
#include "base/macros.h"
#include "components/content_settings/core/common/content_settings.h"
#include "components/subresource_filter/content/browser/subresource_filter_client.h"
#include "content/public/browser/web_contents_user_data.h"
class GURL;
class SubresourceFilterContentSettingsManager;
namespace content {
class NavigationHandle;
class NavigationThrottle;
class WebContents;
} // namespace content
// This enum backs a histogram. Make sure new elements are only added to the
// end. Keep histograms.xml up to date with any changes.
enum SubresourceFilterAction {
// Main frame navigation to a different document.
kActionNavigationStarted = 0,
// Standard UI shown. On Desktop this is in the omnibox,
// On Android, it is an infobar.
kActionUIShown,
// On Desktop, this is a bubble. On Android it is an
// expanded infobar.
kActionDetailsShown,
kActionClickedLearnMore,
// Content settings:
//
// Blocked => The subresource filter will block resources.
// Allowed => The subresource filter will not block resources.
//
// Content setting updated automatically via the standard UI.
kActionContentSettingsAllowedFromUI,
// Content settings which target specific origins (e.g. no wildcards). These
// updates do not include updates from the main UI.
kActionContentSettingsBlocked,
kActionContentSettingsAllowed,
// Global settings.
kActionContentSettingsBlockedGlobal,
kActionContentSettingsAllowedGlobal,
// A wildcard update. The current content settings API makes this a bit
// difficult to see whether it is Block or Allow. This should not be a huge
// problem because this can only be changed from the settings UI, which is
// relatively rare. See crbug.com/706061.
//
// DEPRECATED: The site settings page uses read-only-lists for exceptions, so
// users can't add arbitrary patterns.
kActionContentSettingsWildcardUpdate,
// The UI was suppressed due to "smart" logic which tries not to spam the UI
// on navigations on the same origin within a certain time.
kActionUISuppressed,
// Subresources were explicitly allowed via manual content setting changes
// while smart UI was suppressing the UI. Potentially indicates that the smart
// UI is too aggressive if this happens frequently. This is reported
// alongside kActionContentSettingsAllowed if the UI is currently in
// suppressed mode.
kActionContentSettingsAllowedWhileUISuppressed,
// Logged when a devtools message arrives notifying us to force activation in
// this web contents.
kActionForcedActivationEnabled,
// Logged when we are forcing activation (e.g. via devtools) and resources
// have been blocked. Note that in these cases the UI is suppressed.
kActionForcedActivationNoUIResourceBlocked,
// Logged when a popup is blocked due to subresource filter logic.
kActionPopupBlocked,
kActionLastEntry
};
// Chrome implementation of SubresourceFilterClient.
// TODO(csharrison): Make this a WebContentsObserver and own the throttle
// manager directly.
class ChromeSubresourceFilterClient
: public content::WebContentsUserData<ChromeSubresourceFilterClient>,
public subresource_filter::SubresourceFilterClient {
public:
explicit ChromeSubresourceFilterClient(content::WebContents* web_contents);
~ChromeSubresourceFilterClient() override;
void MaybeAppendNavigationThrottles(
content::NavigationHandle* navigation_handle,
std::vector<std::unique_ptr<content::NavigationThrottle>>* throttles);
void OnReloadRequested();
// SubresourceFilterClient:
void ToggleNotificationVisibility(bool visibility) override;
bool OnPageActivationComputed(content::NavigationHandle* navigation_handle,
bool activated) override;
void WhitelistInCurrentWebContents(const GURL& url) override;
subresource_filter::VerifiedRulesetDealer::Handle* GetRulesetDealer()
override;
bool ForceActivationInCurrentWebContents() override;
// Should be called by devtools in response to a protocol command to enable ad
// blocking in this WebContents. Should only persist while devtools is
// attached.
void ToggleForceActivationInCurrentWebContents(bool force_activation);
bool did_show_ui_for_navigation() const {
return did_show_ui_for_navigation_;
}
static void LogAction(SubresourceFilterAction action);
private:
void WhitelistByContentSettings(const GURL& url);
void ShowUI(const GURL& url);
std::set<std::string> whitelisted_hosts_;
// Owned by the profile.
SubresourceFilterContentSettingsManager* settings_manager_ = nullptr;
content::WebContents* web_contents_ = nullptr;
bool did_show_ui_for_navigation_ = false;
// Corresponds to a devtools command which triggers filtering on all page
// loads. We must be careful to ensure this boolean does not persist after the
// devtools window is closed, which should be handled by the devtools system.
bool activated_via_devtools_ = false;
DISALLOW_COPY_AND_ASSIGN(ChromeSubresourceFilterClient);
};
#endif // CHROME_BROWSER_SUBRESOURCE_FILTER_CHROME_SUBRESOURCE_FILTER_CLIENT_H_