aboutsummaryrefslogtreecommitdiff
path: root/src/blocker/blockerrule.cpp
blob: fb7f2bf4161360c43cfa9f1d2ad250430a756d37 (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
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/** LICENSE ********************************************************************
 **
 ** smolbote: yet another qute browser
 ** Copyright (C) 2017  Xian Nox
 **
 ** This program is free software: you can redistribute it and/or modify
 ** it under the terms of the GNU General Public License as published by
 ** the Free Software Foundation, either version 3 of the License, or
 ** (at your option) any later version.
 **
 ** This program is distributed in the hope that it will be useful,
 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ** GNU General Public License for more details.
 **
 ** You should have received a copy of the GNU General Public License
 ** along with this program.  If not, see <http://www.gnu.org/licenses/>.
 **
 ******************************************************************************/

#include "blockerrule.h"

/* AdBlock filter reference
 * https://adblockplus.org/en/filters
 * https://adblockplus.org/en/filter-cheatsheet
 */

BlockerRule::BlockerRule(QString rule, QObject *parent) :
    QObject(parent)
{
    m_filter = rule;
    QString pattern = rule;

    // Empty rule or comment
    if(pattern.trimmed().isEmpty() || pattern.startsWith("!")) {
        m_valid = false;
        return;
    }

    // Exception
    if(pattern.startsWith("@@")) {
        m_exception = true;
        pattern.remove(0, 2);
    }

    // Ignore element hiding rules for now
    if(pattern.contains("##") || pattern.contains("#@#")) {
        m_valid = false;
        return;
    }

    // Options
    if(pattern.contains("$")) {
        QString opts = pattern.mid(pattern.indexOf("$")+1);
        pattern.remove(pattern.indexOf("$"), pattern.length());

        for(QString opt : opts.split(',')) {
            parseOption(opt);
        }
    }

    // Regular expression
    if(rule.startsWith("/") && rule.endsWith("/")) {
        m_valid = true;
        ruleExpression.setPattern(pattern);
        return;
    }

    // Domain rules
    if(pattern.startsWith("||")) {
        pattern.remove(0, 2);
        // find the end point for the domain
        int end = pattern.indexOf(QRegularExpression("(?:[^\\w\\d\\_\\-\\.\\%]|$)"), 0);
        domainExpression.setPattern(pattern.mid(0, end));
        pattern.remove(0, end+1);
    } else if(pattern.startsWith("|") && pattern.endsWith("|")) {
        pattern.remove(0, 1);
        pattern.chop(1);
        domainExpression.setPattern(pattern);
    } else {
        domainExpression.setPattern(".*");
    }

    // Regular rule
    ruleExpression.setWildcardPattern(pattern);
    m_valid = true;
}

bool BlockerRule::match(const QWebEngineUrlRequestInfo &info)
{
    if(!m_valid) {
        return false;
    }

    // if both domain and rule match
    if(domainExpression.match(info.requestUrl().host()) && ruleExpression.match(info.requestUrl().toString())) {

        // option explicitly allows
        if(matchOptions(info, m_whitelistOptions)) {
            return false;
        }

        // option explicitly bans
        if(matchOptions(info, m_blacklistOptions)) {
            return true;
        }

        // no options, but both domain and rule match --> rule matches
        return true;
    }

    // domain and/or rule do not match
    return false;
}

bool BlockerRule::isValid()
{
    return m_valid;
}
bool BlockerRule::isException()
{
    return m_exception;
}

QString BlockerRule::filter() const
{
    return m_filter;
}

void BlockerRule::parseOption(const QString &opt)
{
    if(opt.startsWith("script")) {
        m_blacklistOptions.setFlag(RuleOption::script, true);
    } else if(opt.startsWith("~script")) {
        m_whitelistOptions.setFlag(RuleOption::script, true);

    } else if(opt.startsWith("image")) {
        m_blacklistOptions.setFlag(RuleOption::image, true);
    } else if(opt.startsWith("~image")) {
        m_whitelistOptions.setFlag(RuleOption::image, true);

    } else if(opt.startsWith("stylesheet")) {
        m_blacklistOptions.setFlag(RuleOption::stylesheet, true);
    } else if(opt.startsWith("~stylesheet")) {
        m_whitelistOptions.setFlag(RuleOption::stylesheet, true);

    } else if(opt.startsWith("object")) {
        m_blacklistOptions.setFlag(RuleOption::object, true);
    } else if(opt.startsWith("~object")) {
        m_whitelistOptions.setFlag(RuleOption::object, true);

    } else if(opt.startsWith("object-subrequest")) {
        m_blacklistOptions.setFlag(RuleOption::objectsubrequest, true);
    } else if(opt.startsWith("~object-subrequest")) {
        m_whitelistOptions.setFlag(RuleOption::objectsubrequest, true);

    } else if(opt.startsWith("subdocument")) {
        m_blacklistOptions.setFlag(RuleOption::subdocument, true);
    } else if(opt.startsWith("~subdocument")) {
        m_whitelistOptions.setFlag(RuleOption::subdocument, true);
    }
}

bool BlockerRule::matchOptions(const QWebEngineUrlRequestInfo &info, const RuleOptions &options)
{
    // no options are defined
    if(options == 0) {
        return false;
    }

    bool hasOption = false;
    switch (info.resourceType()) {
    case QWebEngineUrlRequestInfo::ResourceTypeScript:
        if(options.testFlag(RuleOption::script)) {
            hasOption = true;
        }
        break;
    case QWebEngineUrlRequestInfo::ResourceTypeImage:
        if(options.testFlag(RuleOption::image)) {
            hasOption = true;
        }
        break;
    case QWebEngineUrlRequestInfo::ResourceTypeStylesheet:
        if(options.testFlag(RuleOption::stylesheet)) {
            hasOption = true;
        }
        break;
    case QWebEngineUrlRequestInfo::ResourceTypeObject:
        if(options.testFlag(RuleOption::object)) {
            hasOption = true;
        }
        break;
    case QWebEngineUrlRequestInfo::ResourceTypePluginResource:
        if(options.testFlag(RuleOption::objectsubrequest)) {
            hasOption = true;
        }
        break;
    case QWebEngineUrlRequestInfo::ResourceTypeSubFrame:
        if(options.testFlag(RuleOption::subdocument)) {
            hasOption = true;
        }
        break;
    default:
        break;
    }

    return hasOption;
}