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
content / browser / devtools / protocol / page_handler.h [blame]
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_BROWSER_DEVTOOLS_PROTOCOL_PAGE_HANDLER_H_
#define CONTENT_BROWSER_DEVTOOLS_PROTOCOL_PAGE_HANDLER_H_
#include <stddef.h>
#include <map>
#include <memory>
#include <string>
#include <vector>
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/scoped_observation.h"
#include "build/build_config.h"
#include "cc/trees/render_frame_metadata.h"
#include "content/browser/devtools/devtools_video_consumer.h"
#include "content/browser/devtools/protocol/devtools_domain_handler.h"
#include "content/browser/devtools/protocol/devtools_download_manager_delegate.h"
#include "content/browser/devtools/protocol/page.h"
#include "content/browser/preloading/prerender/prerender_final_status.h"
#include "content/browser/renderer_host/back_forward_cache_impl.h"
#include "content/browser/renderer_host/render_widget_host_impl.h"
#include "content/public/browser/download_manager.h"
#include "content/public/browser/javascript_dialog_manager.h"
#include "content/public/browser/render_widget_host.h"
#include "content/public/browser/render_widget_host_observer.h"
#include "content/public/common/javascript_dialog_type.h"
#include "third_party/abseil-cpp/absl/types/variant.h"
#include "third_party/blink/public/mojom/manifest/manifest.mojom-forward.h"
#include "url/gurl.h"
class SkBitmap;
namespace base {
class UnguessableToken;
}
namespace gfx {
class Image;
} // namespace gfx
namespace content {
class BackForwardCacheCanStoreDocumentResult;
class DevToolsAgentHostImpl;
class FrameTreeNode;
class NavigationRequest;
class RenderFrameHostImpl;
class WebContentsImpl;
namespace protocol {
class BrowserHandler;
class EmulationHandler;
class PageHandler : public DevToolsDomainHandler,
public Page::Backend,
public RenderWidgetHostObserver,
public download::DownloadItem::Observer {
public:
PageHandler(EmulationHandler* emulation_handler,
BrowserHandler* browser_handler,
bool allow_unsafe_operations,
bool is_trusted,
std::optional<url::Origin> navigation_initiator_origin,
bool may_read_local_files);
PageHandler(const PageHandler&) = delete;
PageHandler& operator=(const PageHandler&) = delete;
~PageHandler() override;
static std::vector<PageHandler*> EnabledForWebContents(
WebContentsImpl* contents);
static std::vector<PageHandler*> ForAgentHost(DevToolsAgentHostImpl* host);
void Wire(UberDispatcher* dispatcher) override;
void SetRenderer(int process_host_id,
RenderFrameHostImpl* frame_host) override;
// Instrumentation signals.
void DidAttachInterstitialPage();
void DidDetachInterstitialPage();
using JavaScriptDialogCallback =
content::JavaScriptDialogManager::DialogClosedCallback;
void DidRunJavaScriptDialog(const GURL& url,
const std::u16string& message,
const std::u16string& default_prompt,
JavaScriptDialogType dialog_type,
bool has_non_devtools_handlers,
JavaScriptDialogCallback callback);
void DidRunBeforeUnloadConfirm(const GURL& url,
bool has_non_devtools_handlers,
JavaScriptDialogCallback callback);
void DidCloseJavaScriptDialog(bool success, const std::u16string& user_input);
void NavigationReset(NavigationRequest* navigation_request);
void DownloadWillBegin(FrameTreeNode* ftn, download::DownloadItem* item);
void OnFrameDetached(const base::UnguessableToken& frame_id);
void DidChangeFrameLoadingState(const FrameTreeNode& ftn);
bool ShouldBypassCSP();
void BackForwardCacheNotUsed(
const NavigationRequest* nav_request,
const BackForwardCacheCanStoreDocumentResult* result,
const BackForwardCacheCanStoreTreeResult* tree_result);
void IsPrerenderingAllowed(bool& is_allowed);
Response Enable() override;
Response Disable() override;
Response Crash() override;
Response Close() override;
void Reload(Maybe<bool> bypassCache,
Maybe<std::string> script_to_evaluate_on_load,
Maybe<std::string> loader_id,
std::unique_ptr<ReloadCallback> callback) override;
void Navigate(const std::string& url,
Maybe<std::string> referrer,
Maybe<std::string> transition_type,
Maybe<std::string> frame_id,
Maybe<std::string> referrer_policy,
std::unique_ptr<NavigateCallback> callback) override;
Response StopLoading() override;
using NavigationEntries = protocol::Array<Page::NavigationEntry>;
Response GetNavigationHistory(
int* current_index,
std::unique_ptr<NavigationEntries>* entries) override;
Response NavigateToHistoryEntry(int entry_id) override;
Response ResetNavigationHistory() override;
void CaptureScreenshot(
Maybe<std::string> format,
Maybe<int> quality,
Maybe<Page::Viewport> clip,
Maybe<bool> from_surface,
Maybe<bool> capture_beyond_viewport,
Maybe<bool> optimize_for_speed,
std::unique_ptr<CaptureScreenshotCallback> callback) override;
void CaptureSnapshot(
Maybe<std::string> format,
std::unique_ptr<CaptureSnapshotCallback> callback) override;
Response StartScreencast(Maybe<std::string> format,
Maybe<int> quality,
Maybe<int> max_width,
Maybe<int> max_height,
Maybe<int> every_nth_frame) override;
Response StopScreencast() override;
Response ScreencastFrameAck(int session_id) override;
Response HandleJavaScriptDialog(bool accept,
Maybe<std::string> prompt_text) override;
Response BringToFront() override;
Response SetDownloadBehavior(const std::string& behavior,
Maybe<std::string> download_path) override;
void GetAppManifest(
protocol::Maybe<std::string> manifest_id,
std::unique_ptr<GetAppManifestCallback> callback) override;
Response SetWebLifecycleState(const std::string& state) override;
void GetInstallabilityErrors(
std::unique_ptr<GetInstallabilityErrorsCallback> callback) override;
void GetManifestIcons(
std::unique_ptr<GetManifestIconsCallback> callback) override;
void GetAppId(std::unique_ptr<GetAppIdCallback> callback) override;
Response SetBypassCSP(bool enabled) override;
Response AddCompilationCache(const std::string& url,
const Binary& data) override;
Response SetPrerenderingAllowed(bool is_allowed) override;
Response AssureTopLevelActiveFrame();
private:
struct PendingScreenshotRequest;
using BitmapEncoder =
base::RepeatingCallback<std::optional<std::vector<uint8_t>>(
const SkBitmap& bitmap)>;
void CaptureFullPageScreenshot(
Maybe<std::string> format,
Maybe<int> quality,
Maybe<bool> optimize_for_speed,
std::unique_ptr<CaptureScreenshotCallback> callback,
const gfx::Size& full_page_size);
bool ShouldCaptureNextScreencastFrame();
void NotifyScreencastVisibility(bool visible);
void OnFrameFromVideoConsumer(scoped_refptr<media::VideoFrame> frame);
void ScreencastFrameCaptured(
std::unique_ptr<Page::ScreencastFrameMetadata> metadata,
const SkBitmap& bitmap);
void ScreencastFrameEncoded(
std::unique_ptr<Page::ScreencastFrameMetadata> metadata,
std::optional<std::vector<uint8_t>> data);
void ScreenshotCaptured(std::unique_ptr<PendingScreenshotRequest> request,
const gfx::Image& image);
// RenderWidgetHostObserver overrides.
void RenderWidgetHostVisibilityChanged(RenderWidgetHost* widget_host,
bool became_visible) override;
void RenderWidgetHostDestroyed(RenderWidgetHost* widget_host) override;
// DownloadItem::Observer overrides
void OnDownloadUpdated(download::DownloadItem* item) override;
void OnDownloadDestroyed(download::DownloadItem* item) override;
// Returns WebContents only if `host_` is a top level frame. Otherwise, it
// returns Response with an error.
using ResponseOrWebContents = absl::variant<Response, WebContentsImpl*>;
ResponseOrWebContents GetWebContentsForTopLevelActiveFrame();
const bool allow_unsafe_operations_;
const bool is_trusted_;
const std::optional<url::Origin> navigation_initiator_origin_;
const bool may_read_local_files_;
bool enabled_;
bool bypass_csp_ = false;
BitmapEncoder screencast_encoder_;
int screencast_max_width_;
int screencast_max_height_;
int capture_every_nth_frame_;
int session_id_;
int frame_counter_;
int frames_in_flight_;
// |video_consumer_| consumes video frames from FrameSinkVideoCapturerImpl,
// and provides PageHandler with these frames via OnFrameFromVideoConsumer.
// This is only used if Viz is enabled and if OS is not Android.
std::unique_ptr<DevToolsVideoConsumer> video_consumer_;
// The last surface size used to determine if frames with new sizes need
// to be requested. This changes due to window resizing.
gfx::Size last_surface_size_;
raw_ptr<RenderFrameHostImpl> host_;
raw_ptr<EmulationHandler> emulation_handler_;
raw_ptr<BrowserHandler> browser_handler_;
std::unique_ptr<Page::Frontend> frontend_;
base::ScopedObservation<RenderWidgetHost, RenderWidgetHostObserver>
observation_{this};
JavaScriptDialogCallback pending_dialog_;
// Maps DevTools navigation tokens to pending NavigateCallbacks.
base::flat_map<base::UnguessableToken, std::unique_ptr<NavigateCallback>>
navigate_callbacks_;
base::flat_set<raw_ptr<download::DownloadItem, CtnExperimental>>
pending_downloads_;
bool is_prerendering_allowed_ = true;
base::WeakPtrFactory<PageHandler> weak_factory_{this};
};
} // namespace protocol
} // namespace content
#endif // CONTENT_BROWSER_DEVTOOLS_PROTOCOL_PAGE_HANDLER_H_