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("gps303/collector")
31 def enframe(buffer: bytes) -> 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) -> int:
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()
90 log.warning("%d bytes in buffer on close: %s", len(rest), rest)
92 def recv(self) -> Optional[List[Tuple[float, Tuple[str, int], bytes]]]:
93 """Read from the socket and parse complete messages"""
95 segment = self.sock.recv(MAXBUFFER)
98 "Reading from fd %d (IMEI %s): %s",
104 if not segment: # Terminal has closed connection
106 "EOF reading from fd %d (IMEI %s)",
111 if self.stream is None:
113 if pmod.probe_buffer(segment):
115 self.stream = pmod.Stream()
117 if self.stream is None:
119 "unrecognizable %d bytes of data %s from fd %d",
127 for elem in self.stream.recv(segment):
128 if isinstance(elem, bytes):
129 msgs.append((when, self.addr, elem))
132 "%s from fd %d (IMEI %s)",
139 def send(self, buffer: bytes) -> None:
140 assert self.stream is not None
142 self.sock.send(self.stream.enframe(buffer))
145 "Sending to fd %d (IMEI %s): %s",
153 def __init__(self) -> None:
154 self.by_fd: Dict[int, Client] = {}
155 self.by_imei: Dict[str, Client] = {}
157 def add(self, clntsock: socket, clntaddr: Tuple[str, int]) -> int:
158 fd = clntsock.fileno()
159 log.info("Start serving fd %d from %s", fd, clntaddr)
160 self.by_fd[fd] = Client(clntsock, clntaddr)
163 def stop(self, fd: int) -> None:
164 clnt = self.by_fd[fd]
165 log.info("Stop serving fd %d (IMEI %s)", clnt.sock.fileno(), clnt.imei)
168 del self.by_imei[clnt.imei]
174 List[Tuple[ProtoModule, Optional[str], float, Tuple[str, int], bytes]]
176 clnt = self.by_fd[fd]
181 for when, peeraddr, packet in msgs:
182 assert clnt.pmod is not None
183 if clnt.imei is None:
184 imei = clnt.pmod.imei_from_packet(packet)
186 log.info("LOGIN from fd %d (IMEI %s)", fd, imei)
188 oldclnt = self.by_imei.get(clnt.imei)
189 if oldclnt is not None:
191 "Orphaning fd %d with the same IMEI",
192 oldclnt.sock.fileno(),
195 self.by_imei[clnt.imei] = clnt
198 "Login message from %s: %s, but client imei unfilled",
202 result.append((clnt.pmod, clnt.imei, when, peeraddr, packet))
204 "Received from %s (IMEI %s): %s",
211 def response(self, resp: Resp) -> Optional[ProtoModule]:
212 if resp.imei in self.by_imei:
213 clnt = self.by_imei[resp.imei]
214 clnt.send(resp.packet)
217 log.info("Not connected (IMEI %s)", resp.imei)
221 def runserver(conf: ConfigParser, handle_hibernate: bool = True) -> None:
224 cast(ProtoModule, import_module("." + modnm, __package__))
225 for modnm in conf.get("collector", "protocols").split(",")
227 # Is this https://github.com/zeromq/pyzmq/issues/1627 still not fixed?!
228 zctx = zmq.Context() # type: ignore
229 zpub = zctx.socket(zmq.PUB) # type: ignore
230 zpull = zctx.socket(zmq.PULL) # type: ignore
231 oldmask = umask(0o117)
232 zpub.bind(conf.get("collector", "publishurl"))
233 zpull.bind(conf.get("collector", "listenurl"))
235 tcpl = socket(AF_INET6, SOCK_STREAM)
236 tcpl.setsockopt(SOL_SOCKET, SO_REUSEADDR, 1)
237 tcpl.bind(("", conf.getint("collector", "port")))
239 tcpfd = tcpl.fileno()
240 poller = zmq.Poller() # type: ignore
241 poller.register(zpull, flags=zmq.POLLIN)
242 poller.register(tcpfd, flags=zmq.POLLIN)
249 events = poller.poll(1000)
250 for sk, fl in events:
254 msg = zpull.recv(zmq.NOBLOCK)
260 clntsock, clntaddr = tcpl.accept()
261 clntsock.setsockopt(SOL_SOCKET, SO_KEEPALIVE, 1)
262 topoll.append((clntsock, clntaddr))
263 elif fl & zmq.POLLIN:
264 received = clients.recv(sk)
266 log.debug("Terminal gone from fd %d", sk)
269 for pmod, imei, when, peeraddr, packet in received:
270 proto = pmod.proto_of_message(packet)
281 pmod.is_goodbye_packet(packet)
285 "Goodbye from fd %d (IMEI %s)",
290 respmsg = pmod.inline_response(packet)
291 if respmsg is not None:
293 Resp(imei=imei, when=when, packet=respmsg)
296 log.debug("Stray event: %s on socket %s", fl, sk)
297 # poll queue consumed, make changes now
299 log.debug("Sending to the client: %s", zmsg)
300 rpmod = clients.response(zmsg)
301 if rpmod is not None:
305 proto=rpmod.proto_of_message(zmsg.packet),
312 poller.unregister(fd) # type: ignore
314 for clntsock, clntaddr in topoll:
315 fd = clients.add(clntsock, clntaddr)
316 poller.register(fd, flags=zmq.POLLIN)
317 except KeyboardInterrupt:
320 zctx.destroy() # type: ignore
324 if __name__.endswith("__main__"):
325 runserver(common.init(log))