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
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
use std::collections::VecDeque;
use std::sync::Arc;
use std::time::Instant;
use chromiumoxide_cdp::cdp::browser_protocol::target::DetachFromTargetParams;
use std::task::{Context, Poll};
use tokio::sync::oneshot::Sender;
use tokio::sync::Notify;
use crate::auth::Credentials;
use crate::cdp::browser_protocol::target::CloseTargetParams;
use crate::cmd::CommandChain;
use crate::cmd::CommandMessage;
use crate::error::{CdpError, Result};
use crate::handler::browser::BrowserContext;
use crate::handler::domworld::DOMWorldKind;
use crate::handler::emulation::EmulationManager;
use crate::handler::frame::FrameRequestedNavigation;
use crate::handler::frame::{
FrameEvent, FrameManager, NavigationError, NavigationId, NavigationOk,
};
use crate::handler::network::{NetworkEvent, NetworkManager};
use crate::handler::page::PageHandle;
use crate::handler::viewport::Viewport;
use crate::handler::{PageInner, REQUEST_TIMEOUT};
use crate::listeners::{EventListenerRequest, EventListeners};
use crate::{page::Page, ArcHttpRequest};
use chromiumoxide_cdp::cdp::browser_protocol::{
browser::BrowserContextId,
log as cdplog,
page::{FrameId, GetFrameTreeParams},
target::{AttachToTargetParams, SessionId, SetAutoAttachParams, TargetId, TargetInfo},
};
use chromiumoxide_cdp::cdp::events::CdpEvent;
use chromiumoxide_cdp::cdp::js_protocol::runtime::{
ExecutionContextId, RunIfWaitingForDebuggerParams,
};
use chromiumoxide_cdp::cdp::CdpEventMessage;
use chromiumoxide_types::{Command, Method, Request, Response};
use spider_network_blocker::intercept_manager::NetworkInterceptManager;
use std::time::Duration;
macro_rules! advance_state {
($s:ident, $cx:ident, $now:ident, $cmds: ident, $next_state:expr ) => {{
if let Poll::Ready(poll) = $cmds.poll($now) {
return match poll {
None => {
$s.init_state = $next_state;
$s.poll($cx, $now)
}
Some(Ok((method, params))) => Some(TargetEvent::Request(Request {
method,
session_id: $s.session_id.clone().map(Into::into),
params,
})),
Some(Err(_)) => Some($s.on_initialization_failed()),
};
} else {
return None;
}
}};
}
lazy_static::lazy_static! {
/// Initial start command params.
static ref INIT_COMMANDS_PARAMS: Vec<(chromiumoxide_types::MethodId, serde_json::Value)> = {
if let Ok(attach) = SetAutoAttachParams::builder()
.flatten(true)
.auto_attach(true)
.wait_for_debugger_on_start(true)
.build() {
let disable_log = cdplog::DisableParams::default();
let mut cmds = vec![
(
attach.identifier(),
serde_json::to_value(attach).unwrap_or_default(),
),
(
disable_log.identifier(),
serde_json::to_value(disable_log).unwrap_or_default(),
)
];
// enable performance on pages.
if cfg!(feature = "collect_metrics") {
let enable_performance = chromiumoxide_cdp::cdp::browser_protocol::performance::EnableParams::default();
cmds.push((
enable_performance.identifier(),
serde_json::to_value(enable_performance).unwrap_or_default(),
));
}
cmds
} else {
vec![]
}
};
/// Attach to target commands
static ref ATTACH_TARGET: (chromiumoxide_types::MethodId, serde_json::Value) = {
let runtime_cmd = RunIfWaitingForDebuggerParams::default();
(runtime_cmd.identifier(), serde_json::to_value(runtime_cmd).unwrap_or_default())
};
}
#[derive(Debug)]
pub struct Target {
/// Info about this target as returned from the chromium instance
info: TargetInfo,
/// The type of this target
r#type: TargetType,
/// Configs for this target
config: TargetConfig,
/// The context this target is running in
browser_context: BrowserContext,
/// The frame manager that maintains the state of all frames and handles
/// navigations of frames
frame_manager: FrameManager,
/// Handles all the https
pub(crate) network_manager: NetworkManager,
emulation_manager: EmulationManager,
/// The identifier of the session this target is attached to
session_id: Option<SessionId>,
/// The handle of the browser page of this target
page: Option<PageHandle>,
/// Drives this target towards initialization
pub(crate) init_state: TargetInit,
/// Currently queued events to report to the `Handler`
queued_events: VecDeque<TargetEvent>,
/// All registered event subscriptions
event_listeners: EventListeners,
/// Senders that need to be notified once the main frame has loaded
wait_for_frame_navigation: Vec<Sender<ArcHttpRequest>>,
/// Senders notified once `DOMContentLoaded` fires (before `load`).
wait_for_dom_content_loaded: Vec<Sender<ArcHttpRequest>>,
/// Senders notified once the `load` event fires (all subresources done).
wait_for_load: Vec<Sender<ArcHttpRequest>>,
/// Senders that need to be notified once the main frame reaches `networkIdle`.
wait_for_network_idle: Vec<Sender<ArcHttpRequest>>,
/// (Optional) for `networkAlmostIdle` if you want it as well.
wait_for_network_almost_idle: Vec<Sender<ArcHttpRequest>>,
/// The sender who requested the page.
initiator: Option<Sender<Result<Page>>>,
}
impl Target {
/// Create a new target instance with `TargetInfo` after a
/// `CreateTargetParams` request.
pub fn new(info: TargetInfo, config: TargetConfig, browser_context: BrowserContext) -> Self {
let ty = TargetType::new(&info.r#type);
let request_timeout: Duration = config.request_timeout;
let mut network_manager = NetworkManager::new(config.ignore_https_errors, request_timeout);
if !config.cache_enabled {
network_manager.set_cache_enabled(false);
}
if !config.service_worker_enabled {
network_manager.set_service_worker_enabled(true);
}
network_manager.set_request_interception(config.request_intercept);
network_manager.max_bytes_allowed = config.max_bytes_allowed;
if let Some(headers) = &config.extra_headers {
network_manager.set_extra_headers(headers.clone());
}
if let Some(whitelist) = &config.whitelist_patterns {
network_manager.set_whitelist_patterns(whitelist.clone());
}
if let Some(blacklist) = &config.blacklist_patterns {
network_manager.set_blacklist_patterns(blacklist);
}
network_manager.ignore_visuals = config.ignore_visuals;
network_manager.block_javascript = config.ignore_javascript;
network_manager.block_analytics = config.ignore_analytics;
network_manager.block_prefetch = config.ignore_prefetch;
network_manager.block_stylesheets = config.ignore_stylesheets;
network_manager.only_html = config.only_html;
network_manager.intercept_manager = config.intercept_manager;
#[cfg(feature = "adblock")]
if let Some(rules) = &config.adblock_filter_rules {
use adblock::lists::{FilterSet, ParseOptions, RuleTypes};
let mut filter_set = FilterSet::new(false);
let mut opts = ParseOptions::default();
opts.rule_types = RuleTypes::All;
// Include built-in patterns.
filter_set.add_filters(
&*spider_network_blocker::adblock::ADBLOCK_PATTERNS,
opts.clone(),
);
// Merge user-supplied rules (e.g. EasyList / EasyPrivacy content).
filter_set.add_filters(rules.iter().map(|s| s.as_str()), opts);
let engine = adblock::Engine::from_filter_set(filter_set, true);
network_manager.set_adblock_engine(std::sync::Arc::new(engine));
}
Self {
info,
r#type: ty,
config,
frame_manager: FrameManager::new(request_timeout),
network_manager,
emulation_manager: EmulationManager::new(request_timeout),
session_id: None,
page: None,
init_state: TargetInit::AttachToTarget,
wait_for_frame_navigation: Default::default(),
wait_for_dom_content_loaded: Default::default(),
wait_for_load: Default::default(),
wait_for_network_idle: Default::default(),
wait_for_network_almost_idle: Default::default(),
queued_events: Default::default(),
event_listeners: Default::default(),
initiator: None,
browser_context,
}
}
/// Set the session id.
pub fn set_session_id(&mut self, id: SessionId) {
self.session_id = Some(id)
}
/// Get the session id.
pub fn session_id(&self) -> Option<&SessionId> {
self.session_id.as_ref()
}
/// Get the session id mut.
pub fn session_id_mut(&mut self) -> &mut Option<SessionId> {
&mut self.session_id
}
/// Get the browser context.
pub fn browser_context(&self) -> &BrowserContext {
&self.browser_context
}
/// The identifier for this target
pub fn target_id(&self) -> &TargetId {
&self.info.target_id
}
/// The type of this target
pub fn r#type(&self) -> &TargetType {
&self.r#type
}
/// Whether this target is already initialized
pub fn is_initialized(&self) -> bool {
matches!(self.init_state, TargetInit::Initialized)
}
/// Navigate a frame
pub fn goto(&mut self, req: FrameRequestedNavigation) {
if self.network_manager.has_target_domain() {
self.network_manager.clear_target_domain();
let goto_url = req
.req
.params
.as_object()
.and_then(|o| o.get("url"))
.and_then(|v| v.as_str());
if let Some(url) = goto_url {
self.network_manager.set_page_url(url.into());
}
}
self.frame_manager.goto(req);
}
/// Create a new page from the session.
fn create_page(&mut self) {
if self.page.is_none() {
if let Some(session) = self.session_id.clone() {
let handle = PageHandle::new(
self.target_id().clone(),
session,
self.opener_id().cloned(),
self.config.request_timeout,
self.config.page_wake.clone(),
);
self.page = Some(handle);
}
}
}
/// Tries to create the `PageInner` if this target is already initialized
pub(crate) fn get_or_create_page(&mut self) -> Option<&Arc<PageInner>> {
self.create_page();
self.page.as_ref().map(|p| p.inner())
}
/// Mutable access to the page handle (for `try_recv` in `Handler::run()`).
pub(crate) fn page_mut(&mut self) -> Option<&mut PageHandle> {
self.page.as_mut()
}
/// Is the target a page?
pub fn is_page(&self) -> bool {
self.r#type().is_page()
}
/// The browser context ID.
pub fn browser_context_id(&self) -> Option<&BrowserContextId> {
self.info.browser_context_id.as_ref()
}
/// The target connection info.
pub fn info(&self) -> &TargetInfo {
&self.info
}
/// Get the target that opened this target. Top-level targets return `None`.
pub fn opener_id(&self) -> Option<&TargetId> {
self.info.opener_id.as_ref()
}
pub fn frame_manager(&self) -> &FrameManager {
&self.frame_manager
}
/// The frame manager.
pub fn frame_manager_mut(&mut self) -> &mut FrameManager {
&mut self.frame_manager
}
/// Get event listeners mutably.
pub fn event_listeners_mut(&mut self) -> &mut EventListeners {
&mut self.event_listeners
}
/// Received a response to a command issued by this target
pub fn on_response(&mut self, resp: Response, method: &str) {
if let Some(cmds) = self.init_state.commands_mut() {
cmds.received_response(method);
}
if let GetFrameTreeParams::IDENTIFIER = method {
if let Some(resp) = resp
.result
.and_then(|val| GetFrameTreeParams::response_from_value(val).ok())
{
self.frame_manager.on_frame_tree(resp.frame_tree);
}
}
// requests originated from the network manager all return an empty response, hence they
// can be ignored here
}
/// On CDP Event message.
pub fn on_event(&mut self, event: CdpEventMessage) {
let CdpEventMessage {
params,
method,
session_id,
..
} = event;
let is_session_scoped = matches!(
params,
CdpEvent::FetchRequestPaused(_)
| CdpEvent::FetchAuthRequired(_)
| CdpEvent::NetworkRequestWillBeSent(_)
| CdpEvent::NetworkResponseReceived(_)
| CdpEvent::NetworkLoadingFinished(_)
| CdpEvent::NetworkLoadingFailed(_)
| CdpEvent::PageFrameAttached(_)
| CdpEvent::PageFrameDetached(_)
| CdpEvent::PageFrameNavigated(_)
| CdpEvent::PageNavigatedWithinDocument(_)
| CdpEvent::PageLifecycleEvent(_)
| CdpEvent::PageFrameStartedLoading(_)
| CdpEvent::PageFrameStoppedLoading(_)
| CdpEvent::RuntimeExecutionContextCreated(_)
| CdpEvent::RuntimeExecutionContextDestroyed(_)
| CdpEvent::RuntimeExecutionContextsCleared(_)
| CdpEvent::RuntimeBindingCalled(_)
);
if is_session_scoped {
let ev_sid: &str = match session_id.as_deref() {
Some(s) => s,
None => return,
};
let self_sid: &str = match self.session_id.as_ref() {
Some(sid) => sid.as_ref(),
None => return,
};
if self_sid != ev_sid {
return;
}
}
match ¶ms {
// `FrameManager` events
CdpEvent::PageFrameAttached(ev) => self
.frame_manager
.on_frame_attached(ev.frame_id.clone(), Some(ev.parent_frame_id.clone())),
CdpEvent::PageFrameDetached(ev) => self.frame_manager.on_frame_detached(ev),
CdpEvent::PageFrameNavigated(ev) => {
self.frame_manager.on_frame_navigated(&ev.frame);
}
CdpEvent::PageNavigatedWithinDocument(ev) => {
self.frame_manager.on_frame_navigated_within_document(ev)
}
CdpEvent::RuntimeExecutionContextCreated(ev) => {
self.frame_manager.on_frame_execution_context_created(ev)
}
CdpEvent::RuntimeExecutionContextDestroyed(ev) => {
self.frame_manager.on_frame_execution_context_destroyed(ev)
}
CdpEvent::RuntimeExecutionContextsCleared(_) => {
self.frame_manager.on_execution_contexts_cleared()
}
CdpEvent::RuntimeBindingCalled(ev) => {
// TODO check if binding registered and payload is json
self.frame_manager.on_runtime_binding_called(ev)
}
CdpEvent::PageLifecycleEvent(ev) => self.frame_manager.on_page_lifecycle_event(ev),
CdpEvent::PageFrameStartedLoading(ev) => {
self.frame_manager.on_frame_started_loading(ev);
}
CdpEvent::PageFrameStoppedLoading(ev) => {
self.frame_manager.on_frame_stopped_loading(ev);
}
// `Target` events
CdpEvent::TargetAttachedToTarget(ev) => {
if ev.waiting_for_debugger {
let runtime_cmd = ATTACH_TARGET.clone();
self.queued_events.push_back(TargetEvent::Request(Request {
method: runtime_cmd.0,
session_id: Some(ev.session_id.clone().into()),
params: runtime_cmd.1,
}));
}
if "service_worker" == &ev.target_info.r#type {
let detach_command = DetachFromTargetParams::builder()
.session_id(ev.session_id.clone())
.build();
let method = detach_command.identifier();
if let Ok(params) = serde_json::to_value(detach_command) {
self.queued_events.push_back(TargetEvent::Request(Request {
method,
session_id: self.session_id.clone().map(Into::into),
params,
}));
}
}
}
// `NetworkManager` events
CdpEvent::FetchRequestPaused(ev) => self.network_manager.on_fetch_request_paused(ev),
CdpEvent::FetchAuthRequired(ev) => self.network_manager.on_fetch_auth_required(ev),
CdpEvent::NetworkRequestWillBeSent(ev) => {
self.network_manager.on_request_will_be_sent(ev)
}
CdpEvent::NetworkRequestServedFromCache(ev) => {
self.network_manager.on_request_served_from_cache(ev)
}
CdpEvent::NetworkResponseReceived(ev) => self.network_manager.on_response_received(ev),
CdpEvent::NetworkLoadingFinished(ev) => {
self.network_manager.on_network_loading_finished(ev)
}
CdpEvent::NetworkLoadingFailed(ev) => {
self.network_manager.on_network_loading_failed(ev)
}
_ => (),
}
chromiumoxide_cdp::consume_event!(match params {
|ev| self.event_listeners.start_send(ev),
|json| { let _ = self.event_listeners.try_send_custom(&method, json);}
});
}
/// Called when a init command timed out
fn on_initialization_failed(&mut self) -> TargetEvent {
if let Some(initiator) = self.initiator.take() {
let _ = initiator.send(Err(CdpError::Timeout));
}
self.init_state = TargetInit::Closing;
let close_target = CloseTargetParams::new(self.info.target_id.clone());
TargetEvent::Request(Request {
method: close_target.identifier(),
session_id: self.session_id.clone().map(Into::into),
params: serde_json::to_value(close_target).unwrap_or_default(),
})
}
/// Advance that target's state
pub(crate) fn poll(&mut self, cx: &mut Context<'_>, now: Instant) -> Option<TargetEvent> {
if !self.is_page() {
// can only poll pages
return None;
}
match &mut self.init_state {
TargetInit::AttachToTarget => {
self.init_state = TargetInit::InitializingFrame(FrameManager::init_commands(
self.config.request_timeout,
));
if let Ok(params) = AttachToTargetParams::builder()
.target_id(self.target_id().clone())
.flatten(true)
.build()
{
return Some(TargetEvent::Request(Request::new(
params.identifier(),
serde_json::to_value(params).unwrap_or_default(),
)));
} else {
return None;
}
}
TargetInit::InitializingFrame(cmds) => {
self.session_id.as_ref()?;
if let Poll::Ready(poll) = cmds.poll(now) {
return match poll {
None => {
if let Some(world_name) = self.frame_manager.get_isolated_world_name() {
let world_name = world_name.clone();
if let Some(isolated_world_cmds) =
self.frame_manager.ensure_isolated_world(&world_name)
{
*cmds = isolated_world_cmds;
} else {
self.init_state = TargetInit::InitializingNetwork(
self.network_manager.init_commands(),
);
}
} else {
self.init_state = TargetInit::InitializingNetwork(
self.network_manager.init_commands(),
);
}
self.poll(cx, now)
}
Some(Ok((method, params))) => Some(TargetEvent::Request(Request {
method,
session_id: self.session_id.clone().map(Into::into),
params,
})),
Some(Err(_)) => Some(self.on_initialization_failed()),
};
} else {
return None;
}
}
TargetInit::InitializingNetwork(cmds) => {
advance_state!(
self,
cx,
now,
cmds,
TargetInit::InitializingPage(Self::page_init_commands(
self.config.request_timeout
))
);
}
TargetInit::InitializingPage(cmds) => {
advance_state!(
self,
cx,
now,
cmds,
match self.config.viewport.as_ref() {
Some(viewport) => TargetInit::InitializingEmulation(
self.emulation_manager.init_commands(viewport)
),
None => TargetInit::Initialized,
}
);
}
TargetInit::InitializingEmulation(cmds) => {
advance_state!(self, cx, now, cmds, TargetInit::Initialized);
}
TargetInit::Initialized => {
if let Some(initiator) = self.initiator.take() {
// make sure that the main frame of the page has finished loading
if self
.frame_manager
.main_frame()
.map(|frame| frame.is_loaded())
.unwrap_or_default()
{
if let Some(page) = self.get_or_create_page() {
let _ = initiator.send(Ok(page.clone().into()));
} else {
self.initiator = Some(initiator);
}
} else {
self.initiator = Some(initiator);
}
}
}
TargetInit::Closing => return None,
};
// Prune senders whose receivers have been dropped (caller
// timed out or was cancelled) so the vecs don't grow unbounded.
// Done once per poll() call, outside the inner loop.
if !self.wait_for_frame_navigation.is_empty() {
self.wait_for_frame_navigation.retain(|tx| !tx.is_closed());
}
if !self.wait_for_dom_content_loaded.is_empty() {
self.wait_for_dom_content_loaded
.retain(|tx| !tx.is_closed());
}
if !self.wait_for_load.is_empty() {
self.wait_for_load.retain(|tx| !tx.is_closed());
}
if !self.wait_for_network_idle.is_empty() {
self.wait_for_network_idle.retain(|tx| !tx.is_closed());
}
if !self.wait_for_network_almost_idle.is_empty() {
self.wait_for_network_almost_idle
.retain(|tx| !tx.is_closed());
}
loop {
if self.init_state == TargetInit::Closing {
break None;
}
if let Some(frame) = self.frame_manager.main_frame() {
if frame.is_dom_content_loaded() {
while let Some(tx) = self.wait_for_dom_content_loaded.pop() {
let _ = tx.send(frame.http_request().cloned());
}
while let Some(tx) = self.wait_for_frame_navigation.pop() {
let _ = tx.send(frame.http_request().cloned());
}
}
if frame.is_loaded() {
while let Some(tx) = self.wait_for_load.pop() {
let _ = tx.send(frame.http_request().cloned());
}
}
if frame.is_network_idle() {
while let Some(tx) = self.wait_for_network_idle.pop() {
let _ = tx.send(frame.http_request().cloned());
}
}
if frame.is_network_almost_idle() {
while let Some(tx) = self.wait_for_network_almost_idle.pop() {
let _ = tx.send(frame.http_request().cloned());
}
}
}
// Drain queued messages first.
if let Some(ev) = self.queued_events.pop_front() {
return Some(ev);
}
if let Some(handle) = self.page.as_mut() {
while let Poll::Ready(Some(msg)) = handle.rx.poll_recv(cx) {
if self.init_state == TargetInit::Closing {
break;
}
match msg {
TargetMessage::Command(cmd) => {
if cmd.method == "Network.setBlockedURLs" {
if let Some(arr) = cmd.params.get("urls").and_then(|v| v.as_array())
{
let mut unblock_all = false;
let mut block_all = false;
for s in arr.iter().filter_map(|v| v.as_str()) {
if s == "!*" {
unblock_all = true;
break; // "!*" overrides any block rules
}
if s.contains('*') {
block_all = true;
}
}
if unblock_all {
self.network_manager.set_block_all(false);
} else if block_all {
self.network_manager.set_block_all(true);
}
}
}
self.queued_events.push_back(TargetEvent::Command(cmd));
}
TargetMessage::MainFrame(tx) => {
let _ =
tx.send(self.frame_manager.main_frame().map(|f| f.id().clone()));
}
TargetMessage::AllFrames(tx) => {
let _ = tx.send(
self.frame_manager
.frames()
.map(|f| f.id().clone())
.collect(),
);
}
#[cfg(feature = "_cache")]
TargetMessage::CacheKey((cache_key, cache_policy)) => {
self.network_manager.set_cache_site_key(cache_key);
self.network_manager.set_cache_policy(cache_policy);
}
TargetMessage::Url(req) => {
let GetUrl { frame_id, tx } = req;
let frame = if let Some(frame_id) = frame_id {
self.frame_manager.frame(&frame_id)
} else {
self.frame_manager.main_frame()
};
let _ = tx.send(frame.and_then(|f| f.url().map(str::to_string)));
}
TargetMessage::Name(req) => {
let GetName { frame_id, tx } = req;
let frame = if let Some(frame_id) = frame_id {
self.frame_manager.frame(&frame_id)
} else {
self.frame_manager.main_frame()
};
let _ = tx.send(frame.and_then(|f| f.name().map(str::to_string)));
}
TargetMessage::Parent(req) => {
let GetParent { frame_id, tx } = req;
let frame = self.frame_manager.frame(&frame_id);
let _ = tx.send(frame.and_then(|f| f.parent_id().cloned()));
}
TargetMessage::WaitForNavigation(tx) => {
if let Some(frame) = self.frame_manager.main_frame() {
if frame.is_dom_content_loaded() {
let _ = tx.send(frame.http_request().cloned());
} else {
self.wait_for_frame_navigation.push(tx);
}
} else {
self.wait_for_frame_navigation.push(tx);
}
}
TargetMessage::WaitForDomContentLoaded(tx) => {
if let Some(frame) = self.frame_manager.main_frame() {
if frame.is_dom_content_loaded() {
let _ = tx.send(frame.http_request().cloned());
} else {
self.wait_for_dom_content_loaded.push(tx);
}
} else {
self.wait_for_dom_content_loaded.push(tx);
}
}
TargetMessage::WaitForLoad(tx) => {
if let Some(frame) = self.frame_manager.main_frame() {
if frame.is_loaded() {
let _ = tx.send(frame.http_request().cloned());
} else {
self.wait_for_load.push(tx);
}
} else {
self.wait_for_load.push(tx);
}
}
TargetMessage::WaitForNetworkIdle(tx) => {
if let Some(frame) = self.frame_manager.main_frame() {
if frame.is_network_idle() {
let _ = tx.send(frame.http_request().cloned());
} else {
self.wait_for_network_idle.push(tx);
}
} else {
self.wait_for_network_idle.push(tx);
}
}
TargetMessage::WaitForNetworkAlmostIdle(tx) => {
if let Some(frame) = self.frame_manager.main_frame() {
if frame.is_network_almost_idle() {
let _ = tx.send(frame.http_request().cloned());
} else {
self.wait_for_network_almost_idle.push(tx);
}
} else {
self.wait_for_network_almost_idle.push(tx);
}
}
TargetMessage::AddEventListener(req) => {
if req.method == "Fetch.requestPaused" {
self.network_manager.enable_request_intercept();
}
// register a new listener
self.event_listeners.add_listener(req);
}
TargetMessage::GetExecutionContext(ctx) => {
let GetExecutionContext {
dom_world,
frame_id,
tx,
} = ctx;
let frame = if let Some(frame_id) = frame_id {
self.frame_manager.frame(&frame_id)
} else {
self.frame_manager.main_frame()
};
if let Some(frame) = frame {
match dom_world {
DOMWorldKind::Main => {
let _ = tx.send(frame.main_world().execution_context());
}
DOMWorldKind::Secondary => {
let _ =
tx.send(frame.secondary_world().execution_context());
}
}
} else {
let _ = tx.send(None);
}
}
TargetMessage::Authenticate(credentials) => {
self.network_manager.authenticate(credentials);
}
TargetMessage::BlockNetwork(blocked) => {
self.network_manager.set_block_all(blocked);
}
TargetMessage::EnableInterception(enabled) => {
// if interception is enabled disable the user facing handling.
self.network_manager.user_request_interception_enabled = !enabled;
}
}
}
}
while let Some(event) = self.network_manager.poll() {
if self.init_state == TargetInit::Closing {
break;
}
match event {
NetworkEvent::SendCdpRequest((method, params)) => {
// send a message to the browser
self.queued_events.push_back(TargetEvent::Request(Request {
method,
session_id: self.session_id.clone().map(Into::into),
params,
}))
}
NetworkEvent::Request(_) => {}
NetworkEvent::Response(_) => {}
NetworkEvent::RequestFailed(request) => {
self.frame_manager.on_http_request_finished(request);
}
NetworkEvent::RequestFinished(request) => {
self.frame_manager.on_http_request_finished(request);
}
NetworkEvent::BytesConsumed(n) => {
self.queued_events.push_back(TargetEvent::BytesConsumed(n));
}
}
}
while let Some(event) = self.frame_manager.poll(now) {
if self.init_state == TargetInit::Closing {
break;
}
match event {
FrameEvent::NavigationResult(res) => {
self.queued_events
.push_back(TargetEvent::NavigationResult(res));
}
FrameEvent::NavigationRequest(id, req) => {
self.queued_events
.push_back(TargetEvent::NavigationRequest(id, req));
}
}
}
if self.queued_events.is_empty() {
return None;
}
}
}
/// Process a single message from the page channel.
///
/// Used by `Handler::run()` after `try_recv()` drains the page channel.
pub(crate) fn on_page_message(&mut self, msg: TargetMessage) {
if self.init_state == TargetInit::Closing {
return;
}
match msg {
TargetMessage::Command(cmd) => {
if cmd.method == "Network.setBlockedURLs" {
if let Some(arr) = cmd.params.get("urls").and_then(|v| v.as_array()) {
let mut unblock_all = false;
let mut block_all = false;
for s in arr.iter().filter_map(|v| v.as_str()) {
if s == "!*" {
unblock_all = true;
break;
}
if s.contains('*') {
block_all = true;
}
}
if unblock_all {
self.network_manager.set_block_all(false);
} else if block_all {
self.network_manager.set_block_all(true);
}
}
}
self.queued_events.push_back(TargetEvent::Command(cmd));
}
TargetMessage::MainFrame(tx) => {
let _ = tx.send(self.frame_manager.main_frame().map(|f| f.id().clone()));
}
TargetMessage::AllFrames(tx) => {
let _ = tx.send(
self.frame_manager
.frames()
.map(|f| f.id().clone())
.collect(),
);
}
#[cfg(feature = "_cache")]
TargetMessage::CacheKey((cache_key, cache_policy)) => {
self.network_manager.set_cache_site_key(cache_key);
self.network_manager.set_cache_policy(cache_policy);
}
TargetMessage::Url(req) => {
let GetUrl { frame_id, tx } = req;
let frame = if let Some(frame_id) = frame_id {
self.frame_manager.frame(&frame_id)
} else {
self.frame_manager.main_frame()
};
let _ = tx.send(frame.and_then(|f| f.url().map(str::to_string)));
}
TargetMessage::Name(req) => {
let GetName { frame_id, tx } = req;
let frame = if let Some(frame_id) = frame_id {
self.frame_manager.frame(&frame_id)
} else {
self.frame_manager.main_frame()
};
let _ = tx.send(frame.and_then(|f| f.name().map(str::to_string)));
}
TargetMessage::Parent(req) => {
let GetParent { frame_id, tx } = req;
let frame = self.frame_manager.frame(&frame_id);
let _ = tx.send(frame.and_then(|f| f.parent_id().cloned()));
}
TargetMessage::WaitForNavigation(tx) => {
if let Some(frame) = self.frame_manager.main_frame() {
if frame.is_dom_content_loaded() {
let _ = tx.send(frame.http_request().cloned());
} else {
self.wait_for_frame_navigation.push(tx);
}
} else {
self.wait_for_frame_navigation.push(tx);
}
}
TargetMessage::WaitForDomContentLoaded(tx) => {
if let Some(frame) = self.frame_manager.main_frame() {
if frame.is_dom_content_loaded() {
let _ = tx.send(frame.http_request().cloned());
} else {
self.wait_for_dom_content_loaded.push(tx);
}
} else {
self.wait_for_dom_content_loaded.push(tx);
}
}
TargetMessage::WaitForLoad(tx) => {
if let Some(frame) = self.frame_manager.main_frame() {
if frame.is_loaded() {
let _ = tx.send(frame.http_request().cloned());
} else {
self.wait_for_load.push(tx);
}
} else {
self.wait_for_load.push(tx);
}
}
TargetMessage::WaitForNetworkIdle(tx) => {
if let Some(frame) = self.frame_manager.main_frame() {
if frame.is_network_idle() {
let _ = tx.send(frame.http_request().cloned());
} else {
self.wait_for_network_idle.push(tx);
}
} else {
self.wait_for_network_idle.push(tx);
}
}
TargetMessage::WaitForNetworkAlmostIdle(tx) => {
if let Some(frame) = self.frame_manager.main_frame() {
if frame.is_network_almost_idle() {
let _ = tx.send(frame.http_request().cloned());
} else {
self.wait_for_network_almost_idle.push(tx);
}
} else {
self.wait_for_network_almost_idle.push(tx);
}
}
TargetMessage::AddEventListener(req) => {
if req.method == "Fetch.requestPaused" {
self.network_manager.enable_request_intercept();
}
self.event_listeners.add_listener(req);
}
TargetMessage::GetExecutionContext(ctx) => {
let GetExecutionContext {
dom_world,
frame_id,
tx,
} = ctx;
let frame = if let Some(frame_id) = frame_id {
self.frame_manager.frame(&frame_id)
} else {
self.frame_manager.main_frame()
};
if let Some(frame) = frame {
match dom_world {
DOMWorldKind::Main => {
let _ = tx.send(frame.main_world().execution_context());
}
DOMWorldKind::Secondary => {
let _ = tx.send(frame.secondary_world().execution_context());
}
}
} else {
let _ = tx.send(None);
}
}
TargetMessage::Authenticate(credentials) => {
self.network_manager.authenticate(credentials);
}
TargetMessage::BlockNetwork(blocked) => {
self.network_manager.set_block_all(blocked);
}
TargetMessage::EnableInterception(enabled) => {
self.network_manager.user_request_interception_enabled = !enabled;
}
}
}
/// Advance the target's state machine and drain queued events.
///
/// Like [`poll`](Self::poll) but does **not** read from the page channel
/// (that is handled externally by `Handler::run()` via `try_recv`).
pub(crate) fn advance(&mut self, now: Instant) -> Option<TargetEvent> {
if !self.is_page() {
return None;
}
// Init state machine
match &mut self.init_state {
TargetInit::AttachToTarget => {
self.init_state = TargetInit::InitializingFrame(FrameManager::init_commands(
self.config.request_timeout,
));
if let Ok(params) = AttachToTargetParams::builder()
.target_id(self.target_id().clone())
.flatten(true)
.build()
{
return Some(TargetEvent::Request(Request::new(
params.identifier(),
serde_json::to_value(params).unwrap_or_default(),
)));
} else {
return None;
}
}
TargetInit::InitializingFrame(cmds) => {
self.session_id.as_ref()?;
if let Poll::Ready(poll) = cmds.poll(now) {
return match poll {
None => {
if let Some(world_name) = self.frame_manager.get_isolated_world_name() {
let world_name = world_name.clone();
if let Some(isolated_world_cmds) =
self.frame_manager.ensure_isolated_world(&world_name)
{
*cmds = isolated_world_cmds;
} else {
self.init_state = TargetInit::InitializingNetwork(
self.network_manager.init_commands(),
);
}
} else {
self.init_state = TargetInit::InitializingNetwork(
self.network_manager.init_commands(),
);
}
self.advance(now)
}
Some(Ok((method, params))) => Some(TargetEvent::Request(Request {
method,
session_id: self.session_id.clone().map(Into::into),
params,
})),
Some(Err(_)) => Some(self.on_initialization_failed()),
};
} else {
return None;
}
}
TargetInit::InitializingNetwork(cmds) => {
if let Poll::Ready(poll) = cmds.poll(now) {
return match poll {
None => {
self.init_state = TargetInit::InitializingPage(
Self::page_init_commands(self.config.request_timeout),
);
self.advance(now)
}
Some(Ok((method, params))) => Some(TargetEvent::Request(Request {
method,
session_id: self.session_id.clone().map(Into::into),
params,
})),
Some(Err(_)) => Some(self.on_initialization_failed()),
};
} else {
return None;
}
}
TargetInit::InitializingPage(cmds) => {
if let Poll::Ready(poll) = cmds.poll(now) {
return match poll {
None => {
self.init_state = match self.config.viewport.as_ref() {
Some(viewport) => TargetInit::InitializingEmulation(
self.emulation_manager.init_commands(viewport),
),
None => TargetInit::Initialized,
};
self.advance(now)
}
Some(Ok((method, params))) => Some(TargetEvent::Request(Request {
method,
session_id: self.session_id.clone().map(Into::into),
params,
})),
Some(Err(_)) => Some(self.on_initialization_failed()),
};
} else {
return None;
}
}
TargetInit::InitializingEmulation(cmds) => {
if let Poll::Ready(poll) = cmds.poll(now) {
return match poll {
None => {
self.init_state = TargetInit::Initialized;
self.advance(now)
}
Some(Ok((method, params))) => Some(TargetEvent::Request(Request {
method,
session_id: self.session_id.clone().map(Into::into),
params,
})),
Some(Err(_)) => Some(self.on_initialization_failed()),
};
} else {
return None;
}
}
TargetInit::Initialized => {
if let Some(initiator) = self.initiator.take() {
if self
.frame_manager
.main_frame()
.map(|frame| frame.is_loaded())
.unwrap_or_default()
{
if let Some(page) = self.get_or_create_page() {
let _ = initiator.send(Ok(page.clone().into()));
} else {
self.initiator = Some(initiator);
}
} else {
self.initiator = Some(initiator);
}
}
}
TargetInit::Closing => return None,
};
// Prune dead waiters
if !self.wait_for_frame_navigation.is_empty() {
self.wait_for_frame_navigation.retain(|tx| !tx.is_closed());
}
if !self.wait_for_dom_content_loaded.is_empty() {
self.wait_for_dom_content_loaded
.retain(|tx| !tx.is_closed());
}
if !self.wait_for_load.is_empty() {
self.wait_for_load.retain(|tx| !tx.is_closed());
}
if !self.wait_for_network_idle.is_empty() {
self.wait_for_network_idle.retain(|tx| !tx.is_closed());
}
if !self.wait_for_network_almost_idle.is_empty() {
self.wait_for_network_almost_idle
.retain(|tx| !tx.is_closed());
}
// Drain events loop (same as poll's inner loop, minus page channel reading)
loop {
if self.init_state == TargetInit::Closing {
break None;
}
if let Some(frame) = self.frame_manager.main_frame() {
if frame.is_dom_content_loaded() {
while let Some(tx) = self.wait_for_dom_content_loaded.pop() {
let _ = tx.send(frame.http_request().cloned());
}
while let Some(tx) = self.wait_for_frame_navigation.pop() {
let _ = tx.send(frame.http_request().cloned());
}
}
if frame.is_loaded() {
while let Some(tx) = self.wait_for_load.pop() {
let _ = tx.send(frame.http_request().cloned());
}
}
if frame.is_network_idle() {
while let Some(tx) = self.wait_for_network_idle.pop() {
let _ = tx.send(frame.http_request().cloned());
}
}
if frame.is_network_almost_idle() {
while let Some(tx) = self.wait_for_network_almost_idle.pop() {
let _ = tx.send(frame.http_request().cloned());
}
}
}
if let Some(ev) = self.queued_events.pop_front() {
return Some(ev);
}
while let Some(event) = self.network_manager.poll() {
if self.init_state == TargetInit::Closing {
break;
}
match event {
NetworkEvent::SendCdpRequest((method, params)) => {
self.queued_events.push_back(TargetEvent::Request(Request {
method,
session_id: self.session_id.clone().map(Into::into),
params,
}));
}
NetworkEvent::Request(_) => {}
NetworkEvent::Response(_) => {}
NetworkEvent::RequestFailed(request) => {
self.frame_manager.on_http_request_finished(request);
}
NetworkEvent::RequestFinished(request) => {
self.frame_manager.on_http_request_finished(request);
}
NetworkEvent::BytesConsumed(n) => {
self.queued_events.push_back(TargetEvent::BytesConsumed(n));
}
}
}
while let Some(event) = self.frame_manager.poll(now) {
if self.init_state == TargetInit::Closing {
break;
}
match event {
FrameEvent::NavigationResult(res) => {
self.queued_events
.push_back(TargetEvent::NavigationResult(res));
}
FrameEvent::NavigationRequest(id, req) => {
self.queued_events
.push_back(TargetEvent::NavigationRequest(id, req));
}
}
}
if self.queued_events.is_empty() {
return None;
}
}
}
/// Set the sender half of the channel who requested the creation of this
/// target
pub fn set_initiator(&mut self, tx: Sender<Result<Page>>) {
self.initiator = Some(tx);
}
pub(crate) fn page_init_commands(timeout: Duration) -> CommandChain {
CommandChain::new(INIT_COMMANDS_PARAMS.clone(), timeout)
}
}
/// Configuration for how a single target/page should be fetched and processed.
#[derive(Debug, Clone)]
pub struct TargetConfig {
/// Whether to ignore TLS/HTTPS certificate errors (e.g. self-signed or expired certs).
/// When `true`, connections will proceed even if certificate validation fails.
pub ignore_https_errors: bool,
/// Request timeout to use for the main navigation / resource fetch.
/// This is the total time allowed before a request is considered failed.
pub request_timeout: Duration,
/// Optional browser viewport to use for this target.
/// When `None`, the default viewport (or headless browser default) is used.
pub viewport: Option<Viewport>,
/// Enable request interception for this target.
/// When `true`, all network requests will pass through the intercept manager.
pub request_intercept: bool,
/// Enable caching for this target.
/// When `true`, responses may be read from and written to the cache layer.
pub cache_enabled: bool,
/// If `true`, skip visual/asset resources that are not required for HTML content
/// (e.g. images, fonts, media). Useful for performance-oriented crawls.
pub ignore_visuals: bool,
/// If `true`, block JavaScript execution (or avoid loading JS resources)
/// for this target. This is useful for purely static HTML crawls.
pub ignore_javascript: bool,
/// If `true`, block analytics / tracking requests (e.g. Google Analytics,
/// common tracker domains, etc.).
pub ignore_analytics: bool,
/// Ignore prefetching.
pub ignore_prefetch: bool,
/// If `true`, block stylesheets and related CSS resources for this target.
/// This can reduce bandwidth when only raw HTML is needed.
pub ignore_stylesheets: bool,
/// If `true`, only HTML documents will be fetched/kept.
/// Non-HTML subresources may be skipped entirely.
pub only_html: bool,
/// Whether service workers are allowed for this target.
/// When `true`, service workers may register and intercept requests.
pub service_worker_enabled: bool,
/// Extra HTTP headers to send with each request for this target.
/// Keys should be header names, values their corresponding header values.
pub extra_headers: Option<std::collections::HashMap<String, String>>,
/// Network intercept manager used to make allow/deny/modify decisions
/// for requests when `request_intercept` is enabled.
pub intercept_manager: NetworkInterceptManager,
/// The maximum number of response bytes allowed for this target.
/// When set, responses larger than this limit may be truncated or aborted.
pub max_bytes_allowed: Option<u64>,
/// Whitelist patterns to allow through the network.
pub whitelist_patterns: Option<Vec<String>>,
/// Blacklist patterns to black through the network.
pub blacklist_patterns: Option<Vec<String>>,
/// Extra ABP/uBO filter rules for the adblock engine.
#[cfg(feature = "adblock")]
pub adblock_filter_rules: Option<Vec<String>>,
/// Optional notify handle for waking `Handler::run()`'s select loop.
/// `None` when using the `impl Stream for Handler` path (no overhead).
pub page_wake: Option<Arc<Notify>>,
}
impl Default for TargetConfig {
fn default() -> Self {
Self {
ignore_https_errors: true,
request_timeout: Duration::from_millis(REQUEST_TIMEOUT),
viewport: Default::default(),
request_intercept: false,
cache_enabled: true,
service_worker_enabled: true,
ignore_javascript: false,
ignore_visuals: false,
ignore_stylesheets: false,
ignore_analytics: true,
ignore_prefetch: true,
only_html: false,
extra_headers: Default::default(),
intercept_manager: NetworkInterceptManager::Unknown,
max_bytes_allowed: None,
whitelist_patterns: None,
blacklist_patterns: None,
#[cfg(feature = "adblock")]
adblock_filter_rules: None,
page_wake: None,
}
}
}
#[derive(Debug, Clone, Eq, PartialEq)]
pub enum TargetType {
Page,
BackgroundPage,
ServiceWorker,
SharedWorker,
Other,
Browser,
Webview,
Unknown(String),
}
impl TargetType {
pub fn new(ty: &str) -> Self {
match ty {
"page" => TargetType::Page,
"background_page" => TargetType::BackgroundPage,
"service_worker" => TargetType::ServiceWorker,
"shared_worker" => TargetType::SharedWorker,
"other" => TargetType::Other,
"browser" => TargetType::Browser,
"webview" => TargetType::Webview,
s => TargetType::Unknown(s.to_string()),
}
}
pub fn is_page(&self) -> bool {
matches!(self, TargetType::Page)
}
pub fn is_background_page(&self) -> bool {
matches!(self, TargetType::BackgroundPage)
}
pub fn is_service_worker(&self) -> bool {
matches!(self, TargetType::ServiceWorker)
}
pub fn is_shared_worker(&self) -> bool {
matches!(self, TargetType::SharedWorker)
}
pub fn is_other(&self) -> bool {
matches!(self, TargetType::Other)
}
pub fn is_browser(&self) -> bool {
matches!(self, TargetType::Browser)
}
pub fn is_webview(&self) -> bool {
matches!(self, TargetType::Webview)
}
}
#[derive(Debug)]
pub(crate) enum TargetEvent {
/// An internal request
Request(Request),
/// An internal navigation request
NavigationRequest(NavigationId, Request),
/// Indicates that a previous requested navigation has finished
NavigationResult(Result<NavigationOk, NavigationError>),
/// A new command arrived via a channel
Command(CommandMessage),
/// The bytes consumed by the network.
BytesConsumed(u64),
}
// TODO this can be moved into the classes?
#[derive(Debug, PartialEq)]
pub enum TargetInit {
InitializingFrame(CommandChain),
InitializingNetwork(CommandChain),
InitializingPage(CommandChain),
InitializingEmulation(CommandChain),
AttachToTarget,
Initialized,
Closing,
}
impl TargetInit {
fn commands_mut(&mut self) -> Option<&mut CommandChain> {
match self {
TargetInit::InitializingFrame(cmd) => Some(cmd),
TargetInit::InitializingNetwork(cmd) => Some(cmd),
TargetInit::InitializingPage(cmd) => Some(cmd),
TargetInit::InitializingEmulation(cmd) => Some(cmd),
TargetInit::AttachToTarget => None,
TargetInit::Initialized => None,
TargetInit::Closing => None,
}
}
}
#[derive(Debug)]
pub struct GetExecutionContext {
/// For which world the execution context was requested
pub dom_world: DOMWorldKind,
/// The if of the frame to get the `ExecutionContext` for
pub frame_id: Option<FrameId>,
/// Sender half of the channel to send the response back
pub tx: Sender<Option<ExecutionContextId>>,
}
impl GetExecutionContext {
pub fn new(tx: Sender<Option<ExecutionContextId>>) -> Self {
Self {
dom_world: DOMWorldKind::Main,
frame_id: None,
tx,
}
}
}
#[derive(Debug)]
pub struct GetUrl {
/// The id of the frame to get the url for (None = main frame)
pub frame_id: Option<FrameId>,
/// Sender half of the channel to send the response back
pub tx: Sender<Option<String>>,
}
impl GetUrl {
pub fn new(tx: Sender<Option<String>>) -> Self {
Self { frame_id: None, tx }
}
}
#[derive(Debug)]
pub struct GetName {
/// The id of the frame to get the name for (None = main frame)
pub frame_id: Option<FrameId>,
/// Sender half of the channel to send the response back
pub tx: Sender<Option<String>>,
}
#[derive(Debug)]
pub struct GetParent {
/// The id of the frame to get the parent for (None = main frame)
pub frame_id: FrameId,
/// Sender half of the channel to send the response back
pub tx: Sender<Option<FrameId>>,
}
#[derive(Debug)]
pub enum TargetMessage {
/// Execute a command within the session of this target
Command(CommandMessage),
/// Return the main frame of this target's page
MainFrame(Sender<Option<FrameId>>),
/// Return all the frames of this target's page
AllFrames(Sender<Vec<FrameId>>),
#[cfg(feature = "_cache")]
/// Set the cache key and policy for the target page.
CacheKey((Option<String>, Option<crate::cache::BasicCachePolicy>)),
/// Return the url if available
Url(GetUrl),
/// Return the name if available
Name(GetName),
/// Return the parent id of a frame
Parent(GetParent),
/// A Message that resolves when the frame finished loading a new url
WaitForNavigation(Sender<ArcHttpRequest>),
/// Resolves when `DOMContentLoaded` fires (HTML parsed, sync scripts
/// executed) — before `load`, so subresources may still be in-flight.
WaitForDomContentLoaded(Sender<ArcHttpRequest>),
/// Resolves when the `load` event fires — all subresources (images,
/// fonts, XHRs) are done. Slower than `WaitForNavigation` through proxies.
WaitForLoad(Sender<ArcHttpRequest>),
/// A Message that resolves when the frame network is idle
WaitForNetworkIdle(Sender<ArcHttpRequest>),
/// A Message that resolves when the frame network is almost idle
WaitForNetworkAlmostIdle(Sender<ArcHttpRequest>),
/// A request to submit a new listener that gets notified with every
/// received event
AddEventListener(EventListenerRequest),
/// Get the `ExecutionContext` if available
GetExecutionContext(GetExecutionContext),
Authenticate(Credentials),
/// Set block/unblocked networking
BlockNetwork(bool),
/// Enable/Disable internal request paused interception
EnableInterception(bool),
}