X-Git-Url: http://average.org/gitweb/?a=blobdiff_plain;f=gps303%2Fcollector.py;h=36a5f8a8efd9455b047da437ed60fbfe1c9853a3;hb=099a8195d469486fa9347cc5faaadd3614a2a445;hp=4cb7956d2809c4dfd57782d7a15b9bf57abfdbeb;hpb=513eaed4a832748bd77294679939627eaaf69612;p=loctrkd.git diff --git a/gps303/collector.py b/gps303/collector.py index 4cb7956..36a5f8a 100644 --- a/gps303/collector.py +++ b/gps303/collector.py @@ -1,9 +1,19 @@ """ TCP server that communicates with terminals """ +from configparser import ConfigParser from logging import getLogger -from socket import socket, AF_INET, SOCK_STREAM, SOL_SOCKET, SO_REUSEADDR -from time import time +from os import umask +from socket import ( + socket, + AF_INET6, + SOCK_STREAM, + SOL_SOCKET, + SO_KEEPALIVE, + SO_REUSEADDR, +) from struct import pack +from time import time +from typing import Dict, List, Optional, Tuple import zmq from . import common @@ -18,27 +28,28 @@ from .zmsg import Bcast, Resp log = getLogger("gps303/collector") +MAXBUFFER: int = 4096 + class Client: """Connected socket to the terminal plus buffer and metadata""" - def __init__(self, sock, addr): + def __init__(self, sock: socket, addr: Tuple[str, int]) -> None: self.sock = sock self.addr = addr self.buffer = b"" - self.imei = None + self.imei: Optional[str] = None - def close(self): + def close(self) -> None: log.debug("Closing fd %d (IMEI %s)", self.sock.fileno(), self.imei) self.sock.close() self.buffer = b"" - self.imei = None - def recv(self): + def recv(self) -> Optional[List[Tuple[float, Tuple[str, int], bytes]]]: """Read from the socket and parse complete messages""" try: - segment = self.sock.recv(4096) - except OSError: + segment = self.sock.recv(MAXBUFFER) + except OSError as e: log.warning( "Reading from fd %d (IMEI %s): %s", self.sock.fileno(), @@ -55,6 +66,10 @@ class Client: return None when = time() self.buffer += segment + if len(self.buffer) > MAXBUFFER: + # We are receiving junk. Let's drop it or we run out of memory. + log.warning("More than %d unparseable data, dropping", MAXBUFFER) + self.buffer = b"" msgs = [] while True: framestart = self.buffer.find(b"xx") @@ -62,49 +77,73 @@ class Client: break if framestart > 0: # Should not happen, report log.warning( - 'Undecodable data "%s" from fd %d (IMEI %s)', - self.buffer[:framestart].hex(), + 'Undecodable data (%d) "%s" from fd %d (IMEI %s)', + framestart, + self.buffer[:framestart][:64].hex(), self.sock.fileno(), self.imei, ) self.buffer = self.buffer[framestart:] # At this point, buffer starts with a packet - frameend = self.buffer.find(b"\r\n", 4) + if len(self.buffer) < 6: # no len and proto - cannot proceed + break + exp_end = self.buffer[2] + 3 # Expect '\r\n' here + frameend = 0 + # Length field can legitimeely be much less than the + # length of the packet (e.g. WiFi positioning), but + # it _should not_ be greater. Still sometimes it is. + # Luckily, not by too much: by maybe two or three bytes? + # Do this embarrassing hack to avoid accidental match + # of some binary data in the packet against '\r\n'. + while True: + frameend = self.buffer.find(b"\r\n", frameend + 1) + if frameend == -1 or frameend >= ( + exp_end - 3 + ): # Found realistic match or none + break if frameend == -1: # Incomplete frame, return what we have break packet = self.buffer[2:frameend] self.buffer = self.buffer[frameend + 2 :] + if len(packet) < 2: # frameend comes too early + log.warning("Packet too short: %s", packet) + break if proto_of_message(packet) == LOGIN.PROTO: - self.imei = parse_message(packet).imei - log.info( - "LOGIN from fd %d (IMEI %s)", self.sock.fileno(), self.imei - ) + msg = parse_message(packet) + if isinstance(msg, LOGIN): # Can be unparseable + self.imei = msg.imei + log.info( + "LOGIN from fd %d (IMEI %s)", + self.sock.fileno(), + self.imei, + ) msgs.append((when, self.addr, packet)) return msgs - def send(self, buffer): + def send(self, buffer: bytes) -> None: try: self.sock.send(b"xx" + buffer + b"\r\n") except OSError as e: log.error( "Sending to fd %d (IMEI %s): %s", - self.sock.fileno, + self.sock.fileno(), self.imei, e, ) class Clients: - def __init__(self): - self.by_fd = {} - self.by_imei = {} + def __init__(self) -> None: + self.by_fd: Dict[int, Client] = {} + self.by_imei: Dict[str, Client] = {} - def add(self, clntsock, clntaddr): + def add(self, clntsock: socket, clntaddr: Tuple[str, int]) -> int: fd = clntsock.fileno() + log.info("Start serving fd %d from %s", fd, clntaddr) self.by_fd[fd] = Client(clntsock, clntaddr) return fd - def stop(self, fd): + def stop(self, fd: int) -> None: clnt = self.by_fd[fd] log.info("Stop serving fd %d (IMEI %s)", clnt.sock.fileno(), clnt.imei) clnt.close() @@ -112,7 +151,9 @@ class Clients: del self.by_imei[clnt.imei] del self.by_fd[fd] - def recv(self, fd): + def recv( + self, fd: int + ) -> Optional[List[Tuple[Optional[str], float, Tuple[str, int], bytes]]]: clnt = self.by_fd[fd] msgs = clnt.recv() if msgs is None: @@ -120,28 +161,46 @@ class Clients: result = [] for when, peeraddr, packet in msgs: if proto_of_message(packet) == LOGIN.PROTO: # Could do blindly... - self.by_imei[clnt.imei] = clnt + if clnt.imei: + self.by_imei[clnt.imei] = clnt + else: + log.warning( + "Login message from %s: %s, but client imei unfilled", + peeraddr, + packet, + ) result.append((clnt.imei, when, peeraddr, packet)) + log.debug( + "Received from %s (IMEI %s): %s", + peeraddr, + clnt.imei, + packet.hex(), + ) return result - def response(self, resp): + def response(self, resp: Resp) -> None: if resp.imei in self.by_imei: self.by_imei[resp.imei].send(resp.packet) + else: + log.info("Not connected (IMEI %s)", resp.imei) -def runserver(conf): - zctx = zmq.Context() - zpub = zctx.socket(zmq.PUB) +def runserver(conf: ConfigParser, handle_hibernate: bool = True) -> None: + # Is this https://github.com/zeromq/pyzmq/issues/1627 still not fixed?! + zctx = zmq.Context() # type: ignore + zpub = zctx.socket(zmq.PUB) # type: ignore + zpull = zctx.socket(zmq.PULL) # type: ignore + oldmask = umask(0o117) zpub.bind(conf.get("collector", "publishurl")) - zsub = zctx.socket(zmq.SUB) - zsub.connect(conf.get("collector", "listenurl")) - tcpl = socket(AF_INET, SOCK_STREAM) + zpull.bind(conf.get("collector", "listenurl")) + umask(oldmask) + tcpl = socket(AF_INET6, SOCK_STREAM) tcpl.setsockopt(SOL_SOCKET, SO_REUSEADDR, 1) tcpl.bind(("", conf.getint("collector", "port"))) tcpl.listen(5) tcpfd = tcpl.fileno() - poller = zmq.Poller() - poller.register(zsub, flags=zmq.POLLIN) + poller = zmq.Poller() # type: ignore + poller.register(zpull, flags=zmq.POLLIN) poller.register(tcpfd, flags=zmq.POLLIN) clients = Clients() try: @@ -149,24 +208,24 @@ def runserver(conf): tosend = [] topoll = [] tostop = [] - events = poller.poll(10) + events = poller.poll(1000) for sk, fl in events: - if sk is zsub: + if sk is zpull: while True: try: - msg = zsub.recv(zmq.NOBLOCK) - tosend.append(Resp(msg)) + msg = zpull.recv(zmq.NOBLOCK) + zmsg = Resp(msg) + tosend.append(zmsg) except zmq.Again: break elif sk == tcpfd: clntsock, clntaddr = tcpl.accept() + clntsock.setsockopt(SOL_SOCKET, SO_KEEPALIVE, 1) topoll.append((clntsock, clntaddr)) - else: + elif fl & zmq.POLLIN: received = clients.recv(sk) if received is None: - log.debug( - "Terminal gone from fd %d (IMEI %s)", sk, imei - ) + log.debug("Terminal gone from fd %d", sk) tostop.append(sk) else: for imei, when, peeraddr, packet in received: @@ -180,7 +239,7 @@ def runserver(conf): packet=packet, ).packed ) - if proto == HIBERNATION.PROTO: + if proto == HIBERNATION.PROTO and handle_hibernate: log.debug( "HIBERNATION from fd %d (IMEI %s)", sk, @@ -189,20 +248,35 @@ def runserver(conf): tostop.append(sk) respmsg = inline_response(packet) if respmsg is not None: - clients.response( - Resp(imei=imei, packet=respmsg) + tosend.append( + Resp(imei=imei, when=when, packet=respmsg) ) + else: + log.debug("Stray event: %s on socket %s", fl, sk) # poll queue consumed, make changes now for fd in tostop: - poller.unregister(fd) + poller.unregister(fd) # type: ignore clients.stop(fd) for zmsg in tosend: + zpub.send( + Bcast( + is_incoming=False, + proto=proto_of_message(zmsg.packet), + when=zmsg.when, + imei=zmsg.imei, + packet=zmsg.packet, + ).packed + ) + log.debug("Sending to the client: %s", zmsg) clients.response(zmsg) for clntsock, clntaddr in topoll: fd = clients.add(clntsock, clntaddr) - poller.register(fd) + poller.register(fd, flags=zmq.POLLIN) except KeyboardInterrupt: - pass + zpub.close() + zpull.close() + zctx.destroy() # type: ignore + tcpl.close() if __name__.endswith("__main__"):