meshcore-cli 1.2.4__tar.gz → 1.2.6__tar.gz

{meshcore_cli-1.2.4 → meshcore_cli-1.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meshcore-cli
-Version: 1.2.4
+Version: 1.2.6
 Summary: Command line interface to meshcore companion radios
 Project-URL: Homepage, https://github.com/fdlamotte/meshcore-cli
 Project-URL: Issues, https://github.com/fdlamotte/meshcore-cli/issues
@@ -10,7 +10,7 @@ License-File: LICENSE
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.10
-Requires-Dist: meshcore>=2.1.19
+Requires-Dist: meshcore>=2.1.20
 Requires-Dist: prompt-toolkit>=3.0.50
 Requires-Dist: pycryptodome
 Requires-Dist: requests>=2.28.0

{meshcore_cli-1.2.4 → meshcore_cli-1.2.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "meshcore-cli"
-version = "1.2.4"
+version = "1.2.6"
 authors = [
   { name="Florent de Lamotte", email="florent@frizoncorrea.fr" },
 ]
@@ -17,7 +17,7 @@ classifiers = [
 ]
 license = "MIT"
 license-files = ["LICEN[CS]E*"]
-dependencies = [ "meshcore >= 2.1.19", "prompt_toolkit >= 3.0.50", "requests >= 2.28.0", "pycryptodome" ]
+dependencies = [ "meshcore >= 2.1.20", "prompt_toolkit >= 3.0.50", "requests >= 2.28.0", "pycryptodome" ]
 
 [project.urls]
 Homepage = "https://github.com/fdlamotte/meshcore-cli"

{meshcore_cli-1.2.4 → meshcore_cli-1.2.6}/src/meshcore_cli/meshcore_cli.py

@@ -4,7 +4,7 @@
 """
 
 import asyncio
-import os, sys
+import os, sys, io
 import time, datetime
 import getopt, json, shlex, re
 import logging
@@ -33,7 +33,7 @@ import re
 from meshcore import MeshCore, EventType, logger
 
 # Version
-VERSION = "v1.2.4"
+VERSION = "v1.2.6"
 
 # default ble address is stored in a config file
 MCCLI_CONFIG_DIR = str(Path.home()) + "/.config/meshcore/"
@@ -208,14 +208,19 @@ async def handle_log_rx(event):
         return
 
     pkt = bytes().fromhex(event.payload["payload"])
+    pbuf = io.BytesIO(pkt)
+    header = pbuf.read(1)[0]
+
+    if header & ~1 == 0x14: # flood msg / channel
+        if handle_log_rx.channel_echoes:
+            if header & 1 == 0: # has transport code
+                pbuf.read(4)    # discard transport code
+            path_len = pbuf.read(1)[0]
+            path = pbuf.read(path_len).hex()
+            chan_hash = pbuf.read(1).hex()
+            cipher_mac = pbuf.read(2)
+            msg = pbuf.read() # until the end of buffer
 
-    if handle_log_rx.channel_echoes:
-        if pkt[0] == 0x15: 
-            path_len = pkt[1]
-            path = pkt[2:path_len+2].hex()
-            chan_hash = pkt[path_len+2:path_len+3].hex()
-            cipher_mac = pkt[path_len+3:path_len+5]
-            msg = pkt[path_len+5:]
             channel = None
             for c in await get_channels(mc):
                 if c["channel_hash"] == chan_hash : # validate against MAC
@@ -225,28 +230,32 @@ async def handle_log_rx(event):
                         channel = c
                         break
 
+            chan_name = ""
+
             if channel is None :
-                chan_name = chan_hash
-                message = msg.hex()
+                if handle_log_rx.echo_unk_chans:
+                    chan_name = chan_hash
+                    message = msg.hex()
             else:
                 chan_name = channel["channel_name"]
                 aes_key = bytes.fromhex(channel["channel_secret"])
                 cipher = AES.new(aes_key, AES.MODE_ECB)
                 message = cipher.decrypt(msg)[5:].decode("utf-8").strip("\x00")
-            
-            width = os.get_terminal_size().columns
-            cars = width - 13 - 2 * path_len - len(chan_name) - 1
-            dispmsg = message[0:cars]
-            txt = f"{ANSI_LIGHT_GRAY}{chan_name} {ANSI_DGREEN}{dispmsg+(cars-len(dispmsg))*' '} {ANSI_YELLOW}[{path}]{ANSI_LIGHT_GRAY}{event.payload['snr']:6,.2f}{event.payload['rssi']:4}{ANSI_END}"
-            if handle_message.above:
-                print_above(txt)
-            else:
-                print(txt)
-            return
-            
+
+            if chan_name != "" :
+                width = os.get_terminal_size().columns
+                cars = width - 13 - 2 * path_len - len(chan_name) - 1
+                dispmsg = message[0:cars]
+                txt = f"{ANSI_LIGHT_GRAY}{chan_name} {ANSI_DGREEN}{dispmsg+(cars-len(dispmsg))*' '} {ANSI_YELLOW}[{path}]{ANSI_LIGHT_GRAY}{event.payload['snr']:6,.2f}{event.payload['rssi']:4}{ANSI_END}"
+                if handle_message.above:
+                    print_above(txt)
+                else:
+                    print(txt)
+
 handle_log_rx.json_log_rx = False
 handle_log_rx.channel_echoes = False
 handle_log_rx.mc = None
+handle_log_rx.echo_unk_chans=False
 
 async def handle_advert(event):
     if not handle_advert.print_adverts:
@@ -319,7 +328,7 @@ async def log_message(mc, msg):
     if msg["type"] == "PRIV" :
         ct = mc.get_contact_by_key_prefix(msg['pubkey_prefix'])
         if ct is None:
-            msg["name"] = data["pubkey_prefix"]
+            msg["name"] = msg["pubkey_prefix"]
         else:
             msg["name"] = ct["adv_name"]
     elif msg["type"] == "CHAN" :
@@ -363,7 +372,7 @@ async def subscribe_to_msgs(mc, json_output=False, above=False):
 class MyNestedCompleter(NestedCompleter):
     def get_completions( self, document, complete_event):
         txt = document.text_before_cursor.lstrip()
-        if not " " in txt: 
+        if not " " in txt:
             if txt != "" and txt[0] == "/" and txt.count("/") == 1:
                 opts = []
                 for k in self.options.keys():
@@ -396,6 +405,10 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
     for c in it :
         contact_list[c[1]['adv_name']] = None
 
+    pit = iter(pending.items())
+    for c in pit :
+        pending_list[c[1]['adv_name']] = None
+
     pit = iter(pending.items())
     for c in pit :
         pending_list[c[1]['public_key']] = None
@@ -458,6 +471,8 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
         "set_channel": None,
         "get_channels": None,
         "remove_channel": None,
+        "apply_to": None,
+        "at": None,
         "set" : {
             "name" : None,
             "pin" : None,
@@ -474,6 +489,7 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
             "print_adverts" : {"on":None, "off":None},
             "json_log_rx" : {"on":None, "off":None},
             "channel_echoes" : {"on":None, "off":None},
+            "echo_unk_chans" : {"on":None, "off":None},
             "print_new_contacts" : {"on": None, "off":None},
             "print_path_updates" : {"on":None,"off":None},
             "classic_prompt" : {"on" : None, "off":None},
@@ -503,6 +519,7 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
             "print_adverts":None,
             "json_log_rx":None,
             "channel_echoes":None,
+            "echo_unk_chans":None,
             "print_path_updates":None,
             "print_new_contacts":None,
             "classic_prompt":None,
@@ -522,6 +539,8 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
 
     contact_completion_list = {
         "contact_info": None,
+        "contact_name": None,
+        "contact_lastmod": None,
         "export_contact" : None,
         "share_contact" : None,
         "upload_contact" : None,
@@ -643,7 +662,7 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
     slash_root_completion_list = {}
     for k,v in root_completion_list.items():
         slash_root_completion_list["/"+k]=v
-    
+
     completion_list.update(slash_root_completion_list)
 
     slash_contacts_completion_list = {}
@@ -793,6 +812,9 @@ Line starting with \"$\" or \".\" will issue a meshcli command.
             if line == "" : # blank line
                 pass
 
+            elif line.startswith("?") :
+                get_help_for(line[1:], context="chat")
+
             # raw meshcli command as on command line
             elif line.startswith("$") :
                 try :
@@ -896,6 +918,13 @@ Line starting with \"$\" or \".\" will issue a meshcli command.
                     if last_ack == False :
                         contact = ln
 
+            elif contact is None and\
+                    (line.startswith("apply_to ") or line.startswith("at ")):
+                try:
+                    await apply_command_to_contacts(mc, line.split(" ",2)[1], line.split(" ",2)[2])
+                except IndexError:
+                    logger.error(f"Error with apply_to command parameters")
+
             # commands are passed through if at root
             elif contact is None or line.startswith(".") :
                 try:
@@ -957,6 +986,23 @@ async def process_contact_chat_line(mc, contact, line):
         await process_cmds(mc, args)
         return True
 
+    if line.startswith("contact_name") or line.startswith("cn"):
+        print(contact['adv_name'],end="")
+        if " " in line:
+            print(" ", end="", flush=True)
+            secline = line.split(" ", 1)[1]
+            await process_contact_chat_line(mc, contact, secline)
+        else:
+            print("")
+        return True
+
+    if line == "contact_lastmod":
+        timestamp = contact["lastmod"]
+        print(f"{contact['adv_name']} updated"
+              f" {datetime.datetime.fromtimestamp(timestamp).strftime('%Y-%m-%d at %H:%M:%S')}"
+              f" ({timestamp})")
+        return True
+
     # commands that take contact as second arg will be sent to recipient
     if line == "sc" or line == "share_contact" or\
             line == "ec" or line == "export_contact" or\
@@ -1044,7 +1090,7 @@ async def process_contact_chat_line(mc, contact, line):
         return True
 
     # same but for commands with a parameter
-    if line.startswith("cmd ") or\
+    if line.startswith("cmd ") or line.startswith("msg ") or\
             line.startswith("cp ") or line.startswith("change_path ") or\
             line.startswith("cf ") or line.startswith("change_flags ") or\
             line.startswith("req_binary ") or\
@@ -1076,7 +1122,7 @@ async def process_contact_chat_line(mc, contact, line):
 
         if password == "":
             try:
-                sess = PromptSession("Password: ", is_password=True)
+                sess = PromptSession(f"Password for {contact['adv_name']}: ", is_password=True)
                 password = await sess.prompt_async()
             except EOFError:
                 logger.info("Canceled")
@@ -1115,6 +1161,89 @@ async def process_contact_chat_line(mc, contact, line):
 
     return False
 
+async def apply_command_to_contacts(mc, contact_filter, line):
+    upd_before = None
+    upd_after = None
+    contact_type = None
+    min_hops = None
+    max_hops = None
+
+    await mc.ensure_contacts()
+
+    filters = contact_filter.split(",")
+    for f in filters:
+        if f == "all":
+            pass
+        elif f[0] == "u": #updated
+            val_str = f[2:]
+            t = time.time()
+            if val_str[-1] == "d": # value in days
+                t = t - float(val_str[0:-1]) * 86400
+            elif val_str[-1] == "h": # value in hours
+                t = t - float(val_str[0:-1]) * 3600
+            elif val_str[-1] == "m": # value in minutes
+                t = t - float(val_str[0:-1]) * 60
+            else:
+                t = int(val_str)
+            if f[1] == "<": #before
+                upd_before = t
+            elif f[1] == ">":
+                upd_after = t
+            else:
+                logger.error(f"Time filter can only be < or >")
+                return
+        elif f[0] == "t": # type
+            if f[1] == "=":
+                contact_type = int(f[2:])
+            else:
+                logger.error(f"Type can only be equals to a value")
+                return
+        elif f[0] == "d": # direct
+            min_hops=0
+        elif f[0] == "f": # flood
+            max_hops=-1
+        elif f[0] == "h": # hop number
+            if f[1] == ">":
+                min_hops = int(f[2:])+1
+            elif f[1] == "<":
+                max_hops = int(f[2:])-1
+            elif f[1] == "=":
+                min_hops = int(f[2:])
+                max_hops = int(f[2:])
+        else:
+            logger.error(f"Unknown filter {f}")
+            return
+
+    for c in dict(mc._contacts).items():
+        contact = c[1]
+        if (contact_type is None or contact["type"] == contact_type) and\
+                (upd_before is None or contact["lastmod"] < upd_before) and\
+                (upd_after is None or contact["lastmod"] > upd_after) and\
+                (min_hops is None or contact["out_path_len"] >= min_hops) and\
+                (max_hops is None or contact["out_path_len"] <= max_hops):
+            if await process_contact_chat_line(mc, contact, line):
+                pass
+
+            elif line == "remove_contact":
+                args = [line, contact['adv_name']]
+                await process_cmds(mc, args)
+
+            elif line.startswith("send") or line.startswith("\"") :
+                if line.startswith("send") :
+                    line = line[5:]
+                if line.startswith("\"") :
+                    line = line[1:]
+                await msg_ack(mc, contact, line)
+
+            elif contact["type"] == 2 or\
+                 contact["type"] == 3 or\
+                 contact["type"] == 4 : # repeater, room, sensor send cmd
+                await process_cmds(mc, ["cmd", contact["adv_name"], line])
+                # wait for a reply from cmd
+                await mc.wait_for_event(EventType.MESSAGES_WAITING, timeout=7)
+
+            else:
+                logger.error(f"Can't send {line} to {contact['adv_name']}")
 
 async def send_cmd (mc, contact, cmd) :
     res = await mc.commands.send_cmd(contact, cmd)
@@ -1386,6 +1515,11 @@ async def next_cmd(mc, cmds, json_output=False):
     """ process next command """
     try :
         argnum = 0
+
+        if cmds[0].startswith("?") : # get some help
+            get_help_for(cmds[0][1:], context="line")
+            return cmds[argnum+1:]
+
         if cmds[0].startswith(".") : # override json_output
             json_output = True
             cmd = cmds[0][1:]
@@ -1476,6 +1610,10 @@ async def next_cmd(mc, cmds, json_output=False):
                 else:
                     print("Time set")
 
+            case "apply_to"|"at":
+                argnum = 2
+                await apply_command_to_contacts(mc, cmds[1], cmds[2])
+
             case "set":
                 argnum = 2
                 match cmds[1]:
@@ -1524,6 +1662,10 @@ async def next_cmd(mc, cmds, json_output=False):
                         handle_log_rx.channel_echoes = (cmds[2] == "on")
                         if json_output :
                             print(json.dumps({"cmd" : cmds[1], "param" : cmds[2]}))
+                    case "echo_unk_chans" :
+                        handle_log_rx.echo_unk_chans = (cmds[2] == "on")
+                        if json_output :
+                            print(json.dumps({"cmd" : cmds[1], "param" : cmds[2]}))
                     case "print_adverts" :
                         handle_advert.print_adverts = (cmds[2] == "on")
                         if json_output :
@@ -1764,6 +1906,11 @@ async def next_cmd(mc, cmds, json_output=False):
                             print(json.dumps({"channel_echoes" : handle_log_rx.channel_echoes}))
                         else:
                             print(f"{'on' if handle_log_rx.channel_echoes else 'off'}")
+                    case "echo_unk_chans":
+                        if json_output :
+                            print(json.dumps({"echo_unk_chans" : handle_log_rx.echo_unk_chans}))
+                        else:
+                            print(f"{'on' if handle_log_rx.echo_unk_chans else 'off'}")
                     case "print_adverts":
                         if json_output :
                             print(json.dumps({"print_adverts" : handle_advert.print_adverts}))
@@ -1961,6 +2108,12 @@ async def next_cmd(mc, cmds, json_output=False):
                 if res is None:
                     print("Error setting channel")
 
+            case "scope":
+                argnum = 1
+                res = await mc.commands.set_flood_scope(cmds[1])
+                if res is None or res.type == EventType.ERROR:
+                    print(f"Error while setting scope")
+
             case "remove_channel":
                 argnum = 1
                 res = await set_channel(mc, cmds[1], "", bytes.fromhex(16*"00"))
@@ -2355,6 +2508,13 @@ async def next_cmd(mc, cmds, json_output=False):
             case "add_pending":
                 argnum = 1
                 contact = mc.pop_pending_contact(cmds[1])
+                if contact is None: # try to find by name
+                    key = None
+                    for c in mc.pending_contacts.items():
+                        if c[1]['adv_name'] == cmds[1]:
+                            key = c[1]['public_key']
+                            contact = mc.pop_pending_contact(key)
+                            break
                 if contact is None:
                     if json_output:
                         print(json.dumps({"error":"Contact does not exist"}))
@@ -2693,7 +2853,7 @@ async def next_cmd(mc, cmds, json_output=False):
                 await mc.ensure_contacts()
                 contact = mc.get_contact_by_name(cmds[0])
                 if contact is None:
-                    logger.error(f"Unknown command : {cmd}, will exit ...")
+                    logger.error(f"Unknown command : {cmd}, {cmds} not executed ...")
                     return None
 
                 await interactive_loop(mc, to=contact)
@@ -2702,7 +2862,7 @@ async def next_cmd(mc, cmds, json_output=False):
         return cmds[argnum+1:]
 
     except IndexError:
-        logger.error("Error in parameters, returning")
+        logger.error("Error in parameters")
         return None
     except EOFError:
         logger.error("Cancelled")
@@ -2737,7 +2897,8 @@ def version():
     print (f"meshcore-cli: command line interface to MeshCore companion radios {VERSION}")
 
 def command_help():
-    print("""  General commands
+    print("""    ?<cmd> may give you some more help about cmd
+  General commands
     chat                   : enter the chat (interactive) mode
     chat_to <ct>           : enter chat with contact                to
     script <filename>      : execute commands in filename
@@ -2748,6 +2909,7 @@ def command_help():
     reboot                 : reboots node
     sleep <secs>           : sleeps for a given amount of secs      s
     wait_key               : wait until user presses <Enter>        wk
+    apply_to <scope> <cmds>: sends cmds to contacts matching scope  at
   Messenging
     msg <name> <msg>       : send message to node by name           m  {
     wait_ack               : wait an ack                            wa }
@@ -2787,7 +2949,7 @@ def command_help():
     req_mma <ct>           : requests min/max/avg for a sensor      rm
     req_acl <ct>           : requests access control list for sensor
     pending_contacts       : show pending contacts
-    add_pending <key>      : manually add pending contact from key
+    add_pending <pending>  : manually add pending contact
     flush_pending          : flush pending contact list
   Repeaters
     login <name> <pwd>     : log into a node (rep) with given pwd   l
@@ -2822,6 +2984,30 @@ def usage () :
  Available Commands and shorcuts (can be chained) :""")
     command_help()
 
+def get_help_for (cmdname, context="line") :
+    if cmdname == "apply_to" or cmdname == "at" :
+        print("""apply_to <scope> <cmd> : applies cmd to contacts matching scope
+    Scope acts like a filter with comma separated fields :
+     - u, matches modification time < or > than a timestamp
+            (can also be days hours or minutes ago if followed by d,h or m)
+     - t, matches the type (1: client, 2: repeater, 3: room, 4: sensor)
+     - h, matches number of hops
+     - d, direct, similar to h>-1
+     - f, flood, similar to h<0 or h=-1
+
+    Note: Some commands like contact_name (aka cn), reset_path (aka rp), forget_password (aka fp) can be chained.
+
+    Examples:
+        # removes all clients that have not been updated in last 2 days
+        at u<2d,t=1 remove_contact
+        # gives traces to repeaters that have been updated in the last 24h and are direct
+        at t=2,u>1d,d cn trace
+        # tries to do flood login to all repeaters
+        at t=2 rp login
+        """)
+    else:
+        print(f"Sorry, no help yet for {cmdname}")
+
 async def main(argv):
     """ Do the job """
     json_output = JSON