X-Git-Url: http://www.average.org/gitweb/?a=blobdiff_plain;f=gps303%2Fcollector.py;h=00594e1d9f180bd542cdc99823f917f016f67f5d;hb=10665d8aca2b350782616da33888343e8fcc1e65;hp=d8ca86c0791a2b8c0cda3dae053153b649c863ce;hpb=4c9597cff07443042f51c2330a050b7ee5bc9bcb;p=loctrkd.git diff --git a/gps303/collector.py b/gps303/collector.py index d8ca86c..00594e1 100644 --- a/gps303/collector.py +++ b/gps303/collector.py @@ -1,99 +1,183 @@ -from getopt import getopt -from logging import getLogger, StreamHandler, DEBUG, INFO -from logging.handlers import SysLogHandler -from socket import socket, AF_INET, SOCK_STREAM, SOL_SOCKET, SO_REUSEADDR +""" TCP server that communicates with terminals """ + +from configparser import ConfigParser +from logging import getLogger +from os import umask +from socket import socket, AF_INET6, SOCK_STREAM, SOL_SOCKET, SO_REUSEADDR +from struct import pack from time import time -import sys +from typing import Dict, List, Optional, Tuple import zmq -from .config import readconfig -from .GT06mod import handle_packet, make_response, LOGIN, set_config - -CONF = "/etc/gps303.conf" +from . import common +from .gps303proto import ( + HIBERNATION, + LOGIN, + inline_response, + parse_message, + proto_of_message, +) +from .zmsg import Bcast, Resp log = getLogger("gps303/collector") -class Bcast: - def __init__(self, imei, msg): - self.as_bytes = imei.encode() + msg.encode() - - -class Zmsg: - def __init__(self, msg): - self.imei = msg[:16].decode() - self.payload = msg[16:] - - class Client: - def __init__(self, clntsock, clntaddr): - self.clntsock = clntsock - self.clntaddr = clntaddr + """Connected socket to the terminal plus buffer and metadata""" + + 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): - self.clntsock.close() + def close(self) -> None: + log.debug("Closing fd %d (IMEI %s)", self.sock.fileno(), self.imei) + self.sock.close() + self.buffer = b"" - def recv(self): - packet = self.clntsock.recv(4096) - if not packet: + 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 as e: + log.warning( + "Reading from fd %d (IMEI %s): %s", + self.sock.fileno(), + self.imei, + e, + ) + return None + if not segment: # Terminal has closed connection + log.info( + "EOF reading from fd %d (IMEI %s)", + self.sock.fileno(), + self.imei, + ) return None when = time() - self.buffer += packet - # implement framing properly - msg = handle_packet(packet, self.clntaddr, when) - self.buffer = self.buffer[len(packet):] - if isinstance(msg, LOGIN): - self.imei = msg.imei - return msg + self.buffer += segment + msgs = [] + while True: + framestart = self.buffer.find(b"xx") + if framestart == -1: # No frames, return whatever we have + break + if framestart > 0: # Should not happen, report + log.warning( + 'Undecodable data "%s" from fd %d (IMEI %s)', + self.buffer[:framestart].hex(), + self.sock.fileno(), + self.imei, + ) + self.buffer = self.buffer[framestart:] + # At this point, buffer starts with a packet + 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) + if frameend >= (exp_end - 3): # Found realistic match + break + if frameend == -1: # Incomplete frame, return what we have + break + packet = self.buffer[2:frameend] + self.buffer = self.buffer[frameend + 2 :] + 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 + ) + msgs.append((when, self.addr, packet)) + return msgs - def send(self, buffer): - self.clntsock.send(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.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): - clnt = by_fd[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() if clnt.imei: del self.by_imei[clnt.imei] del self.by_fd[fd] - def recv(self, fd): - clnt = by_fd[fd] - msg = clnt.recv() - if isinstance(msg, LOGIN): - self.by_imei[clnt.imei] = clnt - return clnt.imei, msg + 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: + return None + result = [] + for when, peeraddr, packet in msgs: + if proto_of_message(packet) == LOGIN.PROTO: # Could do blindly... + 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, zmsg): - if zmsg.imei in self.by_imei: - clnt = self.by_imei[zmsg.imei].send(zmsg.payload) + 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(opts, conf): - zctx = zmq.Context() - zpub = zctx.socket(zmq.PUB) +def runserver(conf: ConfigParser) -> 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: @@ -101,44 +185,72 @@ def runserver(opts, 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(Zmsg(msg)) + msg = zpull.recv(zmq.NOBLOCK) + zmsg = Resp(msg) + tosend.append(zmsg) except zmq.Again: break elif sk == tcpfd: - clntsock, clntaddr = ctlsock.accept() + clntsock, clntaddr = tcpl.accept() topoll.append((clntsock, clntaddr)) - else: - imei, msg = clients.recv(sk) - zpub.send(Bcast(imei, msg).as_bytes) - if msg is None or isinstance(msg, HIBERNATION): + elif fl & zmq.POLLIN: + received = clients.recv(sk) + if received is None: + log.debug("Terminal gone from fd %d", sk) tostop.append(sk) + else: + for imei, when, peeraddr, packet in received: + proto = proto_of_message(packet) + zpub.send( + Bcast( + proto=proto, + imei=imei, + when=when, + peeraddr=peeraddr, + packet=packet, + ).packed + ) + if proto == HIBERNATION.PROTO: + log.debug( + "HIBERNATION from fd %d (IMEI %s)", + sk, + imei, + ) + tostop.append(sk) + respmsg = inline_response(packet) + if respmsg is not None: + 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) # type: ignore clients.stop(fd) - pollset.unregister(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) - pollset.register(fd) + poller.register(fd, flags=zmq.POLLIN) except KeyboardInterrupt: pass if __name__.endswith("__main__"): - opts, _ = getopt(sys.argv[1:], "c:d") - opts = dict(opts) - conf = readconfig(opts["-c"] if "-c" in opts else CONF) - if sys.stdout.isatty(): - log.addHandler(StreamHandler(sys.stderr)) - else: - log.addHandler(SysLogHandler(address="/dev/log")) - log.setLevel(DEBUG if "-d" in opts else INFO) - log.info("starting with options: %s", opts) - runserver(opts, conf) + runserver(common.init(log))