blob: 532fb95a7661176dadea2c43cfdd0f31b36e3608 [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"
Chris Luf0b870f2018-11-14 00:31:3722#include "components/favicon/core/large_icon_service.h"
jkrcal7b7e71f12017-04-06 13:12:4023#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,
Natalie Chouinard50024212019-05-06 17:38:5964 std::unique_ptr<RemoteSuggestionsScheduler> remote_suggestions_scheduler)
jkrcale13510e2016-09-08 17:56:2065 : state_(state),
Colin Blundell076714ff2018-02-12 17:26:1466 identity_manager_observer_(this),
jkrcale13510e2016-09-08 17:56:2067 history_service_observer_(this),
jkrcal093410c2016-12-21 16:13:5568 remote_suggestions_provider_(nullptr),
jkrcal7b7e71f12017-04-06 13:12:4069 large_icon_service_(large_icon_service),
dgn52914722016-10-18 10:28:4270 pref_service_(pref_service),
jkrcalf9966462017-03-29 16:25:2171 remote_suggestions_scheduler_(std::move(remote_suggestions_scheduler)),
72 user_classifier_(std::move(user_classifier)),
Natalie Chouinard50024212019-05-06 17:38:5973 category_ranker_(std::move(category_ranker)) {
vitaliii45941152016-09-05 08:58:1374 // Can be null in tests.
Colin Blundell076714ff2018-02-12 17:26:1475 if (identity_manager) {
76 identity_manager_observer_.Add(identity_manager);
dgnf5708892016-11-22 10:36:2277 }
78
vitaliii4408d6c2016-11-21 14:16:2479 if (history_service) {
vitaliii45941152016-09-05 08:58:1380 history_service_observer_.Add(history_service);
vitaliii4408d6c2016-11-21 14:16:2481 }
dgn52914722016-10-18 10:28:4282
83 RestoreDismissedCategoriesFromPrefs();
vitaliii45941152016-09-05 08:58:1384}
pke6dbb90af2016-07-08 14:00:4685
treib62e819e2016-09-27 11:47:3486ContentSuggestionsService::~ContentSuggestionsService() = default;
pke6dbb90af2016-07-08 14:00:4687
88void ContentSuggestionsService::Shutdown() {
jkrcal093410c2016-12-21 16:13:5589 remote_suggestions_provider_ = nullptr;
90 remote_suggestions_scheduler_ = nullptr;
pke5728f082016-08-03 17:27:3591 suggestions_by_category_.clear();
92 providers_by_category_.clear();
93 categories_.clear();
94 providers_.clear();
pke6dbb90af2016-07-08 14:00:4695 state_ = State::DISABLED;
vitaliii4408d6c2016-11-21 14:16:2496 for (Observer& observer : observers_) {
ericwilligers42b92c12016-10-24 20:21:1397 observer.ContentSuggestionsServiceShutdown();
vitaliii4408d6c2016-11-21 14:16:2498 }
pke6dbb90af2016-07-08 14:00:4699}
100
dgn52914722016-10-18 10:28:42101// static
102void ContentSuggestionsService::RegisterProfilePrefs(
103 PrefRegistrySimple* registry) {
104 registry->RegisterListPref(prefs::kDismissedCategories);
105}
106
vitaliii8b5ab282016-12-20 11:06:22107std::vector<Category> ContentSuggestionsService::GetCategories() const {
108 std::vector<Category> sorted_categories = categories_;
109 std::sort(sorted_categories.begin(), sorted_categories.end(),
110 [this](const Category& left, const Category& right) {
111 return category_ranker_->Compare(left, right);
112 });
113 return sorted_categories;
114}
115
pke9c5095ac2016-08-01 13:53:12116CategoryStatus ContentSuggestionsService::GetCategoryStatus(
117 Category category) const {
pke6dbb90af2016-07-08 14:00:46118 if (state_ == State::DISABLED) {
pke9c5095ac2016-08-01 13:53:12119 return CategoryStatus::ALL_SUGGESTIONS_EXPLICITLY_DISABLED;
pke6dbb90af2016-07-08 14:00:46120 }
121
pke4d3a4d62016-08-02 09:06:21122 auto iterator = providers_by_category_.find(category);
vitaliii4408d6c2016-11-21 14:16:24123 if (iterator == providers_by_category_.end()) {
pke9c5095ac2016-08-01 13:53:12124 return CategoryStatus::NOT_PROVIDED;
vitaliii4408d6c2016-11-21 14:16:24125 }
pke6dbb90af2016-07-08 14:00:46126
127 return iterator->second->GetCategoryStatus(category);
128}
129
pkebd2f650a2016-08-09 14:53:45130base::Optional<CategoryInfo> ContentSuggestionsService::GetCategoryInfo(
131 Category category) const {
132 auto iterator = providers_by_category_.find(category);
vitaliii4408d6c2016-11-21 14:16:24133 if (iterator == providers_by_category_.end()) {
pkebd2f650a2016-08-09 14:53:45134 return base::Optional<CategoryInfo>();
vitaliii4408d6c2016-11-21 14:16:24135 }
pkebd2f650a2016-08-09 14:53:45136 return iterator->second->GetCategoryInfo(category);
137}
138
pke6dbb90af2016-07-08 14:00:46139const std::vector<ContentSuggestion>&
pke9c5095ac2016-08-01 13:53:12140ContentSuggestionsService::GetSuggestionsForCategory(Category category) const {
pke6dbb90af2016-07-08 14:00:46141 auto iterator = suggestions_by_category_.find(category);
vitaliii4408d6c2016-11-21 14:16:24142 if (iterator == suggestions_by_category_.end()) {
pke6dbb90af2016-07-08 14:00:46143 return no_suggestions_;
vitaliii4408d6c2016-11-21 14:16:24144 }
pke6dbb90af2016-07-08 14:00:46145 return iterator->second;
146}
147
148void ContentSuggestionsService::FetchSuggestionImage(
treib4bbc54922016-09-28 17:26:44149 const ContentSuggestion::ID& suggestion_id,
gaschler42544c12017-08-03 15:43:26150 ImageFetchedCallback callback) {
treib4bbc54922016-09-28 17:26:44151 if (!providers_by_category_.count(suggestion_id.category())) {
pke6dbb90af2016-07-08 14:00:46152 LOG(WARNING) << "Requested image for suggestion " << suggestion_id
treib4bbc54922016-09-28 17:26:44153 << " for unavailable category " << suggestion_id.category();
pke1da90602016-08-05 14:20:27154 base::ThreadTaskRunnerHandle::Get()->PostTask(
gaschler42544c12017-08-03 15:43:26155 FROM_HERE, base::BindOnce(std::move(callback), gfx::Image()));
pke6dbb90af2016-07-08 14:00:46156 return;
157 }
treib4bbc54922016-09-28 17:26:44158 providers_by_category_[suggestion_id.category()]->FetchSuggestionImage(
gaschler42544c12017-08-03 15:43:26159 suggestion_id, std::move(callback));
pke6dbb90af2016-07-08 14:00:46160}
161
Dan Harrington6eb74dc82018-03-20 17:39:18162void ContentSuggestionsService::FetchSuggestionImageData(
163 const ContentSuggestion::ID& suggestion_id,
164 ImageDataFetchedCallback callback) {
165 if (!providers_by_category_.count(suggestion_id.category())) {
166 LOG(WARNING) << "Requested image for suggestion " << suggestion_id
167 << " for unavailable category " << suggestion_id.category();
168 base::ThreadTaskRunnerHandle::Get()->PostTask(
169 FROM_HERE, base::BindOnce(std::move(callback), std::string()));
170 return;
171 }
172 providers_by_category_[suggestion_id.category()]->FetchSuggestionImageData(
173 suggestion_id, std::move(callback));
174}
175
jkrcalcd011682017-04-13 05:41:16176// TODO(jkrcal): Split the favicon fetching into a separate class.
jkrcal10004602017-03-29 07:44:28177void ContentSuggestionsService::FetchSuggestionFavicon(
178 const ContentSuggestion::ID& suggestion_id,
179 int minimum_size_in_pixel,
180 int desired_size_in_pixel,
gaschler42544c12017-08-03 15:43:26181 ImageFetchedCallback callback) {
jkrcal8083bc52017-04-24 16:34:02182 const GURL& domain_with_favicon = GetFaviconDomain(suggestion_id);
183 if (!domain_with_favicon.is_valid() || !large_icon_service_) {
jkrcal7b7e71f12017-04-06 13:12:40184 base::ThreadTaskRunnerHandle::Get()->PostTask(
gaschler42544c12017-08-03 15:43:26185 FROM_HERE, base::BindOnce(std::move(callback), gfx::Image()));
jkrcal08d79b52017-04-13 14:02:11186 RecordFaviconFetchResult(FaviconFetchResult::FAILURE);
jkrcal7b7e71f12017-04-06 13:12:40187 return;
188 }
189
jkrcal95acdc5a2017-05-19 15:34:37190 GetFaviconFromCache(domain_with_favicon, minimum_size_in_pixel,
gaschler42544c12017-08-03 15:43:26191 desired_size_in_pixel, std::move(callback),
jkrcal95acdc5a2017-05-19 15:34:37192 /*continue_to_google_server=*/true);
jkrcal7b7e71f12017-04-06 13:12:40193}
194
jkrcal8083bc52017-04-24 16:34:02195GURL ContentSuggestionsService::GetFaviconDomain(
196 const ContentSuggestion::ID& suggestion_id) {
197 const std::vector<ContentSuggestion>& suggestions =
198 suggestions_by_category_[suggestion_id.category()];
199 auto position =
200 std::find_if(suggestions.begin(), suggestions.end(),
201 [&suggestion_id](const ContentSuggestion& suggestion) {
202 return suggestion_id == suggestion.id();
203 });
204 if (position != suggestions.end()) {
205 return position->url_with_favicon();
206 }
207
208 // Look up the URL in the archive of |remote_suggestions_provider_|.
209 // TODO(jkrcal): Fix how Fetch more works or find other ways to remove this
210 // hack. crbug.com/714031
211 if (providers_by_category_[suggestion_id.category()] ==
212 remote_suggestions_provider_) {
213 return remote_suggestions_provider_->GetUrlWithFavicon(suggestion_id);
214 }
215 return GURL();
216}
217
jkrcal95acdc5a2017-05-19 15:34:37218void ContentSuggestionsService::GetFaviconFromCache(
219 const GURL& publisher_url,
220 int minimum_size_in_pixel,
221 int desired_size_in_pixel,
gaschler42544c12017-08-03 15:43:26222 ImageFetchedCallback callback,
jkrcal95acdc5a2017-05-19 15:34:37223 bool continue_to_google_server) {
224 // TODO(jkrcal): Create a general wrapper function in LargeIconService that
225 // does handle the get-from-cache-and-fallback-to-google-server functionality
226 // in one shot (for all clients that do not need to react in between).
Jan Krcalb0cbad92017-06-01 09:03:47227
228 // Use desired_size = 0 for getting the icon from the cache (so that the icon
229 // is not poorly rescaled by LargeIconService).
Yi Su4903ce52019-01-24 19:27:02230 large_icon_service_->GetLargeIconImageOrFallbackStyleForPageUrl(
Jan Krcalb0cbad92017-06-01 09:03:47231 publisher_url, minimum_size_in_pixel, /*desired_size_in_pixel=*/0,
jkrcal95acdc5a2017-05-19 15:34:37232 base::Bind(&ContentSuggestionsService::OnGetFaviconFromCacheFinished,
233 base::Unretained(this), publisher_url, minimum_size_in_pixel,
gaschler42544c12017-08-03 15:43:26234 desired_size_in_pixel, base::Passed(std::move(callback)),
235 continue_to_google_server),
jkrcal95acdc5a2017-05-19 15:34:37236 &favicons_task_tracker_);
237}
238
jkrcal7b7e71f12017-04-06 13:12:40239void ContentSuggestionsService::OnGetFaviconFromCacheFinished(
240 const GURL& publisher_url,
241 int minimum_size_in_pixel,
242 int desired_size_in_pixel,
gaschler42544c12017-08-03 15:43:26243 ImageFetchedCallback callback,
jkrcal7b7e71f12017-04-06 13:12:40244 bool continue_to_google_server,
245 const favicon_base::LargeIconImageResult& result) {
246 if (!result.image.IsEmpty()) {
gaschler42544c12017-08-03 15:43:26247 std::move(callback).Run(result.image);
jkrcal08d79b52017-04-13 14:02:11248 // The icon is from cache if we haven't gone to Google server yet. The icon
249 // is freshly fetched, otherwise.
250 RecordFaviconFetchResult(continue_to_google_server
251 ? FaviconFetchResult::SUCCESS_CACHED
252 : FaviconFetchResult::SUCCESS_FETCHED);
Jan Krcal5ade20c2017-07-11 13:03:00253 // Update the time when the icon was last requested - postpone thus the
254 // automatic eviction of the favicon from the favicon database.
255 large_icon_service_->TouchIconFromGoogleServer(result.icon_url);
jkrcal7b7e71f12017-04-06 13:12:40256 return;
257 }
258
259 if (!continue_to_google_server ||
260 (result.fallback_icon_style &&
261 !result.fallback_icon_style->is_default_background_color)) {
262 // We cannot download from the server if there is some small icon in the
jkrcal08d79b52017-04-13 14:02:11263 // cache (resulting in non-default background color) or if we already did
264 // so.
gaschler42544c12017-08-03 15:43:26265 std::move(callback).Run(gfx::Image());
jkrcal08d79b52017-04-13 14:02:11266 RecordFaviconFetchResult(FaviconFetchResult::FAILURE);
jkrcal7b7e71f12017-04-06 13:12:40267 return;
268 }
269
270 // Try to fetch the favicon from a Google favicon server.
jkrcal5de6dff2017-05-24 09:59:47271 // TODO(jkrcal): Currently used only for Articles for you which have public
272 // URLs. Let the provider decide whether |publisher_url| may be private or
273 // not.
Ramin Halavati4bf78aa2017-06-01 04:53:45274 net::NetworkTrafficAnnotationTag traffic_annotation =
275 net::DefineNetworkTrafficAnnotation("content_suggestion_get_favicon", R"(
276 semantics {
277 sender: "Content Suggestion"
278 description:
279 "Sends a request to a Google server to retrieve the favicon bitmap "
280 "for an article suggestion on the new tab page (URLs are public "
281 "and provided by Google)."
282 trigger:
283 "A request can be sent if Chrome does not have a favicon for a "
284 "particular page."
285 data: "Page URL and desired icon size."
286 destination: GOOGLE_OWNED_SERVICE
287 }
288 policy {
Ramin Halavati3b979782017-07-21 11:40:26289 cookies_allowed: NO
Ramin Halavati4bf78aa2017-06-01 04:53:45290 setting: "This feature cannot be disabled by settings."
291 policy_exception_justification: "Not implemented."
292 })");
jkrcal7b7e71f12017-04-06 13:12:40293 large_icon_service_
294 ->GetLargeIconOrFallbackStyleFromGoogleServerSkippingLocalCache(
kristiparkb9ee1082018-05-08 19:25:16295 favicon::FaviconServerFetcherParams::CreateForMobile(
296 publisher_url, minimum_size_in_pixel, desired_size_in_pixel),
Victor Hugo Vianna Silvaf969d2a42019-05-27 13:18:32297 /*may_page_url_be_private=*/false,
298 /*should_trim_page_url_path=*/false, traffic_annotation,
jkrcal7b7e71f12017-04-06 13:12:40299 base::Bind(
300 &ContentSuggestionsService::OnGetFaviconFromGoogleServerFinished,
301 base::Unretained(this), publisher_url, minimum_size_in_pixel,
gaschler42544c12017-08-03 15:43:26302 desired_size_in_pixel, base::Passed(std::move(callback))));
jkrcal7b7e71f12017-04-06 13:12:40303}
304
305void ContentSuggestionsService::OnGetFaviconFromGoogleServerFinished(
306 const GURL& publisher_url,
307 int minimum_size_in_pixel,
308 int desired_size_in_pixel,
gaschler42544c12017-08-03 15:43:26309 ImageFetchedCallback callback,
Jan Krcalf3e5733e2017-07-10 09:06:11310 favicon_base::GoogleFaviconServerRequestStatus status) {
311 if (status != favicon_base::GoogleFaviconServerRequestStatus::SUCCESS) {
gaschler42544c12017-08-03 15:43:26312 std::move(callback).Run(gfx::Image());
jkrcal08d79b52017-04-13 14:02:11313 RecordFaviconFetchResult(FaviconFetchResult::FAILURE);
jkrcal7b7e71f12017-04-06 13:12:40314 return;
315 }
316
jkrcal95acdc5a2017-05-19 15:34:37317 GetFaviconFromCache(publisher_url, minimum_size_in_pixel,
gaschler42544c12017-08-03 15:43:26318 desired_size_in_pixel, std::move(callback),
jkrcal95acdc5a2017-05-19 15:34:37319 /*continue_to_google_server=*/false);
jkrcal10004602017-03-29 07:44:28320}
321
vitaliii685fdfaa2016-08-31 11:25:46322void ContentSuggestionsService::ClearHistory(
323 base::Time begin,
324 base::Time end,
325 const base::Callback<bool(const GURL& url)>& filter) {
326 for (const auto& provider : providers_) {
327 provider->ClearHistory(begin, end, filter);
328 }
vitaliii6343b2c2017-01-04 07:57:11329 category_ranker_->ClearHistory(begin, end);
tschumann5829c3412017-01-09 21:45:43330 // This potentially removed personalized data which we shouldn't display
331 // anymore.
332 for (Observer& observer : observers_) {
333 observer.OnFullRefreshRequired();
334 }
vitaliii685fdfaa2016-08-31 11:25:46335}
336
treib7d1d7a52016-08-24 14:04:55337void ContentSuggestionsService::ClearAllCachedSuggestions() {
pke6dbb90af2016-07-08 14:00:46338 suggestions_by_category_.clear();
Jan Krcal33ed7512017-11-29 12:45:09339 for (const auto& provider : providers_) {
340 provider->ClearCachedSuggestions();
pke6dbb90af2016-07-08 14:00:46341 }
Jan Krcal33ed7512017-11-29 12:45:09342 for (Observer& observer : observers_) {
343 observer.OnFullRefreshRequired();
vitaliii4408d6c2016-11-21 14:16:24344 }
pke151b5502016-08-09 12:15:13345}
346
pkede0dd9f2016-08-23 09:18:11347void ContentSuggestionsService::GetDismissedSuggestionsForDebugging(
348 Category category,
gaschlerdf40dcc2017-08-04 14:06:37349 DismissedSuggestionsCallback callback) {
pke151b5502016-08-09 12:15:13350 auto iterator = providers_by_category_.find(category);
vitaliii4408d6c2016-11-21 14:16:24351 if (iterator != providers_by_category_.end()) {
gaschlerdf40dcc2017-08-04 14:06:37352 iterator->second->GetDismissedSuggestionsForDebugging(category,
353 std::move(callback));
vitaliii4408d6c2016-11-21 14:16:24354 } else {
gaschlerdf40dcc2017-08-04 14:06:37355 std::move(callback).Run(std::vector<ContentSuggestion>());
vitaliii4408d6c2016-11-21 14:16:24356 }
pke151b5502016-08-09 12:15:13357}
358
359void ContentSuggestionsService::ClearDismissedSuggestionsForDebugging(
360 Category category) {
361 auto iterator = providers_by_category_.find(category);
vitaliii4408d6c2016-11-21 14:16:24362 if (iterator != providers_by_category_.end()) {
pke151b5502016-08-09 12:15:13363 iterator->second->ClearDismissedSuggestionsForDebugging(category);
vitaliii4408d6c2016-11-21 14:16:24364 }
pke6dbb90af2016-07-08 14:00:46365}
366
pke2646c95b2016-07-25 12:18:44367void ContentSuggestionsService::DismissSuggestion(
treib4bbc54922016-09-28 17:26:44368 const ContentSuggestion::ID& suggestion_id) {
369 if (!providers_by_category_.count(suggestion_id.category())) {
pke2646c95b2016-07-25 12:18:44370 LOG(WARNING) << "Dismissed suggestion " << suggestion_id
treib4bbc54922016-09-28 17:26:44371 << " for unavailable category " << suggestion_id.category();
pke6dbb90af2016-07-08 14:00:46372 return;
373 }
dgnf6500c12017-05-09 17:05:31374
375 metrics::RecordContentSuggestionDismissed();
376
treib4bbc54922016-09-28 17:26:44377 providers_by_category_[suggestion_id.category()]->DismissSuggestion(
378 suggestion_id);
pke6dbb90af2016-07-08 14:00:46379
vitaliii2600e8e02016-12-09 17:23:36380 // Remove the suggestion locally if it is present. A suggestion may be missing
381 // localy e.g. if it was sent to UI through |Fetch| or it has been dismissed
382 // from a different NTP.
383 RemoveSuggestionByID(suggestion_id);
pke6dbb90af2016-07-08 14:00:46384}
385
dgn212feea3b2016-09-16 15:08:20386void ContentSuggestionsService::DismissCategory(Category category) {
387 auto providers_it = providers_by_category_.find(category);
vitaliii4408d6c2016-11-21 14:16:24388 if (providers_it == providers_by_category_.end()) {
dgn212feea3b2016-09-16 15:08:20389 return;
vitaliii4408d6c2016-11-21 14:16:24390 }
dgn212feea3b2016-09-16 15:08:20391
dgnf6500c12017-05-09 17:05:31392 metrics::RecordCategoryDismissed();
393
dgn52914722016-10-18 10:28:42394 ContentSuggestionsProvider* provider = providers_it->second;
395 UnregisterCategory(category, provider);
396
397 dismissed_providers_by_category_[category] = provider;
398 StoreDismissedCategoriesToPrefs();
vitaliii3d9423e2017-01-03 17:08:13399
400 category_ranker_->OnCategoryDismissed(category);
dgn212feea3b2016-09-16 15:08:20401}
402
mvanouwerkerk52783d92016-10-12 11:03:40403void ContentSuggestionsService::RestoreDismissedCategories() {
404 // Make a copy as the original will be modified during iteration.
405 auto dismissed_providers_by_category_copy = dismissed_providers_by_category_;
406 for (const auto& category_provider_pair :
407 dismissed_providers_by_category_copy) {
dgn52914722016-10-18 10:28:42408 RestoreDismissedCategory(category_provider_pair.first);
mvanouwerkerk52783d92016-10-12 11:03:40409 }
dgn52914722016-10-18 10:28:42410 StoreDismissedCategoriesToPrefs();
mvanouwerkerk52783d92016-10-12 11:03:40411 DCHECK(dismissed_providers_by_category_.empty());
412}
413
pke6dbb90af2016-07-08 14:00:46414void ContentSuggestionsService::AddObserver(Observer* observer) {
415 observers_.AddObserver(observer);
416}
417
418void ContentSuggestionsService::RemoveObserver(Observer* observer) {
419 observers_.RemoveObserver(observer);
420}
421
422void ContentSuggestionsService::RegisterProvider(
pke5728f082016-08-03 17:27:35423 std::unique_ptr<ContentSuggestionsProvider> provider) {
424 DCHECK(state_ == State::ENABLED);
pke5728f082016-08-03 17:27:35425 providers_.push_back(std::move(provider));
pke6dbb90af2016-07-08 14:00:46426}
427
tschumann83578aa2016-11-03 13:18:32428void ContentSuggestionsService::Fetch(
429 const Category& category,
430 const std::set<std::string>& known_suggestion_ids,
gaschlerdf40dcc2017-08-04 14:06:37431 FetchDoneCallback callback) {
tschumann83578aa2016-11-03 13:18:32432 auto providers_it = providers_by_category_.find(category);
vitaliii4408d6c2016-11-21 14:16:24433 if (providers_it == providers_by_category_.end()) {
tschumann83578aa2016-11-03 13:18:32434 return;
vitaliii4408d6c2016-11-21 14:16:24435 }
tschumann83578aa2016-11-03 13:18:32436
dgnf6500c12017-05-09 17:05:31437 metrics::RecordFetchAction();
438
gaschlerdf40dcc2017-08-04 14:06:37439 providers_it->second->Fetch(category, known_suggestion_ids,
440 std::move(callback));
tschumann83578aa2016-11-03 13:18:32441}
442
jkrcal093410c2016-12-21 16:13:55443void ContentSuggestionsService::ReloadSuggestions() {
444 for (const auto& provider : providers_) {
445 provider->ReloadSuggestions();
446 }
447}
448
dgn65d6cd82017-04-11 00:36:36449bool ContentSuggestionsService::AreRemoteSuggestionsEnabled() const {
Nicolas Dossou-gbete18994652017-07-19 16:32:17450 return remote_suggestions_provider_ &&
451 !remote_suggestions_provider_->IsDisabled();
dgnb8a8a5c2017-03-31 12:35:36452}
453
pke6dbb90af2016-07-08 14:00:46454////////////////////////////////////////////////////////////////////////////////
455// Private methods
456
457void ContentSuggestionsService::OnNewSuggestions(
pke4d3a4d62016-08-02 09:06:21458 ContentSuggestionsProvider* provider,
459 Category category,
treib62e819e2016-09-27 11:47:34460 std::vector<ContentSuggestion> suggestions) {
treib534523b2016-10-20 16:19:44461 // Providers shouldn't call this when they're in a non-available state.
462 DCHECK(
463 IsCategoryStatusInitOrAvailable(provider->GetCategoryStatus(category)));
464
dgn52914722016-10-18 10:28:42465 if (TryRegisterProviderForCategory(provider, category)) {
pke4d3a4d62016-08-02 09:06:21466 NotifyCategoryStatusChanged(category);
dgn52914722016-10-18 10:28:42467 } else if (IsCategoryDismissed(category)) {
468 // The category has been registered as a dismissed one. We need to
469 // check if the dismissal can be cleared now that we received new data.
vitaliii4408d6c2016-11-21 14:16:24470 if (suggestions.empty()) {
dgn52914722016-10-18 10:28:42471 return;
vitaliii4408d6c2016-11-21 14:16:24472 }
dgn52914722016-10-18 10:28:42473
474 RestoreDismissedCategory(category);
475 StoreDismissedCategoriesToPrefs();
476
477 NotifyCategoryStatusChanged(category);
478 }
pke3b2e3632016-08-12 12:52:53479
treib39fffa12016-10-14 14:59:10480 if (!IsCategoryStatusAvailable(provider->GetCategoryStatus(category))) {
481 // A provider shouldn't send us suggestions while it's not available.
482 DCHECK(suggestions.empty());
pke3b2e3632016-08-12 12:52:53483 return;
treib39fffa12016-10-14 14:59:10484 }
pke6dbb90af2016-07-08 14:00:46485
treib62e819e2016-09-27 11:47:34486 suggestions_by_category_[category] = std::move(suggestions);
pke6dbb90af2016-07-08 14:00:46487
vitaliii4408d6c2016-11-21 14:16:24488 for (Observer& observer : observers_) {
ericwilligers42b92c12016-10-24 20:21:13489 observer.OnNewSuggestions(category);
vitaliii4408d6c2016-11-21 14:16:24490 }
pke6dbb90af2016-07-08 14:00:46491}
492
493void ContentSuggestionsService::OnCategoryStatusChanged(
pke4d3a4d62016-08-02 09:06:21494 ContentSuggestionsProvider* provider,
495 Category category,
pke9c5095ac2016-08-01 13:53:12496 CategoryStatus new_status) {
pke4d3a4d62016-08-02 09:06:21497 if (new_status == CategoryStatus::NOT_PROVIDED) {
dgn52914722016-10-18 10:28:42498 UnregisterCategory(category, provider);
pke4d3a4d62016-08-02 09:06:21499 } else {
vitaliii4408d6c2016-11-21 14:16:24500 if (!IsCategoryStatusAvailable(new_status)) {
dgn52914722016-10-18 10:28:42501 suggestions_by_category_.erase(category);
vitaliii4408d6c2016-11-21 14:16:24502 }
dgn52914722016-10-18 10:28:42503 TryRegisterProviderForCategory(provider, category);
pke4d3a4d62016-08-02 09:06:21504 DCHECK_EQ(new_status, provider->GetCategoryStatus(category));
505 }
dgn52914722016-10-18 10:28:42506
vitaliii4408d6c2016-11-21 14:16:24507 if (!IsCategoryDismissed(category)) {
dgn52914722016-10-18 10:28:42508 NotifyCategoryStatusChanged(category);
vitaliii4408d6c2016-11-21 14:16:24509 }
pke6dbb90af2016-07-08 14:00:46510}
511
pke2a48f852016-08-18 13:33:52512void ContentSuggestionsService::OnSuggestionInvalidated(
513 ContentSuggestionsProvider* provider,
treib4bbc54922016-09-28 17:26:44514 const ContentSuggestion::ID& suggestion_id) {
515 RemoveSuggestionByID(suggestion_id);
vitaliii4408d6c2016-11-21 14:16:24516 for (Observer& observer : observers_) {
ericwilligers42b92c12016-10-24 20:21:13517 observer.OnSuggestionInvalidated(suggestion_id);
vitaliii4408d6c2016-11-21 14:16:24518 }
pke2a48f852016-08-18 13:33:52519}
Colin Blundell076714ff2018-02-12 17:26:14520// identity::IdentityManager::Observer implementation
521void ContentSuggestionsService::OnPrimaryAccountSet(
Sylvain Defresnebbed9512019-02-08 10:54:30522 const CoreAccountInfo& account_info) {
Colin Blundellce266a692018-01-16 11:07:16523 OnSignInStateChanged(/*has_signed_in=*/true);
dgnf5708892016-11-22 10:36:22524}
525
Colin Blundell076714ff2018-02-12 17:26:14526void ContentSuggestionsService::OnPrimaryAccountCleared(
Sylvain Defresne07a3bed2019-02-11 15:02:51527 const CoreAccountInfo& account_info) {
Colin Blundellce266a692018-01-16 11:07:16528 OnSignInStateChanged(/*has_signed_in=*/false);
dgnf5708892016-11-22 10:36:22529}
530
vitaliii45941152016-09-05 08:58:13531// history::HistoryServiceObserver implementation.
532void ContentSuggestionsService::OnURLsDeleted(
533 history::HistoryService* history_service,
Christian Dullweber34464892018-05-16 07:52:17534 const history::DeletionInfo& deletion_info) {
vitaliii45941152016-09-05 08:58:13535 // We don't care about expired entries.
Christian Dullweber34464892018-05-16 07:52:17536 if (deletion_info.is_from_expiration()) {
vitaliii45941152016-09-05 08:58:13537 return;
vitaliii4408d6c2016-11-21 14:16:24538 }
vitaliii45941152016-09-05 08:58:13539
Christian Dullweber34464892018-05-16 07:52:17540 if (deletion_info.IsAllHistory()) {
vitaliii45941152016-09-05 08:58:13541 base::Callback<bool(const GURL& url)> filter =
542 base::Bind([](const GURL& url) { return true; });
tschumann5829c3412017-01-09 21:45:43543 ClearHistory(base::Time(), base::Time::Max(), filter);
vitaliii45941152016-09-05 08:58:13544 } else {
tschumann5829c3412017-01-09 21:45:43545 // If a user deletes a single URL, we don't consider this a clear user
546 // intend to clear our data.
547 // TODO(tschumann): Single URL deletions should be handled on a case-by-case
548 // basis. However this depends on the provider's details and thus cannot be
549 // done here. Introduce a OnURLsDeleted() method on the providers to move
550 // this decision further down.
Christian Dullweber34464892018-05-16 07:52:17551 if (deletion_info.deleted_rows().size() < 2) {
vitaliii45941152016-09-05 08:58:13552 return;
vitaliii4408d6c2016-11-21 14:16:24553 }
vitaliii45941152016-09-05 08:58:13554 std::set<GURL> deleted_urls;
Christian Dullweber34464892018-05-16 07:52:17555 for (const history::URLRow& row : deletion_info.deleted_rows()) {
vitaliii45941152016-09-05 08:58:13556 deleted_urls.insert(row.url());
557 }
sfierae8969bc2017-03-26 18:38:41558 base::Callback<bool(const GURL& url)> filter =
559 base::Bind([](const std::set<GURL>& set,
560 const GURL& url) { return set.count(url) != 0; },
561 deleted_urls);
tschumann5829c3412017-01-09 21:45:43562 // We usually don't have any time-related information (the URLRow objects
563 // usually don't provide a |last_visit()| timestamp. Hence we simply clear
564 // the whole history for the selected URLs.
565 ClearHistory(base::Time(), base::Time::Max(), filter);
vitaliii45941152016-09-05 08:58:13566 }
567}
568
569void ContentSuggestionsService::HistoryServiceBeingDeleted(
570 history::HistoryService* history_service) {
571 history_service_observer_.RemoveAll();
572}
573
dgn52914722016-10-18 10:28:42574bool ContentSuggestionsService::TryRegisterProviderForCategory(
pke4d3a4d62016-08-02 09:06:21575 ContentSuggestionsProvider* provider,
576 Category category) {
577 auto it = providers_by_category_.find(category);
578 if (it != providers_by_category_.end()) {
579 DCHECK_EQ(it->second, provider);
580 return false;
581 }
582
mvanouwerkerk52783d92016-10-12 11:03:40583 auto dismissed_it = dismissed_providers_by_category_.find(category);
584 if (dismissed_it != dismissed_providers_by_category_.end()) {
dgn52914722016-10-18 10:28:42585 // The initialisation of dismissed categories registers them with |nullptr|
586 // for providers, we need to check for that to see if the provider is
587 // already registered or not.
588 if (!dismissed_it->second) {
589 dismissed_it->second = provider;
590 } else {
591 DCHECK_EQ(dismissed_it->second, provider);
592 }
593 return false;
mvanouwerkerk52783d92016-10-12 11:03:40594 }
595
dgn52914722016-10-18 10:28:42596 RegisterCategory(category, provider);
597 return true;
598}
599
600void ContentSuggestionsService::RegisterCategory(
601 Category category,
602 ContentSuggestionsProvider* provider) {
Jan Wilken Dörrie45d34f42019-06-08 09:40:54603 DCHECK(!base::Contains(providers_by_category_, category));
dgn52914722016-10-18 10:28:42604 DCHECK(!IsCategoryDismissed(category));
605
pke4d3a4d62016-08-02 09:06:21606 providers_by_category_[category] = provider;
607 categories_.push_back(category);
pke4d3a4d62016-08-02 09:06:21608 if (IsCategoryStatusAvailable(provider->GetCategoryStatus(category))) {
609 suggestions_by_category_.insert(
610 std::make_pair(category, std::vector<ContentSuggestion>()));
611 }
dgn52914722016-10-18 10:28:42612}
613
614void ContentSuggestionsService::UnregisterCategory(
615 Category category,
616 ContentSuggestionsProvider* provider) {
617 auto providers_it = providers_by_category_.find(category);
618 if (providers_it == providers_by_category_.end()) {
619 DCHECK(IsCategoryDismissed(category));
620 return;
621 }
622
623 DCHECK_EQ(provider, providers_it->second);
624 providers_by_category_.erase(providers_it);
625 categories_.erase(
626 std::find(categories_.begin(), categories_.end(), category));
627 suggestions_by_category_.erase(category);
pke6dbb90af2016-07-08 14:00:46628}
629
pke2a48f852016-08-18 13:33:52630bool ContentSuggestionsService::RemoveSuggestionByID(
treib4bbc54922016-09-28 17:26:44631 const ContentSuggestion::ID& suggestion_id) {
pke2a48f852016-08-18 13:33:52632 std::vector<ContentSuggestion>* suggestions =
treib4bbc54922016-09-28 17:26:44633 &suggestions_by_category_[suggestion_id.category()];
pke2a48f852016-08-18 13:33:52634 auto position =
635 std::find_if(suggestions->begin(), suggestions->end(),
636 [&suggestion_id](const ContentSuggestion& suggestion) {
637 return suggestion_id == suggestion.id();
638 });
vitaliii4408d6c2016-11-21 14:16:24639 if (position == suggestions->end()) {
pke2a48f852016-08-18 13:33:52640 return false;
vitaliii4408d6c2016-11-21 14:16:24641 }
pke2a48f852016-08-18 13:33:52642 suggestions->erase(position);
treib063e6a62016-08-25 11:34:29643
pke2a48f852016-08-18 13:33:52644 return true;
645}
646
pke9c5095ac2016-08-01 13:53:12647void ContentSuggestionsService::NotifyCategoryStatusChanged(Category category) {
vitaliii4408d6c2016-11-21 14:16:24648 for (Observer& observer : observers_) {
ericwilligers42b92c12016-10-24 20:21:13649 observer.OnCategoryStatusChanged(category, GetCategoryStatus(category));
vitaliii4408d6c2016-11-21 14:16:24650 }
pke6dbb90af2016-07-08 14:00:46651}
652
Colin Blundellce266a692018-01-16 11:07:16653void ContentSuggestionsService::OnSignInStateChanged(bool has_signed_in) {
dgnf5708892016-11-22 10:36:22654 // First notify the providers, so they can make the required changes.
655 for (const auto& provider : providers_) {
Colin Blundellce266a692018-01-16 11:07:16656 provider->OnSignInStateChanged(has_signed_in);
dgnf5708892016-11-22 10:36:22657 }
658
659 // Finally notify the observers so they refresh only after the backend is
660 // ready.
661 for (Observer& observer : observers_) {
662 observer.OnFullRefreshRequired();
663 }
664}
665
dgn52914722016-10-18 10:28:42666bool ContentSuggestionsService::IsCategoryDismissed(Category category) const {
Jan Wilken Dörrie45d34f42019-06-08 09:40:54667 return base::Contains(dismissed_providers_by_category_, category);
dgn52914722016-10-18 10:28:42668}
669
670void ContentSuggestionsService::RestoreDismissedCategory(Category category) {
671 auto dismissed_it = dismissed_providers_by_category_.find(category);
Jan Wilken Dörrie45d34f42019-06-08 09:40:54672 DCHECK(base::Contains(dismissed_providers_by_category_, category));
dgn52914722016-10-18 10:28:42673
674 // Keep the reference to the provider and remove it from the dismissed ones,
675 // because the category registration enforces that it's not dismissed.
676 ContentSuggestionsProvider* provider = dismissed_it->second;
677 dismissed_providers_by_category_.erase(dismissed_it);
678
vitaliii4408d6c2016-11-21 14:16:24679 if (provider) {
dgn52914722016-10-18 10:28:42680 RegisterCategory(category, provider);
vitaliii4408d6c2016-11-21 14:16:24681 }
dgn52914722016-10-18 10:28:42682}
683
684void ContentSuggestionsService::RestoreDismissedCategoriesFromPrefs() {
685 // This must only be called at startup.
686 DCHECK(dismissed_providers_by_category_.empty());
687 DCHECK(providers_by_category_.empty());
688
689 const base::ListValue* list =
690 pref_service_->GetList(prefs::kDismissedCategories);
jdoerriea5676c62017-04-11 18:09:14691 for (const base::Value& entry : *list) {
dgn52914722016-10-18 10:28:42692 int id = 0;
jdoerriea5676c62017-04-11 18:09:14693 if (!entry.GetAsInteger(&id)) {
694 DLOG(WARNING) << "Invalid category pref value: " << entry;
dgn52914722016-10-18 10:28:42695 continue;
696 }
697
698 // When the provider is registered, it will be stored in this map.
vitaliii7456f5a2016-12-19 11:13:25699 dismissed_providers_by_category_[Category::FromIDValue(id)] = nullptr;
dgn52914722016-10-18 10:28:42700 }
701}
702
703void ContentSuggestionsService::StoreDismissedCategoriesToPrefs() {
704 base::ListValue list;
705 for (const auto& category_provider_pair : dismissed_providers_by_category_) {
706 list.AppendInteger(category_provider_pair.first.id());
707 }
708
709 pref_service_->Set(prefs::kDismissedCategories, list);
710}
711
vitaliii69689f312017-10-25 17:36:06712void ContentSuggestionsService::DestroyCategoryAndItsProvider(
713 Category category) {
714 // Destroying articles category is more complex and not implemented.
715 DCHECK_NE(category, Category::FromKnownCategory(KnownCategories::ARTICLES));
716
717 if (providers_by_category_.count(category) != 1) {
718 return;
719 }
720
721 { // Destroy the provider and delete its mentions.
722 ContentSuggestionsProvider* raw_provider = providers_by_category_[category];
723 base::EraseIf(
724 providers_,
725 [&raw_provider](
726 const std::unique_ptr<ContentSuggestionsProvider>& provider) {
727 return provider.get() == raw_provider;
728 });
729 providers_by_category_.erase(category);
730
731 if (dismissed_providers_by_category_.count(category) == 1) {
732 dismissed_providers_by_category_[category] = nullptr;
733 }
734 }
735
736 suggestions_by_category_.erase(category);
737
738 auto it = std::find(categories_.begin(), categories_.end(), category);
739 categories_.erase(it);
740
741 // Notify observers that the category is gone.
742 NotifyCategoryStatusChanged(category);
743}
744
pke6dbb90af2016-07-08 14:00:46745} // namespace ntp_snippets