Passed
Push — main ( 27c38f...3b61e2 )
by Jochen
03:01
created

weitersager.http.RequestHandler.__init__()   A

Complexity

Conditions 1

Size

Total Lines 3
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 1

Importance

Changes 0
Metric Value
cc 1
eloc 3
nop 4
dl 0
loc 3
ccs 3
cts 3
cp 1
crap 1
rs 10
c 0
b 0
f 0
1
"""
2
weitersager.http
3
~~~~~~~~~~~~~~~~
4
5
HTTP server to receive messages
6
7
:Copyright: 2007-2021 Jochen Kupperschmidt
8
:License: MIT, see LICENSE for details.
9
"""
10
11 1
from dataclasses import dataclass
12 1
from functools import partial
13 1
from http import HTTPStatus
14 1
from http.server import BaseHTTPRequestHandler, HTTPServer
15 1
import json
16 1
import sys
17 1
from typing import Optional, Set
18
19 1
from .config import HttpConfig
20 1
from .signals import message_received
21 1
from .util import log, start_thread
22
23
24 1
@dataclass(frozen=True)
25
class Message:
26 1
    channel: str
27 1
    text: str
28
29
30 1
def parse_json_message(json_data: str) -> Message:
31
    """Extract message from JSON."""
32 1
    data = json.loads(json_data)
33
34 1
    channel = data['channel']
35 1
    text = data['text']
36
37 1
    return Message(channel=channel, text=text)
38
39
40 1
class RequestHandler(BaseHTTPRequestHandler):
41
    """Handler for messages submitted via HTTP."""
42
43 1
    def __init__(self, api_tokens: Set[str], *args, **kwargs) -> None:
44 1
        self.api_tokens = api_tokens
45 1
        super().__init__(*args, **kwargs)
46
47 1
    def do_POST(self) -> None:
48 1
        if self.api_tokens:
49 1
            api_token = self._get_api_token()
50 1
            if not api_token:
51 1
                self.send_response(HTTPStatus.UNAUTHORIZED)
52 1
                self.end_headers()
53 1
                return
54
55 1
            if api_token not in self.api_tokens:
56 1
                self.send_response(HTTPStatus.FORBIDDEN)
57 1
                self.end_headers()
58 1
                return
59
60 1
        try:
61 1
            content_length = int(self.headers.get('Content-Length', 0))
62 1
            data = self.rfile.read(content_length).decode('utf-8')
63 1
            message = parse_json_message(data)
64 1
        except (KeyError, ValueError):
65 1
            log(f'Invalid message received from {self.address_string()}.')
66 1
            self.send_error(HTTPStatus.BAD_REQUEST)
67 1
            return
68
69 1
        self.send_response(HTTPStatus.ACCEPTED)
70 1
        self.end_headers()
71
72 1
        message_received.send(
73
            channel_name=message.channel,
74
            text=message.text,
75
            source_address=self.client_address,
76
        )
77
78 1
    def _get_api_token(self) -> Optional[str]:
79 1
        authorization_value = self.headers.get('Authorization')
80 1
        if not authorization_value:
81 1
            return None
82
83 1
        prefix = 'Token '
84 1
        if not authorization_value.startswith(prefix):
85
            return None
86
87 1
        return authorization_value[len(prefix) :]
88
89 1
    def version_string(self) -> str:
90
        """Return custom server version string."""
91 1
        return 'Weitersager'
92
93
94 1
def create_server(config: HttpConfig) -> HTTPServer:
95
    """Create the HTTP server."""
96 1
    address = (config.host, config.port)
97 1
    handler_class = partial(RequestHandler, config.api_tokens)
98 1
    return HTTPServer(address, handler_class)
99
100
101 1
def start_receive_server(config: HttpConfig) -> None:
102
    """Start in a separate thread."""
103
    try:
104
        server = create_server(config)
105
    except OSError as e:
106
        sys.stderr.write(f'Error {e.errno:d}: {e.strerror}\n')
107
        sys.stderr.write(
108
            f'Probably no permission to open port {config.port}. '
109
            'Try to specify a port number above 1,024 (or even '
110
            '4,096) and up to 65,535.\n'
111
        )
112
        sys.exit(1)
113
114
    thread_name = server.__class__.__name__
115
    start_thread(server.serve_forever, thread_name)
116
    log('Listening for HTTP requests on {}:{:d}.', *server.server_address)
117