Passed
Push — main ( 287fd9...ba5fce )
by Jochen
30:44
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, ThreadingHTTPServer
15 1
import json
16 1
import logging
17 1
import sys
18 1
from typing import Optional, Set
19
20 1
from .config import HttpConfig
21 1
from .signals import message_received
22 1
from .util import start_thread
23
24
25 1
logger = logging.getLogger(__name__)
26
27
28 1
@dataclass(frozen=True)
29
class Message:
30 1
    channel: str
31 1
    text: str
32
33
34 1
def parse_json_message(json_data: str) -> Message:
35
    """Extract message from JSON."""
36 1
    data = json.loads(json_data)
37
38 1
    channel = data['channel']
39 1
    text = data['text']
40
41 1
    return Message(channel=channel, text=text)
42
43
44 1
class RequestHandler(BaseHTTPRequestHandler):
45
    """Handler for messages submitted via HTTP."""
46
47 1
    def __init__(self, api_tokens: Set[str], *args, **kwargs) -> None:
48 1
        self.api_tokens = api_tokens
49 1
        super().__init__(*args, **kwargs)
50
51 1
    def do_POST(self) -> None:
52 1
        if self.api_tokens:
53 1
            api_token = self._get_api_token()
54 1
            if not api_token:
55 1
                self.send_response(HTTPStatus.UNAUTHORIZED)
56 1
                self.end_headers()
57 1
                return
58
59 1
            if api_token not in self.api_tokens:
60 1
                self.send_response(HTTPStatus.FORBIDDEN)
61 1
                self.end_headers()
62 1
                return
63
64 1
        try:
65 1
            content_length = int(self.headers.get('Content-Length', 0))
66 1
            data = self.rfile.read(content_length).decode('utf-8')
67 1
            message = parse_json_message(data)
68 1
        except (KeyError, ValueError):
69 1
            logger.info(
70
                'Invalid message received from %s.', self.address_string()
71
            )
72 1
            self.send_error(HTTPStatus.BAD_REQUEST)
73 1
            return
74
75 1
        self.send_response(HTTPStatus.ACCEPTED)
76 1
        self.end_headers()
77
78 1
        message_received.send(
79
            channel_name=message.channel,
80
            text=message.text,
81
            source_address=self.client_address,
82
        )
83
84 1
    def _get_api_token(self) -> Optional[str]:
85 1
        authorization_value = self.headers.get('Authorization')
86 1
        if not authorization_value:
87 1
            return None
88
89 1
        prefix = 'Token '
90 1
        if not authorization_value.startswith(prefix):
91
            return None
92
93 1
        return authorization_value[len(prefix) :]
94
95 1
    def version_string(self) -> str:
96
        """Return custom server version string."""
97 1
        return 'Weitersager'
98
99
100 1
def create_server(config: HttpConfig) -> ThreadingHTTPServer:
101
    """Create the HTTP server."""
102 1
    address = (config.host, config.port)
103 1
    handler_class = partial(RequestHandler, config.api_tokens)
104 1
    return ThreadingHTTPServer(address, handler_class)
105
106
107 1
def start_receive_server(config: HttpConfig) -> None:
108
    """Start in a separate thread."""
109
    try:
110
        server = create_server(config)
111
    except OSError as e:
112
        sys.stderr.write(f'Error {e.errno:d}: {e.strerror}\n')
113
        sys.stderr.write(
114
            f'Probably no permission to open port {config.port}. '
115
            'Try to specify a port number above 1,024 (or even '
116
            '4,096) and up to 65,535.\n'
117
        )
118
        sys.exit(1)
119
120
    thread_name = server.__class__.__name__
121
    start_thread(server.serve_forever, thread_name)
122
    logger.info('Listening for HTTP requests on %s:%d.', *server.server_address)
123