1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
|
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_UI_WEBUI_NEW_TAB_PAGE_NEW_TAB_PAGE_HANDLER_H_
#define CHROME_BROWSER_UI_WEBUI_NEW_TAB_PAGE_NEW_TAB_PAGE_HANDLER_H_
#include <optional>
#include <string>
#include <string_view>
#include <unordered_map>
#include <utility>
#include <vector>
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/scoped_observation.h"
#include "base/time/time.h"
#include "chrome/browser/new_tab_page/feature_promo_helper/new_tab_page_feature_promo_helper.h"
#include "chrome/browser/new_tab_page/microsoft_auth/microsoft_auth_service.h"
#include "chrome/browser/new_tab_page/microsoft_auth/microsoft_auth_service_observer.h"
#include "chrome/browser/new_tab_page/modules/new_tab_page_modules.h"
#include "chrome/browser/new_tab_page/promos/promo_service.h"
#include "chrome/browser/new_tab_page/promos/promo_service_observer.h"
#include "chrome/browser/optimization_guide/optimization_guide_keyed_service.h"
#include "chrome/browser/search/background/ntp_custom_background_service.h"
#include "chrome/browser/search/background/ntp_custom_background_service_observer.h"
#include "chrome/browser/themes/theme_service.h"
#include "chrome/browser/themes/theme_service_observer.h"
#include "chrome/browser/ui/search/ntp_user_data_logger.h"
#include "chrome/browser/ui/webui/new_tab_page/new_tab_page.mojom.h"
#include "chrome/common/search/ntp_logging_events.h"
#include "components/optimization_guide/core/model_execution/settings_enabled_observer.h"
#include "components/prefs/pref_change_registrar.h"
#include "components/search_provider_logos/logo_common.h"
#include "components/segmentation_platform/public/result.h"
#include "components/themes/ntp_background_service_observer.h"
#include "content/public/browser/web_contents_observer.h"
#include "mojo/public/cpp/bindings/pending_receiver.h"
#include "mojo/public/cpp/bindings/pending_remote.h"
#include "mojo/public/cpp/bindings/receiver.h"
#include "mojo/public/cpp/bindings/remote.h"
#include "ui/native_theme/native_theme.h"
#include "ui/native_theme/native_theme_observer.h"
#include "ui/shell_dialogs/select_file_dialog.h"
class GURL;
class NtpBackgroundService;
class Profile;
class MicrosoftAuthService;
class NTPUserDataLogger;
class NewTabPageFeaturePromoHelper;
namespace content {
class WebContents;
} // namespace content
namespace customize_chrome {
class SidePanelController;
} // namespace customize_chrome
namespace search_provider_logos {
class LogoService;
} // namespace search_provider_logos
namespace segmentation_platform {
class SegmentationPlatformService;
} // namespace segmentation_platform
namespace syncer {
class SyncService;
} // namespace syncer
namespace ui {
class ThemeProvider;
} // namespace ui
class NewTabPageHandler : public new_tab_page::mojom::PageHandler,
public ui::NativeThemeObserver,
public ThemeServiceObserver,
public NtpCustomBackgroundServiceObserver,
public NtpBackgroundServiceObserver,
public ui::SelectFileDialog::Listener,
public PromoServiceObserver,
public optimization_guide::SettingsEnabledObserver,
public MicrosoftAuthServiceObserver {
public:
NewTabPageHandler(mojo::PendingReceiver<new_tab_page::mojom::PageHandler>
pending_page_handler,
mojo::PendingRemote<new_tab_page::mojom::Page> pending_page,
Profile* profile,
NtpCustomBackgroundService* ntp_custom_background_service,
ThemeService* theme_service,
search_provider_logos::LogoService* logo_service,
syncer::SyncService* sync_service,
segmentation_platform::SegmentationPlatformService*
segmentation_platform_service,
content::WebContents* web_contents,
std::unique_ptr<NewTabPageFeaturePromoHelper>
customize_chrome_feature_promo_helper,
const base::Time& ntp_navigation_start_time,
const std::vector<ntp::ModuleIdDetail>* module_id_details);
NewTabPageHandler(const NewTabPageHandler&) = delete;
NewTabPageHandler& operator=(const NewTabPageHandler&) = delete;
~NewTabPageHandler() override;
// Histograms being recorded when a module is dismissed or restored.
static const char kModuleDismissedHistogram[];
static const char kModuleRestoredHistogram[];
static void RegisterProfilePrefs(PrefRegistrySimple* registry);
// This method should be called before the tab is deleted.
void TabWillDelete();
// Called when a child page wants to bind its interface in `page_`, so they
// can communicate via Mojo.
void ConnectToParentDocument(
mojo::PendingRemote<new_tab_page::mojom::MicrosoftAuthUntrustedDocument>
child_untrusted_document_remote);
// new_tab_page::mojom::PageHandler:
void SetMostVisitedSettings(bool custom_links_enabled, bool visible) override;
void GetMostVisitedSettings(GetMostVisitedSettingsCallback callback) override;
void SetBackgroundImage(const std::string& attribution_1,
const std::string& attribution_2,
const GURL& attribution_url,
const GURL& image_url,
const GURL& thumbnail_ur,
const std::string& collection_id) override;
void SetDailyRefreshCollectionId(const std::string& collection_id) override;
void SetNoBackgroundImage() override;
void GetBackgroundCollections(
GetBackgroundCollectionsCallback callback) override;
void GetBackgroundImages(const std::string& collection_id,
GetBackgroundImagesCallback callback) override;
void GetDoodle(GetDoodleCallback callback) override;
void ChooseLocalCustomBackground(
ChooseLocalCustomBackgroundCallback callback) override;
void UpdatePromoData() override;
void BlocklistPromo(const std::string& promo_id) override;
void UndoBlocklistPromo(const std::string& promo_id) override;
void OnDismissModule(const std::string& module_id) override;
void OnRestoreModule(const std::string& module_id) override;
void SetModulesVisible(bool visible) override;
void SetModuleDisabled(const std::string& module_id, bool disabled) override;
void UpdateDisabledModules() override;
void OnModulesLoadedWithData(
const std::vector<std::string>& module_ids) override;
void OnModuleUsed(const std::string& module_id) override;
void GetModulesIdNames(GetModulesIdNamesCallback callback) override;
void SetModulesOrder(const std::vector<std::string>& module_ids) override;
void GetModulesOrder(GetModulesOrderCallback callback) override;
void UpdateModulesLoadable() override;
void MaybeShowFeaturePromo(
new_tab_page::mojom::IphFeature iph_feature) override;
void OnAppRendered(double time) override;
void OnOneGoogleBarRendered(double time) override;
void OnPromoRendered(double time,
const std::optional<GURL>& log_url) override;
void OnCustomizeDialogAction(
new_tab_page::mojom::CustomizeDialogAction action) override;
void OnDoodleImageClicked(new_tab_page::mojom::DoodleImageType type,
const std::optional<GURL>& log_url) override;
void OnDoodleImageRendered(new_tab_page::mojom::DoodleImageType type,
double time,
const GURL& log_url,
OnDoodleImageRenderedCallback callback) override;
void OnDoodleShared(new_tab_page::mojom::DoodleShareChannel channel,
const std::string& doodle_id,
const std::optional<std::string>& share_id) override;
void OnPromoLinkClicked() override;
void IncrementComposeButtonShownCount() override;
void SetCustomizeChromeSidePanelControllerForTesting(
customize_chrome::SidePanelController* side_panel_controller);
private:
// ui::NativeThemeObserver:
void OnNativeThemeUpdated(ui::NativeTheme* observed_theme) override;
// ThemeServiceObserver:
void OnThemeChanged() override;
// NtpCustomBackgroundServiceObserver:
void OnCustomBackgroundImageUpdated() override;
// NtpBackgroundServiceObserver:
void OnCollectionInfoAvailable() override;
void OnCollectionImagesAvailable() override;
void OnNextCollectionImageAvailable() override;
void OnNtpBackgroundServiceShuttingDown() override;
// PromoServiceObserver:
void OnPromoDataUpdated() override;
void OnPromoServiceShuttingDown() override;
// SettingsEnabledObserver:
void OnChangeInFeatureCurrentlyEnabledState(bool is_now_enabled) override;
// MicrosoftAuthServiceObserver:
void OnAuthStateUpdated() override;
// SelectFileDialog::Listener:
void FileSelected(const ui::SelectedFileInfo& file, int index) override;
void FileSelectionCanceled() override;
void OnLogoAvailable(
GetDoodleCallback callback,
search_provider_logos::LogoCallbackReason type,
const std::optional<search_provider_logos::EncodedLogo>& logo);
void LogEvent(NTPLoggingEventType event);
typedef base::OnceCallback<void(bool success,
std::unique_ptr<std::string> body)>
OnFetchResultCallback;
void Fetch(const GURL& url, OnFetchResultCallback on_result);
void OnFetchResult(const network::SimpleURLLoader* loader,
OnFetchResultCallback on_result,
std::unique_ptr<std::string> body);
void OnLogFetchResult(OnDoodleImageRenderedCallback callback,
bool success,
std::unique_ptr<std::string> body);
bool IsCustomLinksEnabled() const;
bool IsShortcutsVisible() const;
void MaybeLaunchInteractionSurvey(std::string_view interaction,
const std::string& module_id,
int delay_time_ms = 0);
void MaybeShowWebstoreToast();
void IncrementDictPrefKeyCount(const std::string& pref_name,
const std::string& key);
// Returns a HaTS trigger id associated with the given combination of user
// interaction and module id if one exists, or nullptr otherwise to indicate
// that there is no configured survey trigger id for such combination. The
// valid interaction names are defined in `kModuleInteractionNames`. The valid
// module id strings are listed in `ntp::MakeModuleIdNames`.
const std::string& GetSurveyTriggerIdForModuleAndInteraction(
std::string_view interaction,
const std::string& module_id);
void SetModuleHidden(const std::string& module_id, bool hidden);
// Synchronizes Microsoft module enablement with their current authentication
// state. The return value indicates whether the modules should be considered
// loadable.
bool SyncMicrosoftModulesWithAuth();
ChooseLocalCustomBackgroundCallback choose_local_custom_background_callback_;
raw_ptr<NtpBackgroundService> ntp_background_service_;
raw_ptr<NtpCustomBackgroundService> ntp_custom_background_service_;
raw_ptr<search_provider_logos::LogoService> logo_service_;
raw_ptr<const ui::ThemeProvider> theme_provider_;
raw_ptr<ThemeService> theme_service_;
raw_ptr<syncer::SyncService> sync_service_;
raw_ptr<segmentation_platform::SegmentationPlatformService>
segmentation_platform_service_;
GURL last_blocklisted_;
GetBackgroundCollectionsCallback background_collections_callback_;
base::TimeTicks background_collections_request_start_time_;
std::string images_request_collection_id_;
GetBackgroundImagesCallback background_images_callback_;
base::TimeTicks background_images_request_start_time_;
std::optional<base::TimeTicks> one_google_bar_load_start_time_;
raw_ptr<Profile> profile_;
scoped_refptr<ui::SelectFileDialog> select_file_dialog_;
raw_ptr<content::WebContents> web_contents_;
std::unique_ptr<NewTabPageFeaturePromoHelper> feature_promo_helper_;
base::Time ntp_navigation_start_time_;
raw_ptr<const std::vector<ntp::ModuleIdDetail>> module_id_details_;
NTPUserDataLogger logger_;
std::unordered_map<const network::SimpleURLLoader*,
std::unique_ptr<network::SimpleURLLoader>>
loader_map_;
PrefChangeRegistrar pref_change_registrar_;
raw_ptr<PromoService> promo_service_;
raw_ptr<MicrosoftAuthService> microsoft_auth_service_;
raw_ptr<OptimizationGuideKeyedService> optimization_guide_keyed_service_;
base::ScopedObservation<ui::NativeTheme, ui::NativeThemeObserver>
native_theme_observation_{this};
base::ScopedObservation<ThemeService, ThemeServiceObserver>
theme_service_observation_{this};
base::ScopedObservation<NtpCustomBackgroundService,
NtpCustomBackgroundServiceObserver>
ntp_custom_background_service_observation_{this};
base::ScopedObservation<PromoService, PromoServiceObserver>
promo_service_observation_{this};
base::ScopedObservation<MicrosoftAuthService, MicrosoftAuthServiceObserver>
microsoft_auth_service_observation_{this};
std::optional<base::TimeTicks> promo_load_start_time_;
base::Value::Dict interaction_module_id_trigger_dict_;
// TODO(crbug.com/378475391): Make this const once the TabModel is guaranteed
// to be present during load and fixed for the NTP's lifetime.
raw_ptr<customize_chrome::SidePanelController>
customize_chrome_side_panel_controller_;
// These are located at the end of the list of member variables to ensure the
// WebUI page is disconnected before other members are destroyed.
mojo::Remote<new_tab_page::mojom::Page> page_;
mojo::Receiver<new_tab_page::mojom::PageHandler> receiver_;
base::WeakPtrFactory<NewTabPageHandler> weak_ptr_factory_{this};
};
#endif // CHROME_BROWSER_UI_WEBUI_NEW_TAB_PAGE_NEW_TAB_PAGE_HANDLER_H_
|
