File: SpeculationRulesMatcher.cpp

package info (click to toggle)
webkit2gtk 2.51.4-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 481,584 kB
  • sloc: cpp: 3,903,132; javascript: 198,251; ansic: 165,758; python: 51,432; asm: 21,819; ruby: 18,095; perl: 16,963; xml: 4,623; sh: 2,408; yacc: 2,356; java: 2,019; lex: 1,358; pascal: 372; makefile: 203
file content (163 lines) | stat: -rw-r--r-- 6,683 bytes parent folder | download
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
/*
 * Copyright (C) 2025 Shopify Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "config.h"
#include "SpeculationRulesMatcher.h"

#include "CheckVisibilityOptions.h"
#include "Document.h"
#include "Element.h"
#include "HTMLAnchorElement.h"
#include "JSDOMGlobalObject.h"
#include "ReferrerPolicy.h"
#include "ScriptController.h"
#include "SelectorQuery.h"
#include "ShadowRoot.h"
#include "SpeculationRules.h"
#include "URLPattern.h"
#include "URLPatternOptions.h"

namespace WebCore {

static bool isUnslottedElement(Element& element)
{
    for (RefPtr ancestor = &element; ancestor; ) {
        RefPtr parent = ancestor->parentElement();
        if (parent && parent->shadowRoot() && !ancestor->assignedSlot())
            return true;
        ancestor = WTFMove(parent);
    }
    return false;
}

static bool matches(const SpeculationRules::DocumentPredicate&, Document&, HTMLAnchorElement&);

static bool matches(const SpeculationRules::URLPatternPredicate& predicate, HTMLAnchorElement& anchor)
{
    for (const auto& patternString : predicate.patterns) {
        ExceptionOr<Ref<URLPattern>> exceptionOrPattern = URLPattern::create(anchor.protectedDocument(), patternString, String(anchor.document().baseURL().string()), URLPatternOptions());
        if (exceptionOrPattern.hasException())
            continue;

        Ref<URLPattern> pattern = exceptionOrPattern.returnValue();
        auto result = pattern->test(anchor.protectedDocument(), anchor.href().string(), String(anchor.document().baseURL().string()));
        if (!result.hasException() && result.returnValue())
            return true;
    }
    return false;
}

static bool matches(const SpeculationRules::CSSSelectorPredicate& predicate, Element& element)
{
    for (const auto& selectorString : predicate.selectors) {
        auto query = element.protectedDocument()->selectorQueryForString(selectorString);
        if (query.hasException())
            continue;
        if (query.returnValue().matches(element))
            return true;
    }
    return false;
}

static bool matches(const Box<SpeculationRules::Conjunction>& predicate, Document& document, HTMLAnchorElement& anchor)
{
    for (const auto& clause : predicate->clauses) {
        if (!matches(clause, document, anchor))
            return false;
    }
    return true;
}

static bool matches(const Box<SpeculationRules::Disjunction>& predicate, Document& document, HTMLAnchorElement& anchor)
{
    if (predicate->clauses.isEmpty())
        return false;

    for (const auto& clause : predicate->clauses) {
        if (matches(clause, document, anchor))
            return true;
    }
    return false;
}

static bool matches(const Box<SpeculationRules::Negation>& predicate, Document& document, HTMLAnchorElement& anchor)
{
    return !matches(*predicate->clause, document, anchor);
}

// https://html.spec.whatwg.org/C#dr-predicate-matches
static bool matches(const SpeculationRules::DocumentPredicate& predicate, Document& document, HTMLAnchorElement& anchor)
{
    return WTF::switchOn(predicate.value(),
        [&] (const SpeculationRules::URLPatternPredicate& p) { return matches(p, anchor); },
        [&] (const SpeculationRules::CSSSelectorPredicate& p) { return matches(p, anchor); },
        [&] (const Box<SpeculationRules::Conjunction>& p) { return matches(p, document, anchor); },
        [&] (const Box<SpeculationRules::Disjunction>& p) { return matches(p, document, anchor); },
        [&] (const Box<SpeculationRules::Negation>& p) { return matches(p, document, anchor); }
    );
}

// https://html.spec.whatwg.org/C#find-matching-links
std::optional<PrefetchRule> SpeculationRulesMatcher::hasMatchingRule(Document& document, HTMLAnchorElement& anchor)
{
    Ref speculationRules = document.speculationRules();
    if (speculationRules->prefetchRules().isEmptyIgnoringNullReferences())
        return std::nullopt;

    // 2.2 If descendant is not being rendered or is part of skipped contents, then continue.
    // An element is not being rendered if:
    // - It's unslotted (light DOM child of a shadow host without a slot assignment)
    // - It or an ancestor has display:none
    // - It's part of content-visibility:hidden content
    if (isUnslottedElement(anchor) || !anchor.checkVisibility(CheckVisibilityOptions { }))
        return std::nullopt;

    const auto& url = anchor.href();

    for (auto [node, rules] : speculationRules->prefetchRules()) {
        for (const auto& rule : rules) {
            for (const auto& href : rule.urls) {
                if (href == url)
                    return PrefetchRule { rule.tags, rule.referrerPolicy, rule.eagerness };
            }

            if (rule.predicate && matches(rule.predicate.value(), document, anchor)) {
                // For document rules, if the rule doesn't specify a referrer policy,
                // use the link element's referrerPolicy attribute if present.
                auto referrerPolicy = rule.referrerPolicy;
                if (!referrerPolicy) {
                    auto linkReferrerPolicy = anchor.referrerPolicy();
                    if (linkReferrerPolicy != ReferrerPolicy::EmptyString)
                        referrerPolicy = linkReferrerPolicy;
                }
                return PrefetchRule { rule.tags, referrerPolicy, rule.eagerness };
            }
        }
    }

    return std::nullopt;
}

} // namespace WebCore