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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
content / browser / devtools / protocol / emulation_handler.cc [blame]
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/browser/devtools/protocol/emulation_handler.h"
#include <utility>
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/notreached.h"
#include "base/numerics/safe_conversions.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_util.h"
#include "base/time/time.h"
#include "base/types/expected.h"
#include "base/types/expected_macros.h"
#include "build/build_config.h"
#include "components/download/public/common/download_url_parameters.h"
#include "content/browser/compute_pressure/web_contents_pressure_manager_proxy.h"
#include "content/browser/device_posture/device_posture_provider_impl.h"
#include "content/browser/devtools/devtools_agent_host_impl.h"
#include "content/browser/generic_sensor/web_contents_sensor_provider_proxy.h"
#include "content/browser/idle/idle_manager_impl.h"
#include "content/browser/renderer_host/input/touch_emulator_impl.h"
#include "content/browser/renderer_host/render_frame_host_impl.h"
#include "content/browser/renderer_host/render_widget_host_impl.h"
#include "content/browser/web_contents/web_contents_impl.h"
#include "content/public/common/content_client.h"
#include "content/public/common/url_constants.h"
#include "net/http/http_util.h"
#include "services/device/public/cpp/generic_sensor/sensor_reading.h"
#include "services/device/public/cpp/geolocation/geoposition.h"
#include "services/device/public/mojom/geolocation_context.mojom.h"
#include "services/device/public/mojom/geoposition.mojom.h"
#include "services/device/public/mojom/pressure_manager.mojom.h"
#include "services/device/public/mojom/pressure_update.mojom.h"
#include "services/device/public/mojom/sensor.mojom-shared.h"
#include "services/network/public/cpp/client_hints.h"
#include "third_party/blink/public/mojom/device_posture/device_posture_provider.mojom.h"
#include "ui/display/mojom/screen_orientation.mojom.h"
#include "ui/events/gesture_detection/gesture_provider_config_helper.h"
namespace content {
namespace protocol {
namespace {
constexpr char kCommandIsOnlyAvailableAtTopTarget[] =
"Command can only be executed on top-level targets";
#if BUILDFLAG(ENABLE_COMPUTE_PRESSURE)
constexpr char kPressureSourceIsAlreadyOverridden[] =
"The specified pressure source is already overridden";
constexpr char kPressureSourceIsNotOverridden[] =
"The specified pressure source is not being overridden";
#endif // BUILDFLAG(ENABLE_COMPUTE_PRESSURE)
constexpr char kSensorIsAlreadyOverridden[] =
"The specified sensor type is already overridden";
constexpr char kSensorIsNotOverridden[] =
"This sensor type is not being overridden with a virtual sensor";
display::mojom::ScreenOrientation WebScreenOrientationTypeFromString(
const std::string& type) {
if (type == Emulation::ScreenOrientation::TypeEnum::PortraitPrimary)
return display::mojom::ScreenOrientation::kPortraitPrimary;
if (type == Emulation::ScreenOrientation::TypeEnum::PortraitSecondary)
return display::mojom::ScreenOrientation::kPortraitSecondary;
if (type == Emulation::ScreenOrientation::TypeEnum::LandscapePrimary)
return display::mojom::ScreenOrientation::kLandscapePrimary;
if (type == Emulation::ScreenOrientation::TypeEnum::LandscapeSecondary)
return display::mojom::ScreenOrientation::kLandscapeSecondary;
return display::mojom::ScreenOrientation::kUndefined;
}
std::optional<content::DisplayFeature::Orientation>
DisplayFeatureOrientationTypeFromString(const std::string& type) {
if (type == Emulation::DisplayFeature::OrientationEnum::Vertical)
return content::DisplayFeature::Orientation::kVertical;
if (type == Emulation::DisplayFeature::OrientationEnum::Horizontal)
return content::DisplayFeature::Orientation::kHorizontal;
return std::nullopt;
}
base::expected<blink::mojom::DevicePostureType, protocol::Response>
DevicePostureTypeFromString(const std::string& type) {
if (type == Emulation::DevicePosture::TypeEnum::Continuous) {
return blink::mojom::DevicePostureType::kContinuous;
} else if (type == Emulation::DevicePosture::TypeEnum::Folded) {
return blink::mojom::DevicePostureType::kFolded;
} else {
return base::unexpected(
protocol::Response::InvalidParams("Invalid posture type"));
}
}
ui::GestureProviderConfigType TouchEmulationConfigurationToType(
const std::string& protocol_value) {
ui::GestureProviderConfigType result =
ui::GestureProviderConfigType::CURRENT_PLATFORM;
if (protocol_value ==
Emulation::SetEmitTouchEventsForMouse::ConfigurationEnum::Mobile) {
result = ui::GestureProviderConfigType::GENERIC_MOBILE;
}
if (protocol_value ==
Emulation::SetEmitTouchEventsForMouse::ConfigurationEnum::Desktop) {
result = ui::GestureProviderConfigType::GENERIC_DESKTOP;
}
return result;
}
bool ValidateClientHintString(const std::string& s) {
// Matches definition in structured headers:
// https://tools.ietf.org/html/draft-ietf-httpbis-header-structure-17#section-3.3.3
for (char c : s) {
if (!base::IsAsciiPrintable(c))
return false;
}
return true;
}
} // namespace
EmulationHandler::EmulationHandler()
: DevToolsDomainHandler(Emulation::Metainfo::domainName),
touch_emulation_enabled_(false),
device_emulation_enabled_(false),
focus_emulation_enabled_(false),
host_(nullptr) {}
EmulationHandler::~EmulationHandler() = default;
// static
std::vector<EmulationHandler*> EmulationHandler::ForAgentHost(
DevToolsAgentHostImpl* host) {
return host->HandlersByName<EmulationHandler>(
Emulation::Metainfo::domainName);
}
void EmulationHandler::SetRenderer(int process_host_id,
RenderFrameHostImpl* frame_host) {
if (host_ == frame_host)
return;
if (!frame_host) {
sensor_overrides_.clear();
#if BUILDFLAG(ENABLE_COMPUTE_PRESSURE)
pressure_overrides_.clear();
#endif // BUILDFLAG(ENABLE_COMPUTE_PRESSURE)
}
host_ = frame_host;
if (touch_emulation_enabled_)
UpdateTouchEventEmulationState();
if (device_emulation_enabled_)
UpdateDeviceEmulationState();
}
void EmulationHandler::Wire(UberDispatcher* dispatcher) {
Emulation::Dispatcher::wire(dispatcher, this);
}
Response EmulationHandler::Disable() {
if (touch_emulation_enabled_) {
touch_emulation_enabled_ = false;
UpdateTouchEventEmulationState();
}
user_agent_ = std::string();
if (device_emulation_enabled_) {
device_emulation_enabled_ = false;
UpdateDeviceEmulationState();
}
if (focus_emulation_enabled_)
SetFocusEmulationEnabled(false);
prefers_color_scheme_ = "";
prefers_reduced_motion_ = "";
prefers_reduced_transparency_ = "";
sensor_overrides_.clear();
#if BUILDFLAG(ENABLE_COMPUTE_PRESSURE)
pressure_overrides_.clear();
#endif // BUILDFLAG(ENABLE_COMPUTE_PRESSURE)
ClearDevicePostureOverride();
return Response::Success();
}
namespace {
Response ConvertSensorType(const Emulation::SensorType& type,
device::mojom::SensorType* out_type) {
if (type == Emulation::SensorTypeEnum::AbsoluteOrientation) {
*out_type = device::mojom::SensorType::ABSOLUTE_ORIENTATION_QUATERNION;
} else if (type == Emulation::SensorTypeEnum::Accelerometer) {
*out_type = device::mojom::SensorType::ACCELEROMETER;
} else if (type == Emulation::SensorTypeEnum::AmbientLight) {
*out_type = device::mojom::SensorType::AMBIENT_LIGHT;
} else if (type == Emulation::SensorTypeEnum::Gravity) {
*out_type = device::mojom::SensorType::GRAVITY;
} else if (type == Emulation::SensorTypeEnum::Gyroscope) {
*out_type = device::mojom::SensorType::GYROSCOPE;
} else if (type == Emulation::SensorTypeEnum::LinearAcceleration) {
*out_type = device::mojom::SensorType::LINEAR_ACCELERATION;
} else if (type == Emulation::SensorTypeEnum::Magnetometer) {
*out_type = device::mojom::SensorType::MAGNETOMETER;
} else if (type == Emulation::SensorTypeEnum::RelativeOrientation) {
*out_type = device::mojom::SensorType::RELATIVE_ORIENTATION_QUATERNION;
} else {
return Response::InvalidParams("Invalid sensor type: " + type);
}
return Response::Success();
}
Response ConvertSensorReading(device::mojom::SensorType type,
Emulation::SensorReading* const reading,
device::SensorReading* out_reading) {
switch (type) {
case device::mojom::SensorType::AMBIENT_LIGHT: {
if (!reading->HasSingle()) {
return Response::InvalidParams(
"This sensor type requires a 'single' parameter");
}
auto* single_value = reading->GetSingle(nullptr);
out_reading->als.value = single_value->GetValue();
break;
}
case device::mojom::SensorType::ACCELEROMETER:
case device::mojom::SensorType::GRAVITY:
case device::mojom::SensorType::GYROSCOPE:
case device::mojom::SensorType::LINEAR_ACCELERATION:
case device::mojom::SensorType::MAGNETOMETER: {
if (!reading->HasXyz()) {
return Response::InvalidParams(
"This sensor type requires an 'xyz' parameter");
}
auto* xyz = reading->GetXyz(nullptr);
out_reading->accel.x = xyz->GetX();
out_reading->accel.y = xyz->GetY();
out_reading->accel.z = xyz->GetZ();
break;
}
case device::mojom::SensorType::ABSOLUTE_ORIENTATION_QUATERNION:
case device::mojom::SensorType::RELATIVE_ORIENTATION_QUATERNION: {
if (!reading->HasQuaternion()) {
return Response::InvalidParams(
"This sensor type requires a 'quaternion' parameter");
}
auto* quaternion = reading->GetQuaternion(nullptr);
out_reading->orientation_quat.x = quaternion->GetX();
out_reading->orientation_quat.y = quaternion->GetY();
out_reading->orientation_quat.z = quaternion->GetZ();
out_reading->orientation_quat.w = quaternion->GetW();
break;
}
case device::mojom::SensorType::ABSOLUTE_ORIENTATION_EULER_ANGLES:
case device::mojom::SensorType::RELATIVE_ORIENTATION_EULER_ANGLES:
return Response::InvalidParams("Unsupported sensor type");
}
out_reading->raw.timestamp =
(base::TimeTicks::Now() - base::TimeTicks()).InSecondsF();
return Response::Success();
}
base::expected<device::mojom::VirtualSensorMetadataPtr, Response>
ParseSensorMetadata(Maybe<Emulation::SensorMetadata>& metadata) {
if (!metadata.has_value()) {
return device::mojom::VirtualSensorMetadata::New();
}
if (metadata->HasMinimumFrequency() && metadata->HasMaximumFrequency() &&
metadata->GetMinimumFrequency(0) > metadata->GetMaximumFrequency(0)) {
return base::unexpected(
Response::InvalidParams("The specified minimum frequency is higher "
"than the maximum frequency"));
}
auto virtual_sensor_metadata = device::mojom::VirtualSensorMetadata::New();
if (metadata->HasAvailable()) {
virtual_sensor_metadata->available = metadata->GetAvailable(true);
}
if (metadata->HasMinimumFrequency()) {
virtual_sensor_metadata->minimum_frequency =
metadata->GetMinimumFrequency(0);
}
if (metadata->HasMaximumFrequency()) {
virtual_sensor_metadata->maximum_frequency =
metadata->GetMaximumFrequency(0);
}
return virtual_sensor_metadata;
}
} // namespace
void EmulationHandler::GetOverriddenSensorInformation(
const Emulation::SensorType& type,
std::unique_ptr<GetOverriddenSensorInformationCallback> callback) {
if (!host_) {
callback->sendFailure(Response::InternalError());
return;
}
device::mojom::SensorType sensor_type;
if (auto response = ConvertSensorType(type, &sensor_type);
!response.IsSuccess()) {
callback->sendFailure(response);
return;
}
auto it = sensor_overrides_.find(sensor_type);
if (it == sensor_overrides_.end()) {
callback->sendFailure(Response::InvalidParams(kSensorIsNotOverridden));
return;
}
it->second->GetVirtualSensorInformation(base::BindOnce(
[](std::unique_ptr<GetOverriddenSensorInformationCallback> callback,
device::mojom::GetVirtualSensorInformationResultPtr result) {
if (result->is_error()) {
switch (result->get_error()) {
case device::mojom::GetVirtualSensorInformationError::
kSensorTypeNotOverridden:
callback->sendFailure(
Response::InvalidParams(kSensorIsNotOverridden));
return;
}
}
CHECK(result->is_info());
callback->sendSuccess(result->get_info()->sampling_frequency);
},
std::move(callback)));
}
Response EmulationHandler::SetSensorOverrideEnabled(
bool enabled,
const Emulation::SensorType& type,
Maybe<Emulation::SensorMetadata> metadata) {
if (!host_) {
return Response::InternalError();
}
device::mojom::SensorType sensor_type;
if (auto response = ConvertSensorType(type, &sensor_type);
!response.IsSuccess()) {
return response;
}
if (enabled) {
auto virtual_sensor_metadata = ParseSensorMetadata(metadata);
if (!virtual_sensor_metadata.has_value()) {
return virtual_sensor_metadata.error();
}
if (sensor_overrides_.contains(sensor_type)) {
return Response::InvalidParams(kSensorIsAlreadyOverridden);
}
auto virtual_sensor =
WebContentsSensorProviderProxy::GetOrCreate(GetWebContents())
->CreateVirtualSensorForDevTools(
sensor_type, std::move(virtual_sensor_metadata.value()));
if (!virtual_sensor) {
return Response::InvalidParams(kSensorIsAlreadyOverridden);
}
sensor_overrides_[sensor_type] = std::move(virtual_sensor);
} else {
sensor_overrides_.erase(sensor_type);
}
return Response::Success();
}
void EmulationHandler::SetSensorOverrideReadings(
const Emulation::SensorType& type,
std::unique_ptr<Emulation::SensorReading> reading,
std::unique_ptr<SetSensorOverrideReadingsCallback> callback) {
if (!host_) {
callback->sendFailure(Response::InternalError());
return;
}
device::mojom::SensorType sensor_type;
if (auto response = ConvertSensorType(type, &sensor_type);
!response.IsSuccess()) {
callback->sendFailure(response);
return;
}
device::SensorReading device_reading;
if (auto response =
ConvertSensorReading(sensor_type, reading.get(), &device_reading);
!response.IsSuccess()) {
callback->sendFailure(response);
return;
}
auto it = sensor_overrides_.find(sensor_type);
if (it == sensor_overrides_.end()) {
callback->sendFailure(Response::InvalidParams(kSensorIsNotOverridden));
return;
}
it->second->UpdateVirtualSensor(
device_reading,
base::BindOnce(
[](std::unique_ptr<SetSensorOverrideReadingsCallback> callback,
device::mojom::UpdateVirtualSensorResult result) {
switch (result) {
case device::mojom::UpdateVirtualSensorResult::
kSensorTypeNotOverridden:
callback->sendFailure(
Response::InvalidParams(kSensorIsNotOverridden));
break;
case device::mojom::UpdateVirtualSensorResult::kSuccess:
callback->sendSuccess();
break;
}
},
std::move(callback)));
}
#if BUILDFLAG(ENABLE_COMPUTE_PRESSURE)
namespace {
device::mojom::VirtualPressureSourceMetadataPtr ConvertPressureMetadata(
Maybe<Emulation::PressureMetadata>& metadata) {
auto pressure_metadata = device::mojom::VirtualPressureSourceMetadata::New();
if (metadata.has_value()) {
pressure_metadata->available = metadata->GetAvailable(true);
}
return pressure_metadata;
}
Response ConvertPressureSource(const Emulation::PressureSource& source,
device::mojom::PressureSource* out_type) {
if (source == Emulation::PressureSourceEnum::Cpu) {
*out_type = device::mojom::PressureSource::kCpu;
} else {
return Response::InvalidParams("Invalid pressure source: " + source);
}
return Response::Success();
}
Response ConvertPressureState(const Emulation::PressureState& state,
device::mojom::PressureState* out_type) {
if (state == Emulation::PressureStateEnum::Nominal) {
*out_type = device::mojom::PressureState::kNominal;
} else if (state == Emulation::PressureStateEnum::Fair) {
*out_type = device::mojom::PressureState::kFair;
} else if (state == Emulation::PressureStateEnum::Serious) {
*out_type = device::mojom::PressureState::kSerious;
} else if (state == Emulation::PressureStateEnum::Critical) {
*out_type = device::mojom::PressureState::kCritical;
} else {
return Response::InvalidParams("Invalid pressure state: " + state);
}
return Response::Success();
}
} // namespace
#endif // BUILDFLAG(ENABLE_COMPUTE_PRESSURE)
Response EmulationHandler::SetPressureSourceOverrideEnabled(
bool enabled,
const Emulation::PressureSource& source,
Maybe<Emulation::PressureMetadata> metadata) {
#if BUILDFLAG(ENABLE_COMPUTE_PRESSURE)
if (!host_) {
return Response::InternalError();
}
device::mojom::PressureSource mojo_source;
if (auto response = ConvertPressureSource(source, &mojo_source);
!response.IsSuccess()) {
return response;
}
if (enabled) {
if (pressure_overrides_.contains(mojo_source)) {
return Response::InvalidParams(kPressureSourceIsAlreadyOverridden);
}
auto virtual_pressure_source =
WebContentsPressureManagerProxy::GetOrCreate(GetWebContents())
->CreateVirtualPressureSourceForDevTools(
mojo_source, ConvertPressureMetadata(metadata));
if (!virtual_pressure_source) {
return Response::InvalidParams(kPressureSourceIsAlreadyOverridden);
}
pressure_overrides_[mojo_source] = std::move(virtual_pressure_source);
} else {
pressure_overrides_.erase(mojo_source);
}
return Response::Success();
#else
return Response::InternalError();
#endif // BUILDFLAG(ENABLE_COMPUTE_PRESSURE)
}
void EmulationHandler::SetPressureStateOverride(
const Emulation::PressureSource& source,
const Emulation::PressureState& state,
std::unique_ptr<SetPressureStateOverrideCallback> callback) {
if (!host_) {
callback->sendFailure(Response::InternalError());
return;
}
#if BUILDFLAG(ENABLE_COMPUTE_PRESSURE)
device::mojom::PressureSource mojo_source;
if (auto response = ConvertPressureSource(source, &mojo_source);
!response.IsSuccess()) {
callback->sendFailure(response);
return;
}
device::mojom::PressureState mojo_state;
if (auto response = ConvertPressureState(state, &mojo_state);
!response.IsSuccess()) {
callback->sendFailure(response);
return;
}
auto it = pressure_overrides_.find(mojo_source);
if (it == pressure_overrides_.end()) {
callback->sendFailure(
Response::InvalidParams(kPressureSourceIsNotOverridden));
return;
}
it->second->UpdateVirtualPressureSourceState(
mojo_state, base::BindOnce(&SetPressureStateOverrideCallback::sendSuccess,
std::move(callback)));
#else
callback->sendFailure(Response::InternalError());
#endif // BUILDFLAG(ENABLE_COMPUTE_PRESSURE)
}
Response EmulationHandler::SetIdleOverride(bool is_user_active,
bool is_screen_unlocked) {
if (!host_)
return Response::InternalError();
host_->GetIdleManager()->SetIdleOverride(is_user_active, is_screen_unlocked);
return Response::Success();
}
Response EmulationHandler::ClearIdleOverride() {
if (!host_)
return Response::InternalError();
host_->GetIdleManager()->ClearIdleOverride();
return Response::Success();
}
Response EmulationHandler::SetGeolocationOverride(Maybe<double> latitude,
Maybe<double> longitude,
Maybe<double> accuracy) {
if (!host_)
return Response::InternalError();
auto* geolocation_context = GetWebContents()->GetGeolocationContext();
device::mojom::GeopositionResultPtr override_result;
if (latitude.has_value() && longitude.has_value() && accuracy.has_value()) {
auto position = device::mojom::Geoposition::New();
position->latitude = latitude.value();
position->longitude = longitude.value();
position->accuracy = accuracy.value();
position->timestamp = base::Time::Now();
if (!device::ValidateGeoposition(*position)) {
return Response::ServerError("Invalid geolocation");
}
override_result =
device::mojom::GeopositionResult::NewPosition(std::move(position));
} else {
override_result = device::mojom::GeopositionResult::NewError(
device::mojom::GeopositionError::New(
device::mojom::GeopositionErrorCode::kPositionUnavailable,
/*error_message=*/"", /*error_technical=*/""));
}
geolocation_context->SetOverride(std::move(override_result));
return Response::Success();
}
Response EmulationHandler::ClearGeolocationOverride() {
if (!host_)
return Response::InternalError();
auto* geolocation_context = GetWebContents()->GetGeolocationContext();
geolocation_context->ClearOverride();
return Response::Success();
}
Response EmulationHandler::SetEmitTouchEventsForMouse(
bool enabled,
Maybe<std::string> configuration) {
if (!host_)
return Response::InternalError();
if (host_->GetParentOrOuterDocument())
return Response::ServerError(kCommandIsOnlyAvailableAtTopTarget);
touch_emulation_enabled_ = enabled;
touch_emulation_configuration_ = configuration.value_or("");
UpdateTouchEventEmulationState();
return Response::Success();
}
Response EmulationHandler::CanEmulate(bool* result) {
#if BUILDFLAG(IS_ANDROID)
*result = false;
#else
*result = true;
if (host_) {
if (GetWebContents()->GetVisibleURL().SchemeIs(kChromeDevToolsScheme) ||
host_->GetRenderWidgetHost()->auto_resize_enabled())
*result = false;
}
#endif // BUILDFLAG(IS_ANDROID)
return Response::Success();
}
Response EmulationHandler::SetDeviceMetricsOverride(
int width,
int height,
double device_scale_factor,
bool mobile,
Maybe<double> scale,
Maybe<int> screen_width,
Maybe<int> screen_height,
Maybe<int> position_x,
Maybe<int> position_y,
Maybe<bool> dont_set_visible_size,
Maybe<Emulation::ScreenOrientation> screen_orientation,
Maybe<protocol::Page::Viewport> viewport,
Maybe<protocol::Emulation::DisplayFeature> display_feature,
Maybe<protocol::Emulation::DevicePosture> device_posture) {
const static int max_size = 10000000;
const static double max_scale = 10;
const static int max_orientation_angle = 360;
if (!host_ || host_->GetRenderWidgetHost()->auto_resize_enabled()) {
return Response::ServerError("Target does not support metrics override");
}
if (host_->GetParentOrOuterDocument())
return Response::ServerError(kCommandIsOnlyAvailableAtTopTarget);
if (screen_width.value_or(0) < 0 || screen_height.value_or(0) < 0 ||
screen_width.value_or(0) > max_size ||
screen_height.value_or(0) > max_size) {
return Response::InvalidParams(
"Screen width and height values must be positive, not greater than " +
base::NumberToString(max_size));
}
if (position_x.value_or(0) < 0 || position_y.value_or(0) < 0 ||
position_x.value_or(0) > screen_width.value_or(0) ||
position_y.value_or(0) > screen_height.value_or(0)) {
return Response::InvalidParams("View position should be on the screen");
}
if (width < 0 || height < 0 || width > max_size || height > max_size) {
return Response::InvalidParams(
"Width and height values must be positive, not greater than " +
base::NumberToString(max_size));
}
if (device_scale_factor < 0)
return Response::InvalidParams("deviceScaleFactor must be non-negative");
if (scale.value_or(1) <= 0 || scale.value_or(1) > max_scale) {
return Response::InvalidParams("scale must be positive, not greater than " +
base::NumberToString(max_scale));
}
display::mojom::ScreenOrientation orientationType =
display::mojom::ScreenOrientation::kUndefined;
int orientationAngle = 0;
if (screen_orientation.has_value()) {
Emulation::ScreenOrientation& orientation = screen_orientation.value();
orientationType = WebScreenOrientationTypeFromString(orientation.GetType());
if (orientationType == display::mojom::ScreenOrientation::kUndefined)
return Response::InvalidParams("Invalid screen orientation type value");
orientationAngle = orientation.GetAngle();
if (orientationAngle < 0 || orientationAngle >= max_orientation_angle) {
return Response::InvalidParams(
"Screen orientation angle must be non-negative, less than " +
base::NumberToString(max_orientation_angle));
}
}
std::optional<content::DisplayFeature> content_display_feature = std::nullopt;
if (display_feature.has_value()) {
protocol::Emulation::DisplayFeature& emu_display_feature =
display_feature.value();
std::optional<content::DisplayFeature::Orientation> disp_orientation =
DisplayFeatureOrientationTypeFromString(
emu_display_feature.GetOrientation());
if (!disp_orientation) {
return Response::InvalidParams(
"Invalid display feature orientation type");
}
content::DisplayFeature::ParamErrorEnum error;
content_display_feature = content::DisplayFeature::Create(
*disp_orientation, emu_display_feature.GetOffset(),
emu_display_feature.GetMaskLength(), width, height, &error);
if (!content_display_feature) {
switch (error) {
case content::DisplayFeature::ParamErrorEnum::
kDisplayFeatureWithZeroScreenSize:
return Response::InvalidParams(
"Cannot specify a display feature with zero width and height");
case content::DisplayFeature::ParamErrorEnum::
kNegativeDisplayFeatureParams:
return Response::InvalidParams("Negative display feature parameters");
case content::DisplayFeature::ParamErrorEnum::kOutsideScreenWidth:
return Response::InvalidParams(
"Display feature viewport segments outside screen width");
case content::DisplayFeature::ParamErrorEnum::kOutsideScreenHeight:
return Response::InvalidParams(
"Display feature viewport segments outside screen height");
}
}
}
blink::DeviceEmulationParams params;
params.screen_type = mobile ? blink::mojom::EmulatedScreenType::kMobile
: blink::mojom::EmulatedScreenType::kDesktop;
params.screen_size =
gfx::Size(screen_width.value_or(0), screen_height.value_or(0));
if (position_x.has_value() && position_y.has_value()) {
params.view_position =
gfx::Point(position_x.value_or(0), position_y.value_or(0));
}
params.device_scale_factor = device_scale_factor;
params.view_size = gfx::Size(width, height);
params.scale = scale.value_or(1);
params.screen_orientation_type = orientationType;
params.screen_orientation_angle = orientationAngle;
if (content_display_feature) {
params.viewport_segments =
content_display_feature->ComputeViewportSegments(params.view_size);
}
if (device_posture.has_value()) {
params.device_posture =
DevicePostureTypeFromString(device_posture.value().GetType()).value();
}
if (viewport.has_value()) {
params.viewport_offset.SetPoint(viewport->GetX(), viewport->GetY());
double dpfactor =
device_scale_factor
? device_scale_factor /
host_->GetRenderWidgetHost()->GetDeviceScaleFactor()
: 1;
params.viewport_scale = viewport->GetScale() * dpfactor;
// Resize the RenderWidgetHostView to the size of the overridden viewport.
width = base::ClampRound(viewport->GetWidth() * params.viewport_scale);
height = base::ClampRound(viewport->GetHeight() * params.viewport_scale);
}
bool size_changed = false;
if (!dont_set_visible_size.value_or(false) && width > 0 && height > 0) {
if (GetWebContents()) {
size_changed =
GetWebContents()->SetDeviceEmulationSize(gfx::Size(width, height));
} else {
return Response::ServerError("Can't find the associated web contents");
}
}
if (device_emulation_enabled_ && params == device_emulation_params_) {
// Renderer should answer after size was changed, so that the response is
// only sent to the client once updates were applied.
if (size_changed)
return Response::FallThrough();
return Response::Success();
}
device_emulation_enabled_ = true;
device_emulation_params_ = params;
UpdateDeviceEmulationState();
// Renderer should answer after emulation params were updated, so that the
// response is only sent to the client once updates were applied.
// Unless the renderer has crashed.
if (GetWebContents() && GetWebContents()->IsCrashed())
return Response::Success();
return Response::FallThrough();
}
Response EmulationHandler::ClearDeviceMetricsOverride() {
if (!host_)
return Response::ServerError("Can't find the associated web contents");
if (host_->GetParentOrOuterDocument())
return Response::ServerError(kCommandIsOnlyAvailableAtTopTarget);
if (!device_emulation_enabled_)
return Response::Success();
GetWebContents()->ClearDeviceEmulationSize();
device_emulation_enabled_ = false;
device_emulation_params_ = blink::DeviceEmulationParams();
UpdateDeviceEmulationState();
// Renderer should answer after emulation was disabled, so that the response
// is only sent to the client once updates were applied.
// Unless the renderer has crashed.
if (GetWebContents()->IsCrashed())
return Response::Success();
return Response::FallThrough();
}
Response EmulationHandler::SetVisibleSize(int width, int height) {
if (width < 0 || height < 0)
return Response::InvalidParams("Width and height must be non-negative");
if (!host_)
return Response::ServerError("Can't find the associated web contents");
GetWebContents()->SetDeviceEmulationSize(gfx::Size(width, height));
return Response::Success();
}
Response EmulationHandler::SetUserAgentOverride(
const std::string& user_agent,
Maybe<std::string> accept_language,
Maybe<std::string> platform,
Maybe<Emulation::UserAgentMetadata> ua_metadata_override) {
if (!user_agent.empty() && !net::HttpUtil::IsValidHeaderValue(user_agent))
return Response::InvalidParams("Invalid characters found in userAgent");
std::string accept_lang = accept_language.value_or(std::string());
if (!accept_lang.empty() && !net::HttpUtil::IsValidHeaderValue(accept_lang)) {
return Response::InvalidParams(
"Invalid characters found in acceptLanguage");
}
user_agent_ = user_agent;
accept_language_ = accept_lang;
user_agent_metadata_ = std::nullopt;
if (!ua_metadata_override.has_value()) {
return Response::FallThrough();
}
if (user_agent.empty()) {
return Response::InvalidParams(
"Empty userAgent invalid with userAgentMetadata provided");
}
Emulation::UserAgentMetadata& ua_metadata = ua_metadata_override.value();
blink::UserAgentMetadata new_ua_metadata;
blink::UserAgentMetadata default_ua_metadata =
GetContentClient()->browser()->GetUserAgentMetadata();
if (ua_metadata.HasBrands()) {
for (const auto& bv : *ua_metadata.GetBrands(nullptr)) {
blink::UserAgentBrandVersion out_bv;
if (!ValidateClientHintString(bv->GetBrand()))
return Response::InvalidParams("Invalid brand string");
out_bv.brand = bv->GetBrand();
if (!ValidateClientHintString(bv->GetVersion()))
return Response::InvalidParams("Invalid brand version string");
out_bv.version = bv->GetVersion();
new_ua_metadata.brand_version_list.push_back(std::move(out_bv));
}
} else {
new_ua_metadata.brand_version_list =
std::move(default_ua_metadata.brand_version_list);
}
if (ua_metadata.HasFullVersionList()) {
for (const auto& bv : *ua_metadata.GetFullVersionList(nullptr)) {
blink::UserAgentBrandVersion out_bv;
if (!ValidateClientHintString(bv->GetBrand()))
return Response::InvalidParams("Invalid brand string");
out_bv.brand = bv->GetBrand();
if (!ValidateClientHintString(bv->GetVersion()))
return Response::InvalidParams("Invalid brand version string");
out_bv.version = bv->GetVersion();
new_ua_metadata.brand_full_version_list.push_back(std::move(out_bv));
}
} else {
new_ua_metadata.brand_full_version_list =
std::move(default_ua_metadata.brand_full_version_list);
}
if (ua_metadata.HasFullVersion()) {
String full_version = ua_metadata.GetFullVersion("");
if (!ValidateClientHintString(full_version))
return Response::InvalidParams("Invalid full version string");
new_ua_metadata.full_version = full_version;
} else {
new_ua_metadata.full_version = std::move(default_ua_metadata.full_version);
}
if (!ValidateClientHintString(ua_metadata.GetPlatform())) {
return Response::InvalidParams("Invalid platform string");
}
new_ua_metadata.platform = ua_metadata.GetPlatform();
if (!ValidateClientHintString(ua_metadata.GetPlatformVersion())) {
return Response::InvalidParams("Invalid platform version string");
}
new_ua_metadata.platform_version = ua_metadata.GetPlatformVersion();
if (!ValidateClientHintString(ua_metadata.GetArchitecture())) {
return Response::InvalidParams("Invalid architecture string");
}
new_ua_metadata.architecture = ua_metadata.GetArchitecture();
if (!ValidateClientHintString(ua_metadata.GetModel())) {
return Response::InvalidParams("Invalid model string");
}
new_ua_metadata.model = ua_metadata.GetModel();
new_ua_metadata.mobile = ua_metadata.GetMobile();
if (ua_metadata.HasBitness()) {
String bitness = ua_metadata.GetBitness("");
if (!ValidateClientHintString(bitness))
return Response::InvalidParams("Invalid bitness string");
new_ua_metadata.bitness = std::move(bitness);
} else {
new_ua_metadata.bitness = std::move(default_ua_metadata.bitness);
}
if (ua_metadata.HasWow64()) {
new_ua_metadata.wow64 = ua_metadata.GetWow64(false);
} else {
new_ua_metadata.wow64 = default_ua_metadata.wow64;
}
// All checks OK, can update user_agent_metadata_.
user_agent_metadata_.emplace(std::move(new_ua_metadata));
return Response::FallThrough();
}
Response EmulationHandler::SetFocusEmulationEnabled(bool enabled) {
if (enabled == focus_emulation_enabled_)
return Response::FallThrough();
focus_emulation_enabled_ = enabled;
if (enabled) {
capture_handle_ = GetWebContents()->IncrementCapturerCount(
gfx::Size(),
/*stay_hidden=*/false,
/*stay_awake=*/false, /*is_activity=*/true);
} else {
capture_handle_.RunAndReset();
}
return Response::FallThrough();
}
Response EmulationHandler::SetEmulatedMedia(
Maybe<std::string> media,
Maybe<protocol::Array<protocol::Emulation::MediaFeature>> features) {
if (!host_)
return Response::InternalError();
prefers_color_scheme_ = "";
prefers_reduced_motion_ = "";
prefers_reduced_transparency_ = "";
if (features.has_value()) {
for (auto const& mediaFeature : features.value()) {
auto const& name = mediaFeature->GetName();
auto const& value = mediaFeature->GetValue();
if (name == "prefers-color-scheme") {
prefers_color_scheme_ = (value == network::kPrefersColorSchemeLight ||
value == network::kPrefersColorSchemeDark)
? value
: "";
} else if (name == "prefers-reduced-motion") {
prefers_reduced_motion_ =
(value == network::kPrefersReducedMotionReduce) ? value : "";
} else if (name == "prefers-reduced-transparency") {
prefers_reduced_transparency_ =
(value == network::kPrefersReducedTransparencyReduce) ? value : "";
}
}
}
return Response::FallThrough();
}
blink::DeviceEmulationParams EmulationHandler::GetDeviceEmulationParams() {
return device_emulation_params_;
}
void EmulationHandler::SetDeviceEmulationParams(
const blink::DeviceEmulationParams& params) {
DCHECK(host_);
// Device emulation only happens on the outermost main frame.
DCHECK(!host_->GetParentOrOuterDocument());
bool enabled = params != blink::DeviceEmulationParams();
bool enable_changed = enabled != device_emulation_enabled_;
bool params_changed = params != device_emulation_params_;
if (!device_emulation_enabled_ && !enable_changed)
return; // Still disabled.
if (!enable_changed && !params_changed)
return; // Nothing changed.
device_emulation_enabled_ = enabled;
device_emulation_params_ = params;
UpdateDeviceEmulationState();
}
WebContentsImpl* EmulationHandler::GetWebContents() {
DCHECK(host_); // Only call if |host_| is set.
return static_cast<WebContentsImpl*>(WebContents::FromRenderFrameHost(host_));
}
void EmulationHandler::UpdateTouchEventEmulationState() {
if (!host_)
return;
// We only have a single TouchEmulator for all frames, so let the main frame's
// EmulationHandler enable/disable it.
DCHECK(!host_->GetParentOrOuterDocument());
if (touch_emulation_enabled_) {
if (auto* touch_emulator = host_->GetRenderWidgetHost()->GetTouchEmulator(
/*create_if_necessary=*/true)) {
touch_emulator->Enable(
input::TouchEmulator::Mode::kEmulatingTouchFromMouse,
TouchEmulationConfigurationToType(touch_emulation_configuration_));
}
} else {
if (auto* touch_emulator = host_->GetRenderWidgetHost()->GetTouchEmulator(
/*create_if_necessary=*/true)) {
touch_emulator->Disable();
}
}
GetWebContents()->SetForceDisableOverscrollContent(touch_emulation_enabled_);
}
void EmulationHandler::UpdateDeviceEmulationState() {
if (!host_)
return;
// Device emulation only happens on the outermost main frame.
DCHECK(!host_->GetParentOrOuterDocument());
// TODO(eseckler): Once we change this to mojo, we should wait for an ack to
// these messages from the renderer. The renderer should send the ack once the
// emulation params were applied. That way, we can avoid having to handle
// Set/ClearDeviceMetricsOverride in the renderer. With the old IPC system,
// this is tricky since we'd have to track the DevTools message id with the
// WidgetMsg and acknowledgment, as well as plump the acknowledgment back to
// the EmulationHandler somehow. Mojo callbacks should make this much simpler.
host_->ForEachRenderFrameHostIncludingSpeculative(
[this](RenderFrameHostImpl* host) {
// The main frame of nested subpages (ex. fenced frames) inside this
// page are updated as well.
if (host->is_main_frame())
UpdateDeviceEmulationStateForHost(host->GetRenderWidgetHost());
});
}
void EmulationHandler::UpdateDeviceEmulationStateForHost(
RenderWidgetHostImpl* render_widget_host) {
auto& frame_widget = render_widget_host->GetAssociatedFrameWidget();
if (!frame_widget)
return;
if (device_emulation_enabled_) {
frame_widget->EnableDeviceEmulation(device_emulation_params_);
} else {
frame_widget->DisableDeviceEmulation();
}
}
Response EmulationHandler::SetDevicePostureOverride(
std::unique_ptr<protocol::Emulation::DevicePosture> posture) {
ASSIGN_OR_RETURN(blink::mojom::DevicePostureType posture_type,
DevicePostureTypeFromString(posture->GetType()));
device_posture_emulation_enabled_ = true;
GetWebContents()
->GetDevicePostureProvider()
->OverrideDevicePostureForEmulation(posture_type);
return Response::Success();
}
Response EmulationHandler::ClearDevicePostureOverride() {
if (device_posture_emulation_enabled_) {
device_posture_emulation_enabled_ = false;
GetWebContents()
->GetDevicePostureProvider()
->DisableDevicePostureOverrideForEmulation();
}
return Response::Success();
}
void EmulationHandler::ApplyOverrides(net::HttpRequestHeaders* headers,
bool* user_agent_overridden,
bool* accept_language_overridden) {
if (!user_agent_.empty()) {
headers->SetHeader(net::HttpRequestHeaders::kUserAgent, user_agent_);
}
*user_agent_overridden = !user_agent_.empty();
if (!accept_language_.empty()) {
headers->SetHeader(
net::HttpRequestHeaders::kAcceptLanguage,
net::HttpUtil::GenerateAcceptLanguageHeader(accept_language_));
}
*accept_language_overridden = !accept_language_.empty();
if (!prefers_color_scheme_.empty()) {
const auto& prefers_color_scheme_client_hint_name =
network::GetClientHintToNameMap().at(
network::mojom::WebClientHintsType::kPrefersColorScheme);
if (headers->HasHeader(prefers_color_scheme_client_hint_name)) {
headers->SetHeader(prefers_color_scheme_client_hint_name,
prefers_color_scheme_);
}
}
if (!prefers_reduced_motion_.empty()) {
const auto& prefers_reduced_motion_client_hint_name =
network::GetClientHintToNameMap().at(
network::mojom::WebClientHintsType::kPrefersReducedMotion);
if (headers->HasHeader(prefers_reduced_motion_client_hint_name)) {
headers->SetHeader(prefers_reduced_motion_client_hint_name,
prefers_reduced_motion_);
}
}
if (!prefers_reduced_transparency_.empty()) {
const auto& prefers_reduced_transparency_client_hint_name =
network::GetClientHintToNameMap().at(
network::mojom::WebClientHintsType::kPrefersReducedTransparency);
if (headers->HasHeader(prefers_reduced_transparency_client_hint_name)) {
headers->SetHeader(prefers_reduced_transparency_client_hint_name,
prefers_reduced_transparency_);
}
}
}
bool EmulationHandler::ApplyUserAgentMetadataOverrides(
std::optional<blink::UserAgentMetadata>* override_out) {
// This is conditional on basic user agent override being on; this helps us
// emulate a device not sending any UA client hints.
if (user_agent_.empty())
return false;
*override_out = user_agent_metadata_;
return true;
}
void EmulationHandler::ApplyNetworkOverridesForDownload(
download::DownloadUrlParameters* parameters) {
net::HttpRequestHeaders headers;
bool user_agent_overridden;
bool accept_language_overridden;
ApplyOverrides(&headers, &user_agent_overridden, &accept_language_overridden);
for (net::HttpRequestHeaders::Iterator it(headers); it.GetNext();) {
parameters->add_request_header(it.name(), it.value());
}
}
} // namespace protocol
} // namespace content