script/dom/html/links/
relations.rs1use html5ever::local_name;
8use js::context::JSContext;
9use malloc_size_of::malloc_size_of_is_0;
10use net_traits::request::Referrer;
11use servo_constellation_traits::{LoadData, LoadOrigin, NavigationHistoryBehavior};
12use style::str::HTML_SPACE_CHARACTERS;
13
14use crate::dom::bindings::inheritance::Castable;
15use crate::dom::bindings::str::DOMString;
16use crate::dom::element::referrer_policy_for_element;
17use crate::dom::html::htmlanchorelement::HTMLAnchorElement;
18use crate::dom::html::htmlareaelement::HTMLAreaElement;
19use crate::dom::html::htmlformelement::HTMLFormElement;
20use crate::dom::html::htmllinkelement::HTMLLinkElement;
21use crate::dom::node::NodeTraits;
22use crate::dom::types::Element;
23use crate::dom::window::windowproxy::WindowOpenType;
24use crate::navigation::navigate;
25
26bitflags::bitflags! {
27 #[derive(Clone, Copy, Debug, PartialEq)]
32 pub(crate) struct LinkRelations: u32 {
33 const ALTERNATE = 1;
35
36 const AUTHOR = 1 << 1;
38
39 const BOOKMARK = 1 << 2;
41
42 const CANONICAL = 1 << 3;
44
45 const DNS_PREFETCH = 1 << 4;
47
48 const EXPECT = 1 << 5;
50
51 const EXTERNAL = 1 << 6;
53
54 const HELP = 1 << 7;
56
57 const ICON = 1 << 8;
59
60 const LICENSE = 1 << 9;
62
63 const NEXT = 1 << 10;
65
66 const MANIFEST = 1 << 11;
68
69 const MODULE_PRELOAD = 1 << 12;
71
72 const NO_FOLLOW = 1 << 13;
74
75 const NO_OPENER = 1 << 14;
77
78 const NO_REFERRER = 1 << 15;
80
81 const OPENER = 1 << 16;
83
84 const PING_BACK = 1 << 17;
86
87 const PRECONNECT = 1 << 18;
89
90 const PREFETCH = 1 << 19;
92
93 const PRELOAD = 1 << 20;
95
96 const PREV = 1 << 21;
98
99 const PRIVACY_POLICY = 1 << 22;
101
102 const SEARCH = 1 << 23;
104
105 const STYLESHEET = 1 << 24;
107
108 const TAG = 1 << 25;
110
111 const TERMS_OF_SERVICE = 1 << 26;
113 }
114}
115
116impl LinkRelations {
117 pub(crate) const ALLOWED_LINK_RELATIONS: Self = Self::ALTERNATE
121 .union(Self::CANONICAL)
122 .union(Self::AUTHOR)
123 .union(Self::DNS_PREFETCH)
124 .union(Self::EXPECT)
125 .union(Self::HELP)
126 .union(Self::ICON)
127 .union(Self::MANIFEST)
128 .union(Self::MODULE_PRELOAD)
129 .union(Self::LICENSE)
130 .union(Self::NEXT)
131 .union(Self::PING_BACK)
132 .union(Self::PRECONNECT)
133 .union(Self::PREFETCH)
134 .union(Self::PRELOAD)
135 .union(Self::PREV)
136 .union(Self::PRIVACY_POLICY)
137 .union(Self::SEARCH)
138 .union(Self::STYLESHEET)
139 .union(Self::TERMS_OF_SERVICE);
140
141 pub(crate) const ALLOWED_ANCHOR_OR_AREA_RELATIONS: Self = Self::ALTERNATE
146 .union(Self::AUTHOR)
147 .union(Self::BOOKMARK)
148 .union(Self::EXTERNAL)
149 .union(Self::HELP)
150 .union(Self::LICENSE)
151 .union(Self::NEXT)
152 .union(Self::NO_FOLLOW)
153 .union(Self::NO_OPENER)
154 .union(Self::NO_REFERRER)
155 .union(Self::OPENER)
156 .union(Self::PREV)
157 .union(Self::PRIVACY_POLICY)
158 .union(Self::SEARCH)
159 .union(Self::TAG)
160 .union(Self::TERMS_OF_SERVICE);
161
162 pub(crate) const ALLOWED_FORM_RELATIONS: Self = Self::EXTERNAL
166 .union(Self::HELP)
167 .union(Self::LICENSE)
168 .union(Self::NEXT)
169 .union(Self::NO_FOLLOW)
170 .union(Self::NO_OPENER)
171 .union(Self::NO_REFERRER)
172 .union(Self::OPENER)
173 .union(Self::PREV)
174 .union(Self::SEARCH);
175
176 pub(crate) fn for_element(element: &Element) -> Self {
185 let rel = element.get_attribute_string_ref(&local_name!("rel"));
186
187 let mut relations = rel
188 .map(|attribute| {
189 attribute
190 .value()
191 .split(HTML_SPACE_CHARACTERS)
192 .map(Self::from_single_keyword)
193 .collect()
194 })
195 .unwrap_or(Self::empty());
196
197 let has_legacy_author_relation = element
199 .get_attribute_string_value(&local_name!("rev"))
200 .is_some_and(|rev| rev == "made");
201 if has_legacy_author_relation {
202 relations |= Self::AUTHOR;
203 }
204
205 let allowed_relations = if element.is::<HTMLLinkElement>() {
206 Self::ALLOWED_LINK_RELATIONS
207 } else if element.is::<HTMLAnchorElement>() || element.is::<HTMLAreaElement>() {
208 Self::ALLOWED_ANCHOR_OR_AREA_RELATIONS
209 } else if element.is::<HTMLFormElement>() {
210 Self::ALLOWED_FORM_RELATIONS
211 } else {
212 Self::empty()
213 };
214
215 relations & allowed_relations
216 }
217
218 fn from_single_keyword(keyword: &str) -> Self {
222 if keyword.eq_ignore_ascii_case("alternate") {
223 Self::ALTERNATE
224 } else if keyword.eq_ignore_ascii_case("canonical") {
225 Self::CANONICAL
226 } else if keyword.eq_ignore_ascii_case("author") {
227 Self::AUTHOR
228 } else if keyword.eq_ignore_ascii_case("bookmark") {
229 Self::BOOKMARK
230 } else if keyword.eq_ignore_ascii_case("dns-prefetch") {
231 Self::DNS_PREFETCH
232 } else if keyword.eq_ignore_ascii_case("expect") {
233 Self::EXPECT
234 } else if keyword.eq_ignore_ascii_case("external") {
235 Self::EXTERNAL
236 } else if keyword.eq_ignore_ascii_case("help") {
237 Self::HELP
238 } else if keyword.eq_ignore_ascii_case("icon") ||
239 keyword.eq_ignore_ascii_case("shortcut icon") ||
240 keyword.eq_ignore_ascii_case("apple-touch-icon")
241 {
242 Self::ICON
246 } else if keyword.eq_ignore_ascii_case("manifest") {
247 Self::MANIFEST
248 } else if keyword.eq_ignore_ascii_case("modulepreload") {
249 Self::MODULE_PRELOAD
250 } else if keyword.eq_ignore_ascii_case("license") ||
251 keyword.eq_ignore_ascii_case("copyright")
252 {
253 Self::LICENSE
254 } else if keyword.eq_ignore_ascii_case("next") {
255 Self::NEXT
256 } else if keyword.eq_ignore_ascii_case("nofollow") {
257 Self::NO_FOLLOW
258 } else if keyword.eq_ignore_ascii_case("noopener") {
259 Self::NO_OPENER
260 } else if keyword.eq_ignore_ascii_case("noreferrer") {
261 Self::NO_REFERRER
262 } else if keyword.eq_ignore_ascii_case("opener") {
263 Self::OPENER
264 } else if keyword.eq_ignore_ascii_case("pingback") {
265 Self::PING_BACK
266 } else if keyword.eq_ignore_ascii_case("preconnect") {
267 Self::PRECONNECT
268 } else if keyword.eq_ignore_ascii_case("prefetch") {
269 Self::PREFETCH
270 } else if keyword.eq_ignore_ascii_case("preload") {
271 Self::PRELOAD
272 } else if keyword.eq_ignore_ascii_case("prev") || keyword.eq_ignore_ascii_case("previous") {
273 Self::PREV
274 } else if keyword.eq_ignore_ascii_case("privacy-policy") {
275 Self::PRIVACY_POLICY
276 } else if keyword.eq_ignore_ascii_case("search") {
277 Self::SEARCH
278 } else if keyword.eq_ignore_ascii_case("stylesheet") {
279 Self::STYLESHEET
280 } else if keyword.eq_ignore_ascii_case("tag") {
281 Self::TAG
282 } else if keyword.eq_ignore_ascii_case("terms-of-service") {
283 Self::TERMS_OF_SERVICE
284 } else {
285 Self::empty()
286 }
287 }
288
289 pub(crate) fn get_element_noopener(&self, target_attribute_value: Option<&DOMString>) -> bool {
291 if self.contains(Self::NO_OPENER) || self.contains(Self::NO_REFERRER) {
293 return true;
294 }
295
296 let target_is_blank =
299 target_attribute_value.is_some_and(|target| target.eq_ignore_ascii_case("_blank"));
300 if !self.contains(Self::OPENER) && target_is_blank {
301 return true;
302 }
303
304 false
306 }
307}
308
309malloc_size_of_is_0!(LinkRelations);
310
311fn valid_navigable_target_name(target: &DOMString) -> bool {
313 if target.is_empty() {
317 return false;
318 }
319 if target.contains_tab_or_newline() && target.contains("\u{003C}") {
320 return false;
321 }
322 if target.starts_with('\u{005F}') {
323 return false;
324 }
325 true
326}
327
328pub(crate) fn valid_navigable_target_name_or_keyword(target: &DOMString) -> bool {
330 if valid_navigable_target_name(target) {
333 return true;
334 }
335 target.eq_ignore_ascii_case("_blank") ||
336 target.eq_ignore_ascii_case("_self") ||
337 target.eq_ignore_ascii_case("_parent") ||
338 target.eq_ignore_ascii_case("_top")
339}
340
341pub(crate) fn get_element_target(
343 subject: &Element,
344 target: Option<DOMString>,
345) -> Option<DOMString> {
346 assert!(
347 subject.is::<HTMLAreaElement>() ||
348 subject.is::<HTMLAnchorElement>() ||
349 subject.is::<HTMLFormElement>()
350 );
351
352 let target = target.or_else(|| {
354 let element_target = subject.get_string_attribute(&local_name!("target"));
359 if valid_navigable_target_name_or_keyword(&element_target) {
360 Some(element_target)
361 } else {
362 subject
365 .owner_document()
366 .target_base_element()
367 .and_then(|base_element| {
368 let element = base_element.upcast::<Element>();
369 if element.has_attribute(&local_name!("target")) {
370 Some(element.get_string_attribute(&local_name!("target")))
371 } else {
372 None
373 }
374 })
375 }
376 });
377 if let Some(ref target) = target &&
379 target.contains_tab_or_newline() &&
380 target.contains("\u{003C}")
381 {
382 return Some(DOMString::from_static("_blank"));
383 }
384 target
386}
387
388pub(crate) fn follow_hyperlink(
390 cx: &mut JSContext,
391 subject: &Element,
392 relations: LinkRelations,
393 hyperlink_suffix: Option<String>,
394) {
395 if subject.cannot_navigate() {
397 return;
398 }
399
400 let document = subject.owner_document();
409 let target_attribute_value =
410 if subject.is::<HTMLAreaElement>() || subject.is::<HTMLAnchorElement>() {
411 if document
412 .event_handler()
413 .alternate_action_keyboard_modifier_active()
414 {
415 Some(DOMString::from_static("_blank"))
416 } else {
417 get_element_target(subject, None)
418 }
419 } else {
420 None
421 };
422
423 let noopener = relations.get_element_noopener(target_attribute_value.as_ref());
431
432 let window = document.window();
436
437 let Some(source) = document.browsing_context() else {
438 return;
439 };
440 let (maybe_chosen, history_handling) = match target_attribute_value {
441 Some(name) => {
442 let (maybe_chosen, window_open_type) = source.choose_a_navigable(cx, &name, noopener);
443 let history_handling = if window_open_type != WindowOpenType::ExistingOrNone {
444 NavigationHistoryBehavior::Replace
445 } else {
446 NavigationHistoryBehavior::Push
447 };
448 (maybe_chosen, history_handling)
449 },
450 None => (Some(source), NavigationHistoryBehavior::Push),
451 };
452
453 let chosen = match maybe_chosen {
455 Some(proxy) => proxy,
456 None => return,
457 };
458
459 if let Some(target_document) = chosen.document() {
460 let target_window = target_document.window();
461 let mut href = subject
465 .get_attribute_string_value(&local_name!("href"))
466 .unwrap();
467
468 if let Some(suffix) = hyperlink_suffix {
470 href.push_str(&suffix);
471 }
472 let Ok(url) = document.encoding_parse_a_url(&href) else {
473 return;
474 };
475
476 let referrer_policy = referrer_policy_for_element(subject);
478
479 let referrer = if relations.contains(LinkRelations::NO_REFERRER) {
482 Referrer::NoReferrer
483 } else {
484 target_window.as_global_scope().get_referrer()
485 };
486
487 let secure = target_window.as_global_scope().is_secure_context();
491 let upgrade_insecure_navigations_set = window
492 .as_global_scope()
493 .upgrade_insecure_navigations_set()
494 .clone();
495 let load_data = LoadData::new(
496 LoadOrigin::Script(document.origin().snapshot()),
497 url,
498 document.about_base_url(),
499 Some(window.pipeline_id()),
500 referrer,
501 referrer_policy,
502 Some(secure),
503 Some(document.insecure_requests_policy()),
504 upgrade_insecure_navigations_set,
505 document.has_trustworthy_ancestor_origin(),
506 document.creation_sandboxing_flag_set_considering_parent_iframe(),
507 );
508 debug!("following hyperlink to {}", load_data.url);
509 navigate(cx, target_window, history_handling, false, load_data);
510 };
511}