File: addresses.py

package info (click to toggle)
python-nbxmpp 6.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,340 kB
  • sloc: python: 19,639; makefile: 4
file content (259 lines) | stat: -rw-r--r-- 7,575 bytes parent folder | download | duplicates (2)
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
# Copyright (C) 2020 Philipp Hörist <philipp AT hoerist.com>
#
# This file is part of nbxmpp.
#
# SPDX-License-Identifier: GPL-3.0-or-later

import logging
from collections.abc import Iterator

from nbxmpp.const import ConnectionProtocol
from nbxmpp.const import ConnectionType
from nbxmpp.http import HTTPRequest
from nbxmpp.http import HTTPSession
from nbxmpp.structs import ProxyData
from nbxmpp.structs import ServerAddress
from nbxmpp.types import CustomHostT
from nbxmpp.util import Observable
from nbxmpp.util import parse_websocket_uri

log = logging.getLogger("nbxmpp.addresses")


class ServerAddresses(Observable):
    """
    Signals:

        resolved

    """

    def __init__(self, domain: str | None) -> None:
        Observable.__init__(self, log)

        self._domain = domain
        self._http_session: HTTPSession | None = None
        self._custom_host: CustomHostT | None = None
        self._proxy: ProxyData | None = None
        self._is_resolved = False

        self._addresses: list[ServerAddress] = [
            ServerAddress(
                domain=self._domain,
                service="xmpps-client",
                host=None,
                uri=None,
                protocol=ConnectionProtocol.TCP,
                type=ConnectionType.DIRECT_TLS,
                proxy=None,
            ),
            ServerAddress(
                domain=self._domain,
                service="xmpp-client",
                host=None,
                uri=None,
                protocol=ConnectionProtocol.TCP,
                type=ConnectionType.START_TLS,
                proxy=None,
            ),
            ServerAddress(
                domain=self._domain,
                service="xmpp-client",
                host=None,
                uri=None,
                protocol=ConnectionProtocol.TCP,
                type=ConnectionType.PLAIN,
                proxy=None,
            ),
        ]

        self._fallback_addresses: list[ServerAddress] = [
            ServerAddress(
                domain=self._domain,
                service=None,
                host="%s:%s" % (self._domain, 5222),
                uri=None,
                protocol=ConnectionProtocol.TCP,
                type=ConnectionType.START_TLS,
                proxy=None,
            ),
            ServerAddress(
                domain=self._domain,
                service=None,
                host="%s:%s" % (self._domain, 5222),
                uri=None,
                protocol=ConnectionProtocol.TCP,
                type=ConnectionType.PLAIN,
                proxy=None,
            ),
        ]

    @property
    def domain(self) -> str | None:
        return self._domain

    @property
    def is_resolved(self) -> bool:
        return self._is_resolved

    def resolve(self) -> None:
        if self._is_resolved:
            self._on_request_resolved()
            return

        if self._proxy is not None:
            # Let the proxy resolve the domain
            self._on_request_resolved()
            return

        if self._custom_host is not None:
            self._on_request_resolved()
            return

        self._resolve_alternatives()

    def _resolve_alternatives(self) -> None:
        if self._http_session is None:
            self._on_request_resolved()
            return

        request = self._http_session.create_request()
        request.send(
            "GET",
            f"https://{self._domain}/.well-known/host-meta",
            timeout=5,
            callback=self._on_alternatives_result,
        )

    def _on_alternatives_result(self, request: HTTPRequest) -> None:
        if not request.is_complete():
            log.info(
                "Failed to retrieve host-meta file: %s", request.get_error_string()
            )
            self._on_request_resolved()
            return

        response_body = request.get_data()
        if not response_body:
            log.info("No response body data found")
            self._on_request_resolved()
            return

        try:
            uri = parse_websocket_uri(response_body.decode())
        except Exception as error:
            log.info("Error parsing websocket uri: %s", error)
            self._on_request_resolved()
            return

        if uri.startswith("wss"):
            type_ = ConnectionType.DIRECT_TLS
        elif uri.startswith("ws"):
            type_ = ConnectionType.PLAIN
        else:
            log.warning("Invalid websocket uri: %s", uri)
            self._on_request_resolved()
            return

        addr = ServerAddress(
            domain=self._domain,
            service=None,
            host=None,
            uri=uri,
            protocol=ConnectionProtocol.WEBSOCKET,
            type=type_,
            proxy=None,
        )
        self._addresses.append(addr)

        self._on_request_resolved()

    def cancel_resolve(self) -> None:
        self.remove_subscriptions()

    def set_custom_host(self, address: CustomHostT | None) -> None:
        # Set a custom host, overwrites all other addresses
        self._custom_host = address
        if address is None:
            return

        host_or_uri, protocol, type_ = address
        if protocol == ConnectionProtocol.WEBSOCKET:
            host, uri = None, host_or_uri
        else:
            host, uri = host_or_uri, None

        self._fallback_addresses = []
        self._addresses = [
            ServerAddress(
                domain=self._domain,
                service=None,
                host=host,
                uri=uri,
                protocol=protocol,
                type=type_,
                proxy=None,
            )
        ]

    def set_proxy(self, proxy: ProxyData | None) -> None:
        self._proxy = proxy

    def set_http_session(self, session: HTTPSession) -> None:
        self._http_session = session

    def _on_request_resolved(self) -> None:
        self._is_resolved = True
        self.notify("resolved")
        self.remove_subscriptions()

    def get_next_address(
        self,
        allowed_types: list[ConnectionType],
        allowed_protocols: list[ConnectionProtocol],
    ) -> Iterator[ServerAddress]:
        """
        Selects next address
        """

        for addr in self._filter_allowed(
            self._addresses, allowed_types, allowed_protocols
        ):
            yield self._assure_proxy(addr)

        for addr in self._filter_allowed(
            self._fallback_addresses, allowed_types, allowed_protocols
        ):
            yield self._assure_proxy(addr)

        raise NoMoreAddresses

    def _assure_proxy(self, addr: ServerAddress) -> ServerAddress:
        if self._proxy is None:
            return addr

        if addr.protocol == ConnectionProtocol.TCP:
            return addr._replace(proxy=self._proxy)

        return addr

    def _filter_allowed(
        self,
        addresses: list[ServerAddress],
        allowed_types: list[ConnectionType],
        allowed_protocols: list[ConnectionProtocol],
    ) -> Iterator[ServerAddress]:
        if self._proxy is not None:
            addresses = filter(lambda addr: addr.host is not None, addresses)

        addresses = filter(lambda addr: addr.type in allowed_types, addresses)
        addresses = filter(lambda addr: addr.protocol in allowed_protocols, addresses)
        return addresses

    def __str__(self) -> str:
        addresses = self._addresses + self._fallback_addresses
        return "\n".join([str(addr) for addr in addresses])


class NoMoreAddresses(Exception):
    pass