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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
# SPDX-License-Identifier: GPL-3.0-or-later
# Data structure for querying URL patterns.
#
# This file is part of Hydrilla&Haketilo.
#
# Copyright (C) 2021, 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.
"""
This module contains functions for deconstruction and construction of URLs and
Haketilo URL patterns.
Data structures for querying data using URL patterns are also defined there.
"""
# Enable using with Python 3.7.
from __future__ import annotations
import re
import urllib.parse as up
import typing as t
import dataclasses as dc
from immutables import Map
from .translations import smart_gettext as _
from .exceptions import HaketiloException
default_ports: t.Mapping[str, int] = Map(http=80, https=443, ftp=21)
ParsedUrlType = t.TypeVar('ParsedUrlType', bound='ParsedUrl')
@dc.dataclass(frozen=True, unsafe_hash=True, order=True)
class ParsedUrl:
"""...."""
orig_url: str # used in __hash__() and __lt__()
scheme: str = dc.field(hash=False, compare=False)
domain_labels: tuple[str, ...] = dc.field(hash=False, compare=False)
path_segments: tuple[str, ...] = dc.field(hash=False, compare=False)
query: str = dc.field(hash=False, compare=False)
has_trailing_slash: bool = dc.field(hash=False, compare=False)
port: int = dc.field(hash=False, compare=False)
@property
def url_without_path(self) -> str:
"""...."""
scheme = self.scheme
netloc = '.'.join(reversed(self.domain_labels))
if self.port is not None and \
default_ports[scheme] != self.port:
netloc += f':{self.port}'
return f'{scheme}://{netloc}'
def _reconstruct_url(self) -> str:
"""...."""
path = '/'.join(('', *self.path_segments))
if self.has_trailing_slash:
path += '/'
return self.url_without_path + path
def path_append(self: ParsedUrlType, *new_segments: str) -> ParsedUrlType:
"""...."""
new_url = self._reconstruct_url()
if not self.has_trailing_slash:
new_url += '/'
new_url += '/'.join(new_segments)
return dc.replace(
self,
orig_url = new_url,
path_segments = tuple((*self.path_segments, *new_segments)),
has_trailing_slash = False
)
ParsedPattern = t.NewType('ParsedPattern', ParsedUrl)
# # We sometimes need a dummy pattern that means "match everything".
# catchall_pattern = ParsedPattern(
# ParsedUrl(
# orig_url = '<dummy_catchall_url_pattern>'
# scheme = '<dummy_all-scheme>'
# domain_labels = ('***',)
# path_segments = ('***',)
# has_trailing_slash = False
# port = 0
# )
# )
# URLs with those schemes will be recognized but not all of them have to be
# actually supported by Hydrilla server and Haketilo proxy.
supported_schemes = 'http', 'https', 'ftp', 'file'
def _parse_pattern_or_url(url: str, orig_url: str, is_pattern: bool = False) \
-> ParsedUrl:
"""...."""
if not is_pattern:
assert orig_url == url
parse_result = up.urlparse(url)
# Verify the parsed URL is valid
has_hostname = parse_result.hostname is not None
if not parse_result.scheme or \
(parse_result.scheme == 'file' and parse_result.port is not None) or \
(parse_result.scheme == 'file' and has_hostname) or \
(parse_result.scheme != 'file' and not has_hostname):
if is_pattern:
msg = _('err.url_pattern_{}.bad').format(orig_url)
raise HaketiloException(msg)
else:
raise HaketiloException(_('err.url_{}.bad') .format(url))
# Verify the URL uses a known scheme and extract it.
scheme = parse_result.scheme
if parse_result.scheme not in supported_schemes:
if is_pattern:
msg = _('err.url_pattern_{}.bad_scheme').format(orig_url)
raise HaketiloException(msg)
else:
raise HaketiloException(_('err.url_{}.bad_scheme').format(url))
# Extract and keep information about special pattern schemas used.
if is_pattern and orig_url.startswith('http*:'):
if parse_result.port:
fmt = _('err.url_pattern_{}.special_scheme_port')
raise HaketiloException(fmt.format(orig_url))
# Extract URL's explicit port or deduce the port based on URL's protocol.
try:
explicit_port = parse_result.port
port_out_of_range = explicit_port == 0
except ValueError:
port_out_of_range = True
if port_out_of_range:
if is_pattern:
msg = _('err.url_pattern_{}.bad_port').format(orig_url)
raise HaketiloException(msg)
else:
raise HaketiloException(_('err.url_{}.bad_port').format(url))
port = t.cast(int, explicit_port or default_ports.get(parse_result.scheme))
# Make URL's hostname into a list of labels in reverse order. E.g.
# 'https://a.bc..de.fg.com/h/i/' -> ['com', 'fg', 'de', 'bc', 'a']
hostname = parse_result.hostname or ''
domain_labels_with_empty = reversed(hostname.split('.'))
domain_labels = tuple(lbl for lbl in domain_labels_with_empty if lbl)
# Make URL's path into a list of segments. E.g.
# 'https://ab.cd/e//f/g/' -> ['e', 'f', 'g']
path_segments_with_empty = parse_result.path.split('/')
path_segments = tuple(sgmt for sgmt in path_segments_with_empty if sgmt)
# Record whether a trailing '/' is present in the URL.
has_trailing_slash = parse_result.path.endswith('/')
# Perform some additional sanity checks and return the result.
if is_pattern:
if parse_result.query:
msg = _('err.url_pattern_{}.has_query').format(orig_url)
raise HaketiloException(msg)
if parse_result.fragment:
msg = _('err.url_pattern_{}.has_frag').format(orig_url)
raise HaketiloException(msg)
query = parse_result.query
return ParsedUrl(
orig_url = orig_url,
scheme = scheme,
port = port,
domain_labels = domain_labels,
path_segments = path_segments,
query = query,
has_trailing_slash = has_trailing_slash
)
replace_scheme_regex = re.compile(r'^[^:]*')
def parse_pattern(url_pattern: str) -> t.Iterator[ParsedPattern]:
"""...."""
if url_pattern.startswith('http*:'):
patterns = [
replace_scheme_regex.sub('http', url_pattern),
replace_scheme_regex.sub('https', url_pattern)
]
else:
patterns = [url_pattern]
for pat in patterns:
yield ParsedPattern(_parse_pattern_or_url(pat, url_pattern, True))
def parse_url(url: str) -> ParsedUrl:
"""...."""
return _parse_pattern_or_url(url, url)
|
