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, Set, Tuple, Union
21 from .zmsg import Bcast, Resp
23 log = getLogger("loctrkd/collector")
30 def recv(self, segment: bytes) -> List[Union[bytes, str]]:
33 def close(self) -> bytes:
37 def enframe(buffer: bytes, imei: Optional[str] = None) -> 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 pmods: List[ProtoModule] = []
69 """Connected socket to the terminal plus buffer and metadata"""
71 def __init__(self, sock: socket, addr: Tuple[str, int]) -> None:
74 self.pmod: Optional[ProtoModule] = None
75 self.stream: Optional[ProtoModule.Stream] = None
76 self.imei: Optional[str] = None
78 def close(self) -> None:
79 log.debug("Closing fd %d (IMEI %s)", self.sock.fileno(), self.imei)
82 rest = self.stream.close()
87 "%d bytes in buffer on close: %s", len(rest), rest[:64].hex()
90 def recv(self) -> Optional[List[Tuple[float, Tuple[str, int], bytes]]]:
91 """Read from the socket and parse complete messages"""
93 segment = self.sock.recv(MAXBUFFER)
96 "Reading from fd %d (IMEI %s): %s",
102 if not segment: # Terminal has closed connection
104 "EOF reading from fd %d (IMEI %s)",
109 if self.stream is None:
111 if pmod.probe_buffer(segment):
113 self.stream = pmod.Stream()
115 if self.stream is None:
117 "unrecognizable %d bytes of data %s from fd %d",
125 for elem in self.stream.recv(segment):
126 if isinstance(elem, bytes):
127 msgs.append((when, self.addr, elem))
130 "%s from fd %d (IMEI %s)",
137 def send(self, buffer: bytes) -> None:
138 assert self.stream is not None and self.pmod is not None
140 self.sock.send(self.pmod.enframe(buffer, imei=self.imei))
143 "Sending to fd %d (IMEI %s): %s",
151 def __init__(self) -> None:
152 self.by_fd: Dict[int, Client] = {}
153 self.by_imei: Dict[str, Client] = {}
154 self.tostop: Set[int] = set()
156 def add(self, clntsock: socket, clntaddr: Tuple[str, int]) -> int:
157 fd = clntsock.fileno()
158 log.info("Start serving fd %d from %s", fd, clntaddr)
159 self.by_fd[fd] = Client(clntsock, clntaddr)
162 def stop(self, fd: int) -> None:
163 clnt = self.by_fd[fd]
164 log.info("Stop serving fd %d (IMEI %s)", clnt.sock.fileno(), clnt.imei)
166 if clnt.imei and self.by_imei[clnt.imei] == clnt: # could be replaced
167 del self.by_imei[clnt.imei]
173 List[Tuple[ProtoModule, Optional[str], float, Tuple[str, int], bytes]]
175 clnt = self.by_fd[fd]
180 for when, peeraddr, packet in msgs:
181 assert clnt.pmod is not None
182 if clnt.imei is None:
183 imei = clnt.pmod.imei_from_packet(packet)
185 log.info("LOGIN from fd %d (IMEI %s)", fd, imei)
187 oldclnt = self.by_imei.get(clnt.imei)
188 if oldclnt is not None:
189 oldfd = oldclnt.sock.fileno()
190 log.info("Removing stale connection on fd %d", oldfd)
192 self.tostop.add(oldfd)
193 self.by_imei[clnt.imei] = clnt
194 result.append((clnt.pmod, clnt.imei, when, peeraddr, packet))
196 "Received from %s (IMEI %s): %s",
203 def response(self, resp: Resp) -> Optional[ProtoModule]:
204 if resp.imei in self.by_imei:
205 clnt = self.by_imei[resp.imei]
206 clnt.send(resp.packet)
209 log.info("Not connected (IMEI %s)", resp.imei)
213 def runserver(conf: ConfigParser, handle_hibernate: bool = True) -> None:
216 cast(ProtoModule, import_module("." + modnm, __package__))
217 for modnm in conf.get("collector", "protocols").split(",")
219 # Is this https://github.com/zeromq/pyzmq/issues/1627 still not fixed?!
220 zctx = zmq.Context() # type: ignore
221 zpub = zctx.socket(zmq.PUB) # type: ignore
222 zpull = zctx.socket(zmq.PULL) # type: ignore
223 oldmask = umask(0o117)
224 zpub.bind(conf.get("collector", "publishurl"))
225 zpull.bind(conf.get("collector", "listenurl"))
227 tcpl = socket(AF_INET6, SOCK_STREAM)
228 tcpl.setsockopt(SOL_SOCKET, SO_REUSEADDR, 1)
229 tcpl.bind(("", conf.getint("collector", "port")))
231 tcpfd = tcpl.fileno()
232 poller = zmq.Poller() # type: ignore
233 poller.register(zpull, flags=zmq.POLLIN)
234 poller.register(tcpfd, flags=zmq.POLLIN)
240 clients.tostop = set()
241 events = poller.poll(1000)
242 for sk, fl in events:
246 msg = zpull.recv(zmq.NOBLOCK)
252 clntsock, clntaddr = tcpl.accept()
253 clntsock.setsockopt(SOL_SOCKET, SO_KEEPALIVE, 1)
254 topoll.append((clntsock, clntaddr))
255 elif fl & zmq.POLLIN:
256 received = clients.recv(sk)
258 log.debug("Terminal gone from fd %d", sk)
259 clients.tostop.add(sk)
261 for pmod, imei, when, peeraddr, packet in received:
262 proto = pmod.proto_of_message(packet)
273 pmod.is_goodbye_packet(packet)
277 "Goodbye from fd %d (IMEI %s)",
281 clients.tostop.add(sk)
282 respmsg = pmod.inline_response(packet)
283 if respmsg is not None:
285 Resp(imei=imei, when=when, packet=respmsg)
288 log.debug("Stray event: %s on socket %s", fl, sk)
289 # poll queue consumed, make changes now
291 log.debug("Sending to the client: %s", zmsg)
292 rpmod = clients.response(zmsg)
293 if rpmod is not None:
297 proto=rpmod.proto_of_message(zmsg.packet),
303 for fd in clients.tostop:
304 poller.unregister(fd) # type: ignore
306 for clntsock, clntaddr in topoll:
307 fd = clients.add(clntsock, clntaddr)
308 poller.register(fd, flags=zmq.POLLIN)
309 except KeyboardInterrupt:
312 zctx.destroy() # type: ignore
316 if __name__.endswith("__main__"):
317 runserver(common.init(log))