blob: 58bd3f2bcef91dd3c1ba1b3f2f1cac690e02303a (
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
|
# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
# Copyright 2018-2019 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
#
# This file is part of qutebrowser.
#
# qutebrowser 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.
#
# qutebrowser 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 qutebrowser. If not, see <http://www.gnu.org/licenses/>.
"""Infrastructure for intercepting requests."""
import typing
import enum
import attr
from PyQt5.QtCore import QUrl
class ResourceType(enum.Enum):
"""Possible request types that can be received.
Currently corresponds to the QWebEngineUrlRequestInfo Enum:
https://doc.qt.io/qt-5/qwebengineurlrequestinfo.html#ResourceType-enum
"""
main_frame = 0
sub_frame = 1
stylesheet = 2
script = 3
image = 4
font_resource = 5
sub_resource = 6
object = 7
media = 8
worker = 9
shared_worker = 10
prefetch = 11
favicon = 12
xhr = 13
ping = 14
service_worker = 15
csp_report = 16
plugin_resource = 17
# 18 is "preload", deprecated in Chromium
preload_main_frame = 19
preload_sub_frame = 20
unknown = 255
class RedirectException(Exception):
"""Raised when there was an error with redirection."""
class RedirectFailedException(RedirectException):
"""Raised when the request was invalid, or a request was already made."""
class RedirectUnsupportedException(RedirectException):
"""Raised when redirection is currently unsupported."""
@attr.s
class Request:
"""A request which can be intercepted/blocked."""
#: The URL of the page being shown.
first_party_url = attr.ib() # type: typing.Optional[QUrl]
#: The URL of the file being requested.
request_url = attr.ib() # type: QUrl
is_blocked = attr.ib(False) # type: bool
#: The resource type of the request. None if not supported on this backend.
resource_type = attr.ib(None) # type: typing.Optional[ResourceType]
def block(self) -> None:
"""Block this request."""
self.is_blocked = True
def redirect(self, url: QUrl) -> None:
"""Redirect this request.
Only some types of requests can be successfully redirected.
Improper use of this method can result in redirect loops.
This method will throw a RedirectFailedException if the request was not
possible.
Args:
url: The QUrl to try to redirect to.
"""
# Will be overridden if the backend supports redirection
raise RedirectUnsupportedException("Unsupported backend.")
#: Type annotation for an interceptor function.
InterceptorType = typing.Callable[[Request], None]
_interceptors = [] # type: typing.List[InterceptorType]
def register(interceptor: InterceptorType) -> None:
_interceptors.append(interceptor)
def run(info: Request) -> None:
for interceptor in _interceptors:
interceptor(info)
|
