| 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 | 08d79b5 | 2017-04-13 14:02:11 | [diff] [blame] | 14 | #include "base/metrics/histogram_macros.h" |
| vitaliii | 69689f31 | 2017-10-25 17:36:06 | [diff] [blame] | 15 | #include "base/stl_util.h" |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 16 | #include "base/strings/string_number_conversions.h" |
| vitaliii | 69689f31 | 2017-10-25 17:36:06 | [diff] [blame] | 17 | #include "base/strings/stringprintf.h" |
| pke | 1da9060 | 2016-08-05 14:20:27 | [diff] [blame] | 18 | #include "base/threading/thread_task_runner_handle.h" |
| jkrcal | 27b02c1 | 2017-03-21 11:18:26 | [diff] [blame] | 19 | #include "base/time/default_clock.h" |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 20 | #include "base/values.h" |
| kristipark | b9ee108 | 2018-05-08 19:25:16 | [diff] [blame] | 21 | #include "components/favicon/core/favicon_server_fetcher_params.h" |
| Chris Lu | f0b870f | 2018-11-14 00:31:37 | [diff] [blame] | 22 | #include "components/favicon/core/large_icon_service.h" |
| jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 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, |
| Natalie Chouinard | 5002421 | 2019-05-06 17:38:59 | [diff] [blame] | 64 | std::unique_ptr<RemoteSuggestionsScheduler> remote_suggestions_scheduler) |
| jkrcal | e13510e | 2016-09-08 17:56:20 | [diff] [blame] | 65 | : state_(state), |
| Colin Blundell | 076714ff | 2018-02-12 17:26:14 | [diff] [blame] | 66 | identity_manager_observer_(this), |
| jkrcal | e13510e | 2016-09-08 17:56:20 | [diff] [blame] | 67 | history_service_observer_(this), |
| jkrcal | 093410c | 2016-12-21 16:13:55 | [diff] [blame] | 68 | remote_suggestions_provider_(nullptr), |
| jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 69 | large_icon_service_(large_icon_service), |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 70 | pref_service_(pref_service), |
| jkrcal | f996646 | 2017-03-29 16:25:21 | [diff] [blame] | 71 | remote_suggestions_scheduler_(std::move(remote_suggestions_scheduler)), |
| 72 | user_classifier_(std::move(user_classifier)), |
| Natalie Chouinard | 5002421 | 2019-05-06 17:38:59 | [diff] [blame] | 73 | category_ranker_(std::move(category_ranker)) { |
| vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 74 | // Can be null in tests. |
| Colin Blundell | 076714ff | 2018-02-12 17:26:14 | [diff] [blame] | 75 | if (identity_manager) { |
| 76 | identity_manager_observer_.Add(identity_manager); |
| dgn | f570889 | 2016-11-22 10:36:22 | [diff] [blame] | 77 | } |
| 78 | |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 79 | if (history_service) { |
| vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 80 | history_service_observer_.Add(history_service); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 81 | } |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 82 | |
| 83 | RestoreDismissedCategoriesFromPrefs(); |
| vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 84 | } |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 85 | |
| treib | 62e819e | 2016-09-27 11:47:34 | [diff] [blame] | 86 | ContentSuggestionsService::~ContentSuggestionsService() = default; |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 87 | |
| 88 | void ContentSuggestionsService::Shutdown() { |
| jkrcal | 093410c | 2016-12-21 16:13:55 | [diff] [blame] | 89 | remote_suggestions_provider_ = nullptr; |
| 90 | remote_suggestions_scheduler_ = nullptr; |
| pke | 5728f08 | 2016-08-03 17:27:35 | [diff] [blame] | 91 | suggestions_by_category_.clear(); |
| 92 | providers_by_category_.clear(); |
| 93 | categories_.clear(); |
| 94 | providers_.clear(); |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 95 | state_ = State::DISABLED; |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 96 | for (Observer& observer : observers_) { |
| ericwilligers | 42b92c1 | 2016-10-24 20:21:13 | [diff] [blame] | 97 | observer.ContentSuggestionsServiceShutdown(); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 98 | } |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 99 | } |
| 100 | |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 101 | // static |
| 102 | void ContentSuggestionsService::RegisterProfilePrefs( |
| 103 | PrefRegistrySimple* registry) { |
| 104 | registry->RegisterListPref(prefs::kDismissedCategories); |
| 105 | } |
| 106 | |
| vitaliii | 8b5ab28 | 2016-12-20 11:06:22 | [diff] [blame] | 107 | std::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 | |
| pke | 9c5095ac | 2016-08-01 13:53:12 | [diff] [blame] | 116 | CategoryStatus ContentSuggestionsService::GetCategoryStatus( |
| 117 | Category category) const { |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 118 | if (state_ == State::DISABLED) { |
| pke | 9c5095ac | 2016-08-01 13:53:12 | [diff] [blame] | 119 | return CategoryStatus::ALL_SUGGESTIONS_EXPLICITLY_DISABLED; |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 120 | } |
| 121 | |
| pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 122 | auto iterator = providers_by_category_.find(category); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 123 | if (iterator == providers_by_category_.end()) { |
| pke | 9c5095ac | 2016-08-01 13:53:12 | [diff] [blame] | 124 | return CategoryStatus::NOT_PROVIDED; |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 125 | } |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 126 | |
| 127 | return iterator->second->GetCategoryStatus(category); |
| 128 | } |
| 129 | |
| pke | bd2f650a | 2016-08-09 14:53:45 | [diff] [blame] | 130 | base::Optional<CategoryInfo> ContentSuggestionsService::GetCategoryInfo( |
| 131 | Category category) const { |
| 132 | auto iterator = providers_by_category_.find(category); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 133 | if (iterator == providers_by_category_.end()) { |
| pke | bd2f650a | 2016-08-09 14:53:45 | [diff] [blame] | 134 | return base::Optional<CategoryInfo>(); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 135 | } |
| pke | bd2f650a | 2016-08-09 14:53:45 | [diff] [blame] | 136 | return iterator->second->GetCategoryInfo(category); |
| 137 | } |
| 138 | |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 139 | const std::vector<ContentSuggestion>& |
| pke | 9c5095ac | 2016-08-01 13:53:12 | [diff] [blame] | 140 | ContentSuggestionsService::GetSuggestionsForCategory(Category category) const { |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 141 | auto iterator = suggestions_by_category_.find(category); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 142 | if (iterator == suggestions_by_category_.end()) { |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 143 | return no_suggestions_; |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 144 | } |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 145 | return iterator->second; |
| 146 | } |
| 147 | |
| 148 | void ContentSuggestionsService::FetchSuggestionImage( |
| treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 149 | const ContentSuggestion::ID& suggestion_id, |
| gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 150 | ImageFetchedCallback callback) { |
| treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 151 | if (!providers_by_category_.count(suggestion_id.category())) { |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 152 | LOG(WARNING) << "Requested image for suggestion " << suggestion_id |
| treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 153 | << " for unavailable category " << suggestion_id.category(); |
| pke | 1da9060 | 2016-08-05 14:20:27 | [diff] [blame] | 154 | base::ThreadTaskRunnerHandle::Get()->PostTask( |
| gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 155 | FROM_HERE, base::BindOnce(std::move(callback), gfx::Image())); |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 156 | return; |
| 157 | } |
| treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 158 | providers_by_category_[suggestion_id.category()]->FetchSuggestionImage( |
| gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 159 | suggestion_id, std::move(callback)); |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 160 | } |
| 161 | |
| Dan Harrington | 6eb74dc8 | 2018-03-20 17:39:18 | [diff] [blame] | 162 | void 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 | |
| jkrcal | cd01168 | 2017-04-13 05:41:16 | [diff] [blame] | 176 | // TODO(jkrcal): Split the favicon fetching into a separate class. |
| jkrcal | 1000460 | 2017-03-29 07:44:28 | [diff] [blame] | 177 | void ContentSuggestionsService::FetchSuggestionFavicon( |
| 178 | const ContentSuggestion::ID& suggestion_id, |
| 179 | int minimum_size_in_pixel, |
| 180 | int desired_size_in_pixel, |
| gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 181 | ImageFetchedCallback callback) { |
| jkrcal | 8083bc5 | 2017-04-24 16:34:02 | [diff] [blame] | 182 | const GURL& domain_with_favicon = GetFaviconDomain(suggestion_id); |
| 183 | if (!domain_with_favicon.is_valid() || !large_icon_service_) { |
| jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 184 | base::ThreadTaskRunnerHandle::Get()->PostTask( |
| gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 185 | FROM_HERE, base::BindOnce(std::move(callback), gfx::Image())); |
| jkrcal | 08d79b5 | 2017-04-13 14:02:11 | [diff] [blame] | 186 | RecordFaviconFetchResult(FaviconFetchResult::FAILURE); |
| jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 187 | return; |
| 188 | } |
| 189 | |
| jkrcal | 95acdc5a | 2017-05-19 15:34:37 | [diff] [blame] | 190 | GetFaviconFromCache(domain_with_favicon, minimum_size_in_pixel, |
| gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 191 | desired_size_in_pixel, std::move(callback), |
| jkrcal | 95acdc5a | 2017-05-19 15:34:37 | [diff] [blame] | 192 | /*continue_to_google_server=*/true); |
| jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 193 | } |
| 194 | |
| jkrcal | 8083bc5 | 2017-04-24 16:34:02 | [diff] [blame] | 195 | GURL 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 | |
| jkrcal | 95acdc5a | 2017-05-19 15:34:37 | [diff] [blame] | 218 | void ContentSuggestionsService::GetFaviconFromCache( |
| 219 | const GURL& publisher_url, |
| 220 | int minimum_size_in_pixel, |
| 221 | int desired_size_in_pixel, |
| gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 222 | ImageFetchedCallback callback, |
| jkrcal | 95acdc5a | 2017-05-19 15:34:37 | [diff] [blame] | 223 | 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 Krcal | b0cbad9 | 2017-06-01 09:03:47 | [diff] [blame] | 227 | |
| 228 | // Use desired_size = 0 for getting the icon from the cache (so that the icon |
| 229 | // is not poorly rescaled by LargeIconService). |
| Yi Su | 4903ce5 | 2019-01-24 19:27:02 | [diff] [blame] | 230 | large_icon_service_->GetLargeIconImageOrFallbackStyleForPageUrl( |
| Jan Krcal | b0cbad9 | 2017-06-01 09:03:47 | [diff] [blame] | 231 | publisher_url, minimum_size_in_pixel, /*desired_size_in_pixel=*/0, |
| jkrcal | 95acdc5a | 2017-05-19 15:34:37 | [diff] [blame] | 232 | base::Bind(&ContentSuggestionsService::OnGetFaviconFromCacheFinished, |
| 233 | base::Unretained(this), publisher_url, minimum_size_in_pixel, |
| gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 234 | desired_size_in_pixel, base::Passed(std::move(callback)), |
| 235 | continue_to_google_server), |
| jkrcal | 95acdc5a | 2017-05-19 15:34:37 | [diff] [blame] | 236 | &favicons_task_tracker_); |
| 237 | } |
| 238 | |
| jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 239 | void ContentSuggestionsService::OnGetFaviconFromCacheFinished( |
| 240 | const GURL& publisher_url, |
| 241 | int minimum_size_in_pixel, |
| 242 | int desired_size_in_pixel, |
| gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 243 | ImageFetchedCallback callback, |
| jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 244 | bool continue_to_google_server, |
| 245 | const favicon_base::LargeIconImageResult& result) { |
| 246 | if (!result.image.IsEmpty()) { |
| gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 247 | std::move(callback).Run(result.image); |
| jkrcal | 08d79b5 | 2017-04-13 14:02:11 | [diff] [blame] | 248 | // 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 Krcal | 5ade20c | 2017-07-11 13:03:00 | [diff] [blame] | 253 | // 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); |
| jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 256 | 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 |
| jkrcal | 08d79b5 | 2017-04-13 14:02:11 | [diff] [blame] | 263 | // cache (resulting in non-default background color) or if we already did |
| 264 | // so. |
| gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 265 | std::move(callback).Run(gfx::Image()); |
| jkrcal | 08d79b5 | 2017-04-13 14:02:11 | [diff] [blame] | 266 | RecordFaviconFetchResult(FaviconFetchResult::FAILURE); |
| jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 267 | return; |
| 268 | } |
| 269 | |
| 270 | // Try to fetch the favicon from a Google favicon server. |
| jkrcal | 5de6dff | 2017-05-24 09:59:47 | [diff] [blame] | 271 | // 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 Halavati | 4bf78aa | 2017-06-01 04:53:45 | [diff] [blame] | 274 | 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 Halavati | 3b97978 | 2017-07-21 11:40:26 | [diff] [blame] | 289 | cookies_allowed: NO |
| Ramin Halavati | 4bf78aa | 2017-06-01 04:53:45 | [diff] [blame] | 290 | setting: "This feature cannot be disabled by settings." |
| 291 | policy_exception_justification: "Not implemented." |
| 292 | })"); |
| jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 293 | large_icon_service_ |
| 294 | ->GetLargeIconOrFallbackStyleFromGoogleServerSkippingLocalCache( |
| kristipark | b9ee108 | 2018-05-08 19:25:16 | [diff] [blame] | 295 | favicon::FaviconServerFetcherParams::CreateForMobile( |
| 296 | publisher_url, minimum_size_in_pixel, desired_size_in_pixel), |
| Victor Hugo Vianna Silva | f969d2a4 | 2019-05-27 13:18:32 | [diff] [blame] | 297 | /*may_page_url_be_private=*/false, |
| 298 | /*should_trim_page_url_path=*/false, traffic_annotation, |
| jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 299 | base::Bind( |
| 300 | &ContentSuggestionsService::OnGetFaviconFromGoogleServerFinished, |
| 301 | base::Unretained(this), publisher_url, minimum_size_in_pixel, |
| gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 302 | desired_size_in_pixel, base::Passed(std::move(callback)))); |
| jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 303 | } |
| 304 | |
| 305 | void ContentSuggestionsService::OnGetFaviconFromGoogleServerFinished( |
| 306 | const GURL& publisher_url, |
| 307 | int minimum_size_in_pixel, |
| 308 | int desired_size_in_pixel, |
| gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 309 | ImageFetchedCallback callback, |
| Jan Krcal | f3e5733e | 2017-07-10 09:06:11 | [diff] [blame] | 310 | favicon_base::GoogleFaviconServerRequestStatus status) { |
| 311 | if (status != favicon_base::GoogleFaviconServerRequestStatus::SUCCESS) { |
| gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 312 | std::move(callback).Run(gfx::Image()); |
| jkrcal | 08d79b5 | 2017-04-13 14:02:11 | [diff] [blame] | 313 | RecordFaviconFetchResult(FaviconFetchResult::FAILURE); |
| jkrcal | 7b7e71f1 | 2017-04-06 13:12:40 | [diff] [blame] | 314 | return; |
| 315 | } |
| 316 | |
| jkrcal | 95acdc5a | 2017-05-19 15:34:37 | [diff] [blame] | 317 | GetFaviconFromCache(publisher_url, minimum_size_in_pixel, |
| gaschler | 42544c1 | 2017-08-03 15:43:26 | [diff] [blame] | 318 | desired_size_in_pixel, std::move(callback), |
| jkrcal | 95acdc5a | 2017-05-19 15:34:37 | [diff] [blame] | 319 | /*continue_to_google_server=*/false); |
| jkrcal | 1000460 | 2017-03-29 07:44:28 | [diff] [blame] | 320 | } |
| 321 | |
| vitaliii | 685fdfaa | 2016-08-31 11:25:46 | [diff] [blame] | 322 | void 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 | } |
| vitaliii | 6343b2c | 2017-01-04 07:57:11 | [diff] [blame] | 329 | category_ranker_->ClearHistory(begin, end); |
| tschumann | 5829c341 | 2017-01-09 21:45:43 | [diff] [blame] | 330 | // This potentially removed personalized data which we shouldn't display |
| 331 | // anymore. |
| 332 | for (Observer& observer : observers_) { |
| 333 | observer.OnFullRefreshRequired(); |
| 334 | } |
| vitaliii | 685fdfaa | 2016-08-31 11:25:46 | [diff] [blame] | 335 | } |
| 336 | |
| treib | 7d1d7a5 | 2016-08-24 14:04:55 | [diff] [blame] | 337 | void ContentSuggestionsService::ClearAllCachedSuggestions() { |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 338 | suggestions_by_category_.clear(); |
| Jan Krcal | 33ed751 | 2017-11-29 12:45:09 | [diff] [blame] | 339 | for (const auto& provider : providers_) { |
| 340 | provider->ClearCachedSuggestions(); |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 341 | } |
| Jan Krcal | 33ed751 | 2017-11-29 12:45:09 | [diff] [blame] | 342 | for (Observer& observer : observers_) { |
| 343 | observer.OnFullRefreshRequired(); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 344 | } |
| pke | 151b550 | 2016-08-09 12:15:13 | [diff] [blame] | 345 | } |
| 346 | |
| pke | de0dd9f | 2016-08-23 09:18:11 | [diff] [blame] | 347 | void ContentSuggestionsService::GetDismissedSuggestionsForDebugging( |
| 348 | Category category, |
| gaschler | df40dcc | 2017-08-04 14:06:37 | [diff] [blame] | 349 | DismissedSuggestionsCallback callback) { |
| pke | 151b550 | 2016-08-09 12:15:13 | [diff] [blame] | 350 | auto iterator = providers_by_category_.find(category); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 351 | if (iterator != providers_by_category_.end()) { |
| gaschler | df40dcc | 2017-08-04 14:06:37 | [diff] [blame] | 352 | iterator->second->GetDismissedSuggestionsForDebugging(category, |
| 353 | std::move(callback)); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 354 | } else { |
| gaschler | df40dcc | 2017-08-04 14:06:37 | [diff] [blame] | 355 | std::move(callback).Run(std::vector<ContentSuggestion>()); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 356 | } |
| pke | 151b550 | 2016-08-09 12:15:13 | [diff] [blame] | 357 | } |
| 358 | |
| 359 | void ContentSuggestionsService::ClearDismissedSuggestionsForDebugging( |
| 360 | Category category) { |
| 361 | auto iterator = providers_by_category_.find(category); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 362 | if (iterator != providers_by_category_.end()) { |
| pke | 151b550 | 2016-08-09 12:15:13 | [diff] [blame] | 363 | iterator->second->ClearDismissedSuggestionsForDebugging(category); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 364 | } |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 365 | } |
| 366 | |
| pke | 2646c95b | 2016-07-25 12:18:44 | [diff] [blame] | 367 | void ContentSuggestionsService::DismissSuggestion( |
| treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 368 | const ContentSuggestion::ID& suggestion_id) { |
| 369 | if (!providers_by_category_.count(suggestion_id.category())) { |
| pke | 2646c95b | 2016-07-25 12:18:44 | [diff] [blame] | 370 | LOG(WARNING) << "Dismissed suggestion " << suggestion_id |
| treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 371 | << " for unavailable category " << suggestion_id.category(); |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 372 | return; |
| 373 | } |
| dgn | f6500c1 | 2017-05-09 17:05:31 | [diff] [blame] | 374 | |
| 375 | metrics::RecordContentSuggestionDismissed(); |
| 376 | |
| treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 377 | providers_by_category_[suggestion_id.category()]->DismissSuggestion( |
| 378 | suggestion_id); |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 379 | |
| vitaliii | 2600e8e0 | 2016-12-09 17:23:36 | [diff] [blame] | 380 | // 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); |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 384 | } |
| 385 | |
| dgn | 212feea3b | 2016-09-16 15:08:20 | [diff] [blame] | 386 | void ContentSuggestionsService::DismissCategory(Category category) { |
| 387 | auto providers_it = providers_by_category_.find(category); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 388 | if (providers_it == providers_by_category_.end()) { |
| dgn | 212feea3b | 2016-09-16 15:08:20 | [diff] [blame] | 389 | return; |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 390 | } |
| dgn | 212feea3b | 2016-09-16 15:08:20 | [diff] [blame] | 391 | |
| dgn | f6500c1 | 2017-05-09 17:05:31 | [diff] [blame] | 392 | metrics::RecordCategoryDismissed(); |
| 393 | |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 394 | ContentSuggestionsProvider* provider = providers_it->second; |
| 395 | UnregisterCategory(category, provider); |
| 396 | |
| 397 | dismissed_providers_by_category_[category] = provider; |
| 398 | StoreDismissedCategoriesToPrefs(); |
| vitaliii | 3d9423e | 2017-01-03 17:08:13 | [diff] [blame] | 399 | |
| 400 | category_ranker_->OnCategoryDismissed(category); |
| dgn | 212feea3b | 2016-09-16 15:08:20 | [diff] [blame] | 401 | } |
| 402 | |
| mvanouwerkerk | 52783d9 | 2016-10-12 11:03:40 | [diff] [blame] | 403 | void 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) { |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 408 | RestoreDismissedCategory(category_provider_pair.first); |
| mvanouwerkerk | 52783d9 | 2016-10-12 11:03:40 | [diff] [blame] | 409 | } |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 410 | StoreDismissedCategoriesToPrefs(); |
| mvanouwerkerk | 52783d9 | 2016-10-12 11:03:40 | [diff] [blame] | 411 | DCHECK(dismissed_providers_by_category_.empty()); |
| 412 | } |
| 413 | |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 414 | void ContentSuggestionsService::AddObserver(Observer* observer) { |
| 415 | observers_.AddObserver(observer); |
| 416 | } |
| 417 | |
| 418 | void ContentSuggestionsService::RemoveObserver(Observer* observer) { |
| 419 | observers_.RemoveObserver(observer); |
| 420 | } |
| 421 | |
| 422 | void ContentSuggestionsService::RegisterProvider( |
| pke | 5728f08 | 2016-08-03 17:27:35 | [diff] [blame] | 423 | std::unique_ptr<ContentSuggestionsProvider> provider) { |
| 424 | DCHECK(state_ == State::ENABLED); |
| pke | 5728f08 | 2016-08-03 17:27:35 | [diff] [blame] | 425 | providers_.push_back(std::move(provider)); |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 426 | } |
| 427 | |
| tschumann | 83578aa | 2016-11-03 13:18:32 | [diff] [blame] | 428 | void ContentSuggestionsService::Fetch( |
| 429 | const Category& category, |
| 430 | const std::set<std::string>& known_suggestion_ids, |
| gaschler | df40dcc | 2017-08-04 14:06:37 | [diff] [blame] | 431 | FetchDoneCallback callback) { |
| tschumann | 83578aa | 2016-11-03 13:18:32 | [diff] [blame] | 432 | auto providers_it = providers_by_category_.find(category); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 433 | if (providers_it == providers_by_category_.end()) { |
| tschumann | 83578aa | 2016-11-03 13:18:32 | [diff] [blame] | 434 | return; |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 435 | } |
| tschumann | 83578aa | 2016-11-03 13:18:32 | [diff] [blame] | 436 | |
| dgn | f6500c1 | 2017-05-09 17:05:31 | [diff] [blame] | 437 | metrics::RecordFetchAction(); |
| 438 | |
| gaschler | df40dcc | 2017-08-04 14:06:37 | [diff] [blame] | 439 | providers_it->second->Fetch(category, known_suggestion_ids, |
| 440 | std::move(callback)); |
| tschumann | 83578aa | 2016-11-03 13:18:32 | [diff] [blame] | 441 | } |
| 442 | |
| jkrcal | 093410c | 2016-12-21 16:13:55 | [diff] [blame] | 443 | void ContentSuggestionsService::ReloadSuggestions() { |
| 444 | for (const auto& provider : providers_) { |
| 445 | provider->ReloadSuggestions(); |
| 446 | } |
| 447 | } |
| 448 | |
| dgn | 65d6cd8 | 2017-04-11 00:36:36 | [diff] [blame] | 449 | bool ContentSuggestionsService::AreRemoteSuggestionsEnabled() const { |
| Nicolas Dossou-gbete | 1899465 | 2017-07-19 16:32:17 | [diff] [blame] | 450 | return remote_suggestions_provider_ && |
| 451 | !remote_suggestions_provider_->IsDisabled(); |
| dgn | b8a8a5c | 2017-03-31 12:35:36 | [diff] [blame] | 452 | } |
| 453 | |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 454 | //////////////////////////////////////////////////////////////////////////////// |
| 455 | // Private methods |
| 456 | |
| 457 | void ContentSuggestionsService::OnNewSuggestions( |
| pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 458 | ContentSuggestionsProvider* provider, |
| 459 | Category category, |
| treib | 62e819e | 2016-09-27 11:47:34 | [diff] [blame] | 460 | std::vector<ContentSuggestion> suggestions) { |
| treib | 534523b | 2016-10-20 16:19:44 | [diff] [blame] | 461 | // Providers shouldn't call this when they're in a non-available state. |
| 462 | DCHECK( |
| 463 | IsCategoryStatusInitOrAvailable(provider->GetCategoryStatus(category))); |
| 464 | |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 465 | if (TryRegisterProviderForCategory(provider, category)) { |
| pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 466 | NotifyCategoryStatusChanged(category); |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 467 | } 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. |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 470 | if (suggestions.empty()) { |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 471 | return; |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 472 | } |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 473 | |
| 474 | RestoreDismissedCategory(category); |
| 475 | StoreDismissedCategoriesToPrefs(); |
| 476 | |
| 477 | NotifyCategoryStatusChanged(category); |
| 478 | } |
| pke | 3b2e363 | 2016-08-12 12:52:53 | [diff] [blame] | 479 | |
| treib | 39fffa1 | 2016-10-14 14:59:10 | [diff] [blame] | 480 | if (!IsCategoryStatusAvailable(provider->GetCategoryStatus(category))) { |
| 481 | // A provider shouldn't send us suggestions while it's not available. |
| 482 | DCHECK(suggestions.empty()); |
| pke | 3b2e363 | 2016-08-12 12:52:53 | [diff] [blame] | 483 | return; |
| treib | 39fffa1 | 2016-10-14 14:59:10 | [diff] [blame] | 484 | } |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 485 | |
| treib | 62e819e | 2016-09-27 11:47:34 | [diff] [blame] | 486 | suggestions_by_category_[category] = std::move(suggestions); |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 487 | |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 488 | for (Observer& observer : observers_) { |
| ericwilligers | 42b92c1 | 2016-10-24 20:21:13 | [diff] [blame] | 489 | observer.OnNewSuggestions(category); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 490 | } |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 491 | } |
| 492 | |
| 493 | void ContentSuggestionsService::OnCategoryStatusChanged( |
| pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 494 | ContentSuggestionsProvider* provider, |
| 495 | Category category, |
| pke | 9c5095ac | 2016-08-01 13:53:12 | [diff] [blame] | 496 | CategoryStatus new_status) { |
| pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 497 | if (new_status == CategoryStatus::NOT_PROVIDED) { |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 498 | UnregisterCategory(category, provider); |
| pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 499 | } else { |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 500 | if (!IsCategoryStatusAvailable(new_status)) { |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 501 | suggestions_by_category_.erase(category); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 502 | } |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 503 | TryRegisterProviderForCategory(provider, category); |
| pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 504 | DCHECK_EQ(new_status, provider->GetCategoryStatus(category)); |
| 505 | } |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 506 | |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 507 | if (!IsCategoryDismissed(category)) { |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 508 | NotifyCategoryStatusChanged(category); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 509 | } |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 510 | } |
| 511 | |
| pke | 2a48f85 | 2016-08-18 13:33:52 | [diff] [blame] | 512 | void ContentSuggestionsService::OnSuggestionInvalidated( |
| 513 | ContentSuggestionsProvider* provider, |
| treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 514 | const ContentSuggestion::ID& suggestion_id) { |
| 515 | RemoveSuggestionByID(suggestion_id); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 516 | for (Observer& observer : observers_) { |
| ericwilligers | 42b92c1 | 2016-10-24 20:21:13 | [diff] [blame] | 517 | observer.OnSuggestionInvalidated(suggestion_id); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 518 | } |
| pke | 2a48f85 | 2016-08-18 13:33:52 | [diff] [blame] | 519 | } |
| Colin Blundell | 076714ff | 2018-02-12 17:26:14 | [diff] [blame] | 520 | // identity::IdentityManager::Observer implementation |
| 521 | void ContentSuggestionsService::OnPrimaryAccountSet( |
| Sylvain Defresne | bbed951 | 2019-02-08 10:54:30 | [diff] [blame] | 522 | const CoreAccountInfo& account_info) { |
| Colin Blundell | ce266a69 | 2018-01-16 11:07:16 | [diff] [blame] | 523 | OnSignInStateChanged(/*has_signed_in=*/true); |
| dgn | f570889 | 2016-11-22 10:36:22 | [diff] [blame] | 524 | } |
| 525 | |
| Colin Blundell | 076714ff | 2018-02-12 17:26:14 | [diff] [blame] | 526 | void ContentSuggestionsService::OnPrimaryAccountCleared( |
| Sylvain Defresne | 07a3bed | 2019-02-11 15:02:51 | [diff] [blame] | 527 | const CoreAccountInfo& account_info) { |
| Colin Blundell | ce266a69 | 2018-01-16 11:07:16 | [diff] [blame] | 528 | OnSignInStateChanged(/*has_signed_in=*/false); |
| dgn | f570889 | 2016-11-22 10:36:22 | [diff] [blame] | 529 | } |
| 530 | |
| vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 531 | // history::HistoryServiceObserver implementation. |
| 532 | void ContentSuggestionsService::OnURLsDeleted( |
| 533 | history::HistoryService* history_service, |
| Christian Dullweber | 3446489 | 2018-05-16 07:52:17 | [diff] [blame] | 534 | const history::DeletionInfo& deletion_info) { |
| vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 535 | // We don't care about expired entries. |
| Christian Dullweber | 3446489 | 2018-05-16 07:52:17 | [diff] [blame] | 536 | if (deletion_info.is_from_expiration()) { |
| vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 537 | return; |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 538 | } |
| vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 539 | |
| Christian Dullweber | 3446489 | 2018-05-16 07:52:17 | [diff] [blame] | 540 | if (deletion_info.IsAllHistory()) { |
| vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 541 | base::Callback<bool(const GURL& url)> filter = |
| 542 | base::Bind([](const GURL& url) { return true; }); |
| tschumann | 5829c341 | 2017-01-09 21:45:43 | [diff] [blame] | 543 | ClearHistory(base::Time(), base::Time::Max(), filter); |
| vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 544 | } else { |
| tschumann | 5829c341 | 2017-01-09 21:45:43 | [diff] [blame] | 545 | // 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 Dullweber | 3446489 | 2018-05-16 07:52:17 | [diff] [blame] | 551 | if (deletion_info.deleted_rows().size() < 2) { |
| vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 552 | return; |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 553 | } |
| vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 554 | std::set<GURL> deleted_urls; |
| Christian Dullweber | 3446489 | 2018-05-16 07:52:17 | [diff] [blame] | 555 | for (const history::URLRow& row : deletion_info.deleted_rows()) { |
| vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 556 | deleted_urls.insert(row.url()); |
| 557 | } |
| sfiera | e8969bc | 2017-03-26 18:38:41 | [diff] [blame] | 558 | 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); |
| tschumann | 5829c341 | 2017-01-09 21:45:43 | [diff] [blame] | 562 | // 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); |
| vitaliii | 4594115 | 2016-09-05 08:58:13 | [diff] [blame] | 566 | } |
| 567 | } |
| 568 | |
| 569 | void ContentSuggestionsService::HistoryServiceBeingDeleted( |
| 570 | history::HistoryService* history_service) { |
| 571 | history_service_observer_.RemoveAll(); |
| 572 | } |
| 573 | |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 574 | bool ContentSuggestionsService::TryRegisterProviderForCategory( |
| pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 575 | 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 | |
| mvanouwerkerk | 52783d9 | 2016-10-12 11:03:40 | [diff] [blame] | 583 | auto dismissed_it = dismissed_providers_by_category_.find(category); |
| 584 | if (dismissed_it != dismissed_providers_by_category_.end()) { |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 585 | // 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; |
| mvanouwerkerk | 52783d9 | 2016-10-12 11:03:40 | [diff] [blame] | 594 | } |
| 595 | |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 596 | RegisterCategory(category, provider); |
| 597 | return true; |
| 598 | } |
| 599 | |
| 600 | void ContentSuggestionsService::RegisterCategory( |
| 601 | Category category, |
| 602 | ContentSuggestionsProvider* provider) { |
| Jan Wilken Dörrie | 45d34f4 | 2019-06-08 09:40:54 | [diff] [blame^] | 603 | DCHECK(!base::Contains(providers_by_category_, category)); |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 604 | DCHECK(!IsCategoryDismissed(category)); |
| 605 | |
| pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 606 | providers_by_category_[category] = provider; |
| 607 | categories_.push_back(category); |
| pke | 4d3a4d6 | 2016-08-02 09:06:21 | [diff] [blame] | 608 | if (IsCategoryStatusAvailable(provider->GetCategoryStatus(category))) { |
| 609 | suggestions_by_category_.insert( |
| 610 | std::make_pair(category, std::vector<ContentSuggestion>())); |
| 611 | } |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 612 | } |
| 613 | |
| 614 | void 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); |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 628 | } |
| 629 | |
| pke | 2a48f85 | 2016-08-18 13:33:52 | [diff] [blame] | 630 | bool ContentSuggestionsService::RemoveSuggestionByID( |
| treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 631 | const ContentSuggestion::ID& suggestion_id) { |
| pke | 2a48f85 | 2016-08-18 13:33:52 | [diff] [blame] | 632 | std::vector<ContentSuggestion>* suggestions = |
| treib | 4bbc5492 | 2016-09-28 17:26:44 | [diff] [blame] | 633 | &suggestions_by_category_[suggestion_id.category()]; |
| pke | 2a48f85 | 2016-08-18 13:33:52 | [diff] [blame] | 634 | auto position = |
| 635 | std::find_if(suggestions->begin(), suggestions->end(), |
| 636 | [&suggestion_id](const ContentSuggestion& suggestion) { |
| 637 | return suggestion_id == suggestion.id(); |
| 638 | }); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 639 | if (position == suggestions->end()) { |
| pke | 2a48f85 | 2016-08-18 13:33:52 | [diff] [blame] | 640 | return false; |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 641 | } |
| pke | 2a48f85 | 2016-08-18 13:33:52 | [diff] [blame] | 642 | suggestions->erase(position); |
| treib | 063e6a6 | 2016-08-25 11:34:29 | [diff] [blame] | 643 | |
| pke | 2a48f85 | 2016-08-18 13:33:52 | [diff] [blame] | 644 | return true; |
| 645 | } |
| 646 | |
| pke | 9c5095ac | 2016-08-01 13:53:12 | [diff] [blame] | 647 | void ContentSuggestionsService::NotifyCategoryStatusChanged(Category category) { |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 648 | for (Observer& observer : observers_) { |
| ericwilligers | 42b92c1 | 2016-10-24 20:21:13 | [diff] [blame] | 649 | observer.OnCategoryStatusChanged(category, GetCategoryStatus(category)); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 650 | } |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 651 | } |
| 652 | |
| Colin Blundell | ce266a69 | 2018-01-16 11:07:16 | [diff] [blame] | 653 | void ContentSuggestionsService::OnSignInStateChanged(bool has_signed_in) { |
| dgn | f570889 | 2016-11-22 10:36:22 | [diff] [blame] | 654 | // First notify the providers, so they can make the required changes. |
| 655 | for (const auto& provider : providers_) { |
| Colin Blundell | ce266a69 | 2018-01-16 11:07:16 | [diff] [blame] | 656 | provider->OnSignInStateChanged(has_signed_in); |
| dgn | f570889 | 2016-11-22 10:36:22 | [diff] [blame] | 657 | } |
| 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 | |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 666 | bool ContentSuggestionsService::IsCategoryDismissed(Category category) const { |
| Jan Wilken Dörrie | 45d34f4 | 2019-06-08 09:40:54 | [diff] [blame^] | 667 | return base::Contains(dismissed_providers_by_category_, category); |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 668 | } |
| 669 | |
| 670 | void ContentSuggestionsService::RestoreDismissedCategory(Category category) { |
| 671 | auto dismissed_it = dismissed_providers_by_category_.find(category); |
| Jan Wilken Dörrie | 45d34f4 | 2019-06-08 09:40:54 | [diff] [blame^] | 672 | DCHECK(base::Contains(dismissed_providers_by_category_, category)); |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 673 | |
| 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 | |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 679 | if (provider) { |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 680 | RegisterCategory(category, provider); |
| vitaliii | 4408d6c | 2016-11-21 14:16:24 | [diff] [blame] | 681 | } |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 682 | } |
| 683 | |
| 684 | void 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); |
| jdoerrie | a5676c6 | 2017-04-11 18:09:14 | [diff] [blame] | 691 | for (const base::Value& entry : *list) { |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 692 | int id = 0; |
| jdoerrie | a5676c6 | 2017-04-11 18:09:14 | [diff] [blame] | 693 | if (!entry.GetAsInteger(&id)) { |
| 694 | DLOG(WARNING) << "Invalid category pref value: " << entry; |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 695 | continue; |
| 696 | } |
| 697 | |
| 698 | // When the provider is registered, it will be stored in this map. |
| vitaliii | 7456f5a | 2016-12-19 11:13:25 | [diff] [blame] | 699 | dismissed_providers_by_category_[Category::FromIDValue(id)] = nullptr; |
| dgn | 5291472 | 2016-10-18 10:28:42 | [diff] [blame] | 700 | } |
| 701 | } |
| 702 | |
| 703 | void 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 | |
| vitaliii | 69689f31 | 2017-10-25 17:36:06 | [diff] [blame] | 712 | void 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 | |
| pke | 6dbb90af | 2016-07-08 14:00:46 | [diff] [blame] | 745 | } // namespace ntp_snippets |