aboutsummaryrefslogtreecommitdiff
path: root/lib/urlfilter/urlfilter.h
blob: e15122ad5ac92e08b62b0d074042d68ceeb54f7c (plain)
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
/*
 * This file is part of smolbote. It's copyrighted by the contributors recorded
 * in the version control history of the file, available from its original
 * location: https://neueland.iserlohn-fortress.net/gitea/aqua/smolbote
 *
 * SPDX-License-Identifier: GPL-3.0
 */

#include <QUrl>
#include <QString>
#include <utility>
#include <QWebEngineUrlRequestInfo>

#ifndef SMOLBOTE_URLFILTER_FILTER
#define SMOLBOTE_URLFILTER_FILTER

class UrlFilter
{
public:
    enum MatchResult {
        NotMatched,
        Allow,
        Block,
        Redirect
    };

    enum MatchType {
        InvalidMatch,
        RegularExpressionMatch,
        StringContains,
        StringStartsWith,
        StringEndsWith,
        StringEquals,
        DomainMatch
    };

    virtual ~UrlFilter() = default;

    virtual QString metadata(const QString &key) const = 0;
    virtual std::pair<MatchResult, QString> match(const QUrl &firstParty, const QUrl &requestUrl, QWebEngineUrlRequestInfo::ResourceType type) const = 0;
};

#endif // SMOLBOTE_URLFILTER_FILTER