1 """ TCP server that communicates with terminals """
3 from configparser import ConfigParser
4 from importlib import import_module
5 from logging import getLogger
15 from struct import pack
17 from typing import Any, cast, Dict, List, Optional, Tuple, Union
21 from .zmsg import Bcast, Resp
23 log = getLogger("loctrkd/collector")
31 def enframe(buffer: bytes, imei: Optional[str] = None) -> bytes:
34 def recv(self, segment: bytes) -> List[Union[bytes, str]]:
37 def close(self) -> bytes:
41 def probe_buffer(buffer: bytes) -> bool:
45 def parse_message(packet: bytes, is_incoming: bool = True) -> Any:
49 def inline_response(packet: bytes) -> Optional[bytes]:
53 def is_goodbye_packet(packet: bytes) -> bool:
57 def imei_from_packet(packet: bytes) -> Optional[str]:
61 def proto_of_message(packet: bytes) -> str:
65 def proto_by_name(name: str) -> int:
69 pmods: List[ProtoModule] = []
73 """Connected socket to the terminal plus buffer and metadata"""
75 def __init__(self, sock: socket, addr: Tuple[str, int]) -> None:
78 self.pmod: Optional[ProtoModule] = None
79 self.stream: Optional[ProtoModule.Stream] = None
80 self.imei: Optional[str] = None
82 def close(self) -> None:
83 log.debug("Closing fd %d (IMEI %s)", self.sock.fileno(), self.imei)
86 rest = self.stream.close()
91 "%d bytes in buffer on close: %s", len(rest), rest[:64].hex()
94 def recv(self) -> Optional[List[Tuple[float, Tuple[str, int], bytes]]]:
95 """Read from the socket and parse complete messages"""
97 segment = self.sock.recv(MAXBUFFER)
100 "Reading from fd %d (IMEI %s): %s",
106 if not segment: # Terminal has closed connection
108 "EOF reading from fd %d (IMEI %s)",
113 if self.stream is None:
115 if pmod.probe_buffer(segment):
117 self.stream = pmod.Stream()
119 if self.stream is None:
121 "unrecognizable %d bytes of data %s from fd %d",
129 for elem in self.stream.recv(segment):
130 if isinstance(elem, bytes):
131 msgs.append((when, self.addr, elem))
134 "%s from fd %d (IMEI %s)",
141 def send(self, buffer: bytes) -> None:
142 assert self.stream is not None
144 self.sock.send(self.stream.enframe(buffer, imei=self.imei))
147 "Sending to fd %d (IMEI %s): %s",
155 def __init__(self) -> None:
156 self.by_fd: Dict[int, Client] = {}
157 self.by_imei: Dict[str, Client] = {}
159 def add(self, clntsock: socket, clntaddr: Tuple[str, int]) -> int:
160 fd = clntsock.fileno()
161 log.info("Start serving fd %d from %s", fd, clntaddr)
162 self.by_fd[fd] = Client(clntsock, clntaddr)
165 def stop(self, fd: int) -> None:
166 clnt = self.by_fd[fd]
167 log.info("Stop serving fd %d (IMEI %s)", clnt.sock.fileno(), clnt.imei)
170 del self.by_imei[clnt.imei]
176 List[Tuple[ProtoModule, Optional[str], float, Tuple[str, int], bytes]]
178 clnt = self.by_fd[fd]
183 for when, peeraddr, packet in msgs:
184 assert clnt.pmod is not None
185 if clnt.imei is None:
186 imei = clnt.pmod.imei_from_packet(packet)
188 log.info("LOGIN from fd %d (IMEI %s)", fd, imei)
190 oldclnt = self.by_imei.get(clnt.imei)
191 if oldclnt is not None:
193 "Orphaning fd %d with the same IMEI",
194 oldclnt.sock.fileno(),
197 self.by_imei[clnt.imei] = clnt
200 "Login message from %s: %s, but client imei unfilled",
204 result.append((clnt.pmod, clnt.imei, when, peeraddr, packet))
206 "Received from %s (IMEI %s): %s",
213 def response(self, resp: Resp) -> Optional[ProtoModule]:
214 if resp.imei in self.by_imei:
215 clnt = self.by_imei[resp.imei]
216 clnt.send(resp.packet)
219 log.info("Not connected (IMEI %s)", resp.imei)
223 def runserver(conf: ConfigParser, handle_hibernate: bool = True) -> None:
226 cast(ProtoModule, import_module("." + modnm, __package__))
227 for modnm in conf.get("collector", "protocols").split(",")
229 # Is this https://github.com/zeromq/pyzmq/issues/1627 still not fixed?!
230 zctx = zmq.Context() # type: ignore
231 zpub = zctx.socket(zmq.PUB) # type: ignore
232 zpull = zctx.socket(zmq.PULL) # type: ignore
233 oldmask = umask(0o117)
234 zpub.bind(conf.get("collector", "publishurl"))
235 zpull.bind(conf.get("collector", "listenurl"))
237 tcpl = socket(AF_INET6, SOCK_STREAM)
238 tcpl.setsockopt(SOL_SOCKET, SO_REUSEADDR, 1)
239 tcpl.bind(("", conf.getint("collector", "port")))
241 tcpfd = tcpl.fileno()
242 poller = zmq.Poller() # type: ignore
243 poller.register(zpull, flags=zmq.POLLIN)
244 poller.register(tcpfd, flags=zmq.POLLIN)
251 events = poller.poll(1000)
252 for sk, fl in events:
256 msg = zpull.recv(zmq.NOBLOCK)
262 clntsock, clntaddr = tcpl.accept()
263 clntsock.setsockopt(SOL_SOCKET, SO_KEEPALIVE, 1)
264 topoll.append((clntsock, clntaddr))
265 elif fl & zmq.POLLIN:
266 received = clients.recv(sk)
268 log.debug("Terminal gone from fd %d", sk)
271 for pmod, imei, when, peeraddr, packet in received:
272 proto = pmod.proto_of_message(packet)
283 pmod.is_goodbye_packet(packet)
287 "Goodbye from fd %d (IMEI %s)",
292 respmsg = pmod.inline_response(packet)
293 if respmsg is not None:
295 Resp(imei=imei, when=when, packet=respmsg)
298 log.debug("Stray event: %s on socket %s", fl, sk)
299 # poll queue consumed, make changes now
301 log.debug("Sending to the client: %s", zmsg)
302 rpmod = clients.response(zmsg)
303 if rpmod is not None:
307 proto=rpmod.proto_of_message(zmsg.packet),
314 poller.unregister(fd) # type: ignore
316 for clntsock, clntaddr in topoll:
317 fd = clients.add(clntsock, clntaddr)
318 poller.register(fd, flags=zmq.POLLIN)
319 except KeyboardInterrupt:
322 zctx.destroy() # type: ignore
326 if __name__.endswith("__main__"):
327 runserver(common.init(log))