ladybird/Libraries/LibWeb/Loader/ContentBlocker.cpp

/*
 * Copyright (c) 2021, Andreas Kling <andreas@ladybird.org>
 * Copyright (c) 2025, Tim Ledbetter <tim.ledbetter@ladybird.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#include <AK/BinarySearch.h>
#include <AK/Queue.h>
#include <AK/QuickSort.h>
#include <AK/Span.h>
#include <AK/StringBuilder.h>
#include <LibURL/Parser.h>
#include <LibWeb/DOM/Document.h>
#include <LibWeb/Loader/ContentBlocker.h>

namespace Web {

ContentBlocker& ContentBlocker::the()
{
    static ContentBlocker blocker;
    return blocker;
}

ContentBlocker::ContentBlocker() = default;

ContentBlocker::~ContentBlocker() = default;

bool ContentBlocker::is_filtered(URL::URL const& url) const
{
    if (!filtering_enabled())
        return false;

    if (url.scheme() == "data")
        return false;
    return contains(url.to_string());
}

bool ContentBlocker::is_filtered(URL::URL const& url, URL::URL const& source_url, ResourceType resource_type) const
{
    (void)source_url;
    (void)resource_type;
    return is_filtered(url);
}

bool ContentBlocker::is_filtered(URL::URL const& url, URL::URL const& source_url, Optional<Fetch::Infrastructure::Request::Destination> const& destination, Optional<Fetch::Infrastructure::Request::InitiatorType> const& initiator_type, Fetch::Infrastructure::Request::Mode mode) const
{
    return is_filtered(url, source_url_for_matching(source_url), resource_type_from_fetch_metadata(destination, initiator_type, mode));
}

bool ContentBlocker::contains(StringView text) const
{
    if (!m_matcher)
        return false;
    return m_matcher->contains(text);
}

ErrorOr<void> ContentBlocker::set_patterns(ReadonlySpan<String> patterns)
{
    Vector<String> network_patterns;
    m_cosmetic_rules.clear();

    for (auto const& pattern : patterns) {
        auto pattern_view = pattern.bytes_as_string_view();
        auto cosmetic_marker = pattern_view.find("##"sv);
        if (!cosmetic_marker.has_value()) {
            network_patterns.append(pattern);
            continue;
        }

        auto selector = pattern_view.substring_view(cosmetic_marker.value() + 2);
        if (selector.is_empty())
            continue;

        auto domains = pattern_view.substring_view(0, cosmetic_marker.value());
        if (domains.is_empty()) {
            CosmeticRule rule;
            rule.selector = TRY(String::from_utf8(selector));
            m_cosmetic_rules.append(move(rule));
            continue;
        }

        for (auto domain : domains.split_view(',')) {
            if (domain.is_empty())
                continue;
            CosmeticRule rule;
            rule.domain = TRY(String::from_utf8(domain));
            rule.selector = TRY(String::from_utf8(selector));
            m_cosmetic_rules.append(move(rule));
        }
    }

    m_matcher = make<AsciiStringMatcher>(network_patterns);
    return {};
}

static bool cosmetic_rule_domain_matches(StringView domain, URL::URL const& url)
{
    auto const& host = url.host();
    if (!host.has_value())
        return false;

    auto host_string = host->serialize();
    auto host_view = host_string.bytes_as_string_view();
    if (host_view == domain)
        return true;

    if (!host_view.ends_with(domain))
        return false;
    if (host_view.length() <= domain.length())
        return false;

    return host_view[host_view.length() - domain.length() - 1] == '.';
}

String ContentBlocker::cosmetic_style_sheet_for_document(DOM::Document const& document) const
{
    return cosmetic_style_sheet_for_url(document.fallback_base_url());
}

String ContentBlocker::cosmetic_style_sheet_for_url(URL::URL const& url) const
{
    if (!filtering_enabled())
        return {};

    StringBuilder builder;
    for (auto const& rule : m_cosmetic_rules) {
        if (rule.domain.has_value() && !cosmetic_rule_domain_matches(rule.domain->bytes_as_string_view(), url))
            continue;

        builder.append(rule.selector);
        builder.append(" { display: none !important; }\n"sv);
    }
    return builder.to_string_without_validation();
}

ContentBlocker::ResourceType ContentBlocker::resource_type_from_fetch_metadata(Optional<Fetch::Infrastructure::Request::Destination> const& destination, Optional<Fetch::Infrastructure::Request::InitiatorType> const& initiator_type, Fetch::Infrastructure::Request::Mode mode)
{
    using Fetch::Infrastructure::Request;

    if (mode == Request::Mode::WebSocket)
        return ResourceType::WebSocket;

    if (destination.has_value()) {
        switch (*destination) {
        case Request::Destination::Audio:
        case Request::Destination::Track:
        case Request::Destination::Video:
            return ResourceType::Media;
        case Request::Destination::Document:
            return ResourceType::Document;
        case Request::Destination::Embed:
        case Request::Destination::Object:
            return ResourceType::Object;
        case Request::Destination::Font:
            return ResourceType::Font;
        case Request::Destination::Frame:
        case Request::Destination::IFrame:
            return ResourceType::Subdocument;
        case Request::Destination::Image:
            return ResourceType::Image;
        case Request::Destination::AudioWorklet:
        case Request::Destination::PaintWorklet:
        case Request::Destination::Script:
        case Request::Destination::ServiceWorker:
        case Request::Destination::SharedWorker:
        case Request::Destination::Worker:
            return ResourceType::Script;
        case Request::Destination::Style:
            return ResourceType::Stylesheet;
        case Request::Destination::JSON:
        case Request::Destination::Manifest:
        case Request::Destination::Report:
        case Request::Destination::WebIdentity:
        case Request::Destination::XSLT:
            return ResourceType::Other;
        }
        VERIFY_NOT_REACHED();
    }

    if (initiator_type.has_value()) {
        switch (*initiator_type) {
        case Request::InitiatorType::Audio:
        case Request::InitiatorType::Video:
        case Request::InitiatorType::Track:
            return ResourceType::Media;
        case Request::InitiatorType::Beacon:
        case Request::InitiatorType::Ping:
            return ResourceType::Ping;
        case Request::InitiatorType::Embed:
        case Request::InitiatorType::Object:
            return ResourceType::Object;
        case Request::InitiatorType::Fetch:
        case Request::InitiatorType::XMLHttpRequest:
            return ResourceType::XMLHttpRequest;
        case Request::InitiatorType::Font:
            return ResourceType::Font;
        case Request::InitiatorType::Frame:
        case Request::InitiatorType::IFrame:
            return ResourceType::Subdocument;
        case Request::InitiatorType::Image:
        case Request::InitiatorType::IMG:
            return ResourceType::Image;
        case Request::InitiatorType::Script:
            return ResourceType::Script;
        case Request::InitiatorType::CSS:
        case Request::InitiatorType::EarlyHint:
        case Request::InitiatorType::Body:
        case Request::InitiatorType::Input:
        case Request::InitiatorType::Link:
        case Request::InitiatorType::Other:
            return ResourceType::Other;
        }
        VERIFY_NOT_REACHED();
    }

    return ResourceType::Other;
}

URL::URL ContentBlocker::source_url_for_matching(URL::URL const& source_url)
{
    if (source_url.scheme() != "blob"sv)
        return source_url;

    auto parsed_url = URL::Parser::basic_parse(source_url.serialize_path());
    if (!parsed_url.has_value())
        return source_url;

    return parsed_url.release_value();
}

AsciiStringMatcher::AsciiStringMatcher(ReadonlySpan<String> patterns)
{
    struct BuildTimeNode {
        Vector<Transition> children;
        bool is_output { false };
    };

    Vector<BuildTimeNode> build_time_nodes;
    build_time_nodes.append({});

    for (u32 i = 0; i < patterns.size(); ++i) {
        auto const& pattern = patterns[i];
        u32 node = 0;
        for (u8 ch : pattern.bytes_as_string_view()) {
            VERIFY(is_ascii(ch));
            auto it = build_time_nodes[node].children.find_if(
                [ch](Transition const& t) { return t.character == ch; });

            if (it != build_time_nodes[node].children.end()) {
                node = it->next_state;
            } else {
                u32 new_node = build_time_nodes.size();
                build_time_nodes.append({});
                build_time_nodes[node].children.empend(ch, new_node);
                node = new_node;
            }
        }

        if (!build_time_nodes[node].is_output)
            build_time_nodes[node].is_output = true;
    }

    Vector<u32> failure_links;
    failure_links.resize(build_time_nodes.size());

    Queue<u32> queue;
    for (auto const& transition : build_time_nodes[0].children) {
        u32 child = transition.next_state;
        failure_links[child] = 0;
        queue.enqueue(child);
    }

    while (!queue.is_empty()) {
        u32 current = queue.dequeue();
        for (auto& [character, child] : build_time_nodes[current].children) {
            u32 failure_link = failure_links[current];
            while (failure_link != 0) {
                auto it = build_time_nodes[failure_link].children.find_if(
                    [character](Transition const& tr) { return tr.character == character; });
                if (it != build_time_nodes[failure_link].children.end()) {
                    failure_link = it->next_state;
                    break;
                }
                failure_link = failure_links[failure_link];
            }

            u32 next_failure_link = failure_link;
            failure_links[child] = next_failure_link;

            bool inherited = build_time_nodes[next_failure_link].is_output;
            if (inherited && !build_time_nodes[child].is_output)
                build_time_nodes[child].is_output = true;

            queue.enqueue(child);
        }
    }

    for (auto& node : build_time_nodes) {
        quick_sort(node.children, [](Transition const& a, Transition const& b) {
            return a.character < b.character;
        });
    }

    m_nodes.resize(build_time_nodes.size());
    m_transitions.clear_with_capacity();

    u32 transition_index = 0;
    for (u32 i = 0; i < build_time_nodes.size(); ++i) {
        auto& build_time_node = build_time_nodes[i];
        m_nodes[i].first_transition = transition_index;
        m_nodes[i].transition_count = build_time_node.children.size();
        m_nodes[i].output = build_time_node.is_output;
        m_transitions.extend(build_time_node.children);

        transition_index += build_time_node.children.size();
    }
}

bool AsciiStringMatcher::contains(StringView text) const
{
    if (m_nodes.is_empty())
        return false;

    auto get_children = [this](u32 state) -> ReadonlySpan<Transition> {
        return m_transitions.span().slice(m_nodes[state].first_transition, m_nodes[state].transition_count);
    };

    u32 state = 0;
    for (u8 ch : text.bytes()) {
        auto const& children = get_children(state);

        auto const* found = AK::binary_search(
            children,
            ch,
            nullptr,
            [](u8 needle, Transition const& transition) {
                if (needle > transition.character)
                    return needle < transition.character ? -1 : 1;
                return needle < transition.character ? -1 : 0;
            });

        if (!found) {
            state = 0;
            auto const& root_children = get_children(0);
            found = AK::binary_search(
                root_children,
                ch,
                nullptr,
                [](u8 needle, Transition const& transition) {
                    if (needle > transition.character)
                        return needle < transition.character ? -1 : 1;
                    return needle < transition.character ? -1 : 0;
                });
            if (!found)
                continue;
        }

        state = found->next_state;
        if (m_nodes[state].output)
            return true;
    }
    return false;
}

}