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
|
# SPDX-License-Identifier: GPL-3.0-or-later
# Base defintions for policies for altering HTTP requests.
#
# This file is part of Hydrilla&Haketilo.
#
# Copyright (C) 2022 Wojtek Kosior
#
# 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 <https://www.gnu.org/licenses/>.
#
#
# I, Wojtek Kosior, thereby promise not to sue for violation of this
# file's license. Although I request that you do not make use this code
# in a proprietary program, I am not going to enforce this in court.
"""
.....
"""
# Enable using with Python 3.7.
from __future__ import annotations
import sys
if sys.version_info >= (3, 8):
from typing import Protocol
else:
from typing_extensions import Protocol
import dataclasses as dc
import typing as t
import enum
from abc import ABC, abstractmethod
from immutables import Map
from ...url_patterns import ParsedUrl
from .. import state
class PolicyPriority(int, enum.Enum):
"""...."""
_ONE = 1
_TWO = 2
_THREE = 3
DefaultGetValue = t.TypeVar('DefaultGetValue', object, None)
class IHeaders(Protocol):
"""...."""
def __getitem__(self, key: str) -> str: ...
def get_all(self, key: str) -> t.Iterable[str]: ...
def get(self, key: str, default: DefaultGetValue = None) \
-> t.Union[str, DefaultGetValue]: ...
def items(self) -> t.Iterable[tuple[str, str]]: ...
def encode_headers_items(headers: t.Iterable[tuple[str, str]]) \
-> t.Iterable[tuple[bytes, bytes]]:
"""...."""
for name, value in headers:
yield name.encode(), value.encode()
@dc.dataclass(frozen=True)
class ProducedRequest:
"""...."""
url: str
method: str
headers: t.Iterable[tuple[bytes, bytes]]
body: bytes
@dc.dataclass(frozen=True)
class RequestInfo:
"""...."""
url: ParsedUrl
method: str
headers: IHeaders
body: bytes
def make_produced_request(self) -> ProducedRequest:
"""...."""
return ProducedRequest(
url = self.url.orig_url,
method = self.method,
headers = encode_headers_items(self.headers.items()),
body = self.body
)
@dc.dataclass(frozen=True)
class ProducedResponse:
"""...."""
status_code: int
headers: t.Iterable[tuple[bytes, bytes]]
body: bytes
@dc.dataclass(frozen=True)
class ResponseInfo:
"""...."""
url: ParsedUrl
status_code: int
headers: IHeaders
body: bytes
def make_produced_response(self) -> ProducedResponse:
"""...."""
return ProducedResponse(
status_code = self.status_code,
headers = encode_headers_items(self.headers.items()),
body = self.body
)
class Policy(ABC):
"""...."""
process_request: t.ClassVar[bool] = False
process_response: t.ClassVar[bool] = False
priority: t.ClassVar[PolicyPriority]
@property
def anticache(self) -> bool:
return self.process_request or self.process_response
def consume_request(self, request_info: RequestInfo) \
-> t.Optional[t.Union[ProducedRequest, ProducedResponse]]:
"""...."""
return None
def consume_response(self, response_info: ResponseInfo) \
-> t.Optional[ProducedResponse]:
"""...."""
return None
# mypy needs to be corrected:
# https://stackoverflow.com/questions/70999513/conflict-between-mix-ins-for-abstract-dataclasses/70999704#70999704
@dc.dataclass(frozen=True, unsafe_hash=True) # type: ignore[misc]
class PolicyFactory(ABC):
"""...."""
builtin: bool
@abstractmethod
def make_policy(self, haketilo_state: state.HaketiloState) \
-> t.Optional[Policy]:
"""...."""
...
def __lt__(self, other: 'PolicyFactory'):
"""...."""
return sorting_keys.get(self.__class__.__name__, 999) < \
sorting_keys.get(other.__class__.__name__, 999)
sorting_order = (
'PayloadResourcePolicyFactory',
'PayloadPolicyFactory',
'RuleBlockPolicyFactory',
'RuleAllowPolicyFactory',
'FallbackPolicyFactory'
)
sorting_keys = Map((cls, name) for name, cls in enumerate(sorting_order))
|
