blob: 3f705be5a06910524e2b8feb275cdee68036d1d4 [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 COMPONENTS_PREVIEWS_CORE_PREVIEWS_BLACK_LIST_H_
#define COMPONENTS_PREVIEWS_CORE_PREVIEWS_BLACK_LIST_H_
#include <stdint.h>
#include <map>
#include <memory>
#include <string>
#include <vector>
#include "base/callback.h"
#include "base/macros.h"
#include "base/optional.h"
#include "base/time/time.h"
#include "components/blacklist/opt_out_blacklist/opt_out_blacklist.h"
#include "components/blacklist/opt_out_blacklist/opt_out_blacklist_delegate.h"
#include "components/blacklist/opt_out_blacklist/opt_out_store.h"
#include "components/previews/core/previews_experiments.h"
class GURL;
namespace base {
class Clock;
}
namespace previews {
// Must remain synchronized with PreviewsEligibilityReason in enums.xml.
enum class PreviewsEligibilityReason {
// The preview navigation was allowed.
ALLOWED = 0,
// The black list was not initialized.
BLACKLIST_UNAVAILABLE = 1,
// The black list has not loaded from disk yet.
BLACKLIST_DATA_NOT_LOADED = 2,
// The user has opted out of a preview recently.
USER_RECENTLY_OPTED_OUT = 3,
// The user has opted out of previews often, and is no longer shown previews
// on any host.
USER_BLACKLISTED = 4,
// The user has opted out of previews on a specific host often, and was not
// not shown a previews on that host.
HOST_BLACKLISTED = 5,
// The network quality estimate is not available.
NETWORK_QUALITY_UNAVAILABLE = 6,
// The network was fast enough to not warrant previews.
NETWORK_NOT_SLOW = 7,
// If the page was reloaded, the user should not be shown a stale preview.
RELOAD_DISALLOWED = 8,
// The host is explicitly blacklisted by the server, so the user was not shown
// a preview.
HOST_BLACKLISTED_BY_SERVER = 9,
// The host is not whitelisted by the server for a preview decision that uses
// server optimization hints.
HOST_NOT_WHITELISTED_BY_SERVER = 10,
// The preview is allowed but without an expected check of server optimization
// hints because they are not enabled (features::kOptimizationHints).
ALLOWED_WITHOUT_OPTIMIZATION_HINTS = 11,
// The preview type chosen as the committed preview.
COMMITTED = 12,
// Previews blocked by a Cache-Control:no-transform directive.
CACHE_CONTROL_NO_TRANSFORM = 13,
// The network is faster than the max slow page triggering threshold for the
// session.
NETWORK_NOT_SLOW_FOR_SESSION = 14,
// Device is offline.
DEVICE_OFFLINE = 15,
LAST,
};
// Manages the state of black listed domains for the previews experiment. Loads
// the stored black list from |opt_out_store| and manages an in memory black
// list on the IO thread. Updates to the black list are stored in memory and
// pushed to the store. Asynchronous modifications are stored in a queue and
// executed in order. Reading from the black list is always synchronous, and if
// the black list is not currently loaded (e.g., at startup, after clearing
// browsing history), domains are reported as black listed. The list stores no
// more than previews::params::MaxInMemoryHostsInBlackList hosts in-memory,
// which defaults to 100.
class PreviewsBlackList : public blacklist::OptOutBlacklist {
public:
PreviewsBlackList(
std::unique_ptr<blacklist::OptOutStore> opt_out_store,
base::Clock* clock,
blacklist::OptOutBlacklistDelegate* blacklist_delegate,
blacklist::BlacklistData::AllowedTypesAndVersions allowed_types);
~PreviewsBlackList() override;
// Asynchronously adds a new navigation to to the in-memory black list and
// backing store. |opt_out| is whether the user opted out of the preview or
// navigated away from the page without opting out. |type| is only passed to
// the backing store. If the in memory map has reached the max number of hosts
// allowed, and |url| is a new host, a host will be evicted based on recency
// of the hosts most recent opt out. It returns the time used for recording
// the moment when the navigation is added for logging.
base::Time AddPreviewNavigation(const GURL& url,
bool opt_out,
PreviewsType type);
// Synchronously determines if |host_name| should be allowed to show previews.
// Returns the reason the blacklist disallowed the preview, or
// PreviewsEligibilityReason::ALLOWED if the preview is allowed. Record
// checked reasons in |passed_reasons|. Virtualized in testing.
virtual PreviewsEligibilityReason IsLoadedAndAllowed(
const GURL& url,
PreviewsType type,
bool ignore_long_term_black_list_rules,
std::vector<PreviewsEligibilityReason>* passed_reasons) const;
protected:
// blacklist::OptOutBlacklist (virtual for testing):
bool ShouldUseSessionPolicy(base::TimeDelta* duration,
size_t* history,
int* threshold) const override;
bool ShouldUsePersistentPolicy(base::TimeDelta* duration,
size_t* history,
int* threshold) const override;
bool ShouldUseHostPolicy(base::TimeDelta* duration,
size_t* history,
int* threshold,
size_t* max_hosts) const override;
bool ShouldUseTypePolicy(base::TimeDelta* duration,
size_t* history,
int* threshold) const override;
blacklist::BlacklistData::AllowedTypesAndVersions GetAllowedTypes()
const override;
private:
const blacklist::BlacklistData::AllowedTypesAndVersions allowed_types_;
DISALLOW_COPY_AND_ASSIGN(PreviewsBlackList);
};
} // namespace previews
#endif // COMPONENTS_PREVIEWS_CORE_PREVIEWS_BLACK_LIST_H_