blob: ce663a28b5047aab8b39e82bef4365fba42d9f5a [file] [log] [blame]
pke6dbb90af2016-07-08 14:00:461// Copyright 2016 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#include "components/ntp_snippets/content_suggestions_service.h"
6
7#include <algorithm>
8#include <iterator>
vitaliii45941152016-09-05 08:58:139#include <set>
jkrcale13510e2016-09-08 17:56:2010#include <utility>
pke6dbb90af2016-07-08 14:00:4611
12#include "base/bind.h"
pke1da90602016-08-05 14:20:2713#include "base/location.h"
jkrcal08d79b52017-04-13 14:02:1114#include "base/metrics/histogram_macros.h"
vitaliii69689f312017-10-25 17:36:0615#include "base/stl_util.h"
pke6dbb90af2016-07-08 14:00:4616#include "base/strings/string_number_conversions.h"
vitaliii69689f312017-10-25 17:36:0617#include "base/strings/stringprintf.h"
pke1da90602016-08-05 14:20:2718#include "base/threading/thread_task_runner_handle.h"
jkrcal27b02c12017-03-21 11:18:2619#include "base/time/default_clock.h"
dgn52914722016-10-18 10:28:4220#include "base/values.h"
kristiparkb9ee1082018-05-08 19:25:1621#include "components/favicon/core/favicon_server_fetcher_params.h"
jkrcal7b7e71f12017-04-06 13:12:4022#include "components/favicon/core/large_icon_service.h"
23#include "components/favicon_base/fallback_icon_style.h"
24#include "components/favicon_base/favicon_types.h"
dgnf6500c12017-05-09 17:05:3125#include "components/ntp_snippets/content_suggestions_metrics.h"
dgn52914722016-10-18 10:28:4226#include "components/ntp_snippets/pref_names.h"
jkrcal8083bc52017-04-24 16:34:0227#include "components/ntp_snippets/remote/remote_suggestions_provider.h"
dgn52914722016-10-18 10:28:4228#include "components/prefs/pref_registry_simple.h"
29#include "components/prefs/pref_service.h"
Ramin Halavati4bf78aa2017-06-01 04:53:4530#include "net/traffic_annotation/network_traffic_annotation.h"
pke6dbb90af2016-07-08 14:00:4631#include "ui/gfx/image/image.h"
32
33namespace ntp_snippets {
34
jkrcal08d79b52017-04-13 14:02:1135namespace {
36
37// Enumeration listing all possible outcomes for fetch attempts of favicons for
38// content suggestions. Used for UMA histograms, so do not change existing
39// values. Insert new values at the end, and update the histogram definition.
40// GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.ntp.snippets
41enum class FaviconFetchResult {
42 SUCCESS_CACHED = 0,
43 SUCCESS_FETCHED = 1,
44 FAILURE = 2,
45 COUNT = 3
46};
47
48void RecordFaviconFetchResult(FaviconFetchResult result) {
49 UMA_HISTOGRAM_ENUMERATION(
50 "NewTabPage.ContentSuggestions.ArticleFaviconFetchResult", result,
51 FaviconFetchResult::COUNT);
52}
53
54} // namespace
55
vitaliii45941152016-09-05 08:58:1356ContentSuggestionsService::ContentSuggestionsService(
57 State state,
Colin Blundell076714ff2018-02-12 17:26:1458 identity::IdentityManager* identity_manager,
jkrcale13510e2016-09-08 17:56:2059 history::HistoryService* history_service,
jkrcal7b7e71f12017-04-06 13:12:4060 favicon::LargeIconService* large_icon_service,
vitaliii7456f5a2016-12-19 11:13:2561 PrefService* pref_service,
jkrcalf9966462017-03-29 16:25:2162 std::unique_ptr<CategoryRanker> category_ranker,
63 std::unique_ptr<UserClassifier> user_classifier,
Vitalii Iarkof52ff802017-09-14 12:34:2464 std::unique_ptr<RemoteSuggestionsScheduler> remote_suggestions_scheduler,
65 std::unique_ptr<Logger> debug_logger)
jkrcale13510e2016-09-08 17:56:2066 : state_(state),
Colin Blundell076714ff2018-02-12 17:26:1467 identity_manager_observer_(this),
jkrcale13510e2016-09-08 17:56:2068 history_service_observer_(this),
jkrcal093410c2016-12-21 16:13:5569 remote_suggestions_provider_(nullptr),
jkrcal7b7e71f12017-04-06 13:12:4070 large_icon_service_(large_icon_service),
dgn52914722016-10-18 10:28:4271 pref_service_(pref_service),
jkrcalf9966462017-03-29 16:25:2172 remote_suggestions_scheduler_(std::move(remote_suggestions_scheduler)),
73 user_classifier_(std::move(user_classifier)),
Vitalii Iarkof52ff802017-09-14 12:34:2474 category_ranker_(std::move(category_ranker)),
75 debug_logger_(std::move(debug_logger)) {
vitaliii45941152016-09-05 08:58:1376 // Can be null in tests.
Colin Blundell076714ff2018-02-12 17:26:1477 if (identity_manager) {
78 identity_manager_observer_.Add(identity_manager);
dgnf5708892016-11-22 10:36:2279 }
80
vitaliii4408d6c2016-11-21 14:16:2481 if (history_service) {
vitaliii45941152016-09-05 08:58:1382 history_service_observer_.Add(history_service);
vitaliii4408d6c2016-11-21 14:16:2483 }
dgn52914722016-10-18 10:28:4284
Vitalii Iarkof52ff802017-09-14 12:34:2485 debug_logger_->Log(FROM_HERE, /*message=*/std::string());
86
dgn52914722016-10-18 10:28:4287 RestoreDismissedCategoriesFromPrefs();
vitaliii45941152016-09-05 08:58:1388}
pke6dbb90af2016-07-08 14:00:4689
treib62e819e2016-09-27 11:47:3490ContentSuggestionsService::~ContentSuggestionsService() = default;
pke6dbb90af2016-07-08 14:00:4691
92void ContentSuggestionsService::Shutdown() {
jkrcal093410c2016-12-21 16:13:5593 remote_suggestions_provider_ = nullptr;
94 remote_suggestions_scheduler_ = nullptr;
pke5728f082016-08-03 17:27:3595 suggestions_by_category_.clear();
96 providers_by_category_.clear();
97 categories_.clear();
98 providers_.clear();
pke6dbb90af2016-07-08 14:00:4699 state_ = State::DISABLED;
vitaliii4408d6c2016-11-21 14:16:24100 for (Observer& observer : observers_) {
ericwilligers42b92c12016-10-24 20:21:13101 observer.ContentSuggestionsServiceShutdown();
vitaliii4408d6c2016-11-21 14:16:24102 }
pke6dbb90af2016-07-08 14:00:46103}
104
dgn52914722016-10-18 10:28:42105// static
106void ContentSuggestionsService::RegisterProfilePrefs(
107 PrefRegistrySimple* registry) {
108 registry->RegisterListPref(prefs::kDismissedCategories);
109}
110
vitaliii8b5ab282016-12-20 11:06:22111std::vector<Category> ContentSuggestionsService::GetCategories() const {
112 std::vector<Category> sorted_categories = categories_;
113 std::sort(sorted_categories.begin(), sorted_categories.end(),
114 [this](const Category& left, const Category& right) {
115 return category_ranker_->Compare(left, right);
116 });
117 return sorted_categories;
118}
119
pke9c5095ac2016-08-01 13:53:12120CategoryStatus ContentSuggestionsService::GetCategoryStatus(
121 Category category) const {
pke6dbb90af2016-07-08 14:00:46122 if (state_ == State::DISABLED) {
pke9c5095ac2016-08-01 13:53:12123 return CategoryStatus::ALL_SUGGESTIONS_EXPLICITLY_DISABLED;
pke6dbb90af2016-07-08 14:00:46124 }
125
pke4d3a4d62016-08-02 09:06:21126 auto iterator = providers_by_category_.find(category);
vitaliii4408d6c2016-11-21 14:16:24127 if (iterator == providers_by_category_.end()) {
pke9c5095ac2016-08-01 13:53:12128 return CategoryStatus::NOT_PROVIDED;
vitaliii4408d6c2016-11-21 14:16:24129 }
pke6dbb90af2016-07-08 14:00:46130
131 return iterator->second->GetCategoryStatus(category);
132}
133
pkebd2f650a2016-08-09 14:53:45134base::Optional<CategoryInfo> ContentSuggestionsService::GetCategoryInfo(
135 Category category) const {
136 auto iterator = providers_by_category_.find(category);
vitaliii4408d6c2016-11-21 14:16:24137 if (iterator == providers_by_category_.end()) {
pkebd2f650a2016-08-09 14:53:45138 return base::Optional<CategoryInfo>();
vitaliii4408d6c2016-11-21 14:16:24139 }
pkebd2f650a2016-08-09 14:53:45140 return iterator->second->GetCategoryInfo(category);
141}
142
pke6dbb90af2016-07-08 14:00:46143const std::vector<ContentSuggestion>&
pke9c5095ac2016-08-01 13:53:12144ContentSuggestionsService::GetSuggestionsForCategory(Category category) const {
pke6dbb90af2016-07-08 14:00:46145 auto iterator = suggestions_by_category_.find(category);
vitaliii4408d6c2016-11-21 14:16:24146 if (iterator == suggestions_by_category_.end()) {
pke6dbb90af2016-07-08 14:00:46147 return no_suggestions_;
vitaliii4408d6c2016-11-21 14:16:24148 }
pke6dbb90af2016-07-08 14:00:46149 return iterator->second;
150}
151
152void ContentSuggestionsService::FetchSuggestionImage(
treib4bbc54922016-09-28 17:26:44153 const ContentSuggestion::ID& suggestion_id,
gaschler42544c12017-08-03 15:43:26154 ImageFetchedCallback callback) {
treib4bbc54922016-09-28 17:26:44155 if (!providers_by_category_.count(suggestion_id.category())) {
pke6dbb90af2016-07-08 14:00:46156 LOG(WARNING) << "Requested image for suggestion " << suggestion_id
treib4bbc54922016-09-28 17:26:44157 << " for unavailable category " << suggestion_id.category();
pke1da90602016-08-05 14:20:27158 base::ThreadTaskRunnerHandle::Get()->PostTask(
gaschler42544c12017-08-03 15:43:26159 FROM_HERE, base::BindOnce(std::move(callback), gfx::Image()));
pke6dbb90af2016-07-08 14:00:46160 return;
161 }
treib4bbc54922016-09-28 17:26:44162 providers_by_category_[suggestion_id.category()]->FetchSuggestionImage(
gaschler42544c12017-08-03 15:43:26163 suggestion_id, std::move(callback));
pke6dbb90af2016-07-08 14:00:46164}
165
Dan Harrington6eb74dc82018-03-20 17:39:18166void ContentSuggestionsService::FetchSuggestionImageData(
167 const ContentSuggestion::ID& suggestion_id,
168 ImageDataFetchedCallback callback) {
169 if (!providers_by_category_.count(suggestion_id.category())) {
170 LOG(WARNING) << "Requested image for suggestion " << suggestion_id
171 << " for unavailable category " << suggestion_id.category();
172 base::ThreadTaskRunnerHandle::Get()->PostTask(
173 FROM_HERE, base::BindOnce(std::move(callback), std::string()));
174 return;
175 }
176 providers_by_category_[suggestion_id.category()]->FetchSuggestionImageData(
177 suggestion_id, std::move(callback));
178}
179
jkrcalcd011682017-04-13 05:41:16180// TODO(jkrcal): Split the favicon fetching into a separate class.
jkrcal10004602017-03-29 07:44:28181void ContentSuggestionsService::FetchSuggestionFavicon(
182 const ContentSuggestion::ID& suggestion_id,
183 int minimum_size_in_pixel,
184 int desired_size_in_pixel,
gaschler42544c12017-08-03 15:43:26185 ImageFetchedCallback callback) {
jkrcal8083bc52017-04-24 16:34:02186 const GURL& domain_with_favicon = GetFaviconDomain(suggestion_id);
187 if (!domain_with_favicon.is_valid() || !large_icon_service_) {
jkrcal7b7e71f12017-04-06 13:12:40188 base::ThreadTaskRunnerHandle::Get()->PostTask(
gaschler42544c12017-08-03 15:43:26189 FROM_HERE, base::BindOnce(std::move(callback), gfx::Image()));
jkrcal08d79b52017-04-13 14:02:11190 RecordFaviconFetchResult(FaviconFetchResult::FAILURE);
jkrcal7b7e71f12017-04-06 13:12:40191 return;
192 }
193
jkrcal95acdc5a2017-05-19 15:34:37194 GetFaviconFromCache(domain_with_favicon, minimum_size_in_pixel,
gaschler42544c12017-08-03 15:43:26195 desired_size_in_pixel, std::move(callback),
jkrcal95acdc5a2017-05-19 15:34:37196 /*continue_to_google_server=*/true);
jkrcal7b7e71f12017-04-06 13:12:40197}
198
jkrcal8083bc52017-04-24 16:34:02199GURL ContentSuggestionsService::GetFaviconDomain(
200 const ContentSuggestion::ID& suggestion_id) {
201 const std::vector<ContentSuggestion>& suggestions =
202 suggestions_by_category_[suggestion_id.category()];
203 auto position =
204 std::find_if(suggestions.begin(), suggestions.end(),
205 [&suggestion_id](const ContentSuggestion& suggestion) {
206 return suggestion_id == suggestion.id();
207 });
208 if (position != suggestions.end()) {
209 return position->url_with_favicon();
210 }
211
212 // Look up the URL in the archive of |remote_suggestions_provider_|.
213 // TODO(jkrcal): Fix how Fetch more works or find other ways to remove this
214 // hack. crbug.com/714031
215 if (providers_by_category_[suggestion_id.category()] ==
216 remote_suggestions_provider_) {
217 return remote_suggestions_provider_->GetUrlWithFavicon(suggestion_id);
218 }
219 return GURL();
220}
221
jkrcal95acdc5a2017-05-19 15:34:37222void ContentSuggestionsService::GetFaviconFromCache(
223 const GURL& publisher_url,
224 int minimum_size_in_pixel,
225 int desired_size_in_pixel,
gaschler42544c12017-08-03 15:43:26226 ImageFetchedCallback callback,
jkrcal95acdc5a2017-05-19 15:34:37227 bool continue_to_google_server) {
228 // TODO(jkrcal): Create a general wrapper function in LargeIconService that
229 // does handle the get-from-cache-and-fallback-to-google-server functionality
230 // in one shot (for all clients that do not need to react in between).
Jan Krcalb0cbad92017-06-01 09:03:47231
232 // Use desired_size = 0 for getting the icon from the cache (so that the icon
233 // is not poorly rescaled by LargeIconService).
jkrcal95acdc5a2017-05-19 15:34:37234 large_icon_service_->GetLargeIconImageOrFallbackStyle(
Jan Krcalb0cbad92017-06-01 09:03:47235 publisher_url, minimum_size_in_pixel, /*desired_size_in_pixel=*/0,
jkrcal95acdc5a2017-05-19 15:34:37236 base::Bind(&ContentSuggestionsService::OnGetFaviconFromCacheFinished,
237 base::Unretained(this), publisher_url, minimum_size_in_pixel,
gaschler42544c12017-08-03 15:43:26238 desired_size_in_pixel, base::Passed(std::move(callback)),
239 continue_to_google_server),
jkrcal95acdc5a2017-05-19 15:34:37240 &favicons_task_tracker_);
241}
242
jkrcal7b7e71f12017-04-06 13:12:40243void ContentSuggestionsService::OnGetFaviconFromCacheFinished(
244 const GURL& publisher_url,
245 int minimum_size_in_pixel,
246 int desired_size_in_pixel,
gaschler42544c12017-08-03 15:43:26247 ImageFetchedCallback callback,
jkrcal7b7e71f12017-04-06 13:12:40248 bool continue_to_google_server,
249 const favicon_base::LargeIconImageResult& result) {
250 if (!result.image.IsEmpty()) {
gaschler42544c12017-08-03 15:43:26251 std::move(callback).Run(result.image);
jkrcal08d79b52017-04-13 14:02:11252 // The icon is from cache if we haven't gone to Google server yet. The icon
253 // is freshly fetched, otherwise.
254 RecordFaviconFetchResult(continue_to_google_server
255 ? FaviconFetchResult::SUCCESS_CACHED
256 : FaviconFetchResult::SUCCESS_FETCHED);
Jan Krcal5ade20c2017-07-11 13:03:00257 // Update the time when the icon was last requested - postpone thus the
258 // automatic eviction of the favicon from the favicon database.
259 large_icon_service_->TouchIconFromGoogleServer(result.icon_url);
jkrcal7b7e71f12017-04-06 13:12:40260 return;
261 }
262
263 if (!continue_to_google_server ||
264 (result.fallback_icon_style &&
265 !result.fallback_icon_style->is_default_background_color)) {
266 // We cannot download from the server if there is some small icon in the
jkrcal08d79b52017-04-13 14:02:11267 // cache (resulting in non-default background color) or if we already did
268 // so.
gaschler42544c12017-08-03 15:43:26269 std::move(callback).Run(gfx::Image());
jkrcal08d79b52017-04-13 14:02:11270 RecordFaviconFetchResult(FaviconFetchResult::FAILURE);
jkrcal7b7e71f12017-04-06 13:12:40271 return;
272 }
273
274 // Try to fetch the favicon from a Google favicon server.
jkrcal5de6dff2017-05-24 09:59:47275 // TODO(jkrcal): Currently used only for Articles for you which have public
276 // URLs. Let the provider decide whether |publisher_url| may be private or
277 // not.
Ramin Halavati4bf78aa2017-06-01 04:53:45278 net::NetworkTrafficAnnotationTag traffic_annotation =
279 net::DefineNetworkTrafficAnnotation("content_suggestion_get_favicon", R"(
280 semantics {
281 sender: "Content Suggestion"
282 description:
283 "Sends a request to a Google server to retrieve the favicon bitmap "
284 "for an article suggestion on the new tab page (URLs are public "
285 "and provided by Google)."
286 trigger:
287 "A request can be sent if Chrome does not have a favicon for a "
288 "particular page."
289 data: "Page URL and desired icon size."
290 destination: GOOGLE_OWNED_SERVICE
291 }
292 policy {
Ramin Halavati3b979782017-07-21 11:40:26293 cookies_allowed: NO
Ramin Halavati4bf78aa2017-06-01 04:53:45294 setting: "This feature cannot be disabled by settings."
295 policy_exception_justification: "Not implemented."
296 })");
jkrcal7b7e71f12017-04-06 13:12:40297 large_icon_service_
298 ->GetLargeIconOrFallbackStyleFromGoogleServerSkippingLocalCache(
kristiparkb9ee1082018-05-08 19:25:16299 favicon::FaviconServerFetcherParams::CreateForMobile(
300 publisher_url, minimum_size_in_pixel, desired_size_in_pixel),
Ramin Halavati4bf78aa2017-06-01 04:53:45301 /*may_page_url_be_private=*/false, traffic_annotation,
jkrcal7b7e71f12017-04-06 13:12:40302 base::Bind(
303 &ContentSuggestionsService::OnGetFaviconFromGoogleServerFinished,
304 base::Unretained(this), publisher_url, minimum_size_in_pixel,
gaschler42544c12017-08-03 15:43:26305 desired_size_in_pixel, base::Passed(std::move(callback))));
jkrcal7b7e71f12017-04-06 13:12:40306}
307
308void ContentSuggestionsService::OnGetFaviconFromGoogleServerFinished(
309 const GURL& publisher_url,
310 int minimum_size_in_pixel,
311 int desired_size_in_pixel,
gaschler42544c12017-08-03 15:43:26312 ImageFetchedCallback callback,
Jan Krcalf3e5733e2017-07-10 09:06:11313 favicon_base::GoogleFaviconServerRequestStatus status) {
314 if (status != favicon_base::GoogleFaviconServerRequestStatus::SUCCESS) {
gaschler42544c12017-08-03 15:43:26315 std::move(callback).Run(gfx::Image());
jkrcal08d79b52017-04-13 14:02:11316 RecordFaviconFetchResult(FaviconFetchResult::FAILURE);
jkrcal7b7e71f12017-04-06 13:12:40317 return;
318 }
319
jkrcal95acdc5a2017-05-19 15:34:37320 GetFaviconFromCache(publisher_url, minimum_size_in_pixel,
gaschler42544c12017-08-03 15:43:26321 desired_size_in_pixel, std::move(callback),
jkrcal95acdc5a2017-05-19 15:34:37322 /*continue_to_google_server=*/false);
jkrcal10004602017-03-29 07:44:28323}
324
vitaliii685fdfaa2016-08-31 11:25:46325void ContentSuggestionsService::ClearHistory(
326 base::Time begin,
327 base::Time end,
328 const base::Callback<bool(const GURL& url)>& filter) {
329 for (const auto& provider : providers_) {
330 provider->ClearHistory(begin, end, filter);
331 }
vitaliii6343b2c2017-01-04 07:57:11332 category_ranker_->ClearHistory(begin, end);
tschumann5829c3412017-01-09 21:45:43333 // This potentially removed personalized data which we shouldn't display
334 // anymore.
335 for (Observer& observer : observers_) {
336 observer.OnFullRefreshRequired();
337 }
vitaliii685fdfaa2016-08-31 11:25:46338}
339
treib7d1d7a52016-08-24 14:04:55340void ContentSuggestionsService::ClearAllCachedSuggestions() {
pke6dbb90af2016-07-08 14:00:46341 suggestions_by_category_.clear();
Jan Krcal33ed7512017-11-29 12:45:09342 for (const auto& provider : providers_) {
343 provider->ClearCachedSuggestions();
pke6dbb90af2016-07-08 14:00:46344 }
Jan Krcal33ed7512017-11-29 12:45:09345 for (Observer& observer : observers_) {
346 observer.OnFullRefreshRequired();
vitaliii4408d6c2016-11-21 14:16:24347 }
pke151b5502016-08-09 12:15:13348}
349
pkede0dd9f2016-08-23 09:18:11350void ContentSuggestionsService::GetDismissedSuggestionsForDebugging(
351 Category category,
gaschlerdf40dcc2017-08-04 14:06:37352 DismissedSuggestionsCallback callback) {
pke151b5502016-08-09 12:15:13353 auto iterator = providers_by_category_.find(category);
vitaliii4408d6c2016-11-21 14:16:24354 if (iterator != providers_by_category_.end()) {
gaschlerdf40dcc2017-08-04 14:06:37355 iterator->second->GetDismissedSuggestionsForDebugging(category,
356 std::move(callback));
vitaliii4408d6c2016-11-21 14:16:24357 } else {
gaschlerdf40dcc2017-08-04 14:06:37358 std::move(callback).Run(std::vector<ContentSuggestion>());
vitaliii4408d6c2016-11-21 14:16:24359 }
pke151b5502016-08-09 12:15:13360}
361
362void ContentSuggestionsService::ClearDismissedSuggestionsForDebugging(
363 Category category) {
364 auto iterator = providers_by_category_.find(category);
vitaliii4408d6c2016-11-21 14:16:24365 if (iterator != providers_by_category_.end()) {
pke151b5502016-08-09 12:15:13366 iterator->second->ClearDismissedSuggestionsForDebugging(category);
vitaliii4408d6c2016-11-21 14:16:24367 }
pke6dbb90af2016-07-08 14:00:46368}
369
pke2646c95b2016-07-25 12:18:44370void ContentSuggestionsService::DismissSuggestion(
treib4bbc54922016-09-28 17:26:44371 const ContentSuggestion::ID& suggestion_id) {
372 if (!providers_by_category_.count(suggestion_id.category())) {
pke2646c95b2016-07-25 12:18:44373 LOG(WARNING) << "Dismissed suggestion " << suggestion_id
treib4bbc54922016-09-28 17:26:44374 << " for unavailable category " << suggestion_id.category();
pke6dbb90af2016-07-08 14:00:46375 return;
376 }
dgnf6500c12017-05-09 17:05:31377
378 metrics::RecordContentSuggestionDismissed();
379
treib4bbc54922016-09-28 17:26:44380 providers_by_category_[suggestion_id.category()]->DismissSuggestion(
381 suggestion_id);
pke6dbb90af2016-07-08 14:00:46382
vitaliii2600e8e02016-12-09 17:23:36383 // Remove the suggestion locally if it is present. A suggestion may be missing
384 // localy e.g. if it was sent to UI through |Fetch| or it has been dismissed
385 // from a different NTP.
386 RemoveSuggestionByID(suggestion_id);
pke6dbb90af2016-07-08 14:00:46387}
388
dgn212feea3b2016-09-16 15:08:20389void ContentSuggestionsService::DismissCategory(Category category) {
390 auto providers_it = providers_by_category_.find(category);
vitaliii4408d6c2016-11-21 14:16:24391 if (providers_it == providers_by_category_.end()) {
dgn212feea3b2016-09-16 15:08:20392 return;
vitaliii4408d6c2016-11-21 14:16:24393 }
dgn212feea3b2016-09-16 15:08:20394
dgnf6500c12017-05-09 17:05:31395 metrics::RecordCategoryDismissed();
396
dgn52914722016-10-18 10:28:42397 ContentSuggestionsProvider* provider = providers_it->second;
398 UnregisterCategory(category, provider);
399
400 dismissed_providers_by_category_[category] = provider;
401 StoreDismissedCategoriesToPrefs();
vitaliii3d9423e2017-01-03 17:08:13402
403 category_ranker_->OnCategoryDismissed(category);
dgn212feea3b2016-09-16 15:08:20404}
405
mvanouwerkerk52783d92016-10-12 11:03:40406void ContentSuggestionsService::RestoreDismissedCategories() {
407 // Make a copy as the original will be modified during iteration.
408 auto dismissed_providers_by_category_copy = dismissed_providers_by_category_;
409 for (const auto& category_provider_pair :
410 dismissed_providers_by_category_copy) {
dgn52914722016-10-18 10:28:42411 RestoreDismissedCategory(category_provider_pair.first);
mvanouwerkerk52783d92016-10-12 11:03:40412 }
dgn52914722016-10-18 10:28:42413 StoreDismissedCategoriesToPrefs();
mvanouwerkerk52783d92016-10-12 11:03:40414 DCHECK(dismissed_providers_by_category_.empty());
415}
416
pke6dbb90af2016-07-08 14:00:46417void ContentSuggestionsService::AddObserver(Observer* observer) {
418 observers_.AddObserver(observer);
419}
420
421void ContentSuggestionsService::RemoveObserver(Observer* observer) {
422 observers_.RemoveObserver(observer);
423}
424
425void ContentSuggestionsService::RegisterProvider(
pke5728f082016-08-03 17:27:35426 std::unique_ptr<ContentSuggestionsProvider> provider) {
427 DCHECK(state_ == State::ENABLED);
pke5728f082016-08-03 17:27:35428 providers_.push_back(std::move(provider));
pke6dbb90af2016-07-08 14:00:46429}
430
tschumann83578aa2016-11-03 13:18:32431void ContentSuggestionsService::Fetch(
432 const Category& category,
433 const std::set<std::string>& known_suggestion_ids,
gaschlerdf40dcc2017-08-04 14:06:37434 FetchDoneCallback callback) {
tschumann83578aa2016-11-03 13:18:32435 auto providers_it = providers_by_category_.find(category);
vitaliii4408d6c2016-11-21 14:16:24436 if (providers_it == providers_by_category_.end()) {
tschumann83578aa2016-11-03 13:18:32437 return;
vitaliii4408d6c2016-11-21 14:16:24438 }
tschumann83578aa2016-11-03 13:18:32439
dgnf6500c12017-05-09 17:05:31440 metrics::RecordFetchAction();
441
gaschlerdf40dcc2017-08-04 14:06:37442 providers_it->second->Fetch(category, known_suggestion_ids,
443 std::move(callback));
tschumann83578aa2016-11-03 13:18:32444}
445
jkrcal093410c2016-12-21 16:13:55446void ContentSuggestionsService::ReloadSuggestions() {
447 for (const auto& provider : providers_) {
448 provider->ReloadSuggestions();
449 }
450}
451
dgn65d6cd82017-04-11 00:36:36452bool ContentSuggestionsService::AreRemoteSuggestionsEnabled() const {
Nicolas Dossou-gbete18994652017-07-19 16:32:17453 return remote_suggestions_provider_ &&
454 !remote_suggestions_provider_->IsDisabled();
dgnb8a8a5c2017-03-31 12:35:36455}
456
pke6dbb90af2016-07-08 14:00:46457////////////////////////////////////////////////////////////////////////////////
458// Private methods
459
460void ContentSuggestionsService::OnNewSuggestions(
pke4d3a4d62016-08-02 09:06:21461 ContentSuggestionsProvider* provider,
462 Category category,
treib62e819e2016-09-27 11:47:34463 std::vector<ContentSuggestion> suggestions) {
treib534523b2016-10-20 16:19:44464 // Providers shouldn't call this when they're in a non-available state.
465 DCHECK(
466 IsCategoryStatusInitOrAvailable(provider->GetCategoryStatus(category)));
467
dgn52914722016-10-18 10:28:42468 if (TryRegisterProviderForCategory(provider, category)) {
pke4d3a4d62016-08-02 09:06:21469 NotifyCategoryStatusChanged(category);
dgn52914722016-10-18 10:28:42470 } else if (IsCategoryDismissed(category)) {
471 // The category has been registered as a dismissed one. We need to
472 // check if the dismissal can be cleared now that we received new data.
vitaliii4408d6c2016-11-21 14:16:24473 if (suggestions.empty()) {
dgn52914722016-10-18 10:28:42474 return;
vitaliii4408d6c2016-11-21 14:16:24475 }
dgn52914722016-10-18 10:28:42476
477 RestoreDismissedCategory(category);
478 StoreDismissedCategoriesToPrefs();
479
480 NotifyCategoryStatusChanged(category);
481 }
pke3b2e3632016-08-12 12:52:53482
treib39fffa12016-10-14 14:59:10483 if (!IsCategoryStatusAvailable(provider->GetCategoryStatus(category))) {
484 // A provider shouldn't send us suggestions while it's not available.
485 DCHECK(suggestions.empty());
pke3b2e3632016-08-12 12:52:53486 return;
treib39fffa12016-10-14 14:59:10487 }
pke6dbb90af2016-07-08 14:00:46488
treib62e819e2016-09-27 11:47:34489 suggestions_by_category_[category] = std::move(suggestions);
pke6dbb90af2016-07-08 14:00:46490
vitaliii4408d6c2016-11-21 14:16:24491 for (Observer& observer : observers_) {
ericwilligers42b92c12016-10-24 20:21:13492 observer.OnNewSuggestions(category);
vitaliii4408d6c2016-11-21 14:16:24493 }
pke6dbb90af2016-07-08 14:00:46494}
495
496void ContentSuggestionsService::OnCategoryStatusChanged(
pke4d3a4d62016-08-02 09:06:21497 ContentSuggestionsProvider* provider,
498 Category category,
pke9c5095ac2016-08-01 13:53:12499 CategoryStatus new_status) {
pke4d3a4d62016-08-02 09:06:21500 if (new_status == CategoryStatus::NOT_PROVIDED) {
dgn52914722016-10-18 10:28:42501 UnregisterCategory(category, provider);
pke4d3a4d62016-08-02 09:06:21502 } else {
vitaliii4408d6c2016-11-21 14:16:24503 if (!IsCategoryStatusAvailable(new_status)) {
dgn52914722016-10-18 10:28:42504 suggestions_by_category_.erase(category);
vitaliii4408d6c2016-11-21 14:16:24505 }
dgn52914722016-10-18 10:28:42506 TryRegisterProviderForCategory(provider, category);
pke4d3a4d62016-08-02 09:06:21507 DCHECK_EQ(new_status, provider->GetCategoryStatus(category));
508 }
dgn52914722016-10-18 10:28:42509
vitaliii4408d6c2016-11-21 14:16:24510 if (!IsCategoryDismissed(category)) {
dgn52914722016-10-18 10:28:42511 NotifyCategoryStatusChanged(category);
vitaliii4408d6c2016-11-21 14:16:24512 }
pke6dbb90af2016-07-08 14:00:46513}
514
pke2a48f852016-08-18 13:33:52515void ContentSuggestionsService::OnSuggestionInvalidated(
516 ContentSuggestionsProvider* provider,
treib4bbc54922016-09-28 17:26:44517 const ContentSuggestion::ID& suggestion_id) {
518 RemoveSuggestionByID(suggestion_id);
vitaliii4408d6c2016-11-21 14:16:24519 for (Observer& observer : observers_) {
ericwilligers42b92c12016-10-24 20:21:13520 observer.OnSuggestionInvalidated(suggestion_id);
vitaliii4408d6c2016-11-21 14:16:24521 }
pke2a48f852016-08-18 13:33:52522}
Colin Blundell076714ff2018-02-12 17:26:14523// identity::IdentityManager::Observer implementation
524void ContentSuggestionsService::OnPrimaryAccountSet(
525 const AccountInfo& account_info) {
Colin Blundellce266a692018-01-16 11:07:16526 OnSignInStateChanged(/*has_signed_in=*/true);
dgnf5708892016-11-22 10:36:22527}
528
Colin Blundell076714ff2018-02-12 17:26:14529void ContentSuggestionsService::OnPrimaryAccountCleared(
530 const AccountInfo& account_info) {
Colin Blundellce266a692018-01-16 11:07:16531 OnSignInStateChanged(/*has_signed_in=*/false);
dgnf5708892016-11-22 10:36:22532}
533
vitaliii45941152016-09-05 08:58:13534// history::HistoryServiceObserver implementation.
535void ContentSuggestionsService::OnURLsDeleted(
536 history::HistoryService* history_service,
537 bool all_history,
538 bool expired,
539 const history::URLRows& deleted_rows,
540 const std::set<GURL>& favicon_urls) {
541 // We don't care about expired entries.
vitaliii4408d6c2016-11-21 14:16:24542 if (expired) {
vitaliii45941152016-09-05 08:58:13543 return;
vitaliii4408d6c2016-11-21 14:16:24544 }
vitaliii45941152016-09-05 08:58:13545
vitaliii45941152016-09-05 08:58:13546 if (all_history) {
vitaliii45941152016-09-05 08:58:13547 base::Callback<bool(const GURL& url)> filter =
548 base::Bind([](const GURL& url) { return true; });
tschumann5829c3412017-01-09 21:45:43549 ClearHistory(base::Time(), base::Time::Max(), filter);
vitaliii45941152016-09-05 08:58:13550 } else {
tschumann5829c3412017-01-09 21:45:43551 // If a user deletes a single URL, we don't consider this a clear user
552 // intend to clear our data.
553 // TODO(tschumann): Single URL deletions should be handled on a case-by-case
554 // basis. However this depends on the provider's details and thus cannot be
555 // done here. Introduce a OnURLsDeleted() method on the providers to move
556 // this decision further down.
557 if (deleted_rows.size() < 2) {
vitaliii45941152016-09-05 08:58:13558 return;
vitaliii4408d6c2016-11-21 14:16:24559 }
vitaliii45941152016-09-05 08:58:13560 std::set<GURL> deleted_urls;
561 for (const history::URLRow& row : deleted_rows) {
vitaliii45941152016-09-05 08:58:13562 deleted_urls.insert(row.url());
563 }
sfierae8969bc2017-03-26 18:38:41564 base::Callback<bool(const GURL& url)> filter =
565 base::Bind([](const std::set<GURL>& set,
566 const GURL& url) { return set.count(url) != 0; },
567 deleted_urls);
tschumann5829c3412017-01-09 21:45:43568 // We usually don't have any time-related information (the URLRow objects
569 // usually don't provide a |last_visit()| timestamp. Hence we simply clear
570 // the whole history for the selected URLs.
571 ClearHistory(base::Time(), base::Time::Max(), filter);
vitaliii45941152016-09-05 08:58:13572 }
573}
574
575void ContentSuggestionsService::HistoryServiceBeingDeleted(
576 history::HistoryService* history_service) {
577 history_service_observer_.RemoveAll();
578}
579
dgn52914722016-10-18 10:28:42580bool ContentSuggestionsService::TryRegisterProviderForCategory(
pke4d3a4d62016-08-02 09:06:21581 ContentSuggestionsProvider* provider,
582 Category category) {
583 auto it = providers_by_category_.find(category);
584 if (it != providers_by_category_.end()) {
585 DCHECK_EQ(it->second, provider);
586 return false;
587 }
588
mvanouwerkerk52783d92016-10-12 11:03:40589 auto dismissed_it = dismissed_providers_by_category_.find(category);
590 if (dismissed_it != dismissed_providers_by_category_.end()) {
dgn52914722016-10-18 10:28:42591 // The initialisation of dismissed categories registers them with |nullptr|
592 // for providers, we need to check for that to see if the provider is
593 // already registered or not.
594 if (!dismissed_it->second) {
595 dismissed_it->second = provider;
596 } else {
597 DCHECK_EQ(dismissed_it->second, provider);
598 }
599 return false;
mvanouwerkerk52783d92016-10-12 11:03:40600 }
601
dgn52914722016-10-18 10:28:42602 RegisterCategory(category, provider);
603 return true;
604}
605
606void ContentSuggestionsService::RegisterCategory(
607 Category category,
608 ContentSuggestionsProvider* provider) {
609 DCHECK(!base::ContainsKey(providers_by_category_, category));
610 DCHECK(!IsCategoryDismissed(category));
611
pke4d3a4d62016-08-02 09:06:21612 providers_by_category_[category] = provider;
613 categories_.push_back(category);
pke4d3a4d62016-08-02 09:06:21614 if (IsCategoryStatusAvailable(provider->GetCategoryStatus(category))) {
615 suggestions_by_category_.insert(
616 std::make_pair(category, std::vector<ContentSuggestion>()));
617 }
dgn52914722016-10-18 10:28:42618}
619
620void ContentSuggestionsService::UnregisterCategory(
621 Category category,
622 ContentSuggestionsProvider* provider) {
623 auto providers_it = providers_by_category_.find(category);
624 if (providers_it == providers_by_category_.end()) {
625 DCHECK(IsCategoryDismissed(category));
626 return;
627 }
628
629 DCHECK_EQ(provider, providers_it->second);
630 providers_by_category_.erase(providers_it);
631 categories_.erase(
632 std::find(categories_.begin(), categories_.end(), category));
633 suggestions_by_category_.erase(category);
pke6dbb90af2016-07-08 14:00:46634}
635
pke2a48f852016-08-18 13:33:52636bool ContentSuggestionsService::RemoveSuggestionByID(
treib4bbc54922016-09-28 17:26:44637 const ContentSuggestion::ID& suggestion_id) {
pke2a48f852016-08-18 13:33:52638 std::vector<ContentSuggestion>* suggestions =
treib4bbc54922016-09-28 17:26:44639 &suggestions_by_category_[suggestion_id.category()];
pke2a48f852016-08-18 13:33:52640 auto position =
641 std::find_if(suggestions->begin(), suggestions->end(),
642 [&suggestion_id](const ContentSuggestion& suggestion) {
643 return suggestion_id == suggestion.id();
644 });
vitaliii4408d6c2016-11-21 14:16:24645 if (position == suggestions->end()) {
pke2a48f852016-08-18 13:33:52646 return false;
vitaliii4408d6c2016-11-21 14:16:24647 }
pke2a48f852016-08-18 13:33:52648 suggestions->erase(position);
treib063e6a62016-08-25 11:34:29649
pke2a48f852016-08-18 13:33:52650 return true;
651}
652
pke9c5095ac2016-08-01 13:53:12653void ContentSuggestionsService::NotifyCategoryStatusChanged(Category category) {
vitaliii4408d6c2016-11-21 14:16:24654 for (Observer& observer : observers_) {
ericwilligers42b92c12016-10-24 20:21:13655 observer.OnCategoryStatusChanged(category, GetCategoryStatus(category));
vitaliii4408d6c2016-11-21 14:16:24656 }
pke6dbb90af2016-07-08 14:00:46657}
658
Colin Blundellce266a692018-01-16 11:07:16659void ContentSuggestionsService::OnSignInStateChanged(bool has_signed_in) {
dgnf5708892016-11-22 10:36:22660 // First notify the providers, so they can make the required changes.
661 for (const auto& provider : providers_) {
Colin Blundellce266a692018-01-16 11:07:16662 provider->OnSignInStateChanged(has_signed_in);
dgnf5708892016-11-22 10:36:22663 }
664
665 // Finally notify the observers so they refresh only after the backend is
666 // ready.
667 for (Observer& observer : observers_) {
668 observer.OnFullRefreshRequired();
669 }
670}
671
dgn52914722016-10-18 10:28:42672bool ContentSuggestionsService::IsCategoryDismissed(Category category) const {
673 return base::ContainsKey(dismissed_providers_by_category_, category);
674}
675
676void ContentSuggestionsService::RestoreDismissedCategory(Category category) {
677 auto dismissed_it = dismissed_providers_by_category_.find(category);
678 DCHECK(base::ContainsKey(dismissed_providers_by_category_, category));
679
680 // Keep the reference to the provider and remove it from the dismissed ones,
681 // because the category registration enforces that it's not dismissed.
682 ContentSuggestionsProvider* provider = dismissed_it->second;
683 dismissed_providers_by_category_.erase(dismissed_it);
684
vitaliii4408d6c2016-11-21 14:16:24685 if (provider) {
dgn52914722016-10-18 10:28:42686 RegisterCategory(category, provider);
vitaliii4408d6c2016-11-21 14:16:24687 }
dgn52914722016-10-18 10:28:42688}
689
690void ContentSuggestionsService::RestoreDismissedCategoriesFromPrefs() {
691 // This must only be called at startup.
692 DCHECK(dismissed_providers_by_category_.empty());
693 DCHECK(providers_by_category_.empty());
694
695 const base::ListValue* list =
696 pref_service_->GetList(prefs::kDismissedCategories);
jdoerriea5676c62017-04-11 18:09:14697 for (const base::Value& entry : *list) {
dgn52914722016-10-18 10:28:42698 int id = 0;
jdoerriea5676c62017-04-11 18:09:14699 if (!entry.GetAsInteger(&id)) {
700 DLOG(WARNING) << "Invalid category pref value: " << entry;
dgn52914722016-10-18 10:28:42701 continue;
702 }
703
704 // When the provider is registered, it will be stored in this map.
vitaliii7456f5a2016-12-19 11:13:25705 dismissed_providers_by_category_[Category::FromIDValue(id)] = nullptr;
dgn52914722016-10-18 10:28:42706 }
707}
708
709void ContentSuggestionsService::StoreDismissedCategoriesToPrefs() {
710 base::ListValue list;
711 for (const auto& category_provider_pair : dismissed_providers_by_category_) {
712 list.AppendInteger(category_provider_pair.first.id());
713 }
714
715 pref_service_->Set(prefs::kDismissedCategories, list);
716}
717
vitaliii69689f312017-10-25 17:36:06718void ContentSuggestionsService::DestroyCategoryAndItsProvider(
719 Category category) {
720 // Destroying articles category is more complex and not implemented.
721 DCHECK_NE(category, Category::FromKnownCategory(KnownCategories::ARTICLES));
722
723 if (providers_by_category_.count(category) != 1) {
724 return;
725 }
726
727 { // Destroy the provider and delete its mentions.
728 ContentSuggestionsProvider* raw_provider = providers_by_category_[category];
729 base::EraseIf(
730 providers_,
731 [&raw_provider](
732 const std::unique_ptr<ContentSuggestionsProvider>& provider) {
733 return provider.get() == raw_provider;
734 });
735 providers_by_category_.erase(category);
736
737 if (dismissed_providers_by_category_.count(category) == 1) {
738 dismissed_providers_by_category_[category] = nullptr;
739 }
740 }
741
742 suggestions_by_category_.erase(category);
743
744 auto it = std::find(categories_.begin(), categories_.end(), category);
745 categories_.erase(it);
746
747 // Notify observers that the category is gone.
748 NotifyCategoryStatusChanged(category);
749}
750
pke6dbb90af2016-07-08 14:00:46751} // namespace ntp_snippets