pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 1 | // 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> |
vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 9 | #include <set> |
jkrcal | e13510e | 2016-09-08 17:56:20 | [diff] [blame] | 10 | #include <utility> |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 11 | |
| 12 | #include "base/bind.h" |
pke | 1da9060 | 2016-08-05 14:20:27 | [diff] [blame] | 13 | #include "base/location.h" |
jkrcal | 27b02c1 | 2017-03-21 11:18:26 | [diff] [blame] | 14 | #include "base/memory/ptr_util.h" |
jkrcal | 08d79b5 | 2017-04-13 14:02:11 | [diff] [blame] | 15 | #include "base/metrics/histogram_macros.h" |
vitaliii | 69689f31 | 2017-10-25 17:36:06 | [diff] [blame] | 16 | #include "base/stl_util.h" |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 17 | #include "base/strings/string_number_conversions.h" |
vitaliii | 69689f31 | 2017-10-25 17:36:06 | [diff] [blame] | 18 | #include "base/strings/stringprintf.h" |
pke | 1da9060 | 2016-08-05 14:20:27 | [diff] [blame] | 19 | #include "base/threading/thread_task_runner_handle.h" |
jkrcal | 27b02c1 | 2017-03-21 11:18:26 | [diff] [blame] | 20 | #include "base/time/default_clock.h" |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 21 | #include "base/values.h" |
jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 22 | #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" |
dgn | f6500c1 | 2017-05-09 17:05:31 | [diff] [blame] | 25 | #include "components/ntp_snippets/content_suggestions_metrics.h" |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 26 | #include "components/ntp_snippets/pref_names.h" |
jkrcal | 8083bc5 | 2017-04-24 16:34:02 | [diff] [blame] | 27 | #include "components/ntp_snippets/remote/remote_suggestions_provider.h" |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 28 | #include "components/prefs/pref_registry_simple.h" |
| 29 | #include "components/prefs/pref_service.h" |
Ramin Halavati | 4bf78aa | 2017-06-01 04:53:45 | [diff] [blame] | 30 | #include "net/traffic_annotation/network_traffic_annotation.h" |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 31 | #include "ui/gfx/image/image.h" |
| 32 | |
| 33 | namespace ntp_snippets { |
| 34 | |
jkrcal | 08d79b5 | 2017-04-13 14:02:11 | [diff] [blame] | 35 | namespace { |
| 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 |
| 41 | enum class FaviconFetchResult { |
| 42 | SUCCESS_CACHED = 0, |
| 43 | SUCCESS_FETCHED = 1, |
| 44 | FAILURE = 2, |
| 45 | COUNT = 3 |
| 46 | }; |
| 47 | |
| 48 | void RecordFaviconFetchResult(FaviconFetchResult result) { |
| 49 | UMA_HISTOGRAM_ENUMERATION( |
| 50 | "NewTabPage.ContentSuggestions.ArticleFaviconFetchResult", result, |
| 51 | FaviconFetchResult::COUNT); |
| 52 | } |
| 53 | |
| 54 | } // namespace |
| 55 | |
vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 56 | ContentSuggestionsService::ContentSuggestionsService( |
| 57 | State state, |
Colin Blundell | 076714ff | 2018-02-12 17:26:14 | [diff] [blame] | 58 | identity::IdentityManager* identity_manager, |
jkrcal | e13510e | 2016-09-08 17:56:20 | [diff] [blame] | 59 | history::HistoryService* history_service, |
jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 60 | favicon::LargeIconService* large_icon_service, |
vitaliii | 7456f5a | 2016-12-19 11:13:25 | [diff] [blame] | 61 | PrefService* pref_service, |
jkrcal | f996646 | 2017-03-29 16:25:21 | [diff] [blame] | 62 | std::unique_ptr<CategoryRanker> category_ranker, |
| 63 | std::unique_ptr<UserClassifier> user_classifier, |
Vitalii Iarko | f52ff80 | 2017-09-14 12:34:24 | [diff] [blame] | 64 | std::unique_ptr<RemoteSuggestionsScheduler> remote_suggestions_scheduler, |
| 65 | std::unique_ptr<Logger> debug_logger) |
jkrcal | e13510e | 2016-09-08 17:56:20 | [diff] [blame] | 66 | : state_(state), |
Colin Blundell | 076714ff | 2018-02-12 17:26:14 | [diff] [blame] | 67 | identity_manager_observer_(this), |
jkrcal | e13510e | 2016-09-08 17:56:20 | [diff] [blame] | 68 | history_service_observer_(this), |
jkrcal | 093410c | 2016-12-21 16:13:55 | [diff] [blame] | 69 | remote_suggestions_provider_(nullptr), |
jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 70 | large_icon_service_(large_icon_service), |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 71 | pref_service_(pref_service), |
jkrcal | f996646 | 2017-03-29 16:25:21 | [diff] [blame] | 72 | remote_suggestions_scheduler_(std::move(remote_suggestions_scheduler)), |
| 73 | user_classifier_(std::move(user_classifier)), |
Vitalii Iarko | f52ff80 | 2017-09-14 12:34:24 | [diff] [blame] | 74 | category_ranker_(std::move(category_ranker)), |
| 75 | debug_logger_(std::move(debug_logger)) { |
vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 76 | // Can be null in tests. |
Colin Blundell | 076714ff | 2018-02-12 17:26:14 | [diff] [blame] | 77 | if (identity_manager) { |
| 78 | identity_manager_observer_.Add(identity_manager); |
dgn | f570889 | 2016-11-22 10:36:22 | [diff] [blame] | 79 | } |
| 80 | |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 81 | if (history_service) { |
vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 82 | history_service_observer_.Add(history_service); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 83 | } |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 84 | |
Vitalii Iarko | f52ff80 | 2017-09-14 12:34:24 | [diff] [blame] | 85 | debug_logger_->Log(FROM_HERE, /*message=*/std::string()); |
| 86 | |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 87 | RestoreDismissedCategoriesFromPrefs(); |
vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 88 | } |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 89 | |
treib | 62e819e | 2016-09-27 11:47:34 | [diff] [blame] | 90 | ContentSuggestionsService::~ContentSuggestionsService() = default; |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 91 | |
| 92 | void ContentSuggestionsService::Shutdown() { |
jkrcal | 093410c | 2016-12-21 16:13:55 | [diff] [blame] | 93 | remote_suggestions_provider_ = nullptr; |
| 94 | remote_suggestions_scheduler_ = nullptr; |
pke | 5728f08 | 2016-08-03 17:27:35 | [diff] [blame] | 95 | suggestions_by_category_.clear(); |
| 96 | providers_by_category_.clear(); |
| 97 | categories_.clear(); |
| 98 | providers_.clear(); |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 99 | state_ = State::DISABLED; |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 100 | for (Observer& observer : observers_) { |
ericwilligers | 42b92c1 | 2016-10-24 20:21:13 | [diff] [blame] | 101 | observer.ContentSuggestionsServiceShutdown(); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 102 | } |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 103 | } |
| 104 | |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 105 | // static |
| 106 | void ContentSuggestionsService::RegisterProfilePrefs( |
| 107 | PrefRegistrySimple* registry) { |
| 108 | registry->RegisterListPref(prefs::kDismissedCategories); |
| 109 | } |
| 110 | |
vitaliii | 8b5ab28 | 2016-12-20 11:06:22 | [diff] [blame] | 111 | std::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 | |
pke | 9c5095ac | 2016-08-01 13:53:12 | [diff] [blame] | 120 | CategoryStatus ContentSuggestionsService::GetCategoryStatus( |
| 121 | Category category) const { |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 122 | if (state_ == State::DISABLED) { |
pke | 9c5095ac | 2016-08-01 13:53:12 | [diff] [blame] | 123 | return CategoryStatus::ALL_SUGGESTIONS_EXPLICITLY_DISABLED; |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 124 | } |
| 125 | |
pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 126 | auto iterator = providers_by_category_.find(category); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 127 | if (iterator == providers_by_category_.end()) { |
pke | 9c5095ac | 2016-08-01 13:53:12 | [diff] [blame] | 128 | return CategoryStatus::NOT_PROVIDED; |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 129 | } |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 130 | |
| 131 | return iterator->second->GetCategoryStatus(category); |
| 132 | } |
| 133 | |
pke | bd2f650a | 2016-08-09 14:53:45 | [diff] [blame] | 134 | base::Optional<CategoryInfo> ContentSuggestionsService::GetCategoryInfo( |
| 135 | Category category) const { |
| 136 | auto iterator = providers_by_category_.find(category); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 137 | if (iterator == providers_by_category_.end()) { |
pke | bd2f650a | 2016-08-09 14:53:45 | [diff] [blame] | 138 | return base::Optional<CategoryInfo>(); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 139 | } |
pke | bd2f650a | 2016-08-09 14:53:45 | [diff] [blame] | 140 | return iterator->second->GetCategoryInfo(category); |
| 141 | } |
| 142 | |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 143 | const std::vector<ContentSuggestion>& |
pke | 9c5095ac | 2016-08-01 13:53:12 | [diff] [blame] | 144 | ContentSuggestionsService::GetSuggestionsForCategory(Category category) const { |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 145 | auto iterator = suggestions_by_category_.find(category); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 146 | if (iterator == suggestions_by_category_.end()) { |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 147 | return no_suggestions_; |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 148 | } |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 149 | return iterator->second; |
| 150 | } |
| 151 | |
| 152 | void ContentSuggestionsService::FetchSuggestionImage( |
treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 153 | const ContentSuggestion::ID& suggestion_id, |
gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 154 | ImageFetchedCallback callback) { |
treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 155 | if (!providers_by_category_.count(suggestion_id.category())) { |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 156 | LOG(WARNING) << "Requested image for suggestion " << suggestion_id |
treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 157 | << " for unavailable category " << suggestion_id.category(); |
pke | 1da9060 | 2016-08-05 14:20:27 | [diff] [blame] | 158 | base::ThreadTaskRunnerHandle::Get()->PostTask( |
gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 159 | FROM_HERE, base::BindOnce(std::move(callback), gfx::Image())); |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 160 | return; |
| 161 | } |
treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 162 | providers_by_category_[suggestion_id.category()]->FetchSuggestionImage( |
gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 163 | suggestion_id, std::move(callback)); |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 164 | } |
| 165 | |
Dan Harrington | 6eb74dc8 | 2018-03-20 17:39:18 | [diff] [blame^] | 166 | void 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 | |
jkrcal | cd01168 | 2017-04-13 05:41:16 | [diff] [blame] | 180 | // TODO(jkrcal): Split the favicon fetching into a separate class. |
jkrcal | 1000460 | 2017-03-29 07:44:28 | [diff] [blame] | 181 | void ContentSuggestionsService::FetchSuggestionFavicon( |
| 182 | const ContentSuggestion::ID& suggestion_id, |
| 183 | int minimum_size_in_pixel, |
| 184 | int desired_size_in_pixel, |
gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 185 | ImageFetchedCallback callback) { |
jkrcal | 8083bc5 | 2017-04-24 16:34:02 | [diff] [blame] | 186 | const GURL& domain_with_favicon = GetFaviconDomain(suggestion_id); |
| 187 | if (!domain_with_favicon.is_valid() || !large_icon_service_) { |
jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 188 | base::ThreadTaskRunnerHandle::Get()->PostTask( |
gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 189 | FROM_HERE, base::BindOnce(std::move(callback), gfx::Image())); |
jkrcal | 08d79b5 | 2017-04-13 14:02:11 | [diff] [blame] | 190 | RecordFaviconFetchResult(FaviconFetchResult::FAILURE); |
jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 191 | return; |
| 192 | } |
| 193 | |
jkrcal | 95acdc5a | 2017-05-19 15:34:37 | [diff] [blame] | 194 | GetFaviconFromCache(domain_with_favicon, minimum_size_in_pixel, |
gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 195 | desired_size_in_pixel, std::move(callback), |
jkrcal | 95acdc5a | 2017-05-19 15:34:37 | [diff] [blame] | 196 | /*continue_to_google_server=*/true); |
jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 197 | } |
| 198 | |
jkrcal | 8083bc5 | 2017-04-24 16:34:02 | [diff] [blame] | 199 | GURL 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 | |
jkrcal | 95acdc5a | 2017-05-19 15:34:37 | [diff] [blame] | 222 | void ContentSuggestionsService::GetFaviconFromCache( |
| 223 | const GURL& publisher_url, |
| 224 | int minimum_size_in_pixel, |
| 225 | int desired_size_in_pixel, |
gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 226 | ImageFetchedCallback callback, |
jkrcal | 95acdc5a | 2017-05-19 15:34:37 | [diff] [blame] | 227 | 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 Krcal | b0cbad9 | 2017-06-01 09:03:47 | [diff] [blame] | 231 | |
| 232 | // Use desired_size = 0 for getting the icon from the cache (so that the icon |
| 233 | // is not poorly rescaled by LargeIconService). |
jkrcal | 95acdc5a | 2017-05-19 15:34:37 | [diff] [blame] | 234 | large_icon_service_->GetLargeIconImageOrFallbackStyle( |
Jan Krcal | b0cbad9 | 2017-06-01 09:03:47 | [diff] [blame] | 235 | publisher_url, minimum_size_in_pixel, /*desired_size_in_pixel=*/0, |
jkrcal | 95acdc5a | 2017-05-19 15:34:37 | [diff] [blame] | 236 | base::Bind(&ContentSuggestionsService::OnGetFaviconFromCacheFinished, |
| 237 | base::Unretained(this), publisher_url, minimum_size_in_pixel, |
gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 238 | desired_size_in_pixel, base::Passed(std::move(callback)), |
| 239 | continue_to_google_server), |
jkrcal | 95acdc5a | 2017-05-19 15:34:37 | [diff] [blame] | 240 | &favicons_task_tracker_); |
| 241 | } |
| 242 | |
jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 243 | void ContentSuggestionsService::OnGetFaviconFromCacheFinished( |
| 244 | const GURL& publisher_url, |
| 245 | int minimum_size_in_pixel, |
| 246 | int desired_size_in_pixel, |
gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 247 | ImageFetchedCallback callback, |
jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 248 | bool continue_to_google_server, |
| 249 | const favicon_base::LargeIconImageResult& result) { |
| 250 | if (!result.image.IsEmpty()) { |
gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 251 | std::move(callback).Run(result.image); |
jkrcal | 08d79b5 | 2017-04-13 14:02:11 | [diff] [blame] | 252 | // 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 Krcal | 5ade20c | 2017-07-11 13:03:00 | [diff] [blame] | 257 | // 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); |
jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 260 | 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 |
jkrcal | 08d79b5 | 2017-04-13 14:02:11 | [diff] [blame] | 267 | // cache (resulting in non-default background color) or if we already did |
| 268 | // so. |
gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 269 | std::move(callback).Run(gfx::Image()); |
jkrcal | 08d79b5 | 2017-04-13 14:02:11 | [diff] [blame] | 270 | RecordFaviconFetchResult(FaviconFetchResult::FAILURE); |
jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 271 | return; |
| 272 | } |
| 273 | |
| 274 | // Try to fetch the favicon from a Google favicon server. |
jkrcal | 5de6dff | 2017-05-24 09:59:47 | [diff] [blame] | 275 | // 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 Halavati | 4bf78aa | 2017-06-01 04:53:45 | [diff] [blame] | 278 | 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 Halavati | 3b97978 | 2017-07-21 11:40:26 | [diff] [blame] | 293 | cookies_allowed: NO |
Ramin Halavati | 4bf78aa | 2017-06-01 04:53:45 | [diff] [blame] | 294 | setting: "This feature cannot be disabled by settings." |
| 295 | policy_exception_justification: "Not implemented." |
| 296 | })"); |
jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 297 | large_icon_service_ |
| 298 | ->GetLargeIconOrFallbackStyleFromGoogleServerSkippingLocalCache( |
jkrcal | ff2ef68 | 2017-05-09 07:22:05 | [diff] [blame] | 299 | publisher_url, minimum_size_in_pixel, desired_size_in_pixel, |
Ramin Halavati | 4bf78aa | 2017-06-01 04:53:45 | [diff] [blame] | 300 | /*may_page_url_be_private=*/false, traffic_annotation, |
jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 301 | base::Bind( |
| 302 | &ContentSuggestionsService::OnGetFaviconFromGoogleServerFinished, |
| 303 | base::Unretained(this), publisher_url, minimum_size_in_pixel, |
gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 304 | desired_size_in_pixel, base::Passed(std::move(callback)))); |
jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 305 | } |
| 306 | |
| 307 | void ContentSuggestionsService::OnGetFaviconFromGoogleServerFinished( |
| 308 | const GURL& publisher_url, |
| 309 | int minimum_size_in_pixel, |
| 310 | int desired_size_in_pixel, |
gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 311 | ImageFetchedCallback callback, |
Jan Krcal | f3e5733e | 2017-07-10 09:06:11 | [diff] [blame] | 312 | favicon_base::GoogleFaviconServerRequestStatus status) { |
| 313 | if (status != favicon_base::GoogleFaviconServerRequestStatus::SUCCESS) { |
gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 314 | std::move(callback).Run(gfx::Image()); |
jkrcal | 08d79b5 | 2017-04-13 14:02:11 | [diff] [blame] | 315 | RecordFaviconFetchResult(FaviconFetchResult::FAILURE); |
jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 316 | return; |
| 317 | } |
| 318 | |
jkrcal | 95acdc5a | 2017-05-19 15:34:37 | [diff] [blame] | 319 | GetFaviconFromCache(publisher_url, minimum_size_in_pixel, |
gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 320 | desired_size_in_pixel, std::move(callback), |
jkrcal | 95acdc5a | 2017-05-19 15:34:37 | [diff] [blame] | 321 | /*continue_to_google_server=*/false); |
jkrcal | 1000460 | 2017-03-29 07:44:28 | [diff] [blame] | 322 | } |
| 323 | |
vitaliii | 685fdfaa | 2016-08-31 11:25:46 | [diff] [blame] | 324 | void ContentSuggestionsService::ClearHistory( |
| 325 | base::Time begin, |
| 326 | base::Time end, |
| 327 | const base::Callback<bool(const GURL& url)>& filter) { |
| 328 | for (const auto& provider : providers_) { |
| 329 | provider->ClearHistory(begin, end, filter); |
| 330 | } |
vitaliii | 6343b2c | 2017-01-04 07:57:11 | [diff] [blame] | 331 | category_ranker_->ClearHistory(begin, end); |
tschumann | 5829c341 | 2017-01-09 21:45:43 | [diff] [blame] | 332 | // This potentially removed personalized data which we shouldn't display |
| 333 | // anymore. |
| 334 | for (Observer& observer : observers_) { |
| 335 | observer.OnFullRefreshRequired(); |
| 336 | } |
vitaliii | 685fdfaa | 2016-08-31 11:25:46 | [diff] [blame] | 337 | } |
| 338 | |
treib | 7d1d7a5 | 2016-08-24 14:04:55 | [diff] [blame] | 339 | void ContentSuggestionsService::ClearAllCachedSuggestions() { |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 340 | suggestions_by_category_.clear(); |
Jan Krcal | 33ed751 | 2017-11-29 12:45:09 | [diff] [blame] | 341 | for (const auto& provider : providers_) { |
| 342 | provider->ClearCachedSuggestions(); |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 343 | } |
Jan Krcal | 33ed751 | 2017-11-29 12:45:09 | [diff] [blame] | 344 | for (Observer& observer : observers_) { |
| 345 | observer.OnFullRefreshRequired(); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 346 | } |
pke | 151b550 | 2016-08-09 12:15:13 | [diff] [blame] | 347 | } |
| 348 | |
pke | de0dd9f | 2016-08-23 09:18:11 | [diff] [blame] | 349 | void ContentSuggestionsService::GetDismissedSuggestionsForDebugging( |
| 350 | Category category, |
gaschler | df40dcc | 2017-08-04 14:06:37 | [diff] [blame] | 351 | DismissedSuggestionsCallback callback) { |
pke | 151b550 | 2016-08-09 12:15:13 | [diff] [blame] | 352 | auto iterator = providers_by_category_.find(category); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 353 | if (iterator != providers_by_category_.end()) { |
gaschler | df40dcc | 2017-08-04 14:06:37 | [diff] [blame] | 354 | iterator->second->GetDismissedSuggestionsForDebugging(category, |
| 355 | std::move(callback)); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 356 | } else { |
gaschler | df40dcc | 2017-08-04 14:06:37 | [diff] [blame] | 357 | std::move(callback).Run(std::vector<ContentSuggestion>()); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 358 | } |
pke | 151b550 | 2016-08-09 12:15:13 | [diff] [blame] | 359 | } |
| 360 | |
| 361 | void ContentSuggestionsService::ClearDismissedSuggestionsForDebugging( |
| 362 | Category category) { |
| 363 | auto iterator = providers_by_category_.find(category); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 364 | if (iterator != providers_by_category_.end()) { |
pke | 151b550 | 2016-08-09 12:15:13 | [diff] [blame] | 365 | iterator->second->ClearDismissedSuggestionsForDebugging(category); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 366 | } |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 367 | } |
| 368 | |
pke | 2646c95b | 2016-07-25 12:18:44 | [diff] [blame] | 369 | void ContentSuggestionsService::DismissSuggestion( |
treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 370 | const ContentSuggestion::ID& suggestion_id) { |
| 371 | if (!providers_by_category_.count(suggestion_id.category())) { |
pke | 2646c95b | 2016-07-25 12:18:44 | [diff] [blame] | 372 | LOG(WARNING) << "Dismissed suggestion " << suggestion_id |
treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 373 | << " for unavailable category " << suggestion_id.category(); |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 374 | return; |
| 375 | } |
dgn | f6500c1 | 2017-05-09 17:05:31 | [diff] [blame] | 376 | |
| 377 | metrics::RecordContentSuggestionDismissed(); |
| 378 | |
treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 379 | providers_by_category_[suggestion_id.category()]->DismissSuggestion( |
| 380 | suggestion_id); |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 381 | |
vitaliii | 2600e8e0 | 2016-12-09 17:23:36 | [diff] [blame] | 382 | // Remove the suggestion locally if it is present. A suggestion may be missing |
| 383 | // localy e.g. if it was sent to UI through |Fetch| or it has been dismissed |
| 384 | // from a different NTP. |
| 385 | RemoveSuggestionByID(suggestion_id); |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 386 | } |
| 387 | |
dgn | 212feea3b | 2016-09-16 15:08:20 | [diff] [blame] | 388 | void ContentSuggestionsService::DismissCategory(Category category) { |
| 389 | auto providers_it = providers_by_category_.find(category); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 390 | if (providers_it == providers_by_category_.end()) { |
dgn | 212feea3b | 2016-09-16 15:08:20 | [diff] [blame] | 391 | return; |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 392 | } |
dgn | 212feea3b | 2016-09-16 15:08:20 | [diff] [blame] | 393 | |
dgn | f6500c1 | 2017-05-09 17:05:31 | [diff] [blame] | 394 | metrics::RecordCategoryDismissed(); |
| 395 | |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 396 | ContentSuggestionsProvider* provider = providers_it->second; |
| 397 | UnregisterCategory(category, provider); |
| 398 | |
| 399 | dismissed_providers_by_category_[category] = provider; |
| 400 | StoreDismissedCategoriesToPrefs(); |
vitaliii | 3d9423e | 2017-01-03 17:08:13 | [diff] [blame] | 401 | |
| 402 | category_ranker_->OnCategoryDismissed(category); |
dgn | 212feea3b | 2016-09-16 15:08:20 | [diff] [blame] | 403 | } |
| 404 | |
mvanouwerkerk | 52783d9 | 2016-10-12 11:03:40 | [diff] [blame] | 405 | void ContentSuggestionsService::RestoreDismissedCategories() { |
| 406 | // Make a copy as the original will be modified during iteration. |
| 407 | auto dismissed_providers_by_category_copy = dismissed_providers_by_category_; |
| 408 | for (const auto& category_provider_pair : |
| 409 | dismissed_providers_by_category_copy) { |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 410 | RestoreDismissedCategory(category_provider_pair.first); |
mvanouwerkerk | 52783d9 | 2016-10-12 11:03:40 | [diff] [blame] | 411 | } |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 412 | StoreDismissedCategoriesToPrefs(); |
mvanouwerkerk | 52783d9 | 2016-10-12 11:03:40 | [diff] [blame] | 413 | DCHECK(dismissed_providers_by_category_.empty()); |
| 414 | } |
| 415 | |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 416 | void ContentSuggestionsService::AddObserver(Observer* observer) { |
| 417 | observers_.AddObserver(observer); |
| 418 | } |
| 419 | |
| 420 | void ContentSuggestionsService::RemoveObserver(Observer* observer) { |
| 421 | observers_.RemoveObserver(observer); |
| 422 | } |
| 423 | |
| 424 | void ContentSuggestionsService::RegisterProvider( |
pke | 5728f08 | 2016-08-03 17:27:35 | [diff] [blame] | 425 | std::unique_ptr<ContentSuggestionsProvider> provider) { |
| 426 | DCHECK(state_ == State::ENABLED); |
pke | 5728f08 | 2016-08-03 17:27:35 | [diff] [blame] | 427 | providers_.push_back(std::move(provider)); |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 428 | } |
| 429 | |
tschumann | 83578aa | 2016-11-03 13:18:32 | [diff] [blame] | 430 | void ContentSuggestionsService::Fetch( |
| 431 | const Category& category, |
| 432 | const std::set<std::string>& known_suggestion_ids, |
gaschler | df40dcc | 2017-08-04 14:06:37 | [diff] [blame] | 433 | FetchDoneCallback callback) { |
tschumann | 83578aa | 2016-11-03 13:18:32 | [diff] [blame] | 434 | auto providers_it = providers_by_category_.find(category); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 435 | if (providers_it == providers_by_category_.end()) { |
tschumann | 83578aa | 2016-11-03 13:18:32 | [diff] [blame] | 436 | return; |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 437 | } |
tschumann | 83578aa | 2016-11-03 13:18:32 | [diff] [blame] | 438 | |
dgn | f6500c1 | 2017-05-09 17:05:31 | [diff] [blame] | 439 | metrics::RecordFetchAction(); |
| 440 | |
gaschler | df40dcc | 2017-08-04 14:06:37 | [diff] [blame] | 441 | providers_it->second->Fetch(category, known_suggestion_ids, |
| 442 | std::move(callback)); |
tschumann | 83578aa | 2016-11-03 13:18:32 | [diff] [blame] | 443 | } |
| 444 | |
jkrcal | 093410c | 2016-12-21 16:13:55 | [diff] [blame] | 445 | void ContentSuggestionsService::ReloadSuggestions() { |
| 446 | for (const auto& provider : providers_) { |
| 447 | provider->ReloadSuggestions(); |
| 448 | } |
| 449 | } |
| 450 | |
dgn | 65d6cd8 | 2017-04-11 00:36:36 | [diff] [blame] | 451 | bool ContentSuggestionsService::AreRemoteSuggestionsEnabled() const { |
Nicolas Dossou-gbete | 1899465 | 2017-07-19 16:32:17 | [diff] [blame] | 452 | return remote_suggestions_provider_ && |
| 453 | !remote_suggestions_provider_->IsDisabled(); |
dgn | b8a8a5c | 2017-03-31 12:35:36 | [diff] [blame] | 454 | } |
| 455 | |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 456 | //////////////////////////////////////////////////////////////////////////////// |
| 457 | // Private methods |
| 458 | |
| 459 | void ContentSuggestionsService::OnNewSuggestions( |
pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 460 | ContentSuggestionsProvider* provider, |
| 461 | Category category, |
treib | 62e819e | 2016-09-27 11:47:34 | [diff] [blame] | 462 | std::vector<ContentSuggestion> suggestions) { |
treib | 534523b | 2016-10-20 16:19:44 | [diff] [blame] | 463 | // Providers shouldn't call this when they're in a non-available state. |
| 464 | DCHECK( |
| 465 | IsCategoryStatusInitOrAvailable(provider->GetCategoryStatus(category))); |
| 466 | |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 467 | if (TryRegisterProviderForCategory(provider, category)) { |
pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 468 | NotifyCategoryStatusChanged(category); |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 469 | } else if (IsCategoryDismissed(category)) { |
| 470 | // The category has been registered as a dismissed one. We need to |
| 471 | // check if the dismissal can be cleared now that we received new data. |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 472 | if (suggestions.empty()) { |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 473 | return; |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 474 | } |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 475 | |
| 476 | RestoreDismissedCategory(category); |
| 477 | StoreDismissedCategoriesToPrefs(); |
| 478 | |
| 479 | NotifyCategoryStatusChanged(category); |
| 480 | } |
pke | 3b2e363 | 2016-08-12 12:52:53 | [diff] [blame] | 481 | |
treib | 39fffa1 | 2016-10-14 14:59:10 | [diff] [blame] | 482 | if (!IsCategoryStatusAvailable(provider->GetCategoryStatus(category))) { |
| 483 | // A provider shouldn't send us suggestions while it's not available. |
| 484 | DCHECK(suggestions.empty()); |
pke | 3b2e363 | 2016-08-12 12:52:53 | [diff] [blame] | 485 | return; |
treib | 39fffa1 | 2016-10-14 14:59:10 | [diff] [blame] | 486 | } |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 487 | |
treib | 62e819e | 2016-09-27 11:47:34 | [diff] [blame] | 488 | suggestions_by_category_[category] = std::move(suggestions); |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 489 | |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 490 | for (Observer& observer : observers_) { |
ericwilligers | 42b92c1 | 2016-10-24 20:21:13 | [diff] [blame] | 491 | observer.OnNewSuggestions(category); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 492 | } |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 493 | } |
| 494 | |
| 495 | void ContentSuggestionsService::OnCategoryStatusChanged( |
pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 496 | ContentSuggestionsProvider* provider, |
| 497 | Category category, |
pke | 9c5095ac | 2016-08-01 13:53:12 | [diff] [blame] | 498 | CategoryStatus new_status) { |
pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 499 | if (new_status == CategoryStatus::NOT_PROVIDED) { |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 500 | UnregisterCategory(category, provider); |
pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 501 | } else { |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 502 | if (!IsCategoryStatusAvailable(new_status)) { |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 503 | suggestions_by_category_.erase(category); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 504 | } |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 505 | TryRegisterProviderForCategory(provider, category); |
pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 506 | DCHECK_EQ(new_status, provider->GetCategoryStatus(category)); |
| 507 | } |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 508 | |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 509 | if (!IsCategoryDismissed(category)) { |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 510 | NotifyCategoryStatusChanged(category); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 511 | } |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 512 | } |
| 513 | |
pke | 2a48f85 | 2016-08-18 13:33:52 | [diff] [blame] | 514 | void ContentSuggestionsService::OnSuggestionInvalidated( |
| 515 | ContentSuggestionsProvider* provider, |
treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 516 | const ContentSuggestion::ID& suggestion_id) { |
| 517 | RemoveSuggestionByID(suggestion_id); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 518 | for (Observer& observer : observers_) { |
ericwilligers | 42b92c1 | 2016-10-24 20:21:13 | [diff] [blame] | 519 | observer.OnSuggestionInvalidated(suggestion_id); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 520 | } |
pke | 2a48f85 | 2016-08-18 13:33:52 | [diff] [blame] | 521 | } |
Colin Blundell | 076714ff | 2018-02-12 17:26:14 | [diff] [blame] | 522 | // identity::IdentityManager::Observer implementation |
| 523 | void ContentSuggestionsService::OnPrimaryAccountSet( |
| 524 | const AccountInfo& account_info) { |
Colin Blundell | ce266a69 | 2018-01-16 11:07:16 | [diff] [blame] | 525 | OnSignInStateChanged(/*has_signed_in=*/true); |
dgn | f570889 | 2016-11-22 10:36:22 | [diff] [blame] | 526 | } |
| 527 | |
Colin Blundell | 076714ff | 2018-02-12 17:26:14 | [diff] [blame] | 528 | void ContentSuggestionsService::OnPrimaryAccountCleared( |
| 529 | const AccountInfo& account_info) { |
Colin Blundell | ce266a69 | 2018-01-16 11:07:16 | [diff] [blame] | 530 | OnSignInStateChanged(/*has_signed_in=*/false); |
dgn | f570889 | 2016-11-22 10:36:22 | [diff] [blame] | 531 | } |
| 532 | |
vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 533 | // history::HistoryServiceObserver implementation. |
| 534 | void ContentSuggestionsService::OnURLsDeleted( |
| 535 | history::HistoryService* history_service, |
| 536 | bool all_history, |
| 537 | bool expired, |
| 538 | const history::URLRows& deleted_rows, |
| 539 | const std::set<GURL>& favicon_urls) { |
| 540 | // We don't care about expired entries. |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 541 | if (expired) { |
vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 542 | return; |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 543 | } |
vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 544 | |
vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 545 | if (all_history) { |
vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 546 | base::Callback<bool(const GURL& url)> filter = |
| 547 | base::Bind([](const GURL& url) { return true; }); |
tschumann | 5829c341 | 2017-01-09 21:45:43 | [diff] [blame] | 548 | ClearHistory(base::Time(), base::Time::Max(), filter); |
vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 549 | } else { |
tschumann | 5829c341 | 2017-01-09 21:45:43 | [diff] [blame] | 550 | // If a user deletes a single URL, we don't consider this a clear user |
| 551 | // intend to clear our data. |
| 552 | // TODO(tschumann): Single URL deletions should be handled on a case-by-case |
| 553 | // basis. However this depends on the provider's details and thus cannot be |
| 554 | // done here. Introduce a OnURLsDeleted() method on the providers to move |
| 555 | // this decision further down. |
| 556 | if (deleted_rows.size() < 2) { |
vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 557 | return; |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 558 | } |
vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 559 | std::set<GURL> deleted_urls; |
| 560 | for (const history::URLRow& row : deleted_rows) { |
vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 561 | deleted_urls.insert(row.url()); |
| 562 | } |
sfiera | e8969bc | 2017-03-26 18:38:41 | [diff] [blame] | 563 | base::Callback<bool(const GURL& url)> filter = |
| 564 | base::Bind([](const std::set<GURL>& set, |
| 565 | const GURL& url) { return set.count(url) != 0; }, |
| 566 | deleted_urls); |
tschumann | 5829c341 | 2017-01-09 21:45:43 | [diff] [blame] | 567 | // We usually don't have any time-related information (the URLRow objects |
| 568 | // usually don't provide a |last_visit()| timestamp. Hence we simply clear |
| 569 | // the whole history for the selected URLs. |
| 570 | ClearHistory(base::Time(), base::Time::Max(), filter); |
vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 571 | } |
| 572 | } |
| 573 | |
| 574 | void ContentSuggestionsService::HistoryServiceBeingDeleted( |
| 575 | history::HistoryService* history_service) { |
| 576 | history_service_observer_.RemoveAll(); |
| 577 | } |
| 578 | |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 579 | bool ContentSuggestionsService::TryRegisterProviderForCategory( |
pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 580 | ContentSuggestionsProvider* provider, |
| 581 | Category category) { |
| 582 | auto it = providers_by_category_.find(category); |
| 583 | if (it != providers_by_category_.end()) { |
| 584 | DCHECK_EQ(it->second, provider); |
| 585 | return false; |
| 586 | } |
| 587 | |
mvanouwerkerk | 52783d9 | 2016-10-12 11:03:40 | [diff] [blame] | 588 | auto dismissed_it = dismissed_providers_by_category_.find(category); |
| 589 | if (dismissed_it != dismissed_providers_by_category_.end()) { |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 590 | // The initialisation of dismissed categories registers them with |nullptr| |
| 591 | // for providers, we need to check for that to see if the provider is |
| 592 | // already registered or not. |
| 593 | if (!dismissed_it->second) { |
| 594 | dismissed_it->second = provider; |
| 595 | } else { |
| 596 | DCHECK_EQ(dismissed_it->second, provider); |
| 597 | } |
| 598 | return false; |
mvanouwerkerk | 52783d9 | 2016-10-12 11:03:40 | [diff] [blame] | 599 | } |
| 600 | |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 601 | RegisterCategory(category, provider); |
| 602 | return true; |
| 603 | } |
| 604 | |
| 605 | void ContentSuggestionsService::RegisterCategory( |
| 606 | Category category, |
| 607 | ContentSuggestionsProvider* provider) { |
| 608 | DCHECK(!base::ContainsKey(providers_by_category_, category)); |
| 609 | DCHECK(!IsCategoryDismissed(category)); |
| 610 | |
pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 611 | providers_by_category_[category] = provider; |
| 612 | categories_.push_back(category); |
pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 613 | if (IsCategoryStatusAvailable(provider->GetCategoryStatus(category))) { |
| 614 | suggestions_by_category_.insert( |
| 615 | std::make_pair(category, std::vector<ContentSuggestion>())); |
| 616 | } |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 617 | } |
| 618 | |
| 619 | void ContentSuggestionsService::UnregisterCategory( |
| 620 | Category category, |
| 621 | ContentSuggestionsProvider* provider) { |
| 622 | auto providers_it = providers_by_category_.find(category); |
| 623 | if (providers_it == providers_by_category_.end()) { |
| 624 | DCHECK(IsCategoryDismissed(category)); |
| 625 | return; |
| 626 | } |
| 627 | |
| 628 | DCHECK_EQ(provider, providers_it->second); |
| 629 | providers_by_category_.erase(providers_it); |
| 630 | categories_.erase( |
| 631 | std::find(categories_.begin(), categories_.end(), category)); |
| 632 | suggestions_by_category_.erase(category); |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 633 | } |
| 634 | |
pke | 2a48f85 | 2016-08-18 13:33:52 | [diff] [blame] | 635 | bool ContentSuggestionsService::RemoveSuggestionByID( |
treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 636 | const ContentSuggestion::ID& suggestion_id) { |
pke | 2a48f85 | 2016-08-18 13:33:52 | [diff] [blame] | 637 | std::vector<ContentSuggestion>* suggestions = |
treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 638 | &suggestions_by_category_[suggestion_id.category()]; |
pke | 2a48f85 | 2016-08-18 13:33:52 | [diff] [blame] | 639 | auto position = |
| 640 | std::find_if(suggestions->begin(), suggestions->end(), |
| 641 | [&suggestion_id](const ContentSuggestion& suggestion) { |
| 642 | return suggestion_id == suggestion.id(); |
| 643 | }); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 644 | if (position == suggestions->end()) { |
pke | 2a48f85 | 2016-08-18 13:33:52 | [diff] [blame] | 645 | return false; |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 646 | } |
pke | 2a48f85 | 2016-08-18 13:33:52 | [diff] [blame] | 647 | suggestions->erase(position); |
treib | 063e6a6 | 2016-08-25 11:34:29 | [diff] [blame] | 648 | |
pke | 2a48f85 | 2016-08-18 13:33:52 | [diff] [blame] | 649 | return true; |
| 650 | } |
| 651 | |
pke | 9c5095ac | 2016-08-01 13:53:12 | [diff] [blame] | 652 | void ContentSuggestionsService::NotifyCategoryStatusChanged(Category category) { |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 653 | for (Observer& observer : observers_) { |
ericwilligers | 42b92c1 | 2016-10-24 20:21:13 | [diff] [blame] | 654 | observer.OnCategoryStatusChanged(category, GetCategoryStatus(category)); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 655 | } |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 656 | } |
| 657 | |
Colin Blundell | ce266a69 | 2018-01-16 11:07:16 | [diff] [blame] | 658 | void ContentSuggestionsService::OnSignInStateChanged(bool has_signed_in) { |
dgn | f570889 | 2016-11-22 10:36:22 | [diff] [blame] | 659 | // First notify the providers, so they can make the required changes. |
| 660 | for (const auto& provider : providers_) { |
Colin Blundell | ce266a69 | 2018-01-16 11:07:16 | [diff] [blame] | 661 | provider->OnSignInStateChanged(has_signed_in); |
dgn | f570889 | 2016-11-22 10:36:22 | [diff] [blame] | 662 | } |
| 663 | |
| 664 | // Finally notify the observers so they refresh only after the backend is |
| 665 | // ready. |
| 666 | for (Observer& observer : observers_) { |
| 667 | observer.OnFullRefreshRequired(); |
| 668 | } |
| 669 | } |
| 670 | |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 671 | bool ContentSuggestionsService::IsCategoryDismissed(Category category) const { |
| 672 | return base::ContainsKey(dismissed_providers_by_category_, category); |
| 673 | } |
| 674 | |
| 675 | void ContentSuggestionsService::RestoreDismissedCategory(Category category) { |
| 676 | auto dismissed_it = dismissed_providers_by_category_.find(category); |
| 677 | DCHECK(base::ContainsKey(dismissed_providers_by_category_, category)); |
| 678 | |
| 679 | // Keep the reference to the provider and remove it from the dismissed ones, |
| 680 | // because the category registration enforces that it's not dismissed. |
| 681 | ContentSuggestionsProvider* provider = dismissed_it->second; |
| 682 | dismissed_providers_by_category_.erase(dismissed_it); |
| 683 | |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 684 | if (provider) { |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 685 | RegisterCategory(category, provider); |
vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 686 | } |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 687 | } |
| 688 | |
| 689 | void ContentSuggestionsService::RestoreDismissedCategoriesFromPrefs() { |
| 690 | // This must only be called at startup. |
| 691 | DCHECK(dismissed_providers_by_category_.empty()); |
| 692 | DCHECK(providers_by_category_.empty()); |
| 693 | |
| 694 | const base::ListValue* list = |
| 695 | pref_service_->GetList(prefs::kDismissedCategories); |
jdoerrie | a5676c6 | 2017-04-11 18:09:14 | [diff] [blame] | 696 | for (const base::Value& entry : *list) { |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 697 | int id = 0; |
jdoerrie | a5676c6 | 2017-04-11 18:09:14 | [diff] [blame] | 698 | if (!entry.GetAsInteger(&id)) { |
| 699 | DLOG(WARNING) << "Invalid category pref value: " << entry; |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 700 | continue; |
| 701 | } |
| 702 | |
| 703 | // When the provider is registered, it will be stored in this map. |
vitaliii | 7456f5a | 2016-12-19 11:13:25 | [diff] [blame] | 704 | dismissed_providers_by_category_[Category::FromIDValue(id)] = nullptr; |
dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 705 | } |
| 706 | } |
| 707 | |
| 708 | void ContentSuggestionsService::StoreDismissedCategoriesToPrefs() { |
| 709 | base::ListValue list; |
| 710 | for (const auto& category_provider_pair : dismissed_providers_by_category_) { |
| 711 | list.AppendInteger(category_provider_pair.first.id()); |
| 712 | } |
| 713 | |
| 714 | pref_service_->Set(prefs::kDismissedCategories, list); |
| 715 | } |
| 716 | |
vitaliii | 69689f31 | 2017-10-25 17:36:06 | [diff] [blame] | 717 | void ContentSuggestionsService::DestroyCategoryAndItsProvider( |
| 718 | Category category) { |
| 719 | // Destroying articles category is more complex and not implemented. |
| 720 | DCHECK_NE(category, Category::FromKnownCategory(KnownCategories::ARTICLES)); |
| 721 | |
| 722 | if (providers_by_category_.count(category) != 1) { |
| 723 | return; |
| 724 | } |
| 725 | |
| 726 | { // Destroy the provider and delete its mentions. |
| 727 | ContentSuggestionsProvider* raw_provider = providers_by_category_[category]; |
| 728 | base::EraseIf( |
| 729 | providers_, |
| 730 | [&raw_provider]( |
| 731 | const std::unique_ptr<ContentSuggestionsProvider>& provider) { |
| 732 | return provider.get() == raw_provider; |
| 733 | }); |
| 734 | providers_by_category_.erase(category); |
| 735 | |
| 736 | if (dismissed_providers_by_category_.count(category) == 1) { |
| 737 | dismissed_providers_by_category_[category] = nullptr; |
| 738 | } |
| 739 | } |
| 740 | |
| 741 | suggestions_by_category_.erase(category); |
| 742 | |
| 743 | auto it = std::find(categories_.begin(), categories_.end(), category); |
| 744 | categories_.erase(it); |
| 745 | |
| 746 | // Notify observers that the category is gone. |
| 747 | NotifyCategoryStatusChanged(category); |
| 748 | } |
| 749 | |
pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 750 | } // namespace ntp_snippets |