-
-
Notifications
You must be signed in to change notification settings - Fork 18
Expand file tree
/
Copy pathmqtt.py
More file actions
935 lines (828 loc) · 45.3 KB
/
Copy pathmqtt.py
File metadata and controls
935 lines (828 loc) · 45.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
#!/usr/bin/env python3
import asyncio
import base64
import datetime
import json
import logging
import time
import traceback
from typing import Optional
from zoneinfo import ZoneInfo
import aiomqtt
from meshtastic import mesh_pb2, mqtt_pb2, portnums_pb2, telemetry_pb2
from google.protobuf.json_format import MessageToJson
from google.protobuf.message import DecodeError
from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
from cryptography.hazmat.backends import default_backend
from fastapi.encoders import jsonable_encoder
import channels
from encoders import _JSONDecoder
from models.node import Node
import utils
from utils import normalize_node_id
logger = logging.getLogger(__name__)
def _sane_epoch(v, ceiling: int) -> bool:
"""A real positive epoch no further than tolerance past ceiling
(bool/NaN/inf all fail)."""
return (isinstance(v, (int, float)) and not isinstance(v, bool)
and v == v and 1 <= v <= ceiling + utils.FUTURE_CLOCK_TOLERANCE_S)
def _stamp_position_time(msg):
"""Position payload with a guaranteed-sane time: missing/zero/NaN/future
times become the packet's arrival-bounded rx_time, so real position packets
compete on arrival order at the node_positions freshness guard (#575).
Coordinate-less payloads and retained replays pass through unstamped — a
stamped copy would beat the guard (wiping coordinates / replaying stale
data)."""
pos = msg.get('payload')
if not isinstance(pos, dict) or msg.get('retain'):
return pos
lat, lon = pos.get('latitude_i'), pos.get('longitude_i')
# 0/0 is a no-fix beacon, not null island — as coordinate-less as absent.
if lat is None or lon is None or (not lat and not lon):
return pos
now_epoch = int(time.time())
# The JSON-decoder path delivers the publisher's timestamp unclamped.
rx = msg.get('timestamp')
rx = int(rx) if _sane_epoch(rx, now_epoch) else now_epoch
# Ceiling is now, not rx: rx has its own tolerance, and stacking the two
# would let stored times exceed the guard's poison floor.
if not _sane_epoch(pos.get('time'), now_epoch):
pos = dict(pos)
pos['time'] = rx
return pos
def _node_channel(msg) -> Optional[str]:
"""Channel to stamp on the sending node, or None to leave it alone.
PKI DMs carry no channel; don't stamp last_channel."""
if 'channel' not in msg or msg.get('channel_name') == channels.PKI_CHANNEL:
return None
return str(msg['channel'])
class MQTT:
_DISCORD_DROP_LOG_EVERY = 100
def __init__(self, config, data):
self.config = config
self.data = data
self.host = config['broker']['host']
self.port = config['broker']['port']
self.client_id = config['broker']['client_id']
self.username = config['broker']['username']
self.password = config['broker']['password']
# Discord bridge queue is bounded; we'd rather drop than balloon memory.
# Track drops so the warning at every Nth surfaces a stalled consumer.
self._discord_drops_total: int = 0
# Learns name -> hash from encrypted uplinks so decoded slot indices remap.
self._channel_resolver = channels.ChannelResolver()
# Name bucket -> when its label row was last confirmed written.
self._labeled_name_buckets: dict = {}
self._last_stranded_sweep = time.monotonic()
# Re-confirmed periodically rather than cached for the process lifetime, so
# a row deleted behind our back (a merge, an operator) is written again
# without waiting for a restart.
_LABEL_RECHECK_S = 900
async def _ensure_name_bucket_label(self, bucket: int, channel_name: str) -> None:
"""One label write per name bucket per recheck window; failures retry."""
now = time.monotonic()
last = self._labeled_name_buckets.get(bucket)
if last is not None and now - last < self._LABEL_RECHECK_S:
return
try:
written = await self.data.pg_storage.ensure_channel_label(str(bucket), channel_name)
except Exception:
logger.exception("Labeling name bucket %d (%r) failed", bucket, channel_name)
return
if written:
self._labeled_name_buckets[bucket] = now
async def _merge_stranded_name_buckets(self) -> None:
"""Sweep name buckets whose name has a learned hash back into it.
The learn-event merge fires once, but a bucket can repopulate after it:
write-retry replays carry the pre-merge bucket, the operator backfill
can race a mid-run learn, and a merge that failed before a restart
loses its in-memory requeue. Runs at connect and every recheck window."""
try:
names = await self.data.pg_storage.get_name_bucket_names()
except Exception:
logger.exception("Stranded name-bucket sweep failed")
return
for name in names:
learned = self._channel_resolver.lookup(name)
# <= 7 (e.g. 'ares' -> 7) is unusable as a bucket; that name bucket
# is the channel's permanent home, not a stranding.
if learned is None or learned <= channels.MAX_CHANNEL_INDEX:
continue
try:
await self.data.pg_storage.rebucket_name_channel(name, learned)
except Exception:
logger.exception("Sweep merge for %r -> %d failed; next sweep retries", name, learned)
else:
self._labeled_name_buckets.pop(channels.name_bucket_id(name), None)
def _record_discord_drop(self, event_type: str) -> None:
self._discord_drops_total += 1
if self._discord_drops_total % self._DISCORD_DROP_LOG_EVERY == 0:
logger.warning(
"Discord bridge queue full; dropped %d events so far (latest type=%s) — consumer may be stalled",
self._discord_drops_total, event_type,
)
### actions
async def connect(self):
# Single attempt; main.py's supervise() owns reconnect + exponential backoff.
# Seed from wire-healed names so a restart doesn't reopen the learning
# window (first decoded copy would misfile permanently). Non-fatal.
try:
seedable = await self.data.pg_storage.get_wire_channel_names()
self._channel_resolver.seed(seedable)
except Exception as e:
logger.warning("Channel resolver seeding skipped: %s", e)
await self._merge_stranded_name_buckets()
self._last_stranded_sweep = time.monotonic()
logger.info("Connecting to MQTT broker at %s:%d", self.config['broker']['host'], self.config['broker']['port'])
try:
async with aiomqtt.Client(
hostname = self.config["broker"]["host"],
port = self.config["broker"]["port"],
identifier = self.config["broker"]["client_id"],
username = self.config["broker"]["username"],
password = self.config["broker"]["password"],
) as client:
logger.info("Connected to MQTT broker at %s:%d", self.config["broker"]["host"], self.config["broker"]["port"])
if "topics" in self.config["broker"] and self.config["broker"]["topics"] is not None and isinstance(self.config["broker"]["topics"], list):
for topic in self.config["broker"]["topics"]:
await client.subscribe(topic)
elif "topic" in self.config["broker"] and self.config["broker"]["topic"] is not None and isinstance(self.config["broker"]["topic"], str):
await client.subscribe(self.config["broker"]["topic"])
else:
raise RuntimeError("No MQTT topics to subscribe to defined in config broker.topics or broker.topic")
self.data.mqtt_connect_time = datetime.datetime.now(ZoneInfo(self.config['server']['timezone']))
async for msg in client.messages:
# paho adds a timestamp to messages which is not in
# aiomqtt. We will do that ourself here so it is compatible.
msg.timestamp = time.monotonic() # type: ignore
await self.process_mqtt_msg(client, msg)
except aiomqtt.MqttError as err:
# Friendly log before re-raising; supervise() will log the traceback at restart.
logger.warning("Disconnected from MQTT broker: %s", err)
raise
async def process_mqtt_msg(self, client, msg):
if self.config['broker']['decoders']['protobuf']['enabled']:
if'/2/e/' in msg.topic.value or '/2/map/' in msg.topic.value:
logger.debug("Received a protobuf message: %s %s", msg.topic, msg.payload)
is_encrypted = False
mp = mesh_pb2.MeshPacket()
outs = {}
try:
se = mqtt_pb2.ServiceEnvelope()
se.ParseFromString(msg.payload)
mp = se.packet
outs = json.loads(MessageToJson(mp, preserving_proto_field_name=True, ensure_ascii=False, indent=2, sort_keys=True, use_integers_for_enums=True))
# Extract gateway_id (the node that uplinked this packet to MQTT)
if se.gateway_id:
gw = se.gateway_id.replace('!', '')
if len(gw) <= 8:
outs['sender'] = gw
logger.debug("Decoded protobuf message: %s", outs)
except DecodeError as e:
logger.warning("Discarding malformed protobuf ServiceEnvelope on %s: %s", msg.topic.value, e)
return
except Exception as e:
# Returning early avoids logging a noisy type='unknown' row for a packet we can't read.
logger.exception("Unexpected error decoding protobuf envelope on %s: %s", msg.topic.value, e)
return
if mp.HasField("encrypted") and not mp.HasField("decoded"):
is_encrypted = True
for key_item in self.config['broker']['channels']['encryption']:
key_bytes = base64.b64decode(key_item['key'].encode('ascii'))
try:
logger.debug("Attempting decryption with key: %s", key_item.get('name', '<unnamed>'))
nonce_packet_id = getattr(mp, "id").to_bytes(8, "little")
nonce_from_node = getattr(mp, "from").to_bytes(8, "little")
nonce = nonce_packet_id + nonce_from_node
cipher = Cipher(algorithms.AES(key_bytes), modes.CTR(nonce), backend=default_backend())
decryptor = cipher.decryptor()
decrypted_bytes = decryptor.update(getattr(mp, "encrypted")) + decryptor.finalize()
data = mesh_pb2.Data()
data.ParseFromString(decrypted_bytes)
mp.decoded.CopyFrom(data)
saved_sender = outs.get('sender')
outs = json.loads(MessageToJson(mp, preserving_proto_field_name=True, ensure_ascii=False, indent=2, sort_keys=True, use_integers_for_enums=True))
if saved_sender:
outs['sender'] = saved_sender
break
except Exception as e:
logger.debug("Decryption failed: %s", e)
continue
# A 0/0.0 rssi/snr pair means "no RF measurement" (proto3 no-presence);
# snr alone can legitimately be 0.0 dB. Omit keys (not None) so a
# no-reading copy diffs to an empty dedup extras patch.
if mp.rx_rssi != 0:
outs['rssi'] = mp.rx_rssi
if mp.rx_rssi != 0 or mp.rx_snr != 0.0:
outs['snr'] = mp.rx_snr
# Clamp rx_time to now if the node clock is ahead; floor unset
# (proto3 zero) at arrival — epoch 0 evades every range filter.
rx_time = mp.rx_time
now_epoch = int(time.time())
if not rx_time:
rx_time = now_epoch
elif rx_time > now_epoch + utils.FUTURE_CLOCK_TOLERANCE_S:
node_id = utils.convert_node_id_from_int_to_hex(getattr(mp, "from", 0))
logger.warning("Node %s has future clock: rx_time=%s (%.0f min ahead), clamping to now", node_id, rx_time, (rx_time - now_epoch) / 60)
rx_time = now_epoch
outs['timestamp'] = rx_time
outs['topic'] = msg.topic.value
outs["qos"] = getattr(msg, "qos", None)
outs["retain"] = getattr(msg, "retain", None)
# MessageToJson omits channel 0 (primary); read it off mp.
# mp.channel is the (name,PSK) hash on encrypted uplinks but a
# gateway-local slot index on decoded ones — resolve to one bucket.
# Normalized so resolver keys, name buckets, and stored
# channel_name all agree on one spelling.
channel_name = channels.normalize_wire_name(
se.channel_id or channels.name_from_topic(msg.topic.value)
)
outs['channel'] = self._channel_resolver.resolve(
raw_channel=mp.channel,
is_encrypted=is_encrypted,
channel_name=channel_name,
is_pki=mp.pki_encrypted,
# Lets observe() tell a re-key from one packet published twice.
packet_id=mp.id or None,
)
if channel_name:
outs['channel_name'] = channel_name
# A just-learned hash merges that name's bucket into it. Requeue
# on failure: a reaffirmation never re-emits, so dropping the
# event would strand that name's rows in the old bucket for good.
for learned_name, learned_hash in self._channel_resolver.drain_learn_events():
try:
await self.data.pg_storage.rebucket_name_channel(learned_name, learned_hash)
except Exception:
logger.exception("Bucket merge for %r -> %d failed; will retry",
learned_name, learned_hash)
self._channel_resolver.requeue_learn_event(learned_name, learned_hash)
else:
# The merge drops the label row, so a name that later
# re-derives its bucket (LRU eviction, re-key into 0-7)
# must be able to write it again.
self._labeled_name_buckets.pop(
channels.name_bucket_id(learned_name), None
)
if time.monotonic() - self._last_stranded_sweep >= self._LABEL_RECHECK_S:
self._last_stranded_sweep = time.monotonic()
await self._merge_stranded_name_buckets()
# Name buckets are derived, not stored: without this the label
# only exists once the channel carries a chat message, so
# telemetry/position-only channels render as "Channel <bigint>".
if channel_name and channels.is_name_bucket(outs['channel']):
await self._ensure_name_bucket_label(outs['channel'], channel_name)
# Fallback: extract gateway from topic suffix if gateway_id was empty
if not outs.get('sender'):
topic_parts = msg.topic.value.split('/')
if topic_parts and topic_parts[-1].startswith('!'):
outs['sender'] = topic_parts[-1].replace('!', '')
# Read off mp: MessageToJson hides hop_limit==0. hop_start==0 =
# pre-2.3 firmware, hops unknown → leave absent (NULL).
if mp.hop_start > 0:
outs["hop_start"] = mp.hop_start
outs["hop_limit"] = mp.hop_limit
outs["hops_away"] = max(mp.hop_start - mp.hop_limit, 0)
if mp.decoded.portnum == portnums_pb2.TEXT_MESSAGE_APP:
payload_bytes = bytes(mp.decoded.payload)
try:
text = payload_bytes.decode("utf-8")
outs["type"] = "text"
outs["payload"] = {"text": text}
logger.debug("Decoded protobuf message: text: %s", outs)
except UnicodeDecodeError:
outs["type"] = "text_binary"
outs["payload"] = {
"text_b64": base64.b64encode(payload_bytes).decode("ascii"),
"len": len(payload_bytes),
}
logger.debug("Decoded protobuf message: text_binary: %s", outs)
# Route text payloads through the chat handler; binary payloads only get logged.
if outs.get("type") == "text":
await self._safe_handle("handle_text", self.handle_text(outs))
elif mp.decoded.portnum == portnums_pb2.MAP_REPORT_APP:
try:
report = mqtt_pb2.MapReport().FromString(mp.decoded.payload)
out = json.loads(MessageToJson(report, preserving_proto_field_name=True, ensure_ascii=False, indent=2, sort_keys=True, use_integers_for_enums=True))
outs["type"] = "mapreport"
outs["payload"] = out
logger.debug("Decoded protobuf message: mapreport: %s", outs)
except UnicodeDecodeError as e:
logger.debug("Unicode decoding error: text: %s", e)
except DecodeError as e:
logger.debug("Protobuf decode error: text: %s", e)
else:
await self._safe_handle("handle_mapreport", self.handle_mapreport(outs))
elif mp.decoded.portnum == portnums_pb2.NEIGHBORINFO_APP:
try:
info = mesh_pb2.NeighborInfo().FromString(mp.decoded.payload)
out = json.loads(MessageToJson(info, preserving_proto_field_name=True, ensure_ascii=False, indent=2, sort_keys=True, use_integers_for_enums=True, always_print_fields_with_no_presence=True))
outs["type"] = "neighborinfo"
outs["payload"] = out
logger.debug("Decoded protobuf message: neighborinfo: %s", outs)
except UnicodeDecodeError as e:
logger.debug("Unicode decoding error: text: %s", e)
except DecodeError as e:
logger.debug("Protobuf decode error: text: %s", e)
else:
await self._safe_handle("handle_neighborinfo", self.handle_neighborinfo(outs))
elif mp.decoded.portnum == portnums_pb2.NODEINFO_APP:
try:
info = mesh_pb2.User().FromString(mp.decoded.payload)
out = json.loads(MessageToJson(info, preserving_proto_field_name=True, ensure_ascii=False, indent=2, sort_keys=True, use_integers_for_enums=True))
# User.id is occasionally unset; MeshPacket.from is the fallback.
nid = normalize_node_id(out.get('id')) or normalize_node_id(outs.get('from'))
if nid is None:
logger.debug("NODEINFO packet missing identity; skipping: %s", out)
else:
out["id"] = nid
outs["type"] = "nodeinfo"
outs["payload"] = out
logger.debug("Decoded protobuf message: nodeinfo: %s", outs)
await self._safe_handle("handle_nodeinfo", self.handle_nodeinfo(outs))
except UnicodeDecodeError as e:
logger.debug("Unicode decoding error: text: %s", e)
except DecodeError as e:
logger.debug("Protobuf decode error: text: %s", e)
elif mp.decoded.portnum == portnums_pb2.ROUTING_APP:
try:
data = mesh_pb2.Routing().FromString(mp.decoded.payload)
out = json.loads(MessageToJson(data, preserving_proto_field_name=True, ensure_ascii=False, indent=2, sort_keys=True, use_integers_for_enums=True))
outs["type"] = "routing"
outs["payload"] = out
logger.debug("Decoded protobuf message: routing: %s", outs)
except UnicodeDecodeError as e:
logger.debug("Unicode decoding error: text: %s", e)
except DecodeError as e:
logger.debug("Protobuf decode error: text: %s", e)
elif mp.decoded.portnum == portnums_pb2.TRACEROUTE_APP:
try:
route_msg = mesh_pb2.RouteDiscovery().FromString(mp.decoded.payload)
out = json.loads(MessageToJson(route_msg, preserving_proto_field_name=True, ensure_ascii=False, indent=2, sort_keys=True, use_integers_for_enums=True, always_print_fields_with_no_presence=True))
outs["type"] = "traceroute"
outs["payload"] = out
# Replies carry the request's packet id in Data.request_id
# (0 = unset, i.e. this is a request).
outs["packet_id"] = mp.decoded.request_id or None
logger.debug("Decoded protobuf message: traceroute: %s", outs)
except UnicodeDecodeError as e:
logger.debug("Unicode decoding error: text: %s", e)
except DecodeError as e:
logger.debug("Protobuf decode error: text: %s", e)
else:
await self._safe_handle("handle_traceroute", self.handle_traceroute(outs))
elif mp.decoded.portnum == portnums_pb2.POSITION_APP:
try:
pos = mesh_pb2.Position().FromString(mp.decoded.payload)
out = json.loads(MessageToJson(pos, preserving_proto_field_name=True, ensure_ascii=False, indent=2, sort_keys=True, use_integers_for_enums=True))
outs["type"] = "position"
outs["payload"] = out
logger.debug("Decoded protobuf message: position: %s", outs)
except UnicodeDecodeError as e:
logger.debug("Unicode decoding error: text: %s", e)
except DecodeError as e:
logger.debug("Protobuf decode error: text: %s", e)
else:
await self._safe_handle("handle_position", self.handle_position(outs))
elif mp.decoded.portnum == portnums_pb2.TELEMETRY_APP:
try:
env = telemetry_pb2.Telemetry().FromString(mp.decoded.payload)
out = json.loads(MessageToJson(env, preserving_proto_field_name=True, ensure_ascii=False, indent=2, sort_keys=True, use_integers_for_enums=True))
if 'timestamp' in outs and outs['timestamp'] is not None:
out['timestamp'] = datetime.datetime.fromtimestamp(int(outs['timestamp'])).astimezone(
ZoneInfo(self.config['server']['timezone'])
)
outs["type"] = "telemetry"
# Determine the telemetry variant using protobuf oneof
variant = env.WhichOneof('variant')
outs["telemetry_type"] = variant # e.g. "device_metrics", "environment_metrics", etc.
if variant and variant in out:
outs["payload"] = out[variant]
elif 'device_metrics' in out:
# Fallback for edge cases where WhichOneof returns None
outs["payload"] = out['device_metrics']
outs["telemetry_type"] = "device_metrics"
elif 'environment_metrics' in out:
outs["payload"] = out['environment_metrics']
outs["telemetry_type"] = "environment_metrics"
else:
# Unknown or empty telemetry variant; mark telemetry_type explicitly
outs["payload"] = out
outs["telemetry_type"] = "unknown"
logger.debug("Telemetry with unrecognized variant=%s: %s", variant, out)
logger.debug("Decoded protobuf message: telemetry (variant=%s): %s", variant, outs)
except UnicodeDecodeError as e:
logger.debug("Unicode decoding error: text: %s", e)
except DecodeError as e:
logger.debug("Protobuf decode error: text: %s", e)
except Exception as e:
logger.exception("Telemetry decoding error: %s", e)
else:
await self._safe_handle("handle_telemetry", self.handle_telemetry(outs))
else:
logger.debug("Received an unknown protobuf message: %s", mp)
outs["type"] = "unknown"
if mp.decoded.payload is not None:
try:
outs["payload"] = mp.decoded.payload.decode("utf-8")
except UnicodeDecodeError as e:
logger.debug("Unicode decoding error: text: %s", e)
outs["payload"] = {}
except DecodeError as e:
logger.debug("Protobuf decode error: text: %s", e)
outs["payload"] = {}
else:
outs["payload"] = {}
logger.debug("Processed message: %s", outs)
await self.handle_log(outs)
# Exclusive with protobuf: gateways publish the same packet to both
# namespaces; running both decoders double-fires events.
if (
self.config['broker']['decoders']['json']['enabled']
and not self.config['broker']['decoders']['protobuf']['enabled']
):
if '/2/json' in msg.topic.value:
logger.debug("Received a JSON message: %s %s", msg.topic, msg.payload)
try:
decoded = msg.payload.decode("utf-8")
j = json.loads(decoded, cls=_JSONDecoder)
j['topic'] = msg.topic.value
j["qos"] = getattr(msg, "qos", None)
j["retain"] = getattr(msg, "retain", None)
# Extract gateway node from topic suffix (e.g. msh/US/2/json/LongFast/!67ea9400)
if 'sender' not in j or not j.get('sender'):
topic_parts = msg.topic.value.split('/')
if topic_parts and topic_parts[-1].startswith('!'):
j['sender'] = topic_parts[-1].replace('!', '')
await self.handle_log(j)
msg_type = j.get('type')
if msg_type == "neighborinfo":
await self._safe_handle("handle_neighborinfo", self.handle_neighborinfo(j))
elif msg_type == "nodeinfo":
await self._safe_handle("handle_nodeinfo", self.handle_nodeinfo(j))
elif msg_type == "position":
await self._safe_handle("handle_position", self.handle_position(j))
elif msg_type == "telemetry":
await self._safe_handle("handle_telemetry", self.handle_telemetry(j))
elif msg_type == "text":
await self._safe_handle("handle_text", self.handle_text(j))
elif msg_type == "traceroute":
await self._safe_handle("handle_traceroute", self.handle_traceroute(j))
except Exception as e:
logger.error("JSON message processing error: %s", e, exc_info=True)
### message handlers
async def _safe_handle(self, label: str, coro) -> None:
"""Run a handler coroutine; log + swallow exceptions so one bad packet
doesn't kill the aiomqtt loop and drop concurrent in-flight messages."""
try:
await coro
except Exception as e:
logger.exception("%s failed: %s", label, e)
def _normalize_msg_addrs(self, msg: dict) -> Optional[str]:
"""Normalize msg['from'/'to'/'sender'] in-place; return canonical 'from' or None
if missing/invalid. Accepts int (protobuf) or hex string (JSON publisher)."""
from_id = normalize_node_id(msg.get("from"))
if from_id is None:
return None
msg['from'] = from_id
if 'to' in msg:
to_id = normalize_node_id(msg['to'])
if to_id is not None:
msg['to'] = to_id
else:
msg.pop('to', None)
sender = msg.get('sender')
if isinstance(sender, str):
msg['sender'] = sender.replace('!', '')
return from_id
async def handle_log(self, msg):
topic = msg['topic'] if 'topic' in msg else 'unknown'
logger.debug("MQTT >> %s -- %s", topic, msg)
clean_msg = msg.copy()
clean_msg.pop("decoded", None)
clean_msg.pop("encrypted", None)
row_id = None
try:
row_id = await self.data.pg_storage.write_mqtt_message(clean_msg)
except Exception as e:
logger.error("Failed to write mqtt_message to postgres: %s", e)
if self.config.get('debug'):
logger.debug("Postgres write traceback", exc_info=True)
# Live push: raw packet feed (mqtt_row_id lets the client dedup/deeplink).
if row_id is not None and self.data.broadcaster.subscriber_count:
try:
self.data.broadcaster.publish(
"packet", jsonable_encoder({**clean_msg, "mqtt_row_id": row_id})
)
except Exception as e:
logger.debug("packet broadcast failed: %s", e)
async def handle_neighborinfo(self, msg):
id = self._normalize_msg_addrs(msg)
if id is None:
logger.debug("handle_neighborinfo: missing/invalid 'from'; skipping: %s", msg)
return
payload = msg.get('payload')
if not isinstance(payload, dict):
logger.debug("handle_neighborinfo: missing/invalid payload for %s; skipping", id)
return
node = await self.data.pg_storage.get_node_cached(id)
if node is None:
node = Node.default_node(id)
node['neighborinfo'] = payload
if msg.get('sender'):
node['gateway'] = msg['sender']
await self.data.update_node(id, node)
logger.debug("Node %s updated with neighborinfo", id)
async def handle_nodeinfo(self, msg):
from_id = self._normalize_msg_addrs(msg)
payload = msg.get('payload')
if not isinstance(payload, dict):
logger.debug("handle_nodeinfo: missing/invalid payload; skipping: %s", msg)
return
# User.id when present, MeshPacket 'from' as fallback.
id = normalize_node_id(payload.get('id')) or from_id
if id is None:
logger.debug("handle_nodeinfo: no usable node id; skipping: %s", msg)
return
node = await self.data.pg_storage.get_node_cached(id)
if node is None:
node = Node.default_node(id)
logger.debug("Discovered node %s", id)
else:
logger.debug("Updating node %s", id)
# Different decoders emit snake_case or camelCase for the same field.
if 'hardware' in payload:
node['hardware'] = payload['hardware']
elif 'hw_model' in payload:
node['hardware'] = payload['hw_model']
if 'longname' in payload:
node['longname'] = payload['longname']
elif 'long_name' in payload:
node['longname'] = payload['long_name']
if 'shortname' in payload:
node['shortname'] = payload['shortname']
elif 'short_name' in payload:
node['shortname'] = payload['short_name']
if 'role' in payload:
node['role'] = payload['role']
else:
node['role'] = 0
if msg.get('sender'):
node['gateway'] = msg['sender']
ch_for_node = _node_channel(msg)
if ch_for_node is not None:
node['last_channel'] = ch_for_node
await self.data.update_node(id, node)
async def handle_mapreport(self, msg):
from_id = self._normalize_msg_addrs(msg)
if from_id is None:
logger.debug("handle_mapreport: missing/invalid 'from'; skipping: %s", msg)
return
payload = msg.get('payload')
if not isinstance(payload, dict):
logger.debug("handle_mapreport: missing/invalid payload; skipping: %s", msg)
return
node = await self.data.pg_storage.get_node_cached(from_id)
if node is None:
node = Node.default_node(from_id)
logger.debug("Discovered node %s via mapreport", from_id)
if payload.get('long_name'):
node['longname'] = payload['long_name']
if payload.get('short_name'):
node['shortname'] = payload['short_name']
if 'hw_model' in payload:
node['hardware'] = payload['hw_model']
# proto3 omits zero enums: an absent role means CLIENT (0), same as NODEINFO.
node['role'] = payload.get('role', 0)
# Map reports carry no timestamp, so only fill a position for nodes
# that have none — a real POSITION packet owns the field once seen
# (the node_positions upsert rejects timeless updates over timestamped
# ones; this guard keeps the node cache consistent with that).
if not node.get('position') and payload.get('latitude_i') and payload.get('longitude_i'):
node['position'] = {
'latitude_i': payload['latitude_i'],
'longitude_i': payload['longitude_i'],
'altitude': payload.get('altitude'),
'precision_bits': payload.get('position_precision'),
}
if msg.get('sender'):
node['gateway'] = msg['sender']
ch_for_node = _node_channel(msg)
if ch_for_node is not None:
node['last_channel'] = ch_for_node
await self.data.update_node(from_id, node)
async def handle_position(self, msg):
id = self._normalize_msg_addrs(msg)
if id is None:
logger.debug("handle_position: missing/invalid 'from'; skipping: %s", msg)
return
node = await self.data.pg_storage.get_node_cached(id)
if node is None:
node = Node.default_node(id)
logger.debug("Node %s skeleton added with position", id)
node['position'] = _stamp_position_time(msg)
ch_for_node = _node_channel(msg)
if ch_for_node is not None:
node['last_channel'] = ch_for_node
await self.data.update_node(id, node)
# Emit event for Discord bridge
try:
self.data.discord_event_queue.put_nowait({
'type': 'position',
'msg': msg,
'node_id': id,
})
except asyncio.QueueFull:
self._record_discord_drop('position')
async def handle_telemetry(self, msg):
id = self._normalize_msg_addrs(msg)
if id is None:
logger.debug("handle_telemetry: missing/invalid 'from'; skipping: %s", msg)
return
telemetry_type = msg.get('telemetry_type')
payload = msg.get('payload')
node = await self.data.pg_storage.get_node_cached(id)
if node is None:
node = Node.default_node(id)
# Merge incoming telemetry into the node's existing telemetry dict
# instead of replacing it entirely. This preserves device_metrics
# fields when an environment_metrics message arrives, and vice versa.
if payload is not None:
existing = node.get('telemetry')
if existing is None or not isinstance(existing, dict):
existing = {}
existing.update(payload)
node['telemetry'] = existing
if msg.get('sender'):
node['gateway'] = msg['sender']
ch_for_node = _node_channel(msg)
if ch_for_node is not None:
node['last_channel'] = ch_for_node
await self.data.update_node(id, node)
logger.debug("Node %s updated with telemetry (variant=%s)", id, telemetry_type)
if payload is not None:
await self.data.pg_storage.write_telemetry(id, msg)
# node_telemetry_current uses a variant-aware write so a device_metrics
# message doesn't NULL out environment_metrics columns and vice versa.
if self.data.pg_storage.pool:
try:
async with self.data.pg_storage.pool.acquire() as conn:
await self.data.pg_storage._write_node_telemetry_current(
conn, id, payload, telemetry_type=telemetry_type
)
except Exception as e:
logger.error("Failed to update node_telemetry_current for node %s: %s", id, e)
# Live push: telemetry sample (feeds the Telemetry page charts/feed).
if self.data.broadcaster.subscriber_count:
try:
self.data.broadcaster.publish("telemetry", jsonable_encoder(msg))
except Exception as e:
logger.debug("telemetry broadcast failed: %s", e)
async def handle_text(self, msg):
from_id = self._normalize_msg_addrs(msg)
if from_id is None:
logger.debug("handle_text: missing/invalid 'from'; skipping: %s", msg)
return
payload = msg.get('payload')
text = payload.get('text') if isinstance(payload, dict) else None
if not isinstance(text, str):
logger.debug("handle_text: missing payload.text for %s; skipping", from_id)
return
msg_id = msg.get('id')
timestamp = msg.get('timestamp')
if msg_id is None or timestamp is None:
logger.debug("handle_text: missing id/timestamp for %s; skipping", from_id)
return
chat = {
'id': msg_id,
'from': from_id,
'to': msg.get('to'),
'channel_name': msg.get('channel_name'),
'text': text,
'timestamp': timestamp,
'hops_away': msg.get('hops_away'),
'rssi': msg.get('rssi'),
'snr': msg.get('snr'),
}
# Channel-less stays channel-less; write_chat_message owns the bucket-0 fallback.
if 'channel' in msg:
chat['channel'] = str(msg['channel'])
if 'sender' in msg:
chat['sender'] = msg['sender']
await self.data.pg_storage.write_chat_message(from_id, chat)
# Live push: a new chat message. Published before the node update below
# so a chat still streams even if the node touch no-ops.
try:
self.data.broadcaster.publish("chat", jsonable_encoder(chat))
except Exception as e:
logger.debug("chat broadcast failed: %s", e)
node = await self.data.pg_storage.get_node_cached(from_id)
# TODO: Replace with something more configurable
if node:
if 'TC' in text and 'BBS' in text and 'Commands' in text:
node['tc2_bbs'] = True
ch_for_node = _node_channel(msg)
if ch_for_node is not None:
node['last_channel'] = ch_for_node
await self.data.update_node(node['id'], node)
# Emit event for Discord bridge
try:
self.data.discord_event_queue.put_nowait({
'type': 'text',
'msg': msg,
'chat': chat,
})
except asyncio.QueueFull:
self._record_discord_drop('text')
async def _resolve_route_entries(self, route):
"""Resolve RouteDiscovery hop entries to canonical node ids. Unknown ints
fall back to 8-hex; strings stay verbatim (never minted into ids); bools
are excluded so `true` can't become node 00000001."""
resolved = []
for r in route:
if isinstance(r, str):
# JSON publisher path: route entries arrive as longnames.
node = await self.data.pg_storage.find_node_by_longname(r)
elif isinstance(r, int) and not isinstance(r, bool):
# Protobuf path: route entries are uint32 node ids.
node = await self.data.pg_storage.get_node_cached(utils.convert_node_id_from_int_to_hex(r))
else:
node = None
if node:
resolved.append(node['id'])
elif isinstance(r, int) and not isinstance(r, bool):
resolved.append(normalize_node_id(r) or r)
else:
resolved.append(r)
return resolved
async def handle_traceroute(self, msg):
id = self._normalize_msg_addrs(msg)
if id is None:
logger.debug("handle_traceroute: missing/invalid 'from'; skipping: %s", msg)
return
payload = msg.get('payload')
route = payload.get('route') if isinstance(payload, dict) else None
if not isinstance(route, list):
logger.debug("handle_traceroute: missing payload.route for %s; skipping", id)
return
msg['route'] = route
msg['route_ids'] = await self._resolve_route_entries(route)
route_back = payload.get('route_back') if isinstance(payload, dict) else None
msg['route_back_ids'] = (
await self._resolve_route_entries(route_back)
if isinstance(route_back, list)
else []
)
outcome = await self.data.pg_storage.write_traceroute(id, msg)
# Live push: resolved multi-hop path for the map's traceroute tracer.
# The event mirrors a full non-slim /v1/traceroutes row (same field
# names and value types; `timestamp` stays epoch seconds like the
# BIGINT column) so clients can upsert it into their cached list
# instead of refetching. `sender` is normalized the same way the DB
# write is, so the event matches a later REST fetch of the row.
# 'duplicate' stays silent; None (write buffered on DB outage) still
# broadcasts so the live view survives the outage.
if outcome != "duplicate" and self.data.broadcaster.subscriber_count:
try:
# The broker payload is publisher-controlled: forward only the
# keys the REST row actually mirrors, never the dict verbatim,
# so a hostile publisher can't fan arbitrary bytes out to every
# SSE subscriber.
raw_payload = msg.get("payload", {})
payload = (
{
k: raw_payload[k]
for k in ("route", "route_back", "snr_towards", "snr_back")
if k in raw_payload
}
if isinstance(raw_payload, dict)
else {}
)
event = jsonable_encoder(
{
"from": id,
"to": msg.get("to"),
"sender": normalize_node_id(msg.get("sender")),
"id": msg.get("id"),
"channel": msg.get("channel"),
"packet_id": msg.get("packet_id"),
"hops_away": msg.get("hops_away"),
"rssi": msg.get("rssi"),
"snr": msg.get("snr"),
"timestamp": msg.get("timestamp"),
"route": msg.get("route", []),
"route_ids": msg["route_ids"],
"route_back_ids": msg.get("route_back_ids", []),
# First-heard created_at from write_traceroute; now() covers
# the outage path where the row hasn't landed yet.
"created_at": msg.get("created_at") or int(time.time()),
"payload": payload,
}
)
# A sane traceroute row is well under 4 KB; a pathological one
# degrades to the legacy skinny event (clients then refetch).
if len(json.dumps(event, default=str)) > 4096:
event = {"from": id, "to": msg.get("to"), "route_ids": msg["route_ids"], "id": msg.get("id")}
self.data.broadcaster.publish("traceroute", event)
except Exception as e:
logger.debug("traceroute broadcast failed: %s", e)