1use std::cell::Cell;
10
11use content_security_policy::sandboxing_directive::SandboxingFlagSet;
12use crossbeam_channel::Sender;
13use embedder_traits::user_contents::UserContentManagerId;
14use embedder_traits::{Theme, ViewportDetails, WebDriverLoadStatus};
15use http::header;
16use js::context::JSContext;
17use net_traits::blob_url_store::UrlWithBlobClaim;
18use net_traits::request::{
19 CredentialsMode, InsecureRequestsPolicy, Origin, PreloadedResources, RedirectMode,
20 RequestBuilder, RequestClient, RequestMode,
21};
22use net_traits::response::ResponseInit;
23use net_traits::{
24 BoxedFetchCallback, CoreResourceThread, DOCUMENT_ACCEPT_HEADER_VALUE, FetchResponseMsg,
25 Metadata, ReferrerPolicy, fetch_async, set_default_accept_language,
26};
27use script_bindings::inheritance::Castable;
28use script_traits::{DocumentActivity, NewPipelineInfo};
29use servo_base::cross_process_instant::CrossProcessInstant;
30use servo_base::id::{BrowsingContextId, PipelineId, WebViewId};
31use servo_constellation_traits::{
32 LoadData, LoadOrigin, NavigationHistoryBehavior, ScriptToConstellationMessage,
33 TargetSnapshotParams,
34};
35use servo_url::{ImmutableOrigin, MutableOrigin, ServoUrl};
36use url::Position;
37
38use crate::dom::bindings::codegen::Bindings::HTMLIFrameElementBinding::HTMLIFrameElementMethods;
39use crate::dom::bindings::codegen::Bindings::WindowBinding::WindowMethods;
40use crate::dom::bindings::refcounted::Trusted;
41use crate::dom::element::Element;
42use crate::dom::html::htmliframeelement::HTMLIFrameElement;
43use crate::dom::node::node::NodeTraits;
44use crate::dom::window::Window;
45use crate::dom::windowproxy::WindowProxy;
46use crate::event_loop::script_thread::ScriptThread;
47use crate::fetch::FetchCanceller;
48use crate::messaging::MainThreadScriptMsg;
49
50#[derive(Clone)]
51pub struct NavigationListener {
52 request_builder: RequestBuilder,
53 main_thread_sender: Sender<MainThreadScriptMsg>,
54 send_results_to_main_thread: Cell<bool>,
57}
58
59impl NavigationListener {
60 pub(crate) fn into_callback(self) -> BoxedFetchCallback {
61 Box::new(move |response_msg| self.notify_fetch(response_msg))
62 }
63
64 pub fn new(
65 request_builder: RequestBuilder,
66 main_thread_sender: Sender<MainThreadScriptMsg>,
67 ) -> NavigationListener {
68 NavigationListener {
69 request_builder,
70 main_thread_sender,
71 send_results_to_main_thread: Cell::new(true),
72 }
73 }
74
75 pub fn initiate_fetch(
76 self,
77 core_resource_thread: &CoreResourceThread,
78 response_init: Option<ResponseInit>,
79 ) {
80 fetch_async(
81 core_resource_thread,
82 self.request_builder.clone(),
83 response_init,
84 self.into_callback(),
85 );
86 }
87
88 fn notify_fetch(&self, message: FetchResponseMsg) {
89 if !self.send_results_to_main_thread.get() {
92 return;
93 }
94
95 if Self::http_redirect_metadata(&message).is_some() {
97 self.send_results_to_main_thread.set(false);
98 }
99
100 let pipeline_id = self
101 .request_builder
102 .pipeline_id
103 .expect("Navigation should always have an associated Pipeline");
104 let result = self
105 .main_thread_sender
106 .send(MainThreadScriptMsg::NavigationResponse {
107 pipeline_id,
108 message: Box::new(message),
109 });
110
111 if let Err(error) = result {
112 warn!(
113 "Failed to send network message to pipeline {:?}: {error:?}",
114 pipeline_id
115 );
116 }
117 }
118
119 pub(crate) fn http_redirect_metadata(message: &FetchResponseMsg) -> Option<&Metadata> {
120 let FetchResponseMsg::ProcessResponse(_, Ok(metadata)) = message else {
121 return None;
122 };
123
124 let metadata = metadata.metadata();
126 if !matches!(
127 metadata.location_url,
128 Some(Ok(ref location_url)) if matches!(location_url.scheme(), "http" | "https")
129 ) {
130 return None;
131 }
132
133 Some(metadata)
134 }
135}
136
137#[derive(JSTraceable)]
142pub(crate) struct InProgressLoad {
143 #[no_trace]
145 pub(crate) pipeline_id: PipelineId,
146 #[no_trace]
148 pub(crate) browsing_context_id: BrowsingContextId,
149 #[no_trace]
151 pub(crate) webview_id: WebViewId,
152 #[no_trace]
154 pub(crate) parent_info: Option<PipelineId>,
155 #[no_trace]
157 pub(crate) opener: Option<BrowsingContextId>,
158 #[no_trace]
160 pub(crate) viewport_details: ViewportDetails,
161 #[no_trace]
163 pub(crate) activity: DocumentActivity,
164 pub(crate) throttled: bool,
166 #[no_trace]
168 pub(crate) navigation_start: CrossProcessInstant,
169 pub(crate) canceller: FetchCanceller,
171 #[no_trace]
173 pub(crate) load_data: LoadData,
174 #[no_trace]
177 pub(crate) url_list: Vec<ServoUrl>,
178 #[no_trace]
179 pub(crate) user_content_manager_id: Option<UserContentManagerId>,
181 #[no_trace]
183 pub(crate) embedder_theme: Theme,
184 #[no_trace]
186 pub(crate) target_snapshot_params: TargetSnapshotParams,
187}
188
189impl InProgressLoad {
190 pub(crate) fn new(new_pipeline_info: NewPipelineInfo) -> InProgressLoad {
192 let url = new_pipeline_info.load_data.url.clone();
193 InProgressLoad {
194 pipeline_id: new_pipeline_info.new_pipeline_id,
195 browsing_context_id: new_pipeline_info.browsing_context_id,
196 webview_id: new_pipeline_info.webview_id,
197 parent_info: new_pipeline_info.parent_info,
198 opener: new_pipeline_info.opener,
199 viewport_details: new_pipeline_info.viewport_details,
200 activity: DocumentActivity::FullyActive,
201 throttled: false,
202 navigation_start: CrossProcessInstant::now(),
203 canceller: Default::default(),
204 load_data: new_pipeline_info.load_data,
205 url_list: vec![url],
206 user_content_manager_id: new_pipeline_info.user_content_manager_id,
207 embedder_theme: new_pipeline_info.embedder_theme,
208 target_snapshot_params: new_pipeline_info.target_snapshot_params,
209 }
210 }
211
212 pub(crate) fn request_builder(&mut self) -> RequestBuilder {
213 let client_origin = match self.load_data.load_origin {
214 LoadOrigin::Script(ref initiator_origin) => initiator_origin.immutable().clone(),
215 _ => ImmutableOrigin::new_opaque(),
216 };
217
218 let id = self.pipeline_id;
219 let webview_id = self.webview_id;
220
221 let insecure_requests_policy = self
222 .load_data
223 .inherited_insecure_requests_policy
224 .unwrap_or(InsecureRequestsPolicy::DoNotUpgrade);
225
226 let request_client = RequestClient {
227 preloaded_resources: PreloadedResources::default(),
228 policy_container: self.load_data.policy_container.clone().unwrap_or_default(),
229 origin: Origin::Origin(client_origin),
230 is_nested_browsing_context: self.parent_info.is_some(),
231 insecure_requests_policy,
232 has_trustworthy_ancestor_origin: self.load_data.has_trustworthy_ancestor_origin,
233 };
234
235 let mut request_builder = RequestBuilder::new(
236 Some(webview_id),
237 UrlWithBlobClaim::from_url_without_having_claimed_blob(self.load_data.url.clone()),
238 self.load_data.referrer.clone(),
239 )
240 .method(self.load_data.method.clone())
241 .destination(self.load_data.destination)
242 .mode(RequestMode::Navigate)
243 .credentials_mode(CredentialsMode::Include)
244 .use_url_credentials(true)
245 .pipeline_id(Some(id))
246 .referrer_policy(self.load_data.referrer_policy)
247 .policy_container(self.load_data.policy_container.clone().unwrap_or_default())
248 .headers(self.load_data.headers.clone())
249 .body(self.load_data.data.clone())
250 .redirect_mode(RedirectMode::Manual)
251 .crash(self.load_data.crash.clone())
252 .client(request_client)
253 .url_list(self.url_list.clone());
254
255 request_builder.reload_navigation = self.load_data.reload_navigation;
256 request_builder.history_navigation = self.load_data.history_navigation;
257
258 if !request_builder.headers.contains_key(header::ACCEPT) {
259 request_builder
260 .headers
261 .insert(header::ACCEPT, DOCUMENT_ACCEPT_HEADER_VALUE);
262 }
263 set_default_accept_language(&mut request_builder.headers);
264
265 request_builder
266 }
267}
268
269pub(crate) fn determine_the_origin(
271 url: Option<&ServoUrl>,
272 sandbox_flags: SandboxingFlagSet,
273 source_origin: Option<MutableOrigin>,
274) -> MutableOrigin {
275 let is_sandboxed =
277 sandbox_flags.contains(SandboxingFlagSet::SANDBOXED_ORIGIN_BROWSING_CONTEXT_FLAG);
278 if is_sandboxed {
279 return MutableOrigin::new(ImmutableOrigin::new_opaque());
280 }
281
282 let Some(url) = url else {
284 return MutableOrigin::new(ImmutableOrigin::new_opaque());
285 };
286
287 if url.as_str() == "about:srcdoc" {
289 let source_origin =
291 source_origin.expect("Can't have a null source origin for about:srcdoc");
292 return source_origin;
294 }
295
296 if url.as_str() == "about:blank" &&
298 let Some(source_origin) = source_origin
299 {
300 return source_origin;
301 }
302
303 MutableOrigin::new(url.origin())
305}
306
307fn navigate_to_fragment(
309 cx: &mut JSContext,
310 window: &Window,
311 url: &ServoUrl,
312 history_handling: NavigationHistoryBehavior,
313) {
314 let doc = window.Document();
315 window.send_to_constellation(ScriptToConstellationMessage::NavigatedToFragment(
338 url.clone(),
339 history_handling,
340 ));
341 let old_url = doc.url();
343 doc.set_url(url.clone());
344 doc.update_document_for_history_step_application(&old_url, url);
347 let Some(fragment) = url.fragment() else {
349 unreachable!("Must always have a fragment");
350 };
351 doc.scroll_to_the_fragment(cx, fragment);
352 }
357
358pub(crate) fn navigate(
360 cx: &mut JSContext,
361 window: &Window,
362 history_handling: NavigationHistoryBehavior,
363 force_reload: bool,
364 mut load_data: LoadData,
365) {
366 let doc = window.Document();
367
368 if force_reload {
370 load_data.reload_navigation = true;
372 }
373
374 let initiator_origin_snapshot = &load_data.load_origin;
376
377 let pipeline_id = window.pipeline_id();
382 let window_proxy = window.window_proxy();
383 if let Some(active) = window_proxy.currently_active() &&
384 pipeline_id == active &&
385 doc.is_prompting_or_unloading()
386 {
387 return;
388 }
389
390 let history_handling = if history_handling == NavigationHistoryBehavior::Auto {
392 if let LoadOrigin::Script(initiator_origin) = initiator_origin_snapshot {
399 if load_data.url == doc.url() && initiator_origin.same_origin(&*doc.origin()) {
400 NavigationHistoryBehavior::Replace
401 } else {
402 NavigationHistoryBehavior::Push
404 }
405 } else {
406 NavigationHistoryBehavior::Push
408 }
409 } else {
410 history_handling
411 };
412
413 let history_handling = if load_data.url.scheme() == "javascript" || doc.is_initial_about_blank()
418 {
419 NavigationHistoryBehavior::Replace
420 } else {
421 history_handling
422 };
423
424 if !force_reload
428 && load_data.url.as_url()[..Position::AfterQuery] ==
430 doc.url().as_url()[..Position::AfterQuery]
431 && load_data.url.fragment().is_some()
433 {
434 let webdriver_sender = window.webdriver_load_status_sender();
437 if let Some(ref sender) = webdriver_sender {
438 let _ = sender.send(WebDriverLoadStatus::NavigationStart);
439 }
440 navigate_to_fragment(cx, window, &load_data.url, history_handling);
441 if let Some(sender) = webdriver_sender {
443 let _ = sender.send(WebDriverLoadStatus::NavigationStop);
444 }
445 return;
446 }
447
448 let window_proxy = window.window_proxy();
450 if window_proxy.parent().is_some() {
451 window_proxy.start_delaying_load_events_mode();
452 }
453
454 let target_snapshot_params = snapshot_target_snapshot_params(&window_proxy);
457
458 if let Some(sender) = window.webdriver_load_status_sender() {
463 let _ = sender.send(WebDriverLoadStatus::NavigationStart);
464 }
465
466 if load_data.url.scheme() == "javascript" {
473 let Some(initiator_pipeline_id) = load_data.creator_pipeline_id else {
479 unreachable!("javascript: URL navigations must have a creator pipeline");
480 };
481 let Some(initiator_window) = ScriptThread::find_window(initiator_pipeline_id) else {
482 warn!("Can't find global for navigation initiator");
483 return;
484 };
485
486 let target_window = Trusted::new(window);
487 let mut load_data = load_data;
488 let initiator_window = Trusted::new(&*initiator_window);
489 let task = task!(navigate_javascript: move |cx| {
490 let target_window = target_window.root();
492 let initiator_window = initiator_window.root();
493 if ScriptThread::navigate_to_javascript_url(cx, initiator_window.upcast(), target_window.upcast(), &mut load_data, None, None) {
494 target_window
495 .as_global_scope()
496 .script_to_constellation_chan()
497 .send(ScriptToConstellationMessage::LoadUrl(load_data, history_handling, target_snapshot_params))
498 .unwrap();
499 }
500 });
501 window
502 .as_global_scope()
503 .task_manager()
504 .navigation_and_traversal_task_source()
505 .queue(task);
506 return;
508 }
509
510 let unload_prompt_canceled = doc.check_if_unloading_is_cancelled(cx, false);
517 if !unload_prompt_canceled {
522 return;
528 }
529
530 window.send_to_constellation(ScriptToConstellationMessage::LoadUrl(
535 load_data,
536 history_handling,
537 target_snapshot_params,
538 ));
539}
540
541pub(crate) fn determine_creation_sandboxing_flags(
543 browsing_context: Option<&WindowProxy>,
544 element: Option<&Element>,
545) -> SandboxingFlagSet {
546 match element {
550 None => browsing_context
553 .and_then(|browsing_context| browsing_context.document())
554 .map(|document| document.active_sandboxing_flag_set())
555 .unwrap_or(SandboxingFlagSet::empty()),
556 Some(element) => {
557 element
562 .downcast::<HTMLIFrameElement>()
563 .map(|iframe| iframe.sandboxing_flag_set())
564 .unwrap_or(SandboxingFlagSet::empty())
565 .union(element.owner_document().active_sandboxing_flag_set())
566 },
567 }
568}
569
570pub(crate) fn determine_iframe_element_referrer_policy(
572 element: Option<&Element>,
573) -> ReferrerPolicy {
574 element
577 .and_then(|element| element.downcast::<HTMLIFrameElement>())
578 .map(|iframe| {
579 let token = iframe.ReferrerPolicy();
580 ReferrerPolicy::from(&*token.str())
581 })
582 .unwrap_or(ReferrerPolicy::EmptyString)
584}
585
586pub(crate) fn snapshot_target_snapshot_params(navigable: &WindowProxy) -> TargetSnapshotParams {
588 let container = navigable.frame_element();
590 let sandboxing_flags = determine_creation_sandboxing_flags(Some(navigable), container);
593 let iframe_element_referrer_policy = determine_iframe_element_referrer_policy(container);
596 TargetSnapshotParams {
597 sandboxing_flags,
598 iframe_element_referrer_policy,
599 }
600}