From 1bbfacee9435cb8f2eda0317c49a12d02b2b2e16 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Wed, 11 Sep 2024 00:20:35 +0200 Subject: [PATCH 01/71] Add stamp configuration options --- nomadnet/Conversation.py | 6 ++++- nomadnet/NomadNetworkApp.py | 49 ++++++++++++++++++++++++++++++++++--- nomadnet/ui/textui/Guide.py | 21 ++++++++++++---- 3 files changed, 67 insertions(+), 9 deletions(-) diff --git a/nomadnet/Conversation.py b/nomadnet/Conversation.py index 8e2e523..057e040 100644 --- a/nomadnet/Conversation.py +++ b/nomadnet/Conversation.py @@ -217,7 +217,11 @@ class Conversation: if self.app.message_router.get_outbound_propagation_node() != None: desired_method = LXMF.LXMessage.PROPAGATED - lxm = LXMF.LXMessage(dest, source, content, title=title, desired_method=desired_method) + dest_is_trusted = False + if self.app.directory.trust_level(dest.hash) == DirectoryEntry.TRUSTED: + dest_is_trusted = True + + lxm = LXMF.LXMessage(dest, source, content, title=title, desired_method=desired_method, include_ticket=dest_is_trusted) lxm.register_delivery_callback(self.message_notification) lxm.register_failed_callback(self.message_notification) diff --git a/nomadnet/NomadNetworkApp.py b/nomadnet/NomadNetworkApp.py index c14ed82..84fdcd5 100644 --- a/nomadnet/NomadNetworkApp.py +++ b/nomadnet/NomadNetworkApp.py @@ -134,6 +134,10 @@ class NomadNetworkApp: self.lxmf_sync_interval = 360*60 self.lxmf_sync_limit = 8 self.compact_stream = False + + self.required_stamp_cost = None + self.accept_invalid_stamps = False + if not os.path.isdir(self.storagepath): os.makedirs(self.storagepath) @@ -296,8 +300,9 @@ class NomadNetworkApp: for destination_hash in self.ignored_list: self.message_router.ignore_destination(destination_hash) - self.lxmf_destination = self.message_router.register_delivery_identity(self.identity, display_name=self.peer_settings["display_name"]) - self.lxmf_destination.set_default_app_data(self.get_display_name_bytes) + self.lxmf_destination = self.message_router.register_delivery_identity(self.identity, display_name=self.peer_settings["display_name"], stamp_cost=self.required_stamp_cost) + if not self.accept_invalid_stamps: + self.message_router.enforce_stamps() RNS.Identity.remember( packet_hash=None, @@ -492,7 +497,9 @@ class NomadNetworkApp: self.message_router.cancel_propagation_node_requests() def announce_now(self): - self.lxmf_destination.announce() + self.message_router.set_inbound_stamp_cost(self.lxmf_destination.hash, self.required_stamp_cost) + self.lxmf_destination.display_name = self.peer_settings["display_name"] + self.message_router.announce(self.lxmf_destination.hash) self.peer_settings["last_announce"] = time.time() self.save_peer_settings() @@ -738,6 +745,24 @@ class NomadNetworkApp: else: self.lxmf_sync_limit = None + if option == "required_stamp_cost": + value = self.config["node"]["node_name"] + if value.lower() == "none": + self.required_stamp_cost = None + else: + value = self.config["client"].as_int(option) + + if value > 0: + if value > 255: + value = 255 + self.required_stamp_cost = value + else: + self.required_stamp_cost = None + + if option == "accept_invalid_stamps": + value = self.config["client"].as_bool(option) + self.accept_invalid_stamps = value + if option == "max_accepted_size": value = self.config["client"].as_float(option) @@ -1017,6 +1042,24 @@ lxmf_sync_interval = 360 # the limit, and download everything every time. lxmf_sync_limit = 8 +# You can specify a required stamp cost for +# inbound messages to be accepted. Specifying +# a stamp cost will require untrusted senders +# that message you to include a cryptographic +# stamp in their messages. Performing this +# operation takes the sender an amount of time +# proportional to the stamp cost. As a rough +# estimate, a stamp cost of 8 will take less +# than a second to compute, and a stamp cost +# of 20 could take several minutes, even on +# a fast computer. +required_stamp_cost = None + +# You can signal stamp requirements to senders, +# but still accept messages with invalid stamps +# by setting this option to True. +accept_invalid_stamps = False + # The maximum accepted unpacked size for mes- # sages received directly from other peers, # specified in kilobytes. Messages larger than diff --git a/nomadnet/ui/textui/Guide.py b/nomadnet/ui/textui/Guide.py index 7a3b5c8..69305cf 100644 --- a/nomadnet/ui/textui/Guide.py +++ b/nomadnet/ui/textui/Guide.py @@ -521,6 +521,18 @@ The number of minutes between each automatic sync. The default is equal to 6 hou On low-bandwidth networks, it can be useful to limit the amount of messages downloaded in each sync. The default is 8. Set to 0 to download all available messages every time a sync occurs. < +>>> +`!required_stamp_cost = None`! +>>>> +You can specify a required stamp cost for inbound messages to be accepted. Specifying a stamp cost will require untrusted senders that message you to include a cryptographic stamp in their messages. Performing this operation takes the sender an amount of time proportional to the stamp cost. As a rough estimate, a stamp cost of 8 will take less than a second to compute, and a stamp cost of 20 could take several minutes, even on a fast computer. +< + +>>> +`!accept_invalid_stamps = False`! +>>>> +You can signal stamp requirements to senders, but still accept messages with invalid stamps by setting this option to True. +< + >>> `!max_accepted_size = 500`! >>>> @@ -739,12 +751,11 @@ If you have Internet access, and just want to get started experimenting, you are The Testnet also runs the latest version of Reticulum, often even a short while before it is publicly released, which means strange behaviour might occur. If none of that scares you, add the following interface to your Reticulum configuration file to join: >> -[[RNS Testnet Zurich]] +[[RNS Testnet Dublin]] type = TCPClientInterface - interface_enabled = yes - outgoing = True - target_host = zurich.connect.reticulum.network - target_port = 4242 + enabled = yes + target_host = dublin.connect.reticulum.network + target_port = 4965 < If you connect to the testnet, you can leave nomadnet running for a while and wait for it to receive announces from other nodes on the network that host pages or services, or you can try connecting directly to some nodes listed here: From 53922757823548bcb89a2e9cf77f184c13aadece Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Wed, 11 Sep 2024 11:49:36 +0200 Subject: [PATCH 02/71] Updated dependencies --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 1316a8d..ca07184 100644 --- a/setup.py +++ b/setup.py @@ -30,6 +30,6 @@ setuptools.setup( entry_points= { 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, - install_requires=["rns>=0.7.7", "lxmf>=0.5.0", "urwid>=2.4.4", "qrcode"], + install_requires=["rns>=0.7.7", "lxmf>=0.5.1", "urwid>=2.4.4", "qrcode"], python_requires=">=3.6", ) From e755641dbe9d54cc2e36986f635d13886d0bae80 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Wed, 11 Sep 2024 11:49:50 +0200 Subject: [PATCH 03/71] Updated version --- nomadnet/_version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nomadnet/_version.py b/nomadnet/_version.py index dd9b22c..7225152 100644 --- a/nomadnet/_version.py +++ b/nomadnet/_version.py @@ -1 +1 @@ -__version__ = "0.5.1" +__version__ = "0.5.2" From 03a02a9ebc4fb1a2cc985bb48a7fb99b6d1bf5f5 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Wed, 11 Sep 2024 13:02:05 +0200 Subject: [PATCH 04/71] Fixed incorrect display name loading in conversation list --- nomadnet/Conversation.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nomadnet/Conversation.py b/nomadnet/Conversation.py index 057e040..7487c87 100644 --- a/nomadnet/Conversation.py +++ b/nomadnet/Conversation.py @@ -102,7 +102,7 @@ class Conversation: unread = True if display_name == None and app_data: - display_name = app_data.decode("utf-8") + display_name = LXMF.display_name_from_app_data(app_data) if display_name == None: sort_name = "" From 112a45f270b51d14ded7572bb8996e7ef9f8ce28 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Tue, 17 Sep 2024 14:50:32 +0200 Subject: [PATCH 05/71] Fixed invalid dict key. Fixes #59. --- nomadnet/NomadNetworkApp.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nomadnet/NomadNetworkApp.py b/nomadnet/NomadNetworkApp.py index 84fdcd5..b9ec687 100644 --- a/nomadnet/NomadNetworkApp.py +++ b/nomadnet/NomadNetworkApp.py @@ -746,7 +746,7 @@ class NomadNetworkApp: self.lxmf_sync_limit = None if option == "required_stamp_cost": - value = self.config["node"]["node_name"] + value = self.config["client"][option] if value.lower() == "none": self.required_stamp_cost = None else: From 0df8b56d58360fe8946eaec15e87059758ffc006 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Tue, 17 Sep 2024 14:53:15 +0200 Subject: [PATCH 06/71] Updated versions --- nomadnet/_version.py | 2 +- setup.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/nomadnet/_version.py b/nomadnet/_version.py index 7225152..43a1e95 100644 --- a/nomadnet/_version.py +++ b/nomadnet/_version.py @@ -1 +1 @@ -__version__ = "0.5.2" +__version__ = "0.5.3" diff --git a/setup.py b/setup.py index ca07184..c14730e 100644 --- a/setup.py +++ b/setup.py @@ -30,6 +30,6 @@ setuptools.setup( entry_points= { 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, - install_requires=["rns>=0.7.7", "lxmf>=0.5.1", "urwid>=2.4.4", "qrcode"], + install_requires=["rns>=0.7.8", "lxmf>=0.5.2", "urwid>=2.4.4", "qrcode"], python_requires=">=3.6", ) From c61da069f2d19dbf8315d5858eeac97efefd6add Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 6 Oct 2024 11:14:17 +0200 Subject: [PATCH 07/71] Updated dependencies --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index c14730e..b7fd8da 100644 --- a/setup.py +++ b/setup.py @@ -30,6 +30,6 @@ setuptools.setup( entry_points= { 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, - install_requires=["rns>=0.7.8", "lxmf>=0.5.2", "urwid>=2.4.4", "qrcode"], + install_requires=["rns>=0.8.2", "lxmf>=0.5.5", "urwid>=2.4.4", "qrcode"], python_requires=">=3.6", ) From 0e79c3299ca503fb2f2888b85f681b4e257389f8 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 6 Oct 2024 11:25:08 +0200 Subject: [PATCH 08/71] Added opportunistic delivery if destination ratchets are available --- nomadnet/Conversation.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/nomadnet/Conversation.py b/nomadnet/Conversation.py index 7487c87..9b3f804 100644 --- a/nomadnet/Conversation.py +++ b/nomadnet/Conversation.py @@ -216,6 +216,10 @@ class Conversation: if self.app.directory.preferred_delivery(dest.hash) == DirectoryEntry.PROPAGATED: if self.app.message_router.get_outbound_propagation_node() != None: desired_method = LXMF.LXMessage.PROPAGATED + else: + if not self.app.message_router.delivery_link_available(dest.hash) and RNS.Identity.current_ratchet_id(dest.hash) != None: + RNS.log(f"Have ratchet for {RNS.prettyhexrep(dest.hash)}, requesting opportunistic delivery of message", RNS.LOG_DEBUG) + desired_method = LXMF.LXMessage.OPPORTUNISTIC dest_is_trusted = False if self.app.directory.trust_level(dest.hash) == DirectoryEntry.TRUSTED: From 289136a63226a8af0f59df9322ffb58cf497183e Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 6 Oct 2024 11:26:05 +0200 Subject: [PATCH 09/71] Updated version --- nomadnet/_version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nomadnet/_version.py b/nomadnet/_version.py index 43a1e95..6b27eee 100644 --- a/nomadnet/_version.py +++ b/nomadnet/_version.py @@ -1 +1 @@ -__version__ = "0.5.3" +__version__ = "0.5.4" From dc43bc6a22b5be668a3d75be89c5bae0725b1af5 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Fri, 15 Nov 2024 16:29:46 +0100 Subject: [PATCH 10/71] Fix invalid LXMF link handling in browser --- nomadnet/ui/textui/Browser.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/nomadnet/ui/textui/Browser.py b/nomadnet/ui/textui/Browser.py index c8dd6e0..58ae008 100644 --- a/nomadnet/ui/textui/Browser.py +++ b/nomadnet/ui/textui/Browser.py @@ -1,4 +1,5 @@ import RNS +import LXMF import os import time import urwid @@ -252,7 +253,7 @@ class Browser: display_name = None if display_name_data != None: - display_name = display_name_data.decode("utf-8") + display_name = LXMF.display_name_from_app_data(display_name_data) if not source_hash_text in [c[0] for c in existing_conversations]: entry = DirectoryEntry(bytes.fromhex(source_hash_text), display_name=display_name) From a5aa2097bd7370c3c16bb1fb670b195f42c9b25e Mon Sep 17 00:00:00 2001 From: probability Date: Mon, 25 Nov 2024 18:15:42 -0500 Subject: [PATCH 11/71] Add Checkbox and Radio Button fields to Micron format --- nomadnet/examples/various/input_fields.py | 21 +++- nomadnet/ui/textui/Browser.py | 58 +++++++--- nomadnet/ui/textui/Guide.py | 37 ++++++ nomadnet/ui/textui/MicronParser.py | 131 ++++++++++++++++------ 4 files changed, 192 insertions(+), 55 deletions(-) diff --git a/nomadnet/examples/various/input_fields.py b/nomadnet/examples/various/input_fields.py index 43d7e65..663dc93 100644 --- a/nomadnet/examples/various/input_fields.py +++ b/nomadnet/examples/various/input_fields.py @@ -17,6 +17,8 @@ The following section contains a simple set of fields, and a few different links -= + +>>>Text Fields An input field : `B444``b An masked field : `B444``b @@ -27,7 +29,24 @@ Two fields : `B444`<8|one`One>`b `B444`<8|two`Two>`b The data can be `!`[submitted`:/page/input_fields.mu`username|two]`!. -You can `!`[submit`:/page/input_fields.mu`one|password|small]`! other fields, or just `!`[a single one`:/page/input_fields.mu`username]`! +>> Checkbox Fields + +`B444``b Sign me up + +>> Radio group + +Select your favorite color: + +`B900`<^|color|Red`>`b Red + +`B090`<^|color|Green`>`b Green + +`B009`<^|color|Blue`>`b Blue + + +>>> Submitting data + +You can `!`[submit`:/page/input_fields.mu`one|password|small|color]`! other fields, or just `!`[a single one`:/page/input_fields.mu`username]`! Or simply `!`[submit them all`:/page/input_fields.mu`*]`!. diff --git a/nomadnet/ui/textui/Browser.py b/nomadnet/ui/textui/Browser.py index 58ae008..5e412a4 100644 --- a/nomadnet/ui/textui/Browser.py +++ b/nomadnet/ui/textui/Browser.py @@ -180,23 +180,47 @@ class Browser: else: link_fields.append(e) - def recurse_down(w): - target = None - if isinstance(w, list): - for t in w: - recurse_down(t) - elif isinstance(w, tuple): - for t in w: - recurse_down(t) - elif hasattr(w, "contents"): - recurse_down(w.contents) - elif hasattr(w, "original_widget"): - recurse_down(w.original_widget) - elif hasattr(w, "_original_widget"): - recurse_down(w._original_widget) - else: - if hasattr(w, "field_name") and (all_fields or w.field_name in link_fields): - request_data["field_"+w.field_name] = w.get_edit_text() + def recurse_down(w): + if isinstance(w, list): + for t in w: + recurse_down(t) + elif isinstance(w, tuple): + for t in w: + recurse_down(t) + elif hasattr(w, "contents"): + recurse_down(w.contents) + elif hasattr(w, "original_widget"): + recurse_down(w.original_widget) + elif hasattr(w, "_original_widget"): + recurse_down(w._original_widget) + else: + if hasattr(w, "field_name") and (all_fields or w.field_name in link_fields): + field_key = "field_" + w.field_name + if isinstance(w, urwid.Edit): + request_data[field_key] = w.edit_text + elif isinstance(w, urwid.RadioButton): + if w.state: + user_data = getattr(w, "field_value", None) + if user_data is not None: + request_data[field_key] = user_data + elif isinstance(w, urwid.CheckBox): + user_data = getattr(w, "field_value", "1") + if w.state: + existing_value = request_data.get(field_key, '') + if existing_value: + # Concatenate the new value with the existing one + request_data[field_key] = existing_value + ',' + user_data + else: + # Initialize the field with the current value + request_data[field_key] = user_data + else: + pass # do nothing if checkbox is not check + + + + + + recurse_down(self.attr_maps) RNS.log("Including request data: "+str(request_data), RNS.LOG_DEBUG) diff --git a/nomadnet/ui/textui/Guide.py b/nomadnet/ui/textui/Guide.py index 69305cf..48dfb56 100644 --- a/nomadnet/ui/textui/Guide.py +++ b/nomadnet/ui/textui/Guide.py @@ -1152,6 +1152,43 @@ A sized input field: `B444`<16|with_size`>`B333 A masked input field: `B444``B333 Full control: `B444``B333 +`b +>>> Checkboxes + +In addition to text fields, Checkboxes are another way of submitting data. They allow the user to make a single selection or select multiple options. + +`Faaa +`= +``b Label Text` +`= +When the checkbox is checked, it's field will be set to the provided value. If there are multiple checkboxes that share the same field name, the checked values will be concatenated when they are sent to the node by a comma. +`` + +`B444``b Sign me up` + +>>> Radio groups + +Radio groups are another input that lets the user chose from a set of options. Unlike checkboxes, radio buttons with the same field name are mutually exclusive. + +Example: + +`= +`B900`<^|color|Red`>`b Red + +`B090`<^|color|Green`>`b Green + +`B009`<^|color|Blue`>`b Blue +`= + +will render: + +`B900`<^|color|Red`>`b Red + +`B090`<^|color|Green`>`b Green + +`B009`<^|color|Blue`>`b Blue + +In this example, when the data is submitted, `B444` field_color`b will be set to whichever value from the list was selected. `` diff --git a/nomadnet/ui/textui/MicronParser.py b/nomadnet/ui/textui/MicronParser.py index 27e420b..7668ecf 100644 --- a/nomadnet/ui/textui/MicronParser.py +++ b/nomadnet/ui/textui/MicronParser.py @@ -160,7 +160,6 @@ def parse_line(line, state, url_delegate): tw.in_columns = True else: tw = urwid.Text(o, align=state["align"]) - widgets.append((urwid.PACK, tw)) else: if o["type"] == "field": @@ -169,10 +168,37 @@ def parse_line(line, state, url_delegate): fn = o["name"] fs = o["style"] fmask = "*" if o["masked"] else None - f = urwid.Edit(caption="", edit_text=fd, align=state["align"], multiline=True, mask=fmask) + f = urwid.Edit(caption="", edit_text=fd, align=state["align"], multiline=False, mask=fmask) f.field_name = fn fa = urwid.AttrMap(f, fs) widgets.append((fw, fa)) + elif o["type"] == "checkbox": + fn = o["name"] + fv = o["value"] + flabel = o["label"] + fs = o["style"] + f = urwid.CheckBox(flabel, state=False) + f.field_name = fn + f.field_value = fv + fa = urwid.AttrMap(f, fs) + widgets.append((urwid.PACK, fa)) + elif o["type"] == "radio": + fn = o["name"] + fv = o["value"] + flabel = o["label"] + fs = o["style"] + if not "radio_groups" in state: + state["radio_groups"] = {} + if not fn in state["radio_groups"]: + state["radio_groups"][fn] = [] + group = state["radio_groups"][fn] + f = urwid.RadioButton(group, flabel, state=False, user_data=fv) + f.field_name = fn + f.field_value = fv + fa = urwid.AttrMap(f, fs) + widgets.append((urwid.PACK, fa)) + + columns_widget = urwid.Columns(widgets, dividechars=0) text_widget = columns_widget @@ -458,54 +484,85 @@ def make_output(state, line, url_delegate): elif c == "a": state["align"] = state["default_align"] - elif c == "<": + elif c == '<': + if len(part) > 0: + output.append(make_part(state, part)) + part = "" try: - field_name = None - field_name_end = line[i:].find("`") - if field_name_end == -1: - pass + field_start = i + 1 # position after '<' + backtick_pos = line.find('`', field_start) + if backtick_pos == -1: + pass # No '`', invalid field else: - field_name = line[i+1:i+field_name_end] - field_name_skip = len(field_name) + field_content = line[field_start:backtick_pos] field_masked = False field_width = 24 + field_type = "field" + field_name = field_content + field_value = "" + field_data = "" - if "|" in field_name: - f_components = field_name.split("|") + # check if field_content contains '|' + if '|' in field_content: + f_components = field_content.split('|') field_flags = f_components[0] field_name = f_components[1] - if "!" in field_flags: + + # handle field type indicators + if '^' in field_flags: + field_type = "radio" + field_flags = field_flags.replace("^", "") + elif '?' in field_flags: + field_type = "checkbox" + field_flags = field_flags.replace("?", "") + elif '!' in field_flags: field_flags = field_flags.replace("!", "") field_masked = True - if len(field_flags) > 0: - field_width = min(int(field_flags), 256) - def sr(): - return "@{"+str(random.randint(1000,9999))+"}" - rsg = sr() - while rsg in line[i+field_name_end:]: - rsg = sr() - lr = line[i+field_name_end:].replace("\\>", rsg) - endpos = lr.find(">") - - if endpos == -1: - pass - + # Handle field width + if len(field_flags) > 0: + try: + field_width = min(int(field_flags), 256) + except ValueError: + pass # Ignore invalid width + + if len(f_components) > 2: + field_value = f_components[2] else: - field_data = lr[1:endpos].replace(rsg, "\\>") - skip = len(field_data)+field_name_skip+2 - field_data = field_data.replace("\\>", ">") - output.append({ - "type":"field", - "name": field_name, - "width": field_width, - "masked": field_masked, - "data": field_data, - "style": make_style(state) - }) + field_name = field_content + + # Find the closing '>' character + field_end = line.find('>', backtick_pos) + if field_end == -1: + pass # No closing '>', invalid field + else: + field_data = line[backtick_pos+1:field_end] + + # Now, we have all field data + if field_type in ["checkbox", "radio"]: + # for checkboxes and radios, field_data is the label + output.append({ + "type": field_type, + "name": field_name, + "value": field_value if field_value else field_data, + "label": field_data, + "style": make_style(state) + }) + else: + # For text fields field_data is the initial text + output.append({ + "type": "field", + "name": field_name, + "width": field_width, + "masked": field_masked, + "data": field_data, + "style": make_style(state) + }) + skip = field_end - i except Exception as e: pass - + + elif c == "[": endpos = line[i:].find("]") if endpos == -1: From 912c510ab2df91a436b2c60887900e0fcd060cc2 Mon Sep 17 00:00:00 2001 From: zenith Date: Tue, 26 Nov 2024 19:58:53 -0500 Subject: [PATCH 12/71] Add Checkbox and Radio Button fields to Micron format --- nomadnet/examples/various/input_fields.py | 2 +- nomadnet/ui/textui/Guide.py | 4 ++++ nomadnet/ui/textui/MicronParser.py | 26 +++++++++++++++++++---- 3 files changed, 27 insertions(+), 5 deletions(-) diff --git a/nomadnet/examples/various/input_fields.py b/nomadnet/examples/various/input_fields.py index 663dc93..5d1eccc 100644 --- a/nomadnet/examples/various/input_fields.py +++ b/nomadnet/examples/various/input_fields.py @@ -31,7 +31,7 @@ The data can be `!`[submitted`:/page/input_fields.mu`username|two]`!. >> Checkbox Fields -`B444``b Sign me up +`B444``b Sign me up >> Radio group diff --git a/nomadnet/ui/textui/Guide.py b/nomadnet/ui/textui/Guide.py index 48dfb56..ba6c4d5 100644 --- a/nomadnet/ui/textui/Guide.py +++ b/nomadnet/ui/textui/Guide.py @@ -1166,6 +1166,10 @@ When the checkbox is checked, it's field will be set to the provided value. If t `B444``b Sign me up` +You can also pre-check both checkboxes and radio groups by appending a |* after the field value. + +`B444``b Pre-checked checkbox` + >>> Radio groups Radio groups are another input that lets the user chose from a set of options. Unlike checkboxes, radio buttons with the same field name are mutually exclusive. diff --git a/nomadnet/ui/textui/MicronParser.py b/nomadnet/ui/textui/MicronParser.py index 7668ecf..05ded7a 100644 --- a/nomadnet/ui/textui/MicronParser.py +++ b/nomadnet/ui/textui/MicronParser.py @@ -177,7 +177,8 @@ def parse_line(line, state, url_delegate): fv = o["value"] flabel = o["label"] fs = o["style"] - f = urwid.CheckBox(flabel, state=False) + fprechecked = o.get("prechecked", False) + f = urwid.CheckBox(flabel, state=fprechecked) f.field_name = fn f.field_value = fv fa = urwid.AttrMap(f, fs) @@ -187,12 +188,13 @@ def parse_line(line, state, url_delegate): fv = o["value"] flabel = o["label"] fs = o["style"] - if not "radio_groups" in state: + fprechecked = o.get("prechecked", False) + if "radio_groups" not in state: state["radio_groups"] = {} - if not fn in state["radio_groups"]: + if fn not in state["radio_groups"]: state["radio_groups"][fn] = [] group = state["radio_groups"][fn] - f = urwid.RadioButton(group, flabel, state=False, user_data=fv) + f = urwid.RadioButton(group, flabel, state=fprechecked, user_data=fv) f.field_name = fn f.field_value = fv fa = urwid.AttrMap(f, fs) @@ -200,6 +202,7 @@ def parse_line(line, state, url_delegate): + columns_widget = urwid.Columns(widgets, dividechars=0) text_widget = columns_widget # text_widget = urwid.Text("<"+output+">", align=state["align"]) @@ -501,6 +504,7 @@ def make_output(state, line, url_delegate): field_name = field_content field_value = "" field_data = "" + field_prechecked = False # check if field_content contains '|' if '|' in field_content: @@ -526,10 +530,23 @@ def make_output(state, line, url_delegate): except ValueError: pass # Ignore invalid width + # Check for value and pre-checked flag if len(f_components) > 2: field_value = f_components[2] + else: + field_value = "" + if len(f_components) > 3: + if f_components[3] == '*': + field_prechecked = True + else: + # No '|', so field_name is field_content field_name = field_content + field_type = "field" + field_masked = False + field_width = 24 + field_value = "" + field_prechecked = False # Find the closing '>' character field_end = line.find('>', backtick_pos) @@ -546,6 +563,7 @@ def make_output(state, line, url_delegate): "name": field_name, "value": field_value if field_value else field_data, "label": field_data, + "prechecked": field_prechecked, "style": make_style(state) }) else: From 11fd305959fc8c416e28df9d393fab77c2184c06 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Mon, 9 Dec 2024 22:11:49 +0100 Subject: [PATCH 13/71] Updated versions --- nomadnet/_version.py | 2 +- setup.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/nomadnet/_version.py b/nomadnet/_version.py index 6b27eee..86716a7 100644 --- a/nomadnet/_version.py +++ b/nomadnet/_version.py @@ -1 +1 @@ -__version__ = "0.5.4" +__version__ = "0.5.5" diff --git a/setup.py b/setup.py index b7fd8da..70d8e63 100644 --- a/setup.py +++ b/setup.py @@ -30,6 +30,6 @@ setuptools.setup( entry_points= { 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, - install_requires=["rns>=0.8.2", "lxmf>=0.5.5", "urwid>=2.4.4", "qrcode"], + install_requires=["rns>=0.8.7", "lxmf>=0.5.9", "urwid>=2.4.4", "qrcode"], python_requires=">=3.6", ) From bec76124282f20931704c7d8ebb7e111b2fdfa92 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Mon, 9 Dec 2024 22:49:55 +0100 Subject: [PATCH 14/71] Updated dependencies --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 70d8e63..1ec2fbc 100644 --- a/setup.py +++ b/setup.py @@ -30,6 +30,6 @@ setuptools.setup( entry_points= { 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, - install_requires=["rns>=0.8.7", "lxmf>=0.5.9", "urwid>=2.4.4", "qrcode"], + install_requires=["rns>=0.8.7", "lxmf>=0.5.8", "urwid>=2.4.4", "qrcode"], python_requires=">=3.6", ) From 7b38d4f80eb26b0527c7687d0da13a4765eae516 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Thu, 12 Dec 2024 08:53:20 +0100 Subject: [PATCH 15/71] Fix multiline prop --- nomadnet/ui/textui/MicronParser.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nomadnet/ui/textui/MicronParser.py b/nomadnet/ui/textui/MicronParser.py index 05ded7a..bbda2c8 100644 --- a/nomadnet/ui/textui/MicronParser.py +++ b/nomadnet/ui/textui/MicronParser.py @@ -168,7 +168,7 @@ def parse_line(line, state, url_delegate): fn = o["name"] fs = o["style"] fmask = "*" if o["masked"] else None - f = urwid.Edit(caption="", edit_text=fd, align=state["align"], multiline=False, mask=fmask) + f = urwid.Edit(caption="", edit_text=fd, align=state["align"], multiline=True, mask=fmask) f.field_name = fn fa = urwid.AttrMap(f, fs) widgets.append((fw, fa)) From ccc41a5789ed62c000730f908759669f2cb63cad Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Thu, 12 Dec 2024 08:54:05 +0100 Subject: [PATCH 16/71] Updated version --- nomadnet/_version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nomadnet/_version.py b/nomadnet/_version.py index 86716a7..a779a44 100644 --- a/nomadnet/_version.py +++ b/nomadnet/_version.py @@ -1 +1 @@ -__version__ = "0.5.5" +__version__ = "0.5.6" From d8cfc69ac63faf462f95411efd07d8351b2061a5 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Thu, 12 Dec 2024 08:54:59 +0100 Subject: [PATCH 17/71] Updated dependencies --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 1ec2fbc..e1fe428 100644 --- a/setup.py +++ b/setup.py @@ -30,6 +30,6 @@ setuptools.setup( entry_points= { 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, - install_requires=["rns>=0.8.7", "lxmf>=0.5.8", "urwid>=2.4.4", "qrcode"], + install_requires=["rns>=0.8.8", "lxmf>=0.5.8", "urwid>=2.4.4", "qrcode"], python_requires=">=3.6", ) From 00855c32a7cf7e6694dea92ede3f47f211fb7af9 Mon Sep 17 00:00:00 2001 From: Steve Miller <43918257+kc1awv@users.noreply.github.com> Date: Tue, 17 Dec 2024 09:07:14 -0500 Subject: [PATCH 18/71] Update TextUI.py Replace some missing or deprecated NF icons with new / updated icons. --- nomadnet/ui/TextUI.py | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/nomadnet/ui/TextUI.py b/nomadnet/ui/TextUI.py index 3e4b3cf..1fa7add 100644 --- a/nomadnet/ui/TextUI.py +++ b/nomadnet/ui/TextUI.py @@ -105,27 +105,27 @@ else: GLYPHS = { # Glyph name # Plain # Unicode # Nerd Font - ("check", "=", "\u2713", "\u2713"), - ("cross", "X", "\u2715", "\u2715"), + ("check", "=", "\u2713", "\uf00c"), + ("cross", "X", "\u2715", "\uf467"), ("unknown", "?", "?", "?"), ("encrypted", "", "\u26BF", "\uf023"), ("plaintext", "!", "!", "\uf06e "), - ("arrow_r", "->", "\u2192", "\u2192"), - ("arrow_l", "<-", "\u2190", "\u2190"), - ("arrow_u", "/\\", "\u2191", "\u2191"), - ("arrow_d", "\\/", "\u2193", "\u2193"), + ("arrow_r", "->", "\u2192", "\uf105"), + ("arrow_l", "<-", "\u2190", "\uf104"), + ("arrow_u", "/\\", "\u2191", "\uf106"), + ("arrow_d", "\\/", "\u2193", "\uf107"), ("warning", "!", "\u26a0", "\uf12a"), - ("info", "i", "\u2139", "\U000f064e"), + ("info", "i", "\u2139", "\uf064e"), ("unread", "[!]", "\u2709", ur_char), - ("divider1", "-", "\u2504", "\u2504"), + ("divider1", "-", "\u2504", "\uf01d8"), ("peer", "[P]", "\u24c5 ", "\uf415"), - ("node", "[N]", "\u24c3 ", "\U000f0002"), + ("node", "[N]", "\u24c3 ", "\uf0002"), ("page", "", "\u25a4 ", "\uf719 "), - ("speed", "", "\u25F7 ", "\U000f04c5 "), - ("decoration_menu", " +", " +", " \U000f043b"), + ("speed", "", "\u25F7 ", "\uf04c5 "), + ("decoration_menu", " +", " +", " \uf043b"), ("unread_menu", " !", " \u2709", urm_char), ("globe", "", "", "\uf484"), - ("sent", "/\\", "\u2191", "\U000f0cd8"), + ("sent", "/\\", "\u2191", "\uf0cd8"), ("papermsg", "P", "\u25a4", "\uf719"), ("qrcode", "QR", "\u25a4", "\uf029"), } From 7d18a103cfc69a6b392696e65b1b546e9907fbd9 Mon Sep 17 00:00:00 2001 From: liamcottle Date: Fri, 20 Dec 2024 23:03:31 +1300 Subject: [PATCH 19/71] don't try to execute nomadnet pages when running on windows --- nomadnet/Node.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/nomadnet/Node.py b/nomadnet/Node.py index 70b455c..37eb691 100644 --- a/nomadnet/Node.py +++ b/nomadnet/Node.py @@ -1,4 +1,6 @@ import os +import sys + import RNS import time import threading @@ -159,7 +161,8 @@ class Node: try: if request_allowed: RNS.log("Serving page: "+file_path, RNS.LOG_VERBOSE) - if os.access(file_path, os.X_OK): + is_windows = sys.platform == "win32" + if is_windows is False and os.access(file_path, os.X_OK): env_map = {} if "PATH" in os.environ: env_map["PATH"] = os.environ["PATH"] From c95fd83400b8558eee26dd8f8aac324e266773ca Mon Sep 17 00:00:00 2001 From: Aleksei Stepanov Date: Wed, 1 Jan 2025 13:37:16 +0100 Subject: [PATCH 20/71] Handle urwid API deprecations * `_get_base_widget` method is going to be removed --- nomadnet/ui/textui/Network.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nomadnet/ui/textui/Network.py b/nomadnet/ui/textui/Network.py index 5ae371f..207ed9b 100644 --- a/nomadnet/ui/textui/Network.py +++ b/nomadnet/ui/textui/Network.py @@ -1594,10 +1594,10 @@ class NetworkDisplay(): if self.list_display == 1: parent = self.app.ui.main_display.sub_displays.network_display selected_node_entry = parent.known_nodes_display.ilb.get_selected_item() - if selected_node_entry != None: - selected_node_hash = selected_node_entry._get_base_widget().display_widget.source_hash + if selected_node_entry is not None: + selected_node_hash = selected_node_entry.base_widget.display_widget.source_hash - if selected_node_hash != None: + if selected_node_hash is not None: info_widget = KnownNodeInfo(selected_node_hash) options = parent.left_pile.options(height_type=urwid.WEIGHT, height_amount=1) parent.left_pile.contents[0] = (info_widget, options) From bd909c9f5840dbb86d43db0784a91e2ac2049eb7 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Mon, 13 Jan 2025 14:40:31 +0100 Subject: [PATCH 21/71] Updated version --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index e1fe428..e285a5a 100644 --- a/setup.py +++ b/setup.py @@ -30,6 +30,6 @@ setuptools.setup( entry_points= { 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, - install_requires=["rns>=0.8.8", "lxmf>=0.5.8", "urwid>=2.4.4", "qrcode"], + install_requires=["rns>=0.9.0", "lxmf>=0.5.9", "urwid>=2.4.4", "qrcode"], python_requires=">=3.6", ) From 46eee79da23a1f51a5ed59b7623fb56d23f3cb71 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Mon, 13 Jan 2025 14:40:45 +0100 Subject: [PATCH 22/71] Added sync transfer rate to PN list display --- nomadnet/ui/textui/Network.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/nomadnet/ui/textui/Network.py b/nomadnet/ui/textui/Network.py index 5ae371f..466204d 100644 --- a/nomadnet/ui/textui/Network.py +++ b/nomadnet/ui/textui/Network.py @@ -1797,7 +1797,15 @@ class LXMFPeerEntry(urwid.WidgetWrap): style = "list_unresponsive" focus_style = "list_focus_unresponsive" - widget = ListEntry(sym+" "+display_str+"\n "+alive_string+", last heard "+pretty_date(int(peer.last_heard))+"\n "+str(len(peer.unhandled_messages))+" unhandled LXMs, "+RNS.prettysize(peer.link_establishment_rate/8, "b")+"/s LER") + if peer.propagation_transfer_limit: + txfer_limit = RNS.prettysize(peer.propagation_transfer_limit*1000) + else: + txfer_limit = "No" + peer_info_str = sym+" "+display_str+"\n "+alive_string+", last heard "+pretty_date(int(peer.last_heard)) + peer_info_str += "\n "+str(len(peer.unhandled_messages))+f" unhandled LXMs, {txfer_limit} sync limit\n" + peer_info_str += f" {RNS.prettyspeed(peer.sync_transfer_rate)} STR, " + peer_info_str += f"{RNS.prettyspeed(peer.link_establishment_rate)} LER\n" + widget = ListEntry(peer_info_str) self.display_widget = urwid.AttrMap(widget, style, focus_style) self.display_widget.destination_hash = destination_hash super().__init__(self.display_widget) From eb3ff558c00200dd6901c4f2574f457fc248950e Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Mon, 13 Jan 2025 15:09:39 +0100 Subject: [PATCH 23/71] Use built-in platform check --- nomadnet/Node.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/nomadnet/Node.py b/nomadnet/Node.py index 37eb691..5c2a3e0 100644 --- a/nomadnet/Node.py +++ b/nomadnet/Node.py @@ -161,8 +161,7 @@ class Node: try: if request_allowed: RNS.log("Serving page: "+file_path, RNS.LOG_VERBOSE) - is_windows = sys.platform == "win32" - if is_windows is False and os.access(file_path, os.X_OK): + if not RNS.vendor.platformutils.is_windows() and os.access(file_path, os.X_OK): env_map = {} if "PATH" in os.environ: env_map["PATH"] = os.environ["PATH"] From 01a5c210169c096f2a7acb68a4963662d1f15fff Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Mon, 13 Jan 2025 15:17:03 +0100 Subject: [PATCH 24/71] Revert NF glyphs --- nomadnet/ui/TextUI.py | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/nomadnet/ui/TextUI.py b/nomadnet/ui/TextUI.py index 1fa7add..3e4b3cf 100644 --- a/nomadnet/ui/TextUI.py +++ b/nomadnet/ui/TextUI.py @@ -105,27 +105,27 @@ else: GLYPHS = { # Glyph name # Plain # Unicode # Nerd Font - ("check", "=", "\u2713", "\uf00c"), - ("cross", "X", "\u2715", "\uf467"), + ("check", "=", "\u2713", "\u2713"), + ("cross", "X", "\u2715", "\u2715"), ("unknown", "?", "?", "?"), ("encrypted", "", "\u26BF", "\uf023"), ("plaintext", "!", "!", "\uf06e "), - ("arrow_r", "->", "\u2192", "\uf105"), - ("arrow_l", "<-", "\u2190", "\uf104"), - ("arrow_u", "/\\", "\u2191", "\uf106"), - ("arrow_d", "\\/", "\u2193", "\uf107"), + ("arrow_r", "->", "\u2192", "\u2192"), + ("arrow_l", "<-", "\u2190", "\u2190"), + ("arrow_u", "/\\", "\u2191", "\u2191"), + ("arrow_d", "\\/", "\u2193", "\u2193"), ("warning", "!", "\u26a0", "\uf12a"), - ("info", "i", "\u2139", "\uf064e"), + ("info", "i", "\u2139", "\U000f064e"), ("unread", "[!]", "\u2709", ur_char), - ("divider1", "-", "\u2504", "\uf01d8"), + ("divider1", "-", "\u2504", "\u2504"), ("peer", "[P]", "\u24c5 ", "\uf415"), - ("node", "[N]", "\u24c3 ", "\uf0002"), + ("node", "[N]", "\u24c3 ", "\U000f0002"), ("page", "", "\u25a4 ", "\uf719 "), - ("speed", "", "\u25F7 ", "\uf04c5 "), - ("decoration_menu", " +", " +", " \uf043b"), + ("speed", "", "\u25F7 ", "\U000f04c5 "), + ("decoration_menu", " +", " +", " \U000f043b"), ("unread_menu", " !", " \u2709", urm_char), ("globe", "", "", "\uf484"), - ("sent", "/\\", "\u2191", "\uf0cd8"), + ("sent", "/\\", "\u2191", "\U000f0cd8"), ("papermsg", "P", "\u25a4", "\uf719"), ("qrcode", "QR", "\u25a4", "\uf029"), } From 74e7e4e806ba246149e5c374b720eb1dd23209a0 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Mon, 13 Jan 2025 15:22:13 +0100 Subject: [PATCH 25/71] Updated default config --- nomadnet/NomadNetworkApp.py | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/nomadnet/NomadNetworkApp.py b/nomadnet/NomadNetworkApp.py index b9ec687..d36d555 100644 --- a/nomadnet/NomadNetworkApp.py +++ b/nomadnet/NomadNetworkApp.py @@ -1136,13 +1136,15 @@ announce_interval = 360 # Whether to announce when the node starts. announce_at_start = Yes -# By default, when Nomad Network is hosting a -# node, it will also act as an LXMF propagation +# When Nomad Network is hosting a page-serving +# node, it can also act as an LXMF propagation # node. If there is already a large amount of # propagation nodes on the network, or you # simply want to run a pageserving-only node, # you can disable running a propagation node. -# disable_propagation = False +# Due to lots of propagation nodes being +# available, this is currently the default. +disable_propagation = Yes # The maximum amount of storage to use for # the LXMF Propagation Node message store, @@ -1176,10 +1178,6 @@ max_transfer_size = 256 # and generally you do not need to use it. # prioritise_destinations = 41d20c727598a3fbbdf9106133a3a0ed, d924b81822ca24e68e2effea99bcb8cf -# Automatic rescan interval of the pages directory in minutes. -# Default: int = 0 (no rescan) -page_refresh_interval = 0 - # You can specify the interval in minutes for # rescanning the hosted pages path. By default, # this option is disabled, and the pages path From 4fb97eecc5dab067d272a9a1b97f9ece02f4183f Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Mon, 13 Jan 2025 15:24:23 +0100 Subject: [PATCH 26/71] Updated dependencies --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index e285a5a..a2f54a9 100644 --- a/setup.py +++ b/setup.py @@ -31,5 +31,5 @@ setuptools.setup( 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, install_requires=["rns>=0.9.0", "lxmf>=0.5.9", "urwid>=2.4.4", "qrcode"], - python_requires=">=3.6", + python_requires=">=3.7", ) From c48a8d2a09e618b9fac08ab0c387e426a3efd95d Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Mon, 13 Jan 2025 15:25:12 +0100 Subject: [PATCH 27/71] Updated version --- nomadnet/_version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nomadnet/_version.py b/nomadnet/_version.py index a779a44..1cc82e6 100644 --- a/nomadnet/_version.py +++ b/nomadnet/_version.py @@ -1 +1 @@ -__version__ = "0.5.6" +__version__ = "0.5.7" From 7cd025e236b06b6e3a0e654d4c08e7b97559eac3 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sat, 18 Jan 2025 17:20:29 +0100 Subject: [PATCH 28/71] Updated dependencies --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index a2f54a9..e595b83 100644 --- a/setup.py +++ b/setup.py @@ -30,6 +30,6 @@ setuptools.setup( entry_points= { 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, - install_requires=["rns>=0.9.0", "lxmf>=0.5.9", "urwid>=2.4.4", "qrcode"], + install_requires=["rns>=0.9.0", "lxmf>=0.5.9", "urwid>=2.6.16", "qrcode"], python_requires=">=3.7", ) From d13c8af88ee2dc10b633a2d736d04e3633cdd61a Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 19 Jan 2025 21:47:22 +0100 Subject: [PATCH 29/71] Updated dependencies --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index e595b83..a3e210c 100644 --- a/setup.py +++ b/setup.py @@ -30,6 +30,6 @@ setuptools.setup( entry_points= { 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, - install_requires=["rns>=0.9.0", "lxmf>=0.5.9", "urwid>=2.6.16", "qrcode"], + install_requires=["rns>=0.9.1", "lxmf>=0.6.0", "urwid>=2.6.16", "qrcode"], python_requires=">=3.7", ) From d5cf34f9d9760271c77fbe6d923920bba40d6e15 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Tue, 21 Jan 2025 17:01:06 +0100 Subject: [PATCH 30/71] Get PN message counts faster --- nomadnet/ui/textui/Network.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nomadnet/ui/textui/Network.py b/nomadnet/ui/textui/Network.py index 9c16309..111beba 100644 --- a/nomadnet/ui/textui/Network.py +++ b/nomadnet/ui/textui/Network.py @@ -1802,7 +1802,7 @@ class LXMFPeerEntry(urwid.WidgetWrap): else: txfer_limit = "No" peer_info_str = sym+" "+display_str+"\n "+alive_string+", last heard "+pretty_date(int(peer.last_heard)) - peer_info_str += "\n "+str(len(peer.unhandled_messages))+f" unhandled LXMs, {txfer_limit} sync limit\n" + peer_info_str += "\n "+str(peer.unhandled_message_count)+f" unhandled LXMs, {txfer_limit} sync limit\n" peer_info_str += f" {RNS.prettyspeed(peer.sync_transfer_rate)} STR, " peer_info_str += f"{RNS.prettyspeed(peer.link_establishment_rate)} LER\n" widget = ListEntry(peer_info_str) From 11fda5101730e35bf11b4a2b00274dff0412b5e7 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Wed, 22 Jan 2025 12:03:49 +0100 Subject: [PATCH 31/71] Updated guide --- nomadnet/ui/textui/Guide.py | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/nomadnet/ui/textui/Guide.py b/nomadnet/ui/textui/Guide.py index ba6c4d5..6308edc 100644 --- a/nomadnet/ui/textui/Guide.py +++ b/nomadnet/ui/textui/Guide.py @@ -666,9 +666,9 @@ Determines the interval in minutes for rescanning the hosted files path. By defa < >>> -`!disable_propagation = no`! +`!disable_propagation = yes`! >>>> -By default, when Nomad Network is hosting a node, it will also run an LXMF propagation node. If there is already a large amount of propagation nodes on the network, or you simply want to run a pageserving-only node, you can disable running a propagation node. +When Nomad Network is hosting a node, it can also run an LXMF propagation node. If there is already a large amount of propagation nodes on the network, or you simply want to run a pageserving-only node, you can disable running a propagation node. < >>> @@ -689,6 +689,18 @@ The maximum accepted transfer size per incoming propagation transfer, in kilobyt Configures the LXMF Propagation Node to prioritise storing messages for certain destinations. If the message store reaches the specified limit, LXMF will prioritise keeping messages for destinations specified with this option. This setting is optional, and generally you do not need to use it. < +>>> +`!max_peers = 25`! +>>>> +Configures the maximum number of other nodes the LXMF Propagation Node will automatically peer with. The default is 50, but can be lowered or increased according to available resources. +< + +>>> +`!static_peers = e17f833c4ddf8890dd3a79a6fea8161d, 5a2d0029b6e5ec87020abaea0d746da4`! +>>>> +Configures the LXMF Propagation Node to always maintain propagation node peering with the specified list of destination hashes. +< + >> Printing Section This section holds configuration directives related to printing. It is delimited by the `![printing]`! header in the configuration file. Available directives, along with example values, are as follows: From 9ee052a12208a0ab85757c74a3cbf6c77567b0cc Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Wed, 22 Jan 2025 12:04:34 +0100 Subject: [PATCH 32/71] Sort PNs according to STR --- nomadnet/ui/textui/Network.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nomadnet/ui/textui/Network.py b/nomadnet/ui/textui/Network.py index 111beba..1a151a7 100644 --- a/nomadnet/ui/textui/Network.py +++ b/nomadnet/ui/textui/Network.py @@ -1753,7 +1753,7 @@ class LXMFPeers(urwid.WidgetWrap): def make_peer_widgets(self): widget_list = [] - sorted_peers = sorted(self.peer_list, key=lambda pid: (self.app.directory.pn_trust_level(pid), self.peer_list[pid].link_establishment_rate), reverse=True) + sorted_peers = sorted(self.peer_list, key=lambda pid: (self.app.directory.pn_trust_level(pid), self.peer_list[pid].sync_transfer_rate), reverse=True) for peer_id in sorted_peers: peer = self.peer_list[peer_id] trust_level = self.app.directory.pn_trust_level(peer_id) From e332be62118210805c04abaed540d1b8ef516d16 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Wed, 22 Jan 2025 12:05:08 +0100 Subject: [PATCH 33/71] Added ability configure max_peers and static_peers --- nomadnet/NomadNetworkApp.py | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/nomadnet/NomadNetworkApp.py b/nomadnet/NomadNetworkApp.py index d36d555..6fb6cbb 100644 --- a/nomadnet/NomadNetworkApp.py +++ b/nomadnet/NomadNetworkApp.py @@ -290,9 +290,20 @@ class NomadNetworkApp: self.directory = nomadnet.Directory(self) + static_peers = [] + for static_peer in self.static_peers: + try: + dh = bytes.fromhex(static_peer) + if len(dh) != RNS.Reticulum.TRUNCATED_HASHLENGTH//8: + raise ValueError("Invalid destination length") + static_peers.append(dh) + except Exception as e: + RNS.log(f"Could not decode static peer destination hash {static_peer}: {e}", RNS.LOG_ERROR) + self.message_router = LXMF.LXMRouter( identity = self.identity, storagepath = self.storagepath, autopeer = True, propagation_limit = self.lxmf_max_propagation_size, delivery_limit = self.lxmf_max_incoming_size, + max_peers = self.max_peers, static_peers = static_peers, ) self.message_router.register_delivery_callback(self.lxmf_delivery) @@ -920,6 +931,19 @@ class NomadNetworkApp: else: self.prioritised_lxmf_destinations = [] + if "static_peers" in self.config["node"]: + self.static_peers = self.config["node"].as_list("static_peers") + else: + self.static_peers = [] + + if not "max_peers" in self.config["node"]: + self.max_peers = None + else: + value = self.config["node"].as_int("max_peers") + if value < 0: + value = 0 + self.max_peers = value + if not "message_storage_limit" in self.config["node"]: self.message_storage_limit = 2000 else: @@ -1178,6 +1202,17 @@ max_transfer_size = 256 # and generally you do not need to use it. # prioritise_destinations = 41d20c727598a3fbbdf9106133a3a0ed, d924b81822ca24e68e2effea99bcb8cf +# You can configure the maximum number of other +# propagation nodes that this node will peer +# with automatically. The default is 50. +# max_peers = 25 + +# You can configure a list of static propagation +# node peers, that this node will always be +# peered with, by specifying a list of +# destination hashes. +# static_peers = e17f833c4ddf8890dd3a79a6fea8161d, 5a2d0029b6e5ec87020abaea0d746da4 + # You can specify the interval in minutes for # rescanning the hosted pages path. By default, # this option is disabled, and the pages path From f000073594556731f87071e3ec0829c44c7a3def Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Wed, 22 Jan 2025 12:06:05 +0100 Subject: [PATCH 34/71] Updated versions --- nomadnet/_version.py | 2 +- setup.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/nomadnet/_version.py b/nomadnet/_version.py index 1cc82e6..906d362 100644 --- a/nomadnet/_version.py +++ b/nomadnet/_version.py @@ -1 +1 @@ -__version__ = "0.5.7" +__version__ = "0.6.0" diff --git a/setup.py b/setup.py index a3e210c..431f029 100644 --- a/setup.py +++ b/setup.py @@ -30,6 +30,6 @@ setuptools.setup( entry_points= { 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, - install_requires=["rns>=0.9.1", "lxmf>=0.6.0", "urwid>=2.6.16", "qrcode"], + install_requires=["rns>=0.9.1", "lxmf>=0.6.1", "urwid>=2.6.16", "qrcode"], python_requires=">=3.7", ) From 5f31aeb3c1b2b9583f8a921dc8986ad37fae57c8 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Mon, 27 Jan 2025 10:26:39 +0100 Subject: [PATCH 35/71] Fixed missing none check --- nomadnet/Directory.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/nomadnet/Directory.py b/nomadnet/Directory.py index b4a993e..90dd714 100644 --- a/nomadnet/Directory.py +++ b/nomadnet/Directory.py @@ -143,8 +143,9 @@ class Directory: while len(self.announce_stream) > Directory.ANNOUNCE_STREAM_MAXLENGTH: self.announce_stream.pop() - if hasattr(self.app.ui, "main_display"): - self.app.ui.main_display.sub_displays.network_display.directory_change_callback() + if hasattr(self.app, "ui") and self.app.ui != None: + if hasattr(self.app.ui, "main_display"): + self.app.ui.main_display.sub_displays.network_display.directory_change_callback() def node_announce_received(self, source_hash, app_data, associated_peer): if app_data != None: From 704a4ea828272f8231673add1c7846764b2c9707 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Mon, 27 Jan 2025 10:26:55 +0100 Subject: [PATCH 36/71] Updated issue template --- .github/ISSUE_TEMPLATE/🐛-bug-report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/🐛-bug-report.md b/.github/ISSUE_TEMPLATE/🐛-bug-report.md index 77ad6c2..65b492e 100644 --- a/.github/ISSUE_TEMPLATE/🐛-bug-report.md +++ b/.github/ISSUE_TEMPLATE/🐛-bug-report.md @@ -12,7 +12,7 @@ Before creating a bug report on this issue tracker, you **must** read the [Contr - The issue tracker is used by developers of this project. **Do not use it to ask general questions, or for support requests**. - Ideas and feature requests can be made on the [Discussions](https://github.com/markqvist/Reticulum/discussions). **Only** feature requests accepted by maintainers and developers are tracked and included on the issue tracker. **Do not post feature requests here**. -- After reading the [Contribution Guidelines](https://github.com/markqvist/Reticulum/blob/master/Contributing.md), delete this section from your bug report. +- After reading the [Contribution Guidelines](https://github.com/markqvist/Reticulum/blob/master/Contributing.md), **delete this section only** (*"Read the Contribution Guidelines"*) from your bug report, **and fill in all the other sections**. **Describe the Bug** A clear and concise description of what the bug is. From 9ef34fc7740b87628197da5e1478a42b7867a94e Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Tue, 28 Jan 2025 22:45:32 +0100 Subject: [PATCH 37/71] Maintain PN list position --- nomadnet/ui/textui/Network.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/nomadnet/ui/textui/Network.py b/nomadnet/ui/textui/Network.py index 1a151a7..7cf4058 100644 --- a/nomadnet/ui/textui/Network.py +++ b/nomadnet/ui/textui/Network.py @@ -1612,9 +1612,15 @@ class NetworkDisplay(): self.announce_stream_display.rebuild_widget_list() def reinit_lxmf_peers(self): + if self.lxmf_peers_display: + si = self.lxmf_peers_display.ilb.get_selected_position() + else: + si = None self.lxmf_peers_display = LXMFPeers(self.app) self.lxmf_peers_display.delegate = self self.close_list_dialogs() + if si != None: + self.lxmf_peers_display.ilb.select_item(si) def close_list_dialogs(self): if self.list_display == 0: From eeb15dcb434fa065a3e3d8302e1367806ffdb309 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Tue, 28 Jan 2025 23:04:22 +0100 Subject: [PATCH 38/71] Use lock on announce stream updates --- nomadnet/Directory.py | 155 ++++++++++++++++++++++-------------------- 1 file changed, 80 insertions(+), 75 deletions(-) diff --git a/nomadnet/Directory.py b/nomadnet/Directory.py index 90dd714..53c8572 100644 --- a/nomadnet/Directory.py +++ b/nomadnet/Directory.py @@ -3,6 +3,7 @@ import RNS import LXMF import time import nomadnet +import threading import RNS.vendor.umsgpack as msgpack class PNAnnounceHandler: @@ -55,6 +56,7 @@ class Directory: self.directory_entries = {} self.announce_stream = [] self.app = app + self.announce_lock = threading.Lock() self.load_from_disk() self.pn_announce_handler = PNAnnounceHandler(self) @@ -124,91 +126,94 @@ class Directory: RNS.log("Could not load directory from disk. The contained exception was: "+str(e), RNS.LOG_ERROR) def lxmf_announce_received(self, source_hash, app_data): - if app_data != None: - if self.app.compact_stream: - try: - remove_announces = [] - for announce in self.announce_stream: - if announce[1] == source_hash: - remove_announces.append(announce) + with self.announce_lock: + if app_data != None: + if self.app.compact_stream: + try: + remove_announces = [] + for announce in self.announce_stream: + if announce[1] == source_hash: + remove_announces.append(announce) - for a in remove_announces: - self.announce_stream.remove(a) + for a in remove_announces: + self.announce_stream.remove(a) + + except Exception as e: + RNS.log("An error occurred while compacting the announce stream. The contained exception was:"+str(e), RNS.LOG_ERROR) + + timestamp = time.time() + self.announce_stream.insert(0, (timestamp, source_hash, app_data, "peer")) + while len(self.announce_stream) > Directory.ANNOUNCE_STREAM_MAXLENGTH: + self.announce_stream.pop() + + if hasattr(self.app, "ui") and self.app.ui != None: + if hasattr(self.app.ui, "main_display"): + self.app.ui.main_display.sub_displays.network_display.directory_change_callback() + + def node_announce_received(self, source_hash, app_data, associated_peer): + with self.announce_lock: + if app_data != None: + if self.app.compact_stream: + try: + remove_announces = [] + for announce in self.announce_stream: + if announce[1] == source_hash: + remove_announces.append(announce) + + for a in remove_announces: + self.announce_stream.remove(a) + + except Exception as e: + RNS.log("An error occurred while compacting the announce stream. The contained exception was:"+str(e), RNS.LOG_ERROR) + + timestamp = time.time() + self.announce_stream.insert(0, (timestamp, source_hash, app_data, "node")) + while len(self.announce_stream) > Directory.ANNOUNCE_STREAM_MAXLENGTH: + self.announce_stream.pop() + + if self.trust_level(associated_peer) == DirectoryEntry.TRUSTED: + existing_entry = self.find(source_hash) + if not existing_entry: + node_entry = DirectoryEntry(source_hash, display_name=app_data.decode("utf-8"), trust_level=DirectoryEntry.TRUSTED, hosts_node=True) + self.remember(node_entry) - except Exception as e: - RNS.log("An error occurred while compacting the announce stream. The contained exception was:"+str(e), RNS.LOG_ERROR) - - timestamp = time.time() - self.announce_stream.insert(0, (timestamp, source_hash, app_data, "peer")) - while len(self.announce_stream) > Directory.ANNOUNCE_STREAM_MAXLENGTH: - self.announce_stream.pop() - - if hasattr(self.app, "ui") and self.app.ui != None: if hasattr(self.app.ui, "main_display"): self.app.ui.main_display.sub_displays.network_display.directory_change_callback() - def node_announce_received(self, source_hash, app_data, associated_peer): - if app_data != None: - if self.app.compact_stream: - try: - remove_announces = [] - for announce in self.announce_stream: - if announce[1] == source_hash: - remove_announces.append(announce) - - for a in remove_announces: - self.announce_stream.remove(a) - - except Exception as e: - RNS.log("An error occurred while compacting the announce stream. The contained exception was:"+str(e), RNS.LOG_ERROR) - - timestamp = time.time() - self.announce_stream.insert(0, (timestamp, source_hash, app_data, "node")) - while len(self.announce_stream) > Directory.ANNOUNCE_STREAM_MAXLENGTH: - self.announce_stream.pop() - - if self.trust_level(associated_peer) == DirectoryEntry.TRUSTED: - existing_entry = self.find(source_hash) - if not existing_entry: - node_entry = DirectoryEntry(source_hash, display_name=app_data.decode("utf-8"), trust_level=DirectoryEntry.TRUSTED, hosts_node=True) - self.remember(node_entry) - - if hasattr(self.app.ui, "main_display"): - self.app.ui.main_display.sub_displays.network_display.directory_change_callback() - def pn_announce_received(self, source_hash, app_data, associated_peer, associated_node): - found_node = None - for sh in self.directory_entries: - if sh == associated_node: - found_node = True - break + with self.announce_lock: + found_node = None + for sh in self.directory_entries: + if sh == associated_node: + found_node = True + break - for e in self.announce_stream: - if e[1] == associated_node: - found_node = True - break + for e in self.announce_stream: + if e[1] == associated_node: + found_node = True + break - if not found_node: - if self.app.compact_stream: - try: - remove_announces = [] - for announce in self.announce_stream: - if announce[1] == source_hash: - remove_announces.append(announce) + if not found_node: + if self.app.compact_stream: + try: + remove_announces = [] + for announce in self.announce_stream: + if announce[1] == source_hash: + remove_announces.append(announce) - for a in remove_announces: - self.announce_stream.remove(a) + for a in remove_announces: + self.announce_stream.remove(a) + + except Exception as e: + RNS.log("An error occurred while compacting the announce stream. The contained exception was:"+str(e), RNS.LOG_ERROR) + + timestamp = time.time() + self.announce_stream.insert(0, (timestamp, source_hash, app_data, "pn")) + while len(self.announce_stream) > Directory.ANNOUNCE_STREAM_MAXLENGTH: + self.announce_stream.pop() - except Exception as e: - RNS.log("An error occurred while compacting the announce stream. The contained exception was:"+str(e), RNS.LOG_ERROR) - - timestamp = time.time() - self.announce_stream.insert(0, (timestamp, source_hash, app_data, "pn")) - while len(self.announce_stream) > Directory.ANNOUNCE_STREAM_MAXLENGTH: - self.announce_stream.pop() - - if hasattr(self.app.ui, "main_display"): - self.app.ui.main_display.sub_displays.network_display.directory_change_callback() + if hasattr(self.app.ui, "main_display"): + self.app.ui.main_display.sub_displays.network_display.directory_change_callback() def remove_announce_with_timestamp(self, timestamp): selected_announce = None From 46f3a4127c85a2434d51b8c491150447adeffa81 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Wed, 29 Jan 2025 01:24:08 +0100 Subject: [PATCH 39/71] Updated dependencies --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 431f029..430d07c 100644 --- a/setup.py +++ b/setup.py @@ -30,6 +30,6 @@ setuptools.setup( entry_points= { 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, - install_requires=["rns>=0.9.1", "lxmf>=0.6.1", "urwid>=2.6.16", "qrcode"], + install_requires=["rns>=0.9.1", "lxmf>=0.6.2", "urwid>=2.6.16", "qrcode"], python_requires=">=3.7", ) From a26edd21db8d193fd470057db0a41336f76dbf7b Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Wed, 29 Jan 2025 01:24:29 +0100 Subject: [PATCH 40/71] Added acceptance rate to PN peer stats --- nomadnet/ui/textui/Network.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/nomadnet/ui/textui/Network.py b/nomadnet/ui/textui/Network.py index 7cf4058..42b2c0a 100644 --- a/nomadnet/ui/textui/Network.py +++ b/nomadnet/ui/textui/Network.py @@ -1807,10 +1807,11 @@ class LXMFPeerEntry(urwid.WidgetWrap): txfer_limit = RNS.prettysize(peer.propagation_transfer_limit*1000) else: txfer_limit = "No" + ar = round(peer.acceptance_rate*100, 2) peer_info_str = sym+" "+display_str+"\n "+alive_string+", last heard "+pretty_date(int(peer.last_heard)) peer_info_str += "\n "+str(peer.unhandled_message_count)+f" unhandled LXMs, {txfer_limit} sync limit\n" peer_info_str += f" {RNS.prettyspeed(peer.sync_transfer_rate)} STR, " - peer_info_str += f"{RNS.prettyspeed(peer.link_establishment_rate)} LER\n" + peer_info_str += f"{RNS.prettyspeed(peer.link_establishment_rate)} LER, {ar}% AR\n" widget = ListEntry(peer_info_str) self.display_widget = urwid.AttrMap(widget, style, focus_style) self.display_widget.destination_hash = destination_hash From 9f00ffbae680234392bd68d3f49e474194a20f95 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Wed, 29 Jan 2025 01:25:33 +0100 Subject: [PATCH 41/71] Updated version --- nomadnet/_version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nomadnet/_version.py b/nomadnet/_version.py index 906d362..43c4ab0 100644 --- a/nomadnet/_version.py +++ b/nomadnet/_version.py @@ -1 +1 @@ -__version__ = "0.6.0" +__version__ = "0.6.1" From c3c8f991311dee3cf4c3488fb56352523600bd15 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Wed, 29 Jan 2025 01:41:25 +0100 Subject: [PATCH 42/71] Updated logging --- nomadnet/NomadNetworkApp.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nomadnet/NomadNetworkApp.py b/nomadnet/NomadNetworkApp.py index 6fb6cbb..37c3f1e 100644 --- a/nomadnet/NomadNetworkApp.py +++ b/nomadnet/NomadNetworkApp.py @@ -537,7 +537,7 @@ class NomadNetworkApp: RNS.log("Could not autoselect a propagation node! LXMF propagation will not be available until a trusted node announces on the network, or a propagation node is manually selected.", RNS.LOG_WARNING) else: pn_name_str = "" - RNS.log("Selecting "+RNS.prettyhexrep(selected_node)+pn_name_str+" as default LXMF propagation node", RNS.LOG_INFO) + RNS.log("Selecting "+RNS.prettyhexrep(selected_node)+pn_name_str+" as default LXMF propagation node", RNS.LOG_DEBUG) self.message_router.set_outbound_propagation_node(selected_node) def get_user_selected_propagation_node(self): From 7ced4c36596980c0752d3708bdf2a1589ee8c671 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Wed, 29 Jan 2025 14:45:19 +0100 Subject: [PATCH 43/71] Fixed missing attribute check --- nomadnet/Directory.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nomadnet/Directory.py b/nomadnet/Directory.py index 53c8572..335db63 100644 --- a/nomadnet/Directory.py +++ b/nomadnet/Directory.py @@ -212,7 +212,7 @@ class Directory: while len(self.announce_stream) > Directory.ANNOUNCE_STREAM_MAXLENGTH: self.announce_stream.pop() - if hasattr(self.app.ui, "main_display"): + if hasattr(self.app, "ui") and hasattr(self.app.ui, "main_display"): self.app.ui.main_display.sub_displays.network_display.directory_change_callback() def remove_announce_with_timestamp(self, timestamp): From d9886980fa84a368c3645713555aed0226c34eac Mon Sep 17 00:00:00 2001 From: byte-diver Date: Fri, 7 Feb 2025 00:10:44 +0100 Subject: [PATCH 44/71] fix docker, add tabs --- Dockerfile.build | 4 -- nomadnet/ui/textui/Network.py | 119 ++++++++++++++++++++++++---------- 2 files changed, 84 insertions(+), 39 deletions(-) diff --git a/Dockerfile.build b/Dockerfile.build index 3ffba8e..e28e9bd 100644 --- a/Dockerfile.build +++ b/Dockerfile.build @@ -16,10 +16,6 @@ ENV PATH="/home/myuser/.local/bin:${PATH}" ################### BEGIN NomadNet ########################################### -COPY --chown=myuser:myuser requirements.txt requirements.txt - -RUN pip install --user -r requirements.txt - COPY --chown=myuser:myuser . . diff --git a/nomadnet/ui/textui/Network.py b/nomadnet/ui/textui/Network.py index 42b2c0a..d6c6014 100644 --- a/nomadnet/ui/textui/Network.py +++ b/nomadnet/ui/textui/Network.py @@ -141,7 +141,7 @@ class AnnounceInfo(urwid.WidgetWrap): if is_node: try: existing_conversations = nomadnet.Conversation.conversation_list(self.app) - + source_hash_text = RNS.hexrep(op_hash, delimit=False) display_name = op_str @@ -162,7 +162,7 @@ class AnnounceInfo(urwid.WidgetWrap): show_announce_stream(None) try: existing_conversations = nomadnet.Conversation.conversation_list(self.app) - + source_hash_text = RNS.hexrep(source_hash, delimit=False) display_name = data_str @@ -316,7 +316,7 @@ class AnnounceStreamEntry(urwid.WidgetWrap): info_widget = AnnounceInfo(announce, parent, self.app) options = parent.left_pile.options(height_type=urwid.WEIGHT, height_amount=1) parent.left_pile.contents[0] = (info_widget, options) - + except KeyError as e: def dismiss_dialog(sender): self.delegate.parent.close_list_dialogs() @@ -368,6 +368,10 @@ class AnnounceStreamEntry(urwid.WidgetWrap): def timestamp(self): return self.timestamp +class TabButton(urwid.Button): + button_left = urwid.Text("[") + button_right = urwid.Text("]") + class AnnounceStream(urwid.WidgetWrap): def __init__(self, app, parent): self.app = app @@ -376,11 +380,24 @@ class AnnounceStream(urwid.WidgetWrap): self.timeout = self.app.config["textui"]["animation_interval"]*2 self.ilb = None self.no_content = True - + self.current_tab = "nodes" + self.added_entries = [] self.widget_list = [] self.update_widget_list() + # Create tab buttons + self.tab_nodes = urwid.AttrMap(TabButton("Nodes", on_press=self.show_nodes_tab), "tab_active") + self.tab_peers = urwid.AttrMap(TabButton("Peers", on_press=self.show_peers_tab), "tab_inactive") + self.tab_pn = urwid.AttrMap(TabButton("LXMF Propagation Nodes", on_press=self.show_pn_tab), "tab_inactive") + + # Create tab bar with proportional widths + self.tab_bar = urwid.Columns([ + ('weight', 1, self.tab_nodes), + ('weight', 1, self.tab_peers), + ('weight', 3, self.tab_pn), + ], dividechars=1) # Add 1 character spacing between tabs + self.ilb = ExceptionHandlingListBox( self.widget_list, on_selection_change=self.list_selection, @@ -389,7 +406,13 @@ class AnnounceStream(urwid.WidgetWrap): #highlight_offFocus="list_off_focus" ) - self.display_widget = self.ilb + # Combine tab bar and list box + self.pile = urwid.Pile([ + ('pack', self.tab_bar), + ('weight', 1, self.ilb), + ]) + + self.display_widget = self.pile super().__init__(urwid.LineBox(self.display_widget, title="Announce Stream")) def keypress(self, size, key): @@ -397,7 +420,7 @@ class AnnounceStream(urwid.WidgetWrap): nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.focus_position = "header" elif key == "ctrl x": self.delete_selected_entry() - + return super(AnnounceStream, self).keypress(size, key) def delete_selected_entry(self): @@ -412,28 +435,54 @@ class AnnounceStream(urwid.WidgetWrap): self.update_widget_list() def update_widget_list(self): + self.widget_list = [] new_entries = [] - for e in self.app.directory.announce_stream: - if not e[0] in self.added_entries: - self.added_entries.insert(0, e[0]) - new_entries.insert(0, e) - for e in new_entries: + for e in self.app.directory.announce_stream: + announce_type = e[3] + + # Filter based on current tab + if self.current_tab == "nodes" and (announce_type == "node" or announce_type == True): + new_entries.append(e) + elif self.current_tab == "peers" and (announce_type == "peer" or announce_type == False): + new_entries.append(e) + elif self.current_tab == "pn" and announce_type == "pn": + new_entries.append(e) + + for e in reversed(new_entries): nw = AnnounceStreamEntry(self.app, e, self) nw.timestamp = e[0] - self.widget_list.insert(0, nw) + self.widget_list.append(nw) if len(new_entries) > 0: self.no_content = False - if self.ilb != None: - self.ilb.set_body(self.widget_list) else: - if len(self.widget_list) == 0: - self.no_content = True - - if self.ilb != None: - self.ilb.set_body(self.widget_list) + self.no_content = True + self.widget_list = [urwid.Text(f"No {self.current_tab} announces", align='center')] + if self.ilb: + self.ilb.set_body(self.widget_list) + + def show_nodes_tab(self, button): + self.current_tab = "nodes" + self.tab_nodes.set_attr_map({None: "tab_active"}) + self.tab_peers.set_attr_map({None: "tab_inactive"}) + self.tab_pn.set_attr_map({None: "tab_inactive"}) + self.update_widget_list() + + def show_peers_tab(self, button): + self.current_tab = "peers" + self.tab_nodes.set_attr_map({None: "tab_inactive"}) + self.tab_peers.set_attr_map({None: "tab_active"}) + self.tab_pn.set_attr_map({None: "tab_inactive"}) + self.update_widget_list() + + def show_pn_tab(self, button): + self.current_tab = "pn" + self.tab_nodes.set_attr_map({None: "tab_inactive"}) + self.tab_peers.set_attr_map({None: "tab_inactive"}) + self.tab_pn.set_attr_map({None: "tab_active"}) + self.update_widget_list() def list_selection(self, arg1, arg2): pass @@ -596,7 +645,7 @@ class KnownNodeInfo(urwid.WidgetWrap): if node_ident != None: try: existing_conversations = nomadnet.Conversation.conversation_list(self.app) - + source_hash_text = RNS.hexrep(op_hash, delimit=False) display_name = op_str @@ -632,7 +681,7 @@ class KnownNodeInfo(urwid.WidgetWrap): trust_level = DirectoryEntry.UNTRUSTED if r_unknown.get_state() == True: trust_level = DirectoryEntry.UNKNOWN - + if r_trusted.get_state() == True: trust_level = DirectoryEntry.TRUSTED @@ -699,7 +748,7 @@ class KnownNodeInfo(urwid.WidgetWrap): pile_widgets.insert(4, operator_entry) pile = urwid.Pile(pile_widgets) - + pile.focus_position = len(pile.contents)-1 button_columns.focus_position = 0 @@ -733,7 +782,7 @@ class KnownNodes(urwid.WidgetWrap): g = self.app.ui.glyphs self.widget_list = self.make_node_widgets() - + self.ilb = ExceptionHandlingListBox( self.widget_list, on_selection_change=self.node_list_selection, @@ -767,7 +816,7 @@ class KnownNodes(urwid.WidgetWrap): nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.focus_position = "header" elif key == "ctrl x": self.delete_selected_entry() - + return super(KnownNodes, self).keypress(size, key) @@ -910,7 +959,7 @@ class NodeEntry(urwid.WidgetWrap): focus_style = "list_focus_untrusted" type_symbol = g["node"] - + widget = ListEntry(type_symbol+" "+display_str) urwid.connect_signal(widget, "click", delegate.connect_node, node) @@ -1209,7 +1258,7 @@ class LocalPeer(urwid.WidgetWrap): #overlay = urwid.Overlay(dialog, bottom, align=urwid.CENTER, width=urwid.RELATIVE_100, valign=urwid.MIDDLE, height=urwid.PACK, left=4, right=4) overlay = dialog - + self.dialog_open = True options = self.parent.left_pile.options(height_type=urwid.PACK, height_amount=None) self.parent.left_pile.contents[1] = (overlay, options) @@ -1226,7 +1275,7 @@ class LocalPeer(urwid.WidgetWrap): self.t_last_announce.update_time() announce_button = urwid.Button("Announce Now", on_press=announce_query) - + self.display_widget = urwid.Pile( [ t_id, @@ -1270,13 +1319,13 @@ class NodeInfo(urwid.WidgetWrap): def show_peer_info(sender): options = self.parent.left_pile.options(height_type=urwid.PACK, height_amount=None) self.parent.left_pile.contents[1] = (LocalPeer(self.app, self.parent), options) - + if self.app.enable_node: if self.app.node != None: display_name = self.app.node.name else: display_name = None - + if display_name == None: display_name = "" @@ -1308,7 +1357,7 @@ class NodeInfo(urwid.WidgetWrap): #overlay = urwid.Overlay(dialog, bottom, align=urwid.CENTER, width=urwid.RELATIVE_100, valign=urwid.MIDDLE, height=urwid.PACK, left=4, right=4) overlay = dialog - + self.dialog_open = True options = self.parent.left_pile.options(height_type=urwid.PACK, height_amount=None) self.parent.left_pile.contents[1] = (overlay, options) @@ -1596,12 +1645,12 @@ class NetworkDisplay(): selected_node_entry = parent.known_nodes_display.ilb.get_selected_item() if selected_node_entry is not None: selected_node_hash = selected_node_entry.base_widget.display_widget.source_hash - + if selected_node_hash is not None: info_widget = KnownNodeInfo(selected_node_hash) options = parent.left_pile.options(height_type=urwid.WEIGHT, height_amount=1) parent.left_pile.contents[0] = (info_widget, options) - + def focus_lists(self): self.columns.focus_position = 0 @@ -1689,7 +1738,7 @@ class LXMFPeers(urwid.WidgetWrap): self.delete_selected_entry() elif key == "ctrl r": self.sync_selected_entry() - + return super(LXMFPeers, self).keypress(size, key) @@ -1713,7 +1762,7 @@ class LXMFPeers(urwid.WidgetWrap): peer = self.app.message_router.peers[destination_hash] if time.time() > peer.last_sync_attempt+sync_grace: peer.next_sync_attempt = time.time()-1 - + def job(): peer.sync() threading.Thread(target=job, daemon=True).start() @@ -1778,7 +1827,7 @@ class LXMFPeerEntry(urwid.WidgetWrap): node_identity = RNS.Identity.recall(destination_hash) display_str = RNS.prettyhexrep(destination_hash) - if node_identity != None: + if node_identity != None: node_hash = RNS.Destination.hash_from_name_and_identity("nomadnetwork.node", node_identity) display_name = self.app.directory.alleged_display_str(node_hash) if display_name != None: From c198d516da1c30b458816cadcfecf8e816aa2c5d Mon Sep 17 00:00:00 2001 From: byte-diver Date: Fri, 7 Feb 2025 00:23:43 +0100 Subject: [PATCH 45/71] cleaning and sort --- nomadnet/ui/textui/Network.py | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/nomadnet/ui/textui/Network.py b/nomadnet/ui/textui/Network.py index d6c6014..bc87f5a 100644 --- a/nomadnet/ui/textui/Network.py +++ b/nomadnet/ui/textui/Network.py @@ -387,9 +387,9 @@ class AnnounceStream(urwid.WidgetWrap): self.update_widget_list() # Create tab buttons - self.tab_nodes = urwid.AttrMap(TabButton("Nodes", on_press=self.show_nodes_tab), "tab_active") - self.tab_peers = urwid.AttrMap(TabButton("Peers", on_press=self.show_peers_tab), "tab_inactive") - self.tab_pn = urwid.AttrMap(TabButton("LXMF Propagation Nodes", on_press=self.show_pn_tab), "tab_inactive") + self.tab_nodes = TabButton("Nodes", on_press=self.show_nodes_tab) + self.tab_peers = TabButton("Peers", on_press=self.show_peers_tab) + self.tab_pn = TabButton("LXMF Propagation Nodes", on_press=self.show_pn_tab) # Create tab bar with proportional widths self.tab_bar = urwid.Columns([ @@ -449,7 +449,7 @@ class AnnounceStream(urwid.WidgetWrap): elif self.current_tab == "pn" and announce_type == "pn": new_entries.append(e) - for e in reversed(new_entries): + for e in new_entries: nw = AnnounceStreamEntry(self.app, e, self) nw.timestamp = e[0] self.widget_list.append(nw) @@ -465,23 +465,14 @@ class AnnounceStream(urwid.WidgetWrap): def show_nodes_tab(self, button): self.current_tab = "nodes" - self.tab_nodes.set_attr_map({None: "tab_active"}) - self.tab_peers.set_attr_map({None: "tab_inactive"}) - self.tab_pn.set_attr_map({None: "tab_inactive"}) self.update_widget_list() def show_peers_tab(self, button): self.current_tab = "peers" - self.tab_nodes.set_attr_map({None: "tab_inactive"}) - self.tab_peers.set_attr_map({None: "tab_active"}) - self.tab_pn.set_attr_map({None: "tab_inactive"}) self.update_widget_list() def show_pn_tab(self, button): self.current_tab = "pn" - self.tab_nodes.set_attr_map({None: "tab_inactive"}) - self.tab_peers.set_attr_map({None: "tab_inactive"}) - self.tab_pn.set_attr_map({None: "tab_active"}) self.update_widget_list() def list_selection(self, arg1, arg2): From f8775adbabdbd4d9140eac8696a2d2360565986e Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Tue, 18 Feb 2025 20:27:33 +0100 Subject: [PATCH 46/71] Increased announce stream length --- nomadnet/Directory.py | 2 +- nomadnet/ui/textui/Network.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/nomadnet/Directory.py b/nomadnet/Directory.py index 335db63..ee0ef09 100644 --- a/nomadnet/Directory.py +++ b/nomadnet/Directory.py @@ -30,7 +30,7 @@ class PNAnnounceHandler: RNS.log("The contained exception was: "+str(e), RNS.LOG_DEBUG) class Directory: - ANNOUNCE_STREAM_MAXLENGTH = 64 + ANNOUNCE_STREAM_MAXLENGTH = 256 aspect_filter = "nomadnetwork.node" @staticmethod diff --git a/nomadnet/ui/textui/Network.py b/nomadnet/ui/textui/Network.py index bc87f5a..63f00ec 100644 --- a/nomadnet/ui/textui/Network.py +++ b/nomadnet/ui/textui/Network.py @@ -389,7 +389,7 @@ class AnnounceStream(urwid.WidgetWrap): # Create tab buttons self.tab_nodes = TabButton("Nodes", on_press=self.show_nodes_tab) self.tab_peers = TabButton("Peers", on_press=self.show_peers_tab) - self.tab_pn = TabButton("LXMF Propagation Nodes", on_press=self.show_pn_tab) + self.tab_pn = TabButton("Propagation Nodes", on_press=self.show_pn_tab) # Create tab bar with proportional widths self.tab_bar = urwid.Columns([ From 03d1b22b8f537667e45e0380b45210e16651fd5b Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Tue, 18 Feb 2025 21:20:50 +0100 Subject: [PATCH 47/71] Updated dependencies --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 430d07c..a17efae 100644 --- a/setup.py +++ b/setup.py @@ -30,6 +30,6 @@ setuptools.setup( entry_points= { 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, - install_requires=["rns>=0.9.1", "lxmf>=0.6.2", "urwid>=2.6.16", "qrcode"], + install_requires=["rns>=0.9.2", "lxmf>=0.6.2", "urwid>=2.6.16", "qrcode"], python_requires=">=3.7", ) From c280e36a84c5cb3ac6bb60e285b9c53676533a1a Mon Sep 17 00:00:00 2001 From: RFNexus Date: Sun, 9 Mar 2025 15:20:36 -0400 Subject: [PATCH 48/71] Interface Management (1/2) --- nomadnet/ui/TextUI.py | 22 +- nomadnet/ui/textui/Guide.py | 6 + nomadnet/ui/textui/Interfaces.py | 2865 +++++++++++++++++ nomadnet/ui/textui/Main.py | 30 +- nomadnet/vendor/AsciiChart.py | 87 + .../additional_urwid_widgets/FormWidgets.py | 283 ++ 6 files changed, 3280 insertions(+), 13 deletions(-) create mode 100644 nomadnet/ui/textui/Interfaces.py create mode 100644 nomadnet/vendor/AsciiChart.py create mode 100644 nomadnet/vendor/additional_urwid_widgets/FormWidgets.py diff --git a/nomadnet/ui/TextUI.py b/nomadnet/ui/TextUI.py index 3e4b3cf..11dd2c7 100644 --- a/nomadnet/ui/TextUI.py +++ b/nomadnet/ui/TextUI.py @@ -51,7 +51,15 @@ THEMES = { ("browser_controls", "light gray", "default", "default", "#bbb", "default"), ("progress_full", "black", "light gray", "standout", "#111", "#bbb"), ("progress_empty", "light gray", "default", "default", "#ddd", "default"), - ], + ("interface_title", "", "", "default", "", ""), + ("interface_title_selected", "bold", "", "bold", "", ""), + ("connected_status", "dark green", "default", "default", "dark green", "default"), + ("disconnected_status", "dark red", "default", "default", "dark red", "default"), + ("placeholder", "dark gray", "default", "default", "dark gray", "default"), + ("placeholder_text", "dark gray", "default", "default", "dark gray", "default"), + ("error", "light red,blink", "default", "blink", "#f44,blink", "default"), + + ], }, THEME_LIGHT: { "urwid_theme": [ @@ -69,6 +77,7 @@ THEMES = { ("msg_header_ok", "black", "dark green", "standout", "#111", "#6b2"), ("msg_header_caution", "black", "yellow", "standout", "#111", "#fd3"), ("msg_header_sent", "black", "dark gray", "standout", "#111", "#ddd"), + ("msg_header_propagated", "black", "light blue", "standout", "#111", "#28b"), ("msg_header_delivered", "black", "light blue", "standout", "#111", "#28b"), ("msg_header_failed", "black", "dark gray", "standout", "#000", "#777"), ("msg_warning_untrusted", "black", "dark red", "standout", "#111", "dark red"), @@ -86,6 +95,13 @@ THEMES = { ("browser_controls", "dark gray", "default", "default", "#444", "default"), ("progress_full", "black", "dark gray", "standout", "#111", "#bbb"), ("progress_empty", "dark gray", "default", "default", "#ddd", "default"), + ("interface_title", "dark gray", "default", "default", "#444", "default"), + ("interface_title_selected", "dark gray,bold", "default", "bold", "#444,bold", "default"), + ("connected_status", "dark green", "default", "default", "#4a0", "default"), + ("disconnected_status", "dark red", "default", "default", "#a22", "default"), + ("placeholder", "light gray", "default", "default", "#999", "default"), + ("placeholder_text", "light gray", "default", "default", "#999", "default"), + ("error", "dark red,blink", "default", "blink", "#a22,blink", "default"), ], } } @@ -128,6 +144,8 @@ GLYPHS = { ("sent", "/\\", "\u2191", "\U000f0cd8"), ("papermsg", "P", "\u25a4", "\uf719"), ("qrcode", "QR", "\u25a4", "\uf029"), + ("selected", "[*] ", "\u25CF", "\u25CF"), + ("unselected", "[ ] ", "\u25CB", "\u25CB"), } class TextUI: @@ -163,7 +181,7 @@ class TextUI: if self.app.config["textui"]["glyphs"] == "plain": glyphset = "plain" - elif self.app.config["textui"]["glyphs"] == "unicoode": + elif self.app.config["textui"]["glyphs"] == "unicode": glyphset = "unicode" elif self.app.config["textui"]["glyphs"] == "nerdfont": glyphset = "nerdfont" diff --git a/nomadnet/ui/textui/Guide.py b/nomadnet/ui/textui/Guide.py index 6308edc..94f83d0 100644 --- a/nomadnet/ui/textui/Guide.py +++ b/nomadnet/ui/textui/Guide.py @@ -109,6 +109,7 @@ class TopicList(urwid.WidgetWrap): self.topic_list = [ GuideEntry(self.app, self, guide_display, "Introduction"), GuideEntry(self.app, self, guide_display, "Concepts & Terminology"), + GuideEntry(self.app, self, guide_display, "Interfaces"), GuideEntry(self.app, self, guide_display, "Hosting a Node"), GuideEntry(self.app, self, guide_display, "Configuration Options"), GuideEntry(self.app, self, guide_display, "Keyboard Shortcuts"), @@ -386,6 +387,10 @@ Links can be inserted into micron documents. See the `*Markup`* section of this ''' +TOPIC_INTERFACES = ''' +>TODO +''' + TOPIC_CONVERSATIONS = '''>Conversations Conversations in Nomad Network @@ -1247,6 +1252,7 @@ TOPICS = { "Introduction": TOPIC_INTRODUCTION, "Concepts & Terminology": TOPIC_CONCEPTS, "Conversations": TOPIC_CONVERSATIONS, + "Interfaces": TOPIC_INTERFACES, "Hosting a Node": TOPIC_HOSTING, "Configuration Options": TOPIC_CONFIG, "Keyboard Shortcuts": TOPIC_SHORTCUTS, diff --git a/nomadnet/ui/textui/Interfaces.py b/nomadnet/ui/textui/Interfaces.py new file mode 100644 index 0000000..281e505 --- /dev/null +++ b/nomadnet/ui/textui/Interfaces.py @@ -0,0 +1,2865 @@ +import RNS +import time +from math import log10, pow + +from nomadnet.vendor.additional_urwid_widgets.FormWidgets import * +from nomadnet.vendor.AsciiChart import AsciiChart + +### GYLPHS ### +INTERFACE_GLYPHS = { + # Glyph name # Plain # Unicode # Nerd Font + ("NetworkInterfaceType", "(IP)", "\U0001f5a7", "\U000f0200"), + ("SerialInterfaceType", "(<->)", "\u2194", "\U000f065c"), + ("RNodeInterfaceType", "(R)" , "\u16b1", "\U000f043a"), + ("OtherInterfaceType", "(#)" , "\U0001f67e", "\ued95"), +} + +### HELPER ### +def _get_interface_icon(glyphset, iface_type): + glyphset_index = 1 # Default to unicode + if glyphset == "plain": + glyphset_index = 0 # plain + elif glyphset == "nerdfont": + glyphset_index = 2 # nerdfont + + type_to_glyph_tuple = { + "AutoInterface": "NetworkInterfaceType", + "TCPClientInterface": "NetworkInterfaceType", + "TCPServerInterface": "NetworkInterfaceType", + "UDPInterface": "NetworkInterfaceType", + "I2PInterface": "NetworkInterfaceType", + + "RNodeInterface": "RNodeInterfaceType", + "RNodeMultiInterface": "RNodeInterfaceType", + + "SerialInterface": "SerialInterfaceType", + "KISSInterface": "SerialInterfaceType", + "AX25KISSInterface": "SerialInterfaceType", + + "PipeInterface": "OtherInterfaceType" + } + + glyph_tuple_name = type_to_glyph_tuple.get(iface_type, "OtherInterfaceType") + + for glyph_tuple in INTERFACE_GLYPHS: + if glyph_tuple[0] == glyph_tuple_name: + return glyph_tuple[glyphset_index + 1] + + # Fallback + return "(#)" if glyphset == "plain" else "🙾" if glyphset == "unicode" else " " + +def format_bytes(bytes_value): + units = ['bytes', 'KB/s', 'MB/s', 'GB/s', 'TB/s'] + size = float(bytes_value) + unit_index = 0 + + while size >= 1024.0 and unit_index < len(units) - 1: + size /= 1024.0 + unit_index += 1 + + if unit_index == 0: + return f"{int(size)} {units[unit_index]}" + else: + return f"{size:.1f} {units[unit_index]}" + +### PORT FUNCTIONS ### +PYSERIAL_AVAILABLE = False # If NomadNet is installed on environments with rnspure instead of rns, pyserial won't be available +try: + import serial.tools.list_ports + PYSERIAL_AVAILABLE = True +except ImportError: + class DummyPort: + def __init__(self, device, description=None, manufacturer=None, hwid=None): + self.device = device + self.description = description or device + self.manufacturer = manufacturer + self.hwid = hwid + self.vid = None + self.pid = None + +def get_port_info(): + if not PYSERIAL_AVAILABLE: + return [] + + try: + ports = serial.tools.list_ports.comports() + port_info = [] + + # Ports are sorted into categories for dropdown, priority ports appear first + priority_ports = [] # USB, ACM, bluetooth, etc + standard_ports = [] # COM, tty/s ports + + for port in ports: + desc = f"{port.device}" + if port.description and port.description != port.device: + desc += f" ({port.description})" + if port.manufacturer: + desc += f" - {port.manufacturer}" + + is_standard = ( + port.device.startswith("COM") or # windows + "/dev/ttyS" in port.device or # Linux + "Serial" in port.description + ) + + port_data = { + 'device': port.device, + 'description': desc, + 'hwid': port.hwid, + 'vid': port.vid, + 'pid': port.pid, + 'is_standard': is_standard + } + + if is_standard: + standard_ports.append(port_data) + else: + priority_ports.append(port_data) + + priority_ports.sort(key=lambda x: x['device']) + standard_ports.sort(key=lambda x: x['device']) + + return priority_ports + standard_ports + except Exception as e: + RNS.log(f"error accessing serial ports: {str(e)}", RNS.LOG_ERROR) + return [] + +def get_port_field(): + if not PYSERIAL_AVAILABLE: + return { + "config_key": "port", + "type": "edit", + "label": "Port: ", + "default": "", + "placeholder": "/dev/ttyUSB0 or COM port (pyserial not installed)", + "validation": ["required"], + "transform": lambda x: x.strip() + } + + port_info = get_port_info() + + if len(port_info) > 1: + options = [p['description'] for p in port_info] + device_map = {p['description']: p['device'] for p in port_info} + + return { + "config_key": "port", + "type": "dropdown", + "label": "Port: ", + "options": options, + "default": options[0] if options else "", + "validation": ["required"], + "transform": lambda x: device_map[x] + } + else: + # single or no ports - use text field + default = port_info[0]['device'] if port_info else "" + placeholder = "/dev/ttyXXX (or COM port on Windows)" + + return { + "config_key": "port", + "type": "edit", + "label": "Port: ", + "default": default, + "placeholder": placeholder, + "validation": ["required"], + "transform": lambda x: x.strip() + } + +### RNODE #### +def calculate_rnode_parameters(bandwidth, spreading_factor, coding_rate, noise_floor=6, antenna_gain=0, + transmit_power=17): + crn = { + 5: 1, + 6: 2, + 7: 3, + 8: 4, + } + coding_rate_n = crn.get(coding_rate, 1) + + sfn = { + 5: -2.5, + 6: -5, + 7: -7.5, + 8: -10, + 9: -12.5, + 10: -15, + 11: -17.5, + 12: -20 + } + + data_rate = spreading_factor * ( + (4 / (4 + coding_rate_n)) / (pow(2, spreading_factor) / (bandwidth / 1000))) * 1000 + + sensitivity = -174 + 10 * log10(bandwidth) + noise_floor + (sfn.get(spreading_factor, 0)) + + if bandwidth == 203125 or bandwidth == 406250 or bandwidth > 500000: + sensitivity = -165.6 + 10 * log10(bandwidth) + noise_floor + (sfn.get(spreading_factor, 0)) + + link_budget = (transmit_power - sensitivity) + antenna_gain + + if data_rate < 1000: + data_rate_str = f"{data_rate:.0f} bps" + else: + data_rate_str = f"{(data_rate / 1000):.2f} kbps" + + return { + "data_rate": data_rate_str, + "link_budget": f"{link_budget:.1f} dB", + "sensitivity": f"{sensitivity:.1f} dBm", + "raw_data_rate": data_rate, + "raw_link_budget": link_budget, + "raw_sensitivity": sensitivity + } + +class RNodeCalculator(urwid.WidgetWrap): + def __init__(self, parent_view): + self.parent_view = parent_view + self.update_alarm = None + + self.data_rate_widget = urwid.Text("Data Rate: Calculating...") + self.link_budget_widget = urwid.Text("Link Budget: Calculating...") + self.sensitivity_widget = urwid.Text("Sensitivity: Calculating...") + + self.noise_floor_edit = urwid.Edit("", "0") + self.antenna_gain_edit = urwid.Edit("", "0") + + layout = urwid.Pile([ + urwid.Divider("-"), + + urwid.Columns([ + (28, urwid.Text(("key", "Enter Noise Floor (dB): "), align="right")), + self.noise_floor_edit + ]), + + urwid.Columns([ + (28, urwid.Text(("key", "Enter Antenna Gain (dBi): "), align="right")), + self.antenna_gain_edit + ]), + + urwid.Divider(), + + urwid.Text(("connected_status", "On-Air Calculations:"), align="left"), + self.data_rate_widget, + self.link_budget_widget, + self.sensitivity_widget, + urwid.Divider(), + + urwid.Text([ + "These calculations will update as you change RNode parameters" + ]) + ]) + + super().__init__(layout) + + self.connect_all_field_signals() + + self.update_calculation() + + def connect_all_field_signals(self): + urwid.connect_signal(self.noise_floor_edit, 'change', self._queue_update) + urwid.connect_signal(self.antenna_gain_edit, 'change', self._queue_update) + rnode_fields = ['bandwidth', 'spreadingfactor', 'codingrate', 'txpower'] + + for field_name in rnode_fields: + if field_name in self.parent_view.fields: + + field_widget = self.parent_view.fields[field_name]['widget'] + + if hasattr(field_widget, 'edit_text'): + urwid.connect_signal(field_widget, 'change', self._queue_update) + elif hasattr(field_widget, '_emit') and 'change' in getattr(field_widget, 'signals', []): + urwid.connect_signal(field_widget, 'change', self._queue_update) + + def _queue_update(self, widget, new_text): + if self.update_alarm is not None: + try: + self.parent_view.parent.app.ui.loop.remove_alarm(self.update_alarm) + except: + pass + + self.update_alarm = self.parent_view.parent.app.ui.loop.set_alarm_in( + 0.3, self._delayed_update) + + def _delayed_update(self, loop, user_data): + self.update_alarm = None + self.update_calculation() + + def update_calculation(self): + try: + + try: + bandwidth_widget = self.parent_view.fields.get('bandwidth', {}).get('widget') + bandwidth = int(bandwidth_widget.get_value()) if bandwidth_widget else 125000 + except (ValueError, AttributeError): + bandwidth = 125000 + + try: + sf_widget = self.parent_view.fields.get('spreadingfactor', {}).get('widget') + spreading_factor = int(sf_widget.get_value()) if sf_widget else 7 + except (ValueError, AttributeError): + spreading_factor = 7 + + try: + cr_widget = self.parent_view.fields.get('codingrate', {}).get('widget') + coding_rate = int(cr_widget.get_value()) if cr_widget else 5 + if isinstance(coding_rate, str) and ":" in coding_rate: + coding_rate = int(coding_rate.split(":")[1]) + except (ValueError, AttributeError): + coding_rate = 5 + + try: + txpower_widget = self.parent_view.fields.get('txpower', {}).get('widget') + if hasattr(txpower_widget, 'edit_text'): + txpower_text = txpower_widget.edit_text.strip() + txpower = int(txpower_text) if txpower_text else 17 + else: + txpower = int(txpower_widget.get_value()) if txpower_widget else 17 + except (ValueError, AttributeError): + txpower = 17 + + try: + noise_floor_text = self.noise_floor_edit.edit_text.strip() + noise_floor = int(noise_floor_text) if noise_floor_text else 0 + except (ValueError, AttributeError): + noise_floor = 0 + + try: + antenna_gain_text = self.antenna_gain_edit.edit_text.strip() + antenna_gain = int(antenna_gain_text) if antenna_gain_text else 0 + except (ValueError, AttributeError): + antenna_gain = 0 + + result = calculate_rnode_parameters( + bandwidth=bandwidth, + spreading_factor=spreading_factor, + coding_rate=coding_rate, + noise_floor=noise_floor, + antenna_gain=antenna_gain, + transmit_power=txpower + ) + + self.data_rate_widget.set_text(f"Data Rate: {result['data_rate']}") + self.link_budget_widget.set_text(f"Link Budget: {result['link_budget']}") + self.sensitivity_widget.set_text(f"Sensitivity: {result['sensitivity']}") + + except (ValueError, KeyError, TypeError) as e: + self.data_rate_widget.set_text(f"Data Rate: Waiting for parameters...") + self.link_budget_widget.set_text(f"Link Budget: Waiting for valid parameters...") + self.sensitivity_widget.set_text(f"Sensitivity: Waiting for parameters...") + +### INTERFACE FIELDS ### +COMMON_INTERFACE_OPTIONS = [ + { + "config_key": "network_name", + "type": "edit", + "label": "Virtual Network Name: ", + "placeholder": "Optional virtual network name", + "default": "", + "validation": [], + "transform": lambda x: x.strip() + }, + { + "config_key": "passphrase", + "type": "edit", + "label": "IFAC Passphrase: ", + "placeholder": "IFAC authentication passphrase", + "default": "", + "validation": [], + "transform": lambda x: x.strip() + }, + { + "config_key": "ifac_size", + "type": "edit", + "label": "IFAC Size: ", + "placeholder": "8 - 512", + "default": "", + "validation": ['number'], + "transform": lambda x: x.strip() + }, + { + "config_key": "bitrate", + "type": "edit", + "label": "Inferred Bitrate: ", + "placeholder": "Automatically determined", + "default": "", + "validation": ['number'], + "transform": lambda x: x.strip() + }, +] + +INTERFACE_FIELDS = { + "AutoInterface": [ + { + + }, + { + "additional_options": [ + { + "config_key": "devices", + "type": "multilist", + "label": "Devices: ", + "validation": [], + "transform": lambda x: ",".join(x) + }, + { + "config_key": "ignored_devices", + "type": "multilist", + "label": "Ignored Devices: ", + "validation": [], + "transform": lambda x: ",".join(x) + }, + { + "config_key": "group_id", + "type": "edit", + "label": "Group ID: ", + "default": "", + "placeholder": "e.g., my_custom_network", + "validation": [], + "transform": lambda x: x.strip() + }, + { + "config_key": "discovery_scope", + "type": "dropdown", + "label": "Discovery Scope: ", + "options": ["None", "link", "admin", "site", "organisation", "global"], + "default": "None", + "validation": [], + "transform": lambda x: "" if x == "None" else x.strip() + } + ] + }, + ], + "I2PInterface": [ + { + "config_key": "peers", + "type": "multilist", + "label": "Peers: ", + "placeholder": "", + "validation": ["required"], + "transform": lambda x: ",".join(x) + } + ], + "TCPServerInterface": [ + { + "config_key": "listen_ip", + "type": "edit", + "label": "Listen IP: ", + "default": "", + "placeholder": "e.g., 0.0.0.0", + "validation": ["required"], + "transform": lambda x: x.strip() + }, + { + "config_key": "listen_port", + "type": "edit", + "label": "Listen Port: ", + "default": "", + "placeholder": "e.g., 4242", + "validation": ["required", "number"], + "transform": lambda x: int(x.strip()) if x.strip() else 4242 + }, + { + "additional_options": [ + { + "config_key": "prefer_ipv6", + "type": "checkbox", + "label": "Prefer IPv6?", + "default": False, + "validation": [], + "transform": lambda x: bool(x) + }, + { + "config_key": "i2p_tunneled", + "type": "checkbox", + "label": "I2P Tunneled?", + "default": False, + "validation": [], + "transform": lambda x: bool(x) + }, + { + "config_key": "device", + "type": "edit", + "label": "Device: ", + "placeholder": "A specific network device to listen on - e.g. eth0", + "default": "", + "validation": [], + "transform": lambda x: x.strip() + }, + { + "config_key": "port", + "type": "edit", + "label": "Port: ", + "default": "", + "placeholder": "e.g., 4242", + "validation": ["number"], + "transform": lambda x: int(x.strip()) if x.strip() else 4242 + }, + ] + } + ], + "TCPClientInterface": [ + { + "config_key": "target_host", + "type": "edit", + "label": "Target Host: ", + "default": "", + "placeholder": "e.g., 127.0.0.1", + "validation": ["required"], + "transform": lambda x: x.strip() + }, + { + "config_key": "target_port", + "type": "edit", + "label": "Target Port: ", + "default": "", + "placeholder": "e.g., 8080", + "validation": ["required", "number"], + "transform": lambda x: int(x.strip()) if x.strip() else 4242 + }, + { + "additional_options": [ + { + "config_key": "i2p_tunneled", + "type": "checkbox", + "label": "I2P Tunneled?", + "default": False, + "validation": [], + "transform": lambda x: bool(x) + }, + { + "config_key": "kiss_framing", + "type": "checkbox", + "label": "KISS Framing?", + "default": False, + "validation": [], + "transform": lambda x: bool(x) + } + ] + } + ], + "UDPInterface": [ + { + "config_key": "listen_ip", + "type": "edit", + "label": "Listen IP: ", + "default": "", + "placeholder": "e.g., 0.0.0.0", + "validation": ["required"], + "transform": lambda x: x.strip() + }, + { + "config_key": "listen_port", + "type": "edit", + "label": "Listen Port: ", + "default": "", + "placeholder": "e.g., 4242", + "validation": ["required", "number"], + "transform": lambda x: int(x.strip()) if x.strip() else 4242 + }, + { + "config_key": "forward_ip", + "type": "edit", + "label": "Forward IP: ", + "default": "", + "placeholder": "e.g., 255.255.255.255", + "validation": ["required"], + "transform": lambda x: x.strip() + }, + { + "config_key": "forward_port", + "type": "edit", + "label": "Forward Port: ", + "default": "", + "placeholder": "e.g., 4242", + "validation": ["required", "number"], + "transform": lambda x: int(x.strip()) if x.strip() else 4242 + }, + { + "additional_options": [ + { + "config_key": "device", + "type": "edit", + "label": "Device: ", + "placeholder": "A specific network device to listen on - e.g. eth0", + "default": "", + "validation": [], + "transform": lambda x: x.strip() + }, + { + "config_key": "port", + "type": "edit", + "label": "Port: ", + "default": "", + "placeholder": "e.g., 4242", + "validation": ["number"], + "transform": lambda x: int(x.strip()) if x.strip() else 4242 + }, + ] + } + ], + "RNodeInterface": [ + get_port_field(), + { + "config_key": "frequency", + "type": "edit", + "label": "Frequency (MHz): ", + "default": "", + "placeholder": "868.5", + "validation": ["required", "float"], + "transform": lambda x: int(float(x.strip()) * 1000000) if x.strip() else 868500000 + }, + { + "config_key": "txpower", + "type": "edit", + "label": "Transmit Power (dBm): ", + "default": "", + "placeholder": "17", + "validation": ["required", "number"], + "transform": lambda x: int(x.strip()) if x.strip() else 17 + }, + { + "config_key": "bandwidth", + "type": "dropdown", + "label": "Bandwidth (Hz): ", + "options": ["7800", "10400", "15600", "20800", "31250", "41700", "62500", "125000", "250000", + "500000", "1625000"], + "default": "7800", + "validation": ["required"], + "transform": lambda x: int(x) + }, + { + "config_key": "spreadingfactor", + "type": "dropdown", + "label": "Spreading Factor: ", + "options": ["7", "8", "9", "10", "11", "12"], + "default": "7", + "validation": ["required"], + "transform": lambda x: int(x) + }, + { + "config_key": "codingrate", + "type": "dropdown", + "label": "Coding Rate: ", + "options": ["4:5", "4:6", "4:7", "4:8"], + "default": "4:5", + "validation": ["required"], + "transform": lambda x: int(x.split(":")[1]) + }, + { + "additional_options": [ + { + "config_key": "id_callsign", + "type": "edit", + "label": "Callsign: ", + "default": "", + "placeholder": "e.g. MYCALL-0", + "validation": [""], + "transform": lambda x: x.strip() + }, + { + "config_key": "id_interval", + "type": "edit", + "label": "ID Interval (Seconds): ", + "placeholder": "e.g. 600", + "default": "", + "validation": ['number'], + "transform": lambda x: "" if x == "" else int(x) + }, + { + "config_key": "airtime_limit_long", + "type": "edit", + "label": "Airtime Limit Long (Seconds): ", + "placeholder": "e.g. 1.5", + "default": "", + "validation": ['number'], + "transform": lambda x: "" if x == "" else int(x) + }, + { + "config_key": "airtime_limit_short", + "type": "edit", + "label": "Airtime Limit Short (Seconds): ", + "placeholder": "e.g. 33", + "default": "", + "validation": ['number'], + "transform": lambda x: "" if x == "" else int(x) + }, + ] + } + ], + "SerialInterface": [ + get_port_field(), + { + "config_key": "speed", + "type": "edit", + "label": "Speed (bps): ", + "default": "", + "placeholder": "e.g. 115200", + "validation": ["required", "number"], + "transform": lambda x: int(x.strip()) + }, + { + "config_key": "databits", + "type": "edit", + "label": "Databits: ", + "default": "", + "placeholder": "e.g. 8", + "validation": ["required", "number"], + "transform": lambda x: int(x.strip()) + }, + { + "config_key": "parity", + "type": "edit", + "label": "Parity: ", + "default": "", + "placeholder": "", + "validation": ["number"], + "transform": lambda x: "" if x == "" else int(x.strip()) + }, + { + "config_key": "stopbits", + "type": "edit", + "label": "Stopbits: ", + "default": "", + "placeholder": "e.g. 1", + "validation": ["number"], + "transform": lambda x: "" if x == "" else int(x.strip()) + }, + ], + "PipeInterface": [ + { + "config_key": "command", + "type": "edit", + "label": "Command: ", + "default": "", + "placeholder": "e.g. netcat -l 5757", + "validation": ["required"], + "transform": lambda x: x.strip() + }, + { + "config_key": "respawn_delay", + "type": "edit", + "label": "Respawn Delay (seconds): ", + "default": "", + "placeholder": "e.g. 5", + "validation": ["number"], + "transform": lambda x: x.strip() + }, + ], + "KISSInterface": [ + get_port_field(), + { + "config_key": "speed", + "type": "edit", + "label": "Speed (bps): ", + "default": "", + "placeholder": "e.g. 115200", + "validation": ["required", "number"], + "transform": lambda x: int(x.strip()) + }, + { + "config_key": "databits", + "type": "edit", + "label": "Databits: ", + "default": "", + "placeholder": "e.g. 8", + "validation": ["required", "number"], + "transform": lambda x: int(x.strip()) + }, + { + "config_key": "parity", + "type": "edit", + "label": "Parity: ", + "default": "", + "placeholder": "", + "validation": ["number"], + "transform": lambda x: "" if x == "" else int(x.strip()) + }, + { + "config_key": "stopbits", + "type": "edit", + "label": "Stopbits: ", + "default": "", + "placeholder": "e.g. 1", + "validation": ["number"], + "transform": lambda x: "" if x == "" else int(x.strip()) + }, + { + "config_key": "preamble", + "type": "edit", + "label": "Preamble (miliseconds): ", + "default": "", + "placeholder": "e.g. 150", + "validation": ["required", "number"], + "transform": lambda x: "" if x == "" else int(x.strip()) + }, + { + "config_key": "txtail", + "type": "edit", + "label": "TX Tail (miliseconds): ", + "default": "", + "placeholder": "e.g. 10", + "validation": ["required", "number"], + "transform": lambda x: "" if x == "" else int(x.strip()) + }, + { + "config_key": "slottime", + "type": "edit", + "label": "slottime (miliseconds): ", + "default": "", + "placeholder": "e.g. 20", + "validation": ["required", "number"], + "transform": lambda x: "" if x == "" else int(x.strip()) + }, + { + "config_key": "persistence", + "type": "edit", + "label": "Persistence (miliseconds): ", + "default": "", + "placeholder": "e.g. 200", + "validation": ["required", "number"], + "transform": lambda x: "" if x == "" else int(x.strip()) + }, + { + "additional_options": [ + { + "config_key": "id_callsign", + "type": "edit", + "label": "ID Callsign: ", + "default": "", + "placeholder": "e.g. MYCALL-0", + "validation": [""], + "transform": lambda x: x.strip() + }, + { + "config_key": "id_interval", + "type": "edit", + "label": "ID Interval (Seconds): ", + "placeholder": "e.g. 600", + "default": "", + "validation": ['number'], + "transform": lambda x: "" if x == "" else int(x) + }, + { + "config_key": "flow_control", + "type": "checkbox", + "label": "Flow Control ", + "validation": [], + "transform": lambda x: "" if x == "" else bool(x) + }, + ] + } + ], + "AX25KISSInterface": [ + get_port_field(), + { + "config_key": "callsign", + "type": "edit", + "label": "Callsign: ", + "default": "", + "placeholder": "e.g. NO1CLL", + "validation": ["required"], + "transform": lambda x: x.strip() + }, + { + "config_key": "ssid", + "type": "edit", + "label": "SSID: ", + "default": "", + "placeholder": "e.g. 0", + "validation": ["required"], + "transform": lambda x: x.strip() + }, + { + "config_key": "speed", + "type": "edit", + "label": "Speed (bps): ", + "default": "", + "placeholder": "e.g. 115200", + "validation": ["required", "number"], + "transform": lambda x: int(x.strip()) + }, + { + "config_key": "databits", + "type": "edit", + "label": "Databits: ", + "default": "", + "placeholder": "e.g. 8", + "validation": ["required", "number"], + "transform": lambda x: int(x.strip()) + }, + { + "config_key": "parity", + "type": "edit", + "label": "Parity: ", + "default": "", + "placeholder": "", + "validation": ["number"], + "transform": lambda x: "" if x == "" else int(x.strip()) + }, + { + "config_key": "stopbits", + "type": "edit", + "label": "Stopbits: ", + "default": "", + "placeholder": "e.g. 1", + "validation": ["number"], + "transform": lambda x: "" if x == "" else int(x.strip()) + }, + { + "config_key": "preamble", + "type": "edit", + "label": "Preamble (miliseconds): ", + "default": "", + "placeholder": "e.g. 150", + "validation": ["required", "number"], + "transform": lambda x: "" if x == "" else int(x.strip()) + }, + { + "config_key": "txtail", + "type": "edit", + "label": "TX Tail (miliseconds): ", + "default": "", + "placeholder": "e.g. 10", + "validation": ["required", "number"], + "transform": lambda x: "" if x == "" else int(x.strip()) + }, + { + "config_key": "slottime", + "type": "edit", + "label": "Slottime (miliseconds): ", + "default": "", + "placeholder": "e.g. 20", + "validation": ["required", "number"], + "transform": lambda x: "" if x == "" else int(x.strip()) + }, + { + "config_key": "persistence", + "type": "edit", + "label": "Persistence (miliseconds): ", + "default": "", + "placeholder": "e.g. 200", + "validation": ["required", "number"], + "transform": lambda x: "" if x == "" else int(x.strip()) + }, + { + "additional_options": [ + { + "config_key": "flow_control", + "type": "checkbox", + "label": "Flow Control ", + "validation": [], + "transform": lambda x: "" if x == "" else bool(x) + }, + ] + } + ], + "default": [ + { + + }, + ] +} + +### INTERFACE WIDGETS #### +class SelectableInterfaceItem(urwid.WidgetWrap): + def __init__(self, parent, name, is_connected, is_enabled, iface_type, tx, rx, icon="?", iface_options=None): + self.parent = parent + self._selectable = True + self.icon = icon + self.name = name + self.is_connected = is_connected + self.is_enabled = is_enabled + self.iface_options = iface_options + + + if is_enabled: + enabled_txt = ("connected_status", "Enabled") + else: + enabled_txt = ("disconnected_status", "Disabled") + + if is_connected: + connected_txt = ("connected_status", "Connected") + else: + connected_txt = ("disconnected_status", "Disconnected") + + self.selection_txt = urwid.Text(" ") + self.title_widget = urwid.Text(("interface_title", f"{icon} {name}")) + + title_content = urwid.Columns([ + (4, self.selection_txt), + self.title_widget, + ]) + + self.tx_widget = urwid.Text(("value", format_bytes(tx))) + self.rx_widget = urwid.Text(("value", format_bytes(rx))) + + self.status_widget = urwid.Text(enabled_txt) + self.connection_widget = urwid.Text(connected_txt) + + rows = [ + urwid.Columns([ + (10, urwid.Text(("key", "Status: "))), + (10, self.status_widget), + (3, urwid.Text(" | ")), + self.connection_widget, + ]), + + urwid.Columns([ + (10, urwid.Text(("key", "Type:"))), + urwid.Text(("value", iface_type)), + ]), + + urwid.Divider("-"), + + urwid.Columns([ + (10, urwid.Text(("key", "TX:"))), + (15, self.tx_widget), + (10, urwid.Text(("key", "RX:"))), + self.rx_widget, + ]), + ] + + pile_contents = [title_content] + rows + + pile = urwid.Pile(pile_contents) + + padded_body = urwid.Padding(pile, left=2, right=2) + + box = urwid.LineBox( + padded_body, + title=None, + #todo + tlcorner="╭", tline="─", + trcorner="╮", lline="│", + rline="│", blcorner="╰", + bline="─", brcorner="╯" + ) + + super().__init__(box) + + def update_status_display(self): + if self.is_enabled: + self.status_widget.set_text(("connected_status", "Enabled")) + else: + self.status_widget.set_text(("disconnected_status", "Disabled")) + + def selectable(self): + return True + + def render(self, size, focus=False): + self.selection_txt.set_text(self.parent.g['selected'] if focus else self.parent.g['unselected']) + + if focus: + self.title_widget.set_text( + ("interface_title_selected", f"{self.icon} {self.name}")) + else: + self.title_widget.set_text(("interface_title", f"{self.icon} {self.name}")) + + return super().render(size, focus=focus) + + def keypress(self, size, key): + if key == "enter": + self.parent.switch_to_show_interface(self.name) + return None + return key + + def update_stats(self, tx, rx): + self.tx_widget.set_text(("value", format_bytes(tx))) + self.rx_widget.set_text(("value", format_bytes(rx))) + +class InterfaceOptionItem(urwid.WidgetWrap): + def __init__(self, parent_display, label, value): + self.parent_display = parent_display + self.label = label + self.value = value + self._selectable = True + + text_widget = urwid.Text(label, align="left") + super().__init__(urwid.AttrMap(text_widget, "list_normal", focus_map="list_focus")) + + def selectable(self): + return True + + def keypress(self, size, key): + if key == "enter": + self.parent_display.dismiss_dialog() + self.parent_display.switch_to_add_interface(self.value) + return None + return super().keypress(size, key) + +class InterfaceBandwidthChart: + + def __init__(self, history_length=60, glyphset="unicode"): + self.history_length = history_length + self.glyphset = glyphset + self.rx_rates = [0] * history_length + self.tx_rates = [0] * history_length + + self.prev_rx = None + self.prev_tx = None + self.prev_time = None + + self.max_rx_rate = 1 + self.max_tx_rate = 1 + + self.first_update = True + self.initialization_complete = False + self.stabilization_updates = 2 + self.update_count = 0 + + self.peak_rx_for_display = 0 + self.peak_tx_for_display = 0 + + def update(self, rx_bytes, tx_bytes): + current_time = time.time() + + if self.prev_rx is None or self.first_update: + self.prev_rx = rx_bytes + self.prev_tx = tx_bytes + self.prev_time = current_time + self.first_update = False + return + + time_delta = max(0.1, current_time - self.prev_time) + + rx_delta = max(0, rx_bytes - self.prev_rx) / time_delta + tx_delta = max(0, tx_bytes - self.prev_tx) / time_delta + + self.prev_rx = rx_bytes + self.prev_tx = tx_bytes + self.prev_time = current_time + + self.update_count += 1 + + self.rx_rates.pop(0) + self.tx_rates.pop(0) + self.rx_rates.append(rx_delta) + self.tx_rates.append(tx_delta) + + if self.update_count >= self.stabilization_updates: + self.initialization_complete = True + + self.peak_rx_for_display = max(self.peak_rx_for_display, rx_delta) + self.peak_tx_for_display = max(self.peak_tx_for_display, tx_delta) + + + current_rx_max = max(self.rx_rates) + current_tx_max = max(self.tx_rates) + + self.max_rx_rate = max(1, current_rx_max) + self.max_tx_rate = max(1, current_tx_max) + + def get_charts(self, height=8): + chart = AsciiChart(glyphset=self.glyphset) + + rx_data = self.rx_rates.copy() + tx_data = self.tx_rates.copy() + + peak_rx = self.peak_rx_for_display if self.initialization_complete else 0 + peak_tx = self.peak_tx_for_display if self.initialization_complete else 0 + + peak_rx_str = format_bytes(peak_rx) + peak_tx_str = format_bytes(peak_tx) + + rx_chart = chart.plot( + [rx_data], + { + 'height': height, + 'format': '{:8.1f}', + 'min': 0, + 'max': self.max_rx_rate * 1.1, + } + ) + + tx_chart = chart.plot( + [tx_data], + { + 'height': height, + 'format': '{:8.1f}', + 'min': 0, + 'max': self.max_tx_rate * 1.1, + } + ) + + return rx_chart, tx_chart, peak_rx_str, peak_tx_str + + +class ResponsiveChartContainer(urwid.WidgetWrap): + + def __init__(self, rx_box, tx_box, min_cols_for_horizontal=100): + self.rx_box = rx_box + self.tx_box = tx_box + self.min_cols_for_horizontal = min_cols_for_horizontal + + self.horizontal_layout = urwid.Columns([ + (urwid.WEIGHT, 1, self.rx_box), + (urwid.WEIGHT, 1, self.tx_box) + ]) + + self.vertical_layout = urwid.Pile([ + self.rx_box, + self.tx_box + ]) + + self.layout = urwid.WidgetPlaceholder(self.horizontal_layout) + + super().__init__(self.layout) + + def render(self, size, focus=False): + maxcol = size[0] if len(size) > 0 else 0 + + if maxcol >= self.min_cols_for_horizontal and self.layout.original_widget is not self.horizontal_layout: + self.layout.original_widget = self.horizontal_layout + elif maxcol < self.min_cols_for_horizontal and self.layout.original_widget is not self.vertical_layout: + self.layout.original_widget = self.vertical_layout + + return super().render(size, focus) + +### URWID FILLER ### +class InterfaceFiller(urwid.WidgetWrap): + def __init__(self, widget, app): + self.app = app + self.filler = urwid.Filler(widget, urwid.TOP) + super().__init__(self.filler) + + def keypress(self, size, key): + if key == "ctrl a": + # add interface + self.app.ui.main_display.sub_displays.interface_display.add_interface() + return + elif key == "ctrl x": + # remove Interface + self.app.ui.main_display.sub_displays.interface_display.remove_selected_interface() + return + elif key == "ctrl e": + # edit interface + self.app.ui.main_display.sub_displays.interface_display.edit_selected_interface() + return None + elif key == "tab": + # navigation + self.app.ui.main_display.frame.focus_position = "header" + return + + return super().keypress(size, key) + +### VIEWS ### +class AddInterfaceView(urwid.WidgetWrap): + def __init__(self, parent, iface_type): + self.parent = parent + self.iface_type = iface_type + self.fields = {} + self.port_pile = None + self.additional_fields = {} + self.additional_pile_contents = [] + self.common_fields = {} + + self.parent.shortcuts_display.set_add_interface_shortcuts() + + name_field = FormEdit( + config_key="name", + placeholder="Enter interface name", + validation_types=["required"] + ) + self.fields['name'] = { + 'label': "Name: ", + 'widget': name_field + } + + config = INTERFACE_FIELDS.get(iface_type, INTERFACE_FIELDS["default"]) + iface_fields = [field for field in config if "config_key" in field] + + for field in iface_fields: + self._initialize_field(field) + + self._initialize_additional_fields(config) + + self._initialize_common_fields() + + pile_items = self._build_form_layout(iface_fields) + + form_pile = urwid.Pile(pile_items) + form_filler = urwid.Filler(form_pile, valign="top") + #todo + form_box = urwid.LineBox( + form_filler, + title="Add Interface", + tlcorner="╭", tline="─", + trcorner="╮", lline="│", + rline="│", blcorner="╰", + bline="─", brcorner="╯" + ) + + background = urwid.SolidFill(" ") + self.overlay = urwid.Overlay( + top_w=form_box, + bottom_w=background, + align='center', + width=('relative', 85), + valign='middle', + height=('relative', 85), + + ) + super().__init__(self.overlay) + + def _initialize_field(self, field): + if field["type"] == "dropdown": + widget = FormDropdown( + config_key=field["config_key"], + label=field["label"], + options=field["options"], + default=field.get("default"), + validation_types=field.get("validation", []), + transform=field.get("transform") + ) + elif field["type"] == "checkbox": + widget = FormCheckbox( + config_key=field["config_key"], + label=field["label"], + state=field.get("default", False), + validation_types=field.get("validation", []), + transform=field.get("transform") + ) + elif field["type"] == "multilist": + widget = FormMultiList( + config_key=field["config_key"], + placeholder=field.get("placeholder", ""), + validation_types=field.get("validation", []), + transform=field.get("transform") + ) + else: + widget = FormEdit( + config_key=field["config_key"], + caption="", + edit_text=field.get("default", ""), + placeholder=field.get("placeholder", ""), + validation_types=field.get("validation", []), + transform=field.get("transform") + ) + + self.fields[field["config_key"]] = { + 'label': field["label"], + 'widget': widget + } + + def _initialize_additional_fields(self, config): + for field in config: + if isinstance(field, dict) and "additional_options" in field: + for option in field["additional_options"]: + if option["type"] == "checkbox": + widget = FormCheckbox( + config_key=option["config_key"], + label=option["label"], + state=option.get("default", False), + validation_types=option.get("validation", []), + transform=option.get("transform") + ) + elif option["type"] == "dropdown": + widget = FormDropdown( + config_key=option["config_key"], + label=option["label"], + options=option["options"], + default=option.get("default"), + validation_types=option.get("validation", []), + transform=option.get("transform") + ) + elif option["type"] == "multilist": + widget = FormMultiList( + config_key=option["config_key"], + placeholder=option.get("placeholder", ""), + validation_types=option.get("validation", []), + transform=option.get("transform") + ) + else: + widget = FormEdit( + config_key=option["config_key"], + caption="", + edit_text=str(option.get("default", "")), + placeholder=option.get("placeholder", ""), + validation_types=option.get("validation", []), + transform=option.get("transform") + ) + + self.additional_fields[option["config_key"]] = { + 'label': option["label"], + 'widget': widget, + 'type': option["type"] + } + + def _initialize_common_fields(self): + + if self.parent.app.rns.transport_enabled(): + # Transport mode options + COMMON_INTERFACE_OPTIONS.extend([ + { + "config_key": "outgoing", + "type": "checkbox", + "label": "Allow outgoing traffic", + "default": True, + "validation": [], + "transform": lambda x: bool(x) + }, + { + "config_key": "mode", + "type": "dropdown", + "label": "Interface Mode: ", + "options": ["full", "gateway", "access_point", "roaming", "boundary"], + "default": "full", + "validation": [], + "transform": lambda x: x + }, + { + "config_key": "announce_cap", + "type": "edit", + "label": "Announce Cap: ", + "placeholder": "Default: 2.0", + "default": "", + "validation": ["float"], + "transform": lambda x: float(x) if x.strip() else 2.0 + } + ]) + + for option in COMMON_INTERFACE_OPTIONS: + if option["type"] == "checkbox": + widget = FormCheckbox( + config_key=option["config_key"], + label=option["label"], + state=option.get("default", False), + validation_types=option.get("validation", []), + transform=option.get("transform") + ) + elif option["type"] == "dropdown": + widget = FormDropdown( + config_key=option["config_key"], + label=option["label"], + options=option["options"], + default=option.get("default"), + validation_types=option.get("validation", []), + transform=option.get("transform") + ) + else: + widget = FormEdit( + config_key=option["config_key"], + caption="", + edit_text=str(option.get("default", "")), + placeholder=option.get("placeholder", ""), + validation_types=option.get("validation", []), + transform=option.get("transform") + ) + + + + self.common_fields[option["config_key"]] = { + 'label': option["label"], + 'widget': widget, + 'type': option["type"] + } + + def _on_rnode_field_change(self, widget, new_value): + if hasattr(self, 'rnode_calculator') and self.calculator_visible: + self.rnode_calculator.update_calculation() + + def _build_form_layout(self, iface_fields): + pile_items = [] + pile_items.append(urwid.Text(("form_title", f"Add new {_get_interface_icon(self.parent.glyphset, self.iface_type)} {self.iface_type}"), align="center")) + pile_items.append(urwid.Divider("─")) + + for key in ["name"] + [f["config_key"] for f in iface_fields]: + field = self.fields[key] + widget = field["widget"] + + field_pile = urwid.Pile([ + urwid.Columns([ + (26, urwid.Text(("key", field["label"]), align="right")), + widget, + ]), + urwid.Padding(widget.error_widget, left=24) + ]) + + if self.iface_type in ["RNodeInterface", "SerialInterface", "AX25KISSInterface", "KISSInterface"] and key == "port": + refresh_btn = urwid.Button("Refresh Ports", on_press=self.refresh_ports) + refresh_btn = urwid.AttrMap(refresh_btn, "button_normal", focus_map="button_focus") + refresh_row = urwid.Padding(refresh_btn, left=26, width=20) + field_pile.contents.append((refresh_row, field_pile.options())) + self.port_pile = field_pile + + pile_items.append(field_pile) + + self.more_options_visible = False + self.more_options_button = urwid.Button("Show more options", on_press=self.toggle_more_options) + self.more_options_button = urwid.AttrMap(self.more_options_button, "button_normal", focus_map="button_focus") + self.more_options_widget = urwid.Pile([]) + + self.ifac_options_visible = False + self.ifac_options_button = urwid.Button("Show IFAC options", on_press=self.toggle_ifac_options) + self.ifac_options_button = urwid.AttrMap(self.ifac_options_button, "button_normal", focus_map="button_focus") + self.ifac_options_widget = urwid.Pile([]) + + if self.iface_type == "RNodeInterface": + self.calculator_button = urwid.Button("Show On-Air Calculations", on_press=self.toggle_calculator) + self.calculator_button = urwid.AttrMap(self.calculator_button, "button_normal", focus_map="button_focus") + + save_btn = urwid.Button("Save", on_press=self.on_save) + back_btn = urwid.Button("Cancel", on_press=self.on_back) + button_row = urwid.Columns([ + (urwid.WEIGHT, 0.45, save_btn), + (urwid.WEIGHT, 0.1, urwid.Text("")), + (urwid.WEIGHT, 0.45, back_btn), + ]) + + pile_items.extend([ + urwid.Divider(), + self.more_options_button, + self.more_options_widget, + ]) + if self.iface_type == "RNodeInterface": + self.rnode_calculator = RNodeCalculator(self) + self.calculator_visible = False + self.calculator_widget = urwid.Pile([]) + pile_items.extend([ + self.calculator_button, + self.calculator_widget, + ]) + pile_items.extend([ + urwid.Divider("─"), + button_row, + ]) + + return pile_items + + def toggle_more_options(self, button): + if self.more_options_visible: + self.more_options_widget.contents = [] + button.base_widget.set_label("Show more options") + self.more_options_visible = False + else: + pile_contents = [] + + if self.additional_fields: + for key, field in self.additional_fields.items(): + widget = field['widget'] + + if field['type'] == "checkbox": + centered_widget = urwid.Columns([ + ('weight', 1, urwid.Text("")), + ('pack', widget), + ('weight', 1, urwid.Text("")) + ]) + field_pile = urwid.Pile([ + centered_widget, + urwid.Padding(widget.error_widget, left=24) + ]) + else: + field_pile = urwid.Pile([ + urwid.Columns([ + (26, urwid.Text(("key", field["label"]), align="right")), + widget + ]), + urwid.Padding(widget.error_widget, left=24) + ]) + + pile_contents.append(field_pile) + + if self.additional_fields and self.common_fields: + pile_contents.append(urwid.Divider("─")) + + if self.common_fields: + # pile_contents.append(urwid.Text(("interface_title", "Common "), align="center")) + for key, field in self.common_fields.items(): + widget = field['widget'] + + if field['type'] == "checkbox": + centered_widget = urwid.Columns([ + ('weight', 1, urwid.Text("")), + ('pack', widget), + ('weight', 1, urwid.Text("")) + ]) + field_pile = urwid.Pile([ + centered_widget, + urwid.Padding(widget.error_widget, left=24) + ]) + else: + field_pile = urwid.Pile([ + urwid.Columns([ + (26, urwid.Text(("key", field["label"]), align="right")), + widget + ]), + urwid.Padding(widget.error_widget, left=24) + ]) + + pile_contents.append(field_pile) + + if pile_contents: + self.more_options_widget.contents = [(w, self.more_options_widget.options()) for w in pile_contents] + else: + self.more_options_widget.contents = [( + urwid.Text("No additional options available", align="center"), + self.more_options_widget.options() + )] + + button.base_widget.set_label("Hide more options") + self.more_options_visible = True + + def toggle_ifac_options(self, button): + if self.ifac_options_visible: + self.ifac_options_widget.contents = [] + button.base_widget.set_label("Show IFAC options") + self.ifac_options_visible = False + else: + dummy = urwid.Text("IFAC (Interface Access Codes)", align="left") + self.ifac_options_widget.contents = [(dummy, self.more_options_widget.options())] + button.base_widget.set_label("Hide IFAC options") + self.ifac_options_visible = True + + def toggle_calculator(self, button): + if self.calculator_visible: + self.calculator_widget.contents = [] + button.base_widget.set_label("Show On-Air Calculations") + self.calculator_visible = False + else: + calculator_contents = [self.rnode_calculator] + + self.calculator_widget.contents = [(w, self.calculator_widget.options()) for w in calculator_contents] + + self.rnode_calculator.update_calculation() + + button.base_widget.set_label("Hide On-Air Calculations") + self.calculator_visible = True + + def refresh_ports(self, button): + if self.port_pile is not None: + # Get fresh port config + port_field = get_port_field() + + if port_field["type"] == "dropdown": + widget = FormDropdown( + config_key=port_field["config_key"], + label=port_field["label"], + options=port_field["options"], + default=port_field.get("default"), + validation_types=port_field.get("validation", []), + transform=port_field.get("transform") + ) + else: + widget = FormEdit( + config_key=port_field["config_key"], + caption="", + edit_text=port_field.get("default", ""), + placeholder=port_field.get("placeholder", ""), + validation_types=port_field.get("validation", []), + transform=port_field.get("transform") + ) + + self.fields["port"] = { + 'label': port_field["label"], + 'widget': widget + } + + columns = urwid.Columns([ + (26, urwid.Text(("key", port_field["label"]), align="right")), + widget + ]) + self.port_pile.contents[0] = (columns, self.port_pile.options()) + + self.port_pile.contents[1] = (urwid.Padding(widget.error_widget, left=24), self.port_pile.options()) + + def validate_all(self): + all_valid = True + + # validate main fields + for field in self.fields.values(): + if not field["widget"].validate(): + all_valid = False + + # validate additional iface fields + for field in self.additional_fields.values(): + if not field["widget"].validate(): + all_valid = False + + # validate common fields + for field in self.common_fields.values(): + if not field["widget"].validate(): + all_valid = False + + return all_valid + + def on_save(self, button): + all_valid = self.validate_all() + + name = self.fields['name']["widget"].get_value() or "Untitled interface" + + existing_interfaces = self.parent.app.rns.config['interfaces'] + if name in existing_interfaces: + self.fields['name']["widget"].error = f"Interface name '{name}' already exists" + self.fields['name']["widget"].error_widget.set_text(("error", self.fields['name']["widget"].error)) + all_valid = False + + if not all_valid: + return + + interface_config = { + "type": self.iface_type, + "interface_enabled": True + } + + for field_key, field in self.fields.items(): + if field_key != "name": + widget = field["widget"] + value = widget.get_value() + if value is not None and value != "": + interface_config[widget.config_key] = value + + for field_key, field in self.additional_fields.items(): + widget = field["widget"] + value = widget.get_value() + if value is not None and value != "": + interface_config[widget.config_key] = value + + for field_key, field in self.common_fields.items(): + widget = field["widget"] + value = widget.get_value() + if value is not None and value != "": + interface_config[widget.config_key] = value + + # Add interface to RNS config + try: + interfaces = self.parent.app.rns.config['interfaces'] + + interfaces[name] = interface_config + + self.parent.app.rns.config.write() + print(self.parent.glyphset) + new_item = SelectableInterfaceItem( + parent=self.parent, + name=name, + is_connected=False, # will always be false until restart + is_enabled=True, + iface_type=self.iface_type, + tx=0, + rx=0, + icon=_get_interface_icon(self.parent.glyphset, self.iface_type), + iface_options=interface_config + ) + + self.parent.interface_items.append(new_item) + self.parent._rebuild_list() + + self.show_message(f"Interface {name} added. Restart NomadNet to start using this interface") + + except Exception as e: + print(f"Error saving interface: {str(e)}") + self.show_message(f"Error: {str(e)}", title="Error") + + def on_back(self, button): + self.parent.switch_to_list() + + def show_message(self, message, title="Notice"): + + def dismiss_dialog(button): + self.parent.switch_to_list() + + dialog = DialogLineBox( + urwid.Pile([ + urwid.Text(message, align="center"), + urwid.Divider(), + urwid.Button("OK", on_press=dismiss_dialog) + ]), + title=title + ) + + overlay = urwid.Overlay( + dialog, + self.parent.interfaces_display, + align='center', + width=100, + valign='middle', + height=8, + min_width=1, + min_height=1 + ) + + self.parent.widget = overlay + self.parent.app.ui.main_display.update_active_sub_display() + +class EditInterfaceView(AddInterfaceView): + def __init__(self, parent, iface_name): + self.parent = parent + self.iface_name = iface_name + + self.interface_config = parent.app.rns.config['interfaces'][iface_name] + self.iface_type = self.interface_config.get("type", "Unknown") + + super().__init__(parent, self.iface_type) + + self.overlay.top_w.title_widget.set_text(f"Edit Interface: {iface_name}") + self._populate_form_fields() + + def _populate_form_fields(self): + + self.fields['name']['widget'].edit_text = self.iface_name + + for key, field in self.fields.items(): + if key != 'name' and key in self.interface_config: + widget = field['widget'] + value = self.interface_config[key] + + if key == 'frequency': + # convert Hz back to MHz + value = float(value) / 1000000 + # decimal format + value = f"{value:.6f}".rstrip('0').rstrip('.') if '.' in f"{value:.6f}" else f"{value}" + + if hasattr(widget, 'edit_text'): + # For text input fields, set edit_text + widget.edit_text = str(value) + elif hasattr(widget, 'set_state'): + # For checkboxes + widget.set_state(bool(value)) + elif isinstance(widget, FormDropdown): + # For dropdowns - update selected and update display + str_value = str(value) + if str_value in widget.options: + widget.selected = str_value + widget.main_button.base_widget.set_text(str_value) + else: + for opt in widget.options: + try: + if widget.transform(opt) == value: + widget.selected = opt + widget.main_button.base_widget.set_text(opt) + break + except: + pass + elif isinstance(widget, FormMultiList): + if isinstance(value, str): + items = [item.strip() for item in value.split(',') if item.strip()] + self._populate_multilist(widget, items) + elif isinstance(value, list): + self._populate_multilist(widget, value) + + for key, field in self.additional_fields.items(): + if key in self.interface_config: + widget = field['widget'] + value = self.interface_config[key] + + if hasattr(widget, 'edit_text'): + widget.edit_text = str(value) + elif hasattr(widget, 'set_state'): + # RNS.log(f"KEY: {key} VAL: {value}") + checkbox_state = value if isinstance(value, bool) else value.strip().lower() not in ('false', 'off', 'no', '0') + widget.set_state(checkbox_state) + elif isinstance(widget, FormDropdown): + str_value = str(value) + if str_value in widget.options: + widget.selected = str_value + widget.main_button.base_widget.set_text(str_value) + else: + # Try to match after transform + for opt in widget.options: + try: + if widget.transform(opt) == value: + widget.selected = opt + widget.main_button.base_widget.set_text(opt) + break + except: + pass + elif isinstance(widget, FormMultiList): + if isinstance(value, str): + items = [item.strip() for item in value.split(',') if item.strip()] + self._populate_multilist(widget, items) + elif isinstance(value, list): + self._populate_multilist(widget, value) + + for key, field in self.common_fields.items(): + if key in self.interface_config: + widget = field['widget'] + value = self.interface_config[key] + + if hasattr(widget, 'edit_text'): + widget.edit_text = str(value) + elif hasattr(widget, 'set_state'): + widget.set_state(bool(value)) + elif isinstance(widget, FormDropdown): + str_value = str(value) + if str_value in widget.options: + widget.selected = str_value + widget.main_button.base_widget.set_text(str_value) + else: + # Try to match after transform + for opt in widget.options: + try: + if widget.transform(opt) == value: + widget.selected = opt + widget.main_button.base_widget.set_text(opt) + break + except: + pass + elif isinstance(widget, FormMultiList): + if isinstance(value, str): + items = [item.strip() for item in value.split(',') if item.strip()] + self._populate_multilist(widget, items) + elif isinstance(value, list): + self._populate_multilist(widget, value) + + def _populate_multilist(self, widget, items): + while len(widget.entries) > 1: + widget.remove_entry(None, widget.entries[-1]) + + if items: + first_entry = widget.entries[0] + first_edit = first_entry.contents[0][0] + if len(items) > 0: + first_edit.edit_text = items[0] + + for i in range(1, len(items)): + widget.add_entry(None) + entry = widget.entries[i] + edit_widget = entry.contents[0][0] + edit_widget.edit_text = items[i] + + def on_save(self, button): + if not self.validate_all(): + return + + new_name = self.fields['name']["widget"].get_value() or self.iface_name + + updated_config = { + "type": self.iface_type, + "interface_enabled": True + } + + for field_key, field in self.fields.items(): + if field_key != "name": + widget = field["widget"] + value = widget.get_value() + if value is not None and value != "": + updated_config[widget.config_key] = value + + for field_key, field in self.additional_fields.items(): + widget = field["widget"] + value = widget.get_value() + if value is not None and value != "": + updated_config[widget.config_key] = value + + for field_key, field in self.common_fields.items(): + widget = field["widget"] + value = widget.get_value() + if value is not None and value != "": + updated_config[widget.config_key] = value + + try: + interfaces = self.parent.app.rns.config['interfaces'] + + if new_name != self.iface_name: + del interfaces[self.iface_name] + interfaces[new_name] = updated_config + + for i, item in enumerate(self.parent.interface_items): + if item.name == self.iface_name: + self.parent.interface_items[i].name = new_name + break + else: + interfaces[self.iface_name] = updated_config + + self.parent.app.rns.config.write() + + for item in self.parent.interface_items: + if item.name == new_name: + item.iface_type = self.iface_type + break + + self.parent._rebuild_list() + + self.show_message(f"Interface {new_name} updated. Restart NomadNet for these changes to take effect") + + except Exception as e: + print(f"Error saving interface: {str(e)}") + self.show_message(f"Error updating interface: {str(e)}", title="Error") + + +class ShowInterface(urwid.WidgetWrap): + def __init__(self, parent, iface_name): + self.parent = parent + self.iface_name = iface_name + self.started = False + self.g = self.parent.app.ui.glyphs + + # get config + self.interface_config = self.parent.app.rns.config['interfaces'][iface_name] + iface_type = self.interface_config.get("type", "Unknown") + + self.parent.shortcuts_display.set_show_interface_shortcuts() + + self.config_rows = [] + + # get interface stats + interface_stats = self.parent.app.rns.get_interface_stats() + stats_lookup = {iface['short_name']: iface for iface in interface_stats['interfaces']} + self.stats = stats_lookup.get(iface_name, {}) + + self.tx = self.stats.get("txb", 0) + self.rx = self.stats.get("rxb", 0) + self.is_connected = self.stats.get("status", False) + self.is_enabled = (str(self.interface_config.get("enabled")).lower() != 'false' and + str(self.interface_config.get("interface_enabled")).lower() != 'false') + + header_content = [ + urwid.Text(("interface_title", f"Interface: {iface_name}"), align="center"), + urwid.Divider("=") + ] + header = urwid.Pile(header_content) + + self.edit_button = urwid.Button("Edit", on_press=self.on_edit) + self.back_button = urwid.Button("Back", on_press=self.on_back) + + self.toggle_button = urwid.Button( + "Disable" if self.is_enabled else "Enable", + on_press=self.on_toggle_enabled + ) + + button_row = urwid.Columns([ + (urwid.WEIGHT, 0.3, self.back_button), + (urwid.WEIGHT, 0.05, urwid.Text("")), + (urwid.WEIGHT, 0.3, self.toggle_button), + (urwid.WEIGHT, 0.05, urwid.Text("")), + (urwid.WEIGHT, 0.3, self.edit_button), + ]) + + footer_content = [ + urwid.Divider("="), + button_row + ] + footer = urwid.Pile(footer_content) + + # status widgets + self.status_text = urwid.Text(("connected_status" if self.is_enabled else "disconnected_status", + "Enabled" if self.is_enabled else "Disabled")) + + self.status_indicator = urwid.Text(("connected_status" if self.is_enabled else "disconnected_status", + self.parent.g['selected'] if self.is_enabled else self.parent.g[ + 'unselected'])) + + self.connection_text = urwid.Text(("connected_status" if self.is_connected else "disconnected_status", + "Connected" if self.is_connected else "Disconnected")) + + self.info_rows = [ + urwid.Columns([ + (10, urwid.Text(("key", "Type:"))), + urwid.Text(("value", f"{_get_interface_icon(self.parent.glyphset, iface_type)} {iface_type}")), + ]), + urwid.Columns([ + (10, urwid.Text(("key", "Status:"))), + (4, self.status_indicator), + (8, self.status_text), + (3, urwid.Text(" | ")), + self.connection_text, + ]), + urwid.Divider("-") + ] + + self.tx_text = urwid.Text(("value", format_bytes(self.tx))) + self.rx_text = urwid.Text(("value", format_bytes(self.rx))) + + self.stat_row = urwid.Columns([ + (10, urwid.Text(("key", "TX:"))), + (15, self.tx_text), + (10, urwid.Text(("key", "RX:"))), + self.rx_text, + ]) + + self.info_rows.append(self.stat_row) + self.info_rows.append(urwid.Divider("-")) + + self.bandwidth_chart = InterfaceBandwidthChart(history_length=60, glyphset=self.parent.glyphset) + self.bandwidth_chart.update(self.rx, self.tx) + + self.rx_chart_text = urwid.Text("Loading RX data...", align='left') + self.tx_chart_text = urwid.Text("Loading TX data...", align='left') + self.rx_peak_text = urwid.Text("Peak: 0 B/s", align='right') + self.tx_peak_text = urwid.Text("Peak: 0 B/s", align='right') + + self.rx_box = urwid.LineBox( + urwid.Pile([ + urwid.AttrMap(self.rx_chart_text, "rx"), + self.rx_peak_text + ]), + title="RX Traffic (60s)" + ) + + self.tx_box = urwid.LineBox( + urwid.Pile([ + urwid.AttrMap(self.tx_chart_text, "tx"), + self.tx_peak_text + ]), + title="TX Traffic (60s)" + ) + + self.horizontal_charts = urwid.Columns([ + (urwid.WEIGHT, 1, self.rx_box), + (urwid.WEIGHT, 1, self.tx_box) + ]) + + self.vertical_charts = urwid.Pile([ + self.rx_box, + self.tx_box + ]) + + self.disconnected_message = urwid.Filler( + urwid.Text(("disconnected_status", + "Charts not available - Interface is not connected"), + align="center"), + valign="top" + ) + self.disconnected_box = urwid.LineBox(self.disconnected_message, title="Bandwidth Charts") + + self.charts_widget = self.vertical_charts + self.is_horizontal = False + + screen = urwid.raw_display.Screen() + screen_cols, _ = screen.get_cols_rows() + if screen_cols >= 100: + self.charts_widget = self.horizontal_charts + self.is_horizontal = True + + if not self.is_connected: + self.charts_widget = self.disconnected_box + + connection_params = [] + radio_params = [] + network_params = [] + ifac_params = [] + other_params = [] + + # Sort parameters into groups + for key, value in self.interface_config.items(): + # skip empty + if value is None or value == "": + continue + + # Skip these keys as their shown elsewhere + if key in ["type", "interface_enabled", "enabled", 'selected_interface_mode', 'name']: + continue + + # Connection parameters + elif key in ["port", "listen_ip", "listen_port", "target_host", "target_port", "device"]: + connection_params.append((key, value)) + + # Radio parameters + elif key in ["frequency", "bandwidth", "spreadingfactor", "codingrate", "txpower"]: + radio_params.append((key, value)) + + # Network parameters + elif key in ["network_name", "bitrate", "peers", "group_id", "multicast_address_type", + "discovery_scope", "announce_cap", "mode"]: + network_params.append((key, value)) + + # IFAC parameters + elif key in ["passphrase", "ifac_size", "ifac_netname", "ifac_netkey"]: + ifac_params.append((key, value)) + + else: + other_params.append((key, value)) + + def create_param_row(key, value): + if isinstance(value, bool): + value_str = "Yes" if value else "No" + elif key == "frequency": + int_value = int(value) + value_str = f"{int_value / 1000000:.3f} MHz" + elif key == "bandwidth": + int_value = int(value) + value_str = f"{int_value / 1000:.1f} kHz" + else: + value_str = str(value) + # format display keys: "listen_port" => Listen Port + display_key = key.replace('_', ' ').title() + + return urwid.Columns([ + (18, urwid.Text(("key", f"{display_key}:"))), + urwid.Text(("value", value_str)), + ]) + + if connection_params: + connection_params.sort(key=lambda x: x[0]) + self.config_rows.append(urwid.Text(("interface_title", "Connection Parameters"), align="left")) + for key, value in connection_params: + self.config_rows.append(create_param_row(key, value)) + self.config_rows.append(urwid.Divider("-")) + + if radio_params: + radio_params.sort(key=lambda x: x[0]) + self.config_rows.append(urwid.Text(("interface_title", "Radio Parameters"), align="left")) + for key, value in radio_params: + self.config_rows.append(create_param_row(key, value)) + self.config_rows.append(urwid.Divider("-")) + + if network_params: + network_params.sort(key=lambda x: x[0]) + self.config_rows.append(urwid.Text(("interface_title", "Network Parameters"), align="left")) + for key, value in network_params: + self.config_rows.append(create_param_row(key, value)) + self.config_rows.append(urwid.Divider("-")) + + if ifac_params: + ifac_params.sort(key=lambda x: x[0]) + self.config_rows.append(urwid.Text(("interface_title", "IFAC Parameters"), align="left")) + for key, value in ifac_params: + self.config_rows.append(create_param_row(key, value)) + self.config_rows.append(urwid.Divider("-")) + + if other_params: + other_params.sort(key=lambda x: x[0]) + self.config_rows.append(urwid.Text(("interface_title", "Additional Parameters"), align="left")) + for key, value in other_params: + self.config_rows.append(create_param_row(key, value)) + self.config_rows.append(urwid.Divider("-")) + + if not self.config_rows: + self.config_rows.append(urwid.Text("No additional parameters", align="center")) + + body_content = [] + body_content.extend(self.info_rows) + body_content.append( + self.charts_widget) + body_content.append(urwid.Divider("-")) + body_content.extend(self.config_rows) + + body_pile = urwid.Pile(body_content) + body_padding = urwid.Padding(body_pile, left=2, right=2) + + body = urwid.ListBox(urwid.SimpleListWalker([body_padding])) + + self.frame = urwid.Frame( + body=body, + header=header, + footer=footer + ) + + self.content_box = urwid.LineBox(self.frame) + + super().__init__(self.content_box) + + def update_status_display(self): + if self.is_enabled: + self.status_indicator.set_text(("connected_status", self.parent.g['selected'])) + self.status_text.set_text(("connected_status", "Enabled")) + else: + self.status_indicator.set_text(("disconnected_status", self.parent.g['unselected'])) + self.status_text.set_text(("disconnected_status", "Disabled")) + + def update_connection_display(self, is_connected): + old_connection_state = self.is_connected + self.is_connected = is_connected + + self.connection_text.set_text(("connected_status" if self.is_connected else "disconnected_status", + "Connected" if self.is_connected else "Disconnected")) + + if old_connection_state != self.is_connected: + body_pile = self.frame.body.body[0].original_widget + + chart_index = None + for i, (widget, options) in enumerate(body_pile.contents): + if (widget == self.horizontal_charts or + widget == self.vertical_charts or + widget == self.disconnected_box): + chart_index = i + break + + if chart_index is not None: + if self.is_connected: + new_widget = self.horizontal_charts if self.is_horizontal else self.vertical_charts + if not self.started: + self.start() + else: + new_widget = self.disconnected_box + self.started = False + + body_pile.contents[chart_index] = (new_widget, body_pile.options()) + + def on_toggle_enabled(self, button): + action = "disable" if self.is_enabled else "enable" + + def on_confirm_yes(confirm_button): + self.parent.app.ui.main_display.frame.body = self.parent.app.ui.main_display.sub_displays.active().widget + + self.is_enabled = not self.is_enabled + + self.toggle_button.set_label("Disable" if self.is_enabled else "Enable") + + if "interface_enabled" in self.interface_config: + self.interface_config["interface_enabled"] = self.is_enabled + else: + self.interface_config["enabled"] = self.is_enabled + + try: + interfaces = self.parent.app.rns.config['interfaces'] + + interfaces[self.iface_name] = self.interface_config + + self.parent.app.rns.config.write() + + self.update_status_display() + + for item in self.parent.interface_items: + if item.name == self.iface_name: + item.is_enabled = self.is_enabled + item.update_status_display() + + if hasattr(self.parent.app.ui, 'loop') and self.parent.app.ui.loop is not None: + self.parent.app.ui.loop.draw_screen() + + self.show_restart_required_message() + + except Exception as e: + self.show_error_message(f"Error updating interface: {str(e)}") + + def on_confirm_no(confirm_button): + self.parent.app.ui.main_display.frame.body = self.parent.app.ui.main_display.sub_displays.active().widget + + confirm_text = urwid.Text(( + "interface_title", + f"Are you sure you want to {action} the {self.iface_name} interface?" + ), align="center") + + yes_button = urwid.Button("Yes", on_press=on_confirm_yes) + no_button = urwid.Button("No", on_press=on_confirm_no) + + buttons_row = urwid.Columns([ + (urwid.WEIGHT, 0.45, yes_button), + (urwid.WEIGHT, 0.1, urwid.Text("")), + (urwid.WEIGHT, 0.45, no_button), + ]) + + pile = urwid.Pile([ + confirm_text, + urwid.Divider(), + buttons_row + ]) + + dialog = DialogLineBox(pile, title="Confirm") + + overlay = urwid.Overlay( + dialog, + self.parent.app.ui.main_display.frame.body, + align='center', + width=50, + valign='middle', + height=7 + ) + + self.parent.app.ui.main_display.frame.body = overlay + + def show_restart_required_message(self): + + def dismiss_dialog(button): + self.parent.app.ui.main_display.frame.body = self.parent.app.ui.main_display.sub_displays.active().widget + + dialog = DialogLineBox( + urwid.Pile([ + urwid.Text( + f"Interface {self.iface_name} has been " + + ("enabled" if self.is_enabled else "disabled") + + ".\nRestart required for changes to take effect.", + align="center" + ), + urwid.Divider(), + urwid.Button("OK", on_press=dismiss_dialog) + ]), + title="Notice" + ) + + overlay = urwid.Overlay( + dialog, + self.parent.app.ui.main_display.frame.body, + align='center', + width=50, + valign='middle', + height=8 + ) + + self.parent.app.ui.main_display.frame.body = overlay + + def show_error_message(self, message): + + def dismiss_dialog(button): + self.parent.app.ui.main_display.frame.body = self.parent.app.ui.main_display.sub_displays.active().widget + + dialog = DialogLineBox( + urwid.Pile([ + urwid.Text(message, align="center"), + urwid.Divider(), + urwid.Button("OK", on_press=dismiss_dialog) + ]), + title="Error" + ) + + overlay = urwid.Overlay( + dialog, + self.parent.app.ui.main_display.frame.body, + align='center', + width=50, + valign='middle', + height=8 + ) + + self.parent.app.ui.main_display.frame.body = overlay + + def keypress(self, size, key): + if key == 'tab': + if self.frame.focus_position == 'body': + self.frame.focus_position = 'footer' + footer_pile = self.frame.footer + if isinstance(footer_pile, urwid.Pile): + footer_pile.focus_position = 1 # button row + button_row = footer_pile.contents[1][0] + if isinstance(button_row, urwid.Columns): + button_row.focus_position = 0 + return None + # If we're currently in footer change the focus + elif self.frame.focus_position == 'footer': + footer_pile = self.frame.footer + if isinstance(footer_pile, urwid.Pile): + button_row = footer_pile.contents[1][0] + if isinstance(button_row, urwid.Columns): + # If on first button (Back), move to Toggle button + if button_row.focus_position == 0: + button_row.focus_position = 2 # skip spacer + return None + # If on toggle button, move to Edit button + elif button_row.focus_position == 2: + button_row.focus_position = 4 + return None + # if on edit button wrap back to toggle button + elif button_row.focus_position == 4: + button_row.focus_position = 0 + return None + elif key == 'shift tab': + if self.frame.focus_position == 'footer': + self.frame.focus_position = 'body' + return None + elif self.frame.focus_position == 'footer': + footer_pile = self.frame.footer + if isinstance(footer_pile, urwid.Pile): + button_row = footer_pile.contents[1][0] + if isinstance(button_row, urwid.Columns): + if button_row.focus_position == 4: # edit button + button_row.focus_position = 2 # toggle button + return None + elif button_row.focus_position == 2: + button_row.focus_position = 0 # back button + return None + elif button_row.focus_position == 0: # back button + self.frame.focus_position = 'body' + return None + elif key == "h" and self.is_connected: # horizontal layout + if not self.is_horizontal: + self.switch_to_horizontal() + return None + elif key == "v" and self.is_connected: # vertical layout + if self.is_horizontal: + self.switch_to_vertical() + return None + + return super().keypress(size, key) + + def switch_to_horizontal(self): + if not self.is_connected: + return + + self.is_horizontal = True + + body_pile = self.frame.body.body[0].original_widget + for i, (widget, options) in enumerate(body_pile.contents): + if widget == self.vertical_charts: + body_pile.contents[i] = (self.horizontal_charts, options) + self.charts_widget = self.horizontal_charts + break + + def switch_to_vertical(self): + if not self.is_connected: + return + + self.is_horizontal = False + body_pile = self.frame.body.body[0].original_widget + for i, (widget, options) in enumerate(body_pile.contents): + if widget == self.horizontal_charts: + body_pile.contents[i] = (self.vertical_charts, options) + self.charts_widget = self.vertical_charts + break + + def start(self): + if not self.started and self.is_connected: + self.started = True + self.parent.app.ui.loop.set_alarm_in(1, self.update_bandwidth_charts) + + def update_bandwidth_charts(self, loop, user_data): + if not self.started: + return + + interface_stats = self.parent.app.rns.get_interface_stats() + stats_lookup = {iface['short_name']: iface for iface in interface_stats['interfaces']} + stats = stats_lookup.get(self.iface_name, {}) + + tx = stats.get("txb", self.tx) + rx = stats.get("rxb", self.rx) + + new_connection_status = stats.get("status", False) + if new_connection_status != self.is_connected: + self.update_connection_display(new_connection_status) + + if not self.is_connected: + return + + self.tx_text.set_text(("value", format_bytes(tx))) + self.rx_text.set_text(("value", format_bytes(rx))) + + self.bandwidth_chart.update(rx, tx) + + rx_chart, tx_chart, peak_rx, peak_tx = self.bandwidth_chart.get_charts(height=8) + + self.rx_chart_text.set_text(rx_chart) + self.tx_chart_text.set_text(tx_chart) + self.rx_peak_text.set_text(f"Peak: {peak_rx}") + self.tx_peak_text.set_text(f"Peak: {peak_tx}") + + self.tx = tx + self.rx = rx + + if self.started: + loop.set_alarm_in(1, self.update_bandwidth_charts) + + def on_back(self, button): + self.started = False + self.parent.switch_to_list() + + def on_edit(self, button): + self.started = False + self.parent.switch_to_edit_interface(self.iface_name) + +### MAIN DISPLAY ### +class InterfaceDisplay: + def __init__(self, app): + self.app = app + self.started = False + self.interface_items = [] + self.glyphset = self.app.config["textui"]["glyphs"] + self.g = self.app.ui.glyphs + + self.terminal_cols, self.terminal_rows = urwid.raw_display.Screen().get_cols_rows() + self.iface_row_offset = 4 + self.list_rows = self.terminal_rows - self.iface_row_offset + + interfaces = app.rns.config['interfaces'] + processed_interfaces = {} + + for interface_name, interface in interfaces.items(): + interface_data = interface.copy() + + # handle sub-interfaces for RNodeMultiInterface + if interface_data.get("type") == "RNodeMultiInterface": + sub_interfaces = [] + for sub_name, sub_config in interface_data.items(): + if sub_name not in {"type", "port", "interface_enabled", "selected_interface_mode", + "configured_bitrate"}: + if isinstance(sub_config, dict): + sub_config["name"] = sub_name + sub_interfaces.append(sub_config) + + # add sub-interfaces to the main interface data + interface_data["sub_interfaces"] = sub_interfaces + + for sub in sub_interfaces: + del interface_data[sub["name"]] + + processed_interfaces[interface_name] = interface_data + + interface_stats = app.rns.get_interface_stats() + stats_lookup = {interface['short_name']: interface for interface in interface_stats['interfaces']} + # print(stats_lookup) + for interface_name, interface_data in processed_interfaces.items(): + # configobj false values + is_enabled = str(interface_data.get("enabled")).lower() not in ('false', 'off', 'no', '0') and str(interface_data.get("interface_enabled")).lower() not in ('false', 'off', 'no', '0') + + iface_type = interface_data.get("type", "Unknown") + icon = _get_interface_icon(self.glyphset, iface_type) + + stats_for_interface = stats_lookup.get(interface_name) + + if stats_for_interface: + tx = stats_for_interface.get("txb", 0) + rx = stats_for_interface.get("rxb", 0) + is_connected = stats_for_interface["status"] + else: + tx = 0 + rx = 0 + is_connected = False + + item = SelectableInterfaceItem( + parent=self, + name=interface_data.get("name", interface_name), + is_connected=is_connected, + is_enabled=is_enabled, + iface_type=iface_type, + tx=tx, + rx=rx, + icon=icon + ) + + self.interface_items.append(item) + + interface_header = urwid.Text(("interface_title", "Interfaces"), align="center") + if len(self.interface_items) == 0: + interface_header = urwid.Text( + ("interface_title", "No interfaces found. Press Ctrl + A to add a new interface "), align="center") + + + list_contents = [ + interface_header, + urwid.Divider(), + ] + self.interface_items + + self.list_walker = urwid.SimpleFocusListWalker(list_contents) + self.list_box = urwid.ListBox(self.list_walker) + + self.box_adapter = urwid.BoxAdapter(self.list_box, self.list_rows) + + + pile = urwid.Pile([self.box_adapter]) + self.interfaces_display = InterfaceFiller(pile, self.app) + self.shortcuts_display = InterfaceDisplayShortcuts(self.app) + self.widget = self.interfaces_display + + def start(self): + # started from Main.py + self.started = True + self.app.ui.loop.set_alarm_in(1, self.poll_stats) + self.app.ui.loop.set_alarm_in(5, self.check_terminal_size) + + def switch_to_edit_interface(self, iface_name): + self.edit_interface_view = EditInterfaceView(self, iface_name) + self.widget = self.edit_interface_view + self.app.ui.main_display.update_active_sub_display() + + def edit_selected_interface(self): + focus_widget, focus_position = self.box_adapter._original_widget.body.get_focus() + + if not isinstance(focus_widget, SelectableInterfaceItem): + return + + selected_item = focus_widget + interface_name = selected_item.name + + self.switch_to_edit_interface(interface_name) + + def check_terminal_size(self, loop, user_data): + new_cols, new_rows = loop.screen.get_cols_rows() + + if new_rows != self.terminal_rows or new_cols != self.terminal_cols: + self.terminal_cols, self.terminal_rows = new_cols, new_rows + self.list_rows = self.terminal_rows - self.iface_row_offset + + self.box_adapter.height = self.list_rows + + loop.draw_screen() + + if self.started: + loop.set_alarm_in(5, self.check_terminal_size) + + def poll_stats(self, loop, user_data): + interface_stats = self.app.rns.get_interface_stats() + stats_lookup = {iface['short_name']: iface for iface in interface_stats['interfaces']} + for item in self.interface_items: + # use interface name as the key + stats_for_interface = stats_lookup.get(item.name) + if stats_for_interface: + tx = stats_for_interface.get("txb", 0) + rx = stats_for_interface.get("rxb", 0) + item.update_stats(tx, rx) + + loop.set_alarm_in(1, self.poll_stats) + + + def shortcuts(self): + return self.shortcuts_display + + def switch_to_show_interface(self, iface_name): + show_interface = ShowInterface(self, iface_name) + self.widget = show_interface + self.app.ui.main_display.update_active_sub_display() + + show_interface.start() + + def switch_to_list(self): + self.shortcuts_display.reset_shortcuts() + self.widget = self.interfaces_display + self._rebuild_list() + self.app.ui.main_display.update_active_sub_display() + + def add_interface(self): + dialog_widgets = [] + + def add_heading(txt): + dialog_widgets.append(urwid.Text(("interface_title", txt), align="left")) + + def add_option(label, value): + item = InterfaceOptionItem(self, label, value) + dialog_widgets.append(item) + + # Get the icons based on plain, unicode, nerdfont glyphset + network_icon = _get_interface_icon(self.glyphset, "AutoInterface") + rnode_icon = _get_interface_icon(self.glyphset, "RNodeInterface") + serial_icon = _get_interface_icon(self.glyphset, "SerialInterface") + other_icon = _get_interface_icon(self.glyphset, "PipeInterface") + + add_heading(f"{network_icon} IP Networks") + add_option("Auto Interface", "AutoInterface") + add_option("TCP Client Interface", "TCPClientInterface") + add_option("TCP Server Interface", "TCPServerInterface") + add_option("UDP Interface", "UDPInterface") + add_option("I2P Interface", "I2PInterface") + + add_heading(f"{rnode_icon} RNodes") + add_option("RNode Interface", "RNodeInterface") + # add_option("RNode Multi Interface", "RNodeMultiInterface") TODO + + add_heading(f"{serial_icon} Hardware") + add_option("Serial Interface", "SerialInterface") + add_option("KISS Interface", "KISSInterface") + add_option("AX.25 KISS Interface", "AX25KISSInterface") + + add_heading(f"{other_icon} Other") + add_option("Pipe Interface", "PipeInterface") + # add_option("Custom Interface", "CustomInterface") TODO + + listbox = urwid.ListBox(urwid.SimpleFocusListWalker(dialog_widgets)) + dialog = DialogLineBox(listbox, parent=self, title="Select Interface Type") + + overlay = urwid.Overlay( + dialog, + self.interfaces_display, + align='center', + width=('relative', 50), + valign='middle', + height=('relative', 50), + min_width=20, + min_height=15, + left=2, + right=2 + ) + self.widget = overlay + self.app.ui.main_display.update_active_sub_display() + + def switch_to_add_interface(self, iface_type): + self.add_interface_view = AddInterfaceView(self, iface_type) + self.widget = self.add_interface_view + self.app.ui.main_display.update_active_sub_display() + + def remove_selected_interface(self): + focus_widget, focus_position = self.box_adapter._original_widget.body.get_focus() + if not isinstance(focus_widget, SelectableInterfaceItem): + return + + selected_item = focus_widget + interface_name = selected_item.name + + def on_confirm_yes(button): + try: + if interface_name in self.app.rns.config['interfaces']: + del self.app.rns.config['interfaces'][interface_name] + self.app.rns.config.write() + + if selected_item in self.interface_items: + self.interface_items.remove(selected_item) + + self._rebuild_list() + self.dismiss_dialog() + + except Exception as e: + print(e) + + def on_confirm_no(button): + self.dismiss_dialog() + + confirm_text = urwid.Text(("interface_title", f"Remove interface {interface_name}?"), align="center") + yes_button = urwid.Button("Yes", on_press=on_confirm_yes) + no_button = urwid.Button("No", on_press=on_confirm_no) + + buttons_row = urwid.Columns([ + (urwid.WEIGHT, 0.45, yes_button), + (urwid.WEIGHT, 0.1, urwid.Text("")), + (urwid.WEIGHT, 0.45, no_button), + ]) + + pile = urwid.Pile([ + confirm_text, + buttons_row + ]) + + dialog = DialogLineBox(pile, parent=self, title="?") + + overlay = urwid.Overlay( + dialog, + self.interfaces_display, + align='center', + width=('relative', 35), + valign='middle', + height=(5), + min_width=5, + left=2, + right=2 + ) + dialog.original_widget.focus_position = 1 # columns row + buttons_row = dialog.original_widget.contents[1][0] + buttons_row.focus_position = 2 # second button "No" + + self.widget = overlay + self.app.ui.main_display.update_active_sub_display() + + def dismiss_dialog(self): + self.widget = self.interfaces_display + self.app.ui.main_display.update_active_sub_display() + + def _rebuild_list(self): + interface_header = urwid.Text(("interface_title", f"Interfaces ({len(self.interface_items)})"), align="center") + if len(self.interface_items) == 0: + interface_header = urwid.Text(("interface_title", "No interfaces found. Press Ctrl + A to add a new interface "), align="center") + + new_list = [ + interface_header, + urwid.Divider(), + ] + self.interface_items + # RNS.log(f"items: {self.interface_items}") + + walker = urwid.SimpleFocusListWalker(new_list) + self.box_adapter._original_widget.body = walker + self.box_adapter._original_widget.focus_position = len(new_list) - 1 + +### SHORTCUTS ### +class InterfaceDisplayShortcuts: + def __init__(self, app): + self.app = app + self.default_shortcuts = "[C-a] Add Interface [C-e] Edit Interface [C-x] Remove Interface [Enter] Show Interface" + self.current_shortcuts = self.default_shortcuts + self.widget = urwid.AttrMap( + urwid.Text(self.current_shortcuts), + "shortcutbar" + ) + + def update_shortcuts(self, new_shortcuts): + self.current_shortcuts = new_shortcuts + self.widget.original_widget.set_text(new_shortcuts) + + def reset_shortcuts(self): + self.update_shortcuts(self.default_shortcuts) + + def set_show_interface_shortcuts(self): + show_shortcuts = "[Back] Return to List [Tab] Navigate [Shift-tab] Change Focus [h] Horizontal Charts [v] Vertical Charts [Up/Down] Scroll" + self.update_shortcuts(show_shortcuts) + + def set_add_interface_shortcuts(self): + add_shortcuts = "[Up/Down] Navigate Fields [Enter] Select Option" + self.update_shortcuts(add_shortcuts) + + def set_edit_interface_shortcuts(self): + edit_shortcuts = "[Up/Down] Navigate Fields [Enter] Select Option" + self.update_shortcuts(edit_shortcuts) \ No newline at end of file diff --git a/nomadnet/ui/textui/Main.py b/nomadnet/ui/textui/Main.py index 303024a..34d88c3 100644 --- a/nomadnet/ui/textui/Main.py +++ b/nomadnet/ui/textui/Main.py @@ -4,6 +4,7 @@ from .Network import * from .Conversations import * from .Directory import * from .Config import * +from .Interfaces import * from .Map import * from .Log import * from .Guide import * @@ -16,6 +17,7 @@ class SubDisplays(): self.conversations_display = ConversationsDisplay(self.app) self.directory_display = DirectoryDisplay(self.app) self.config_display = ConfigDisplay(self.app) + self.interface_display = InterfaceDisplay(self.app) self.map_display = MapDisplay(self.app) self.log_display = LogDisplay(self.app) self.guide_display = GuideDisplay(self.app) @@ -113,6 +115,11 @@ class MainDisplay(): self.sub_displays.active_display = self.sub_displays.config_display self.update_active_sub_display() + def show_interfaces(self, user_data): + self.sub_displays.active_display = self.sub_displays.interface_display + self.update_active_sub_display() + self.sub_displays.interface_display.start() + def show_log(self, user_data): self.sub_displays.active_display = self.sub_displays.log_display self.sub_displays.log_display.show() @@ -171,21 +178,22 @@ class MenuDisplay(): self.menu_indicator = urwid.Text("") - menu_text = (urwid.PACK, self.menu_indicator) - button_network = (11, MenuButton("Network", on_press=handler.show_network)) - button_conversations = (17, MenuButton("Conversations", on_press=handler.show_conversations)) - button_directory = (13, MenuButton("Directory", on_press=handler.show_directory)) - button_map = (7, MenuButton("Map", on_press=handler.show_map)) - button_log = (7, MenuButton("Log", on_press=handler.show_log)) - button_config = (10, MenuButton("Config", on_press=handler.show_config)) - button_guide = (9, MenuButton("Guide", on_press=handler.show_guide)) - button_quit = (8, MenuButton("Quit", on_press=handler.quit)) + menu_text = (urwid.PACK, self.menu_indicator) + button_network = (11, MenuButton("Network", on_press=handler.show_network)) + button_conversations = (17, MenuButton("Conversations", on_press=handler.show_conversations)) + button_directory = (13, MenuButton("Directory", on_press=handler.show_directory)) + button_map = (7, MenuButton("Map", on_press=handler.show_map)) + button_log = (7, MenuButton("Log", on_press=handler.show_log)) + button_config = (10, MenuButton("Config", on_press=handler.show_config)) + button_interfaces = (14, MenuButton("Interfaces", on_press=handler.show_interfaces)) + button_guide = (9, MenuButton("Guide", on_press=handler.show_guide)) + button_quit = (8, MenuButton("Quit", on_press=handler.quit)) # buttons = [menu_text, button_conversations, button_node, button_directory, button_map] if self.app.config["textui"]["hide_guide"]: - buttons = [menu_text, button_conversations, button_network, button_log, button_config, button_quit] + buttons = [menu_text, button_conversations, button_network, button_log, button_interfaces, button_config, button_quit] else: - buttons = [menu_text, button_conversations, button_network, button_log, button_config, button_guide, button_quit] + buttons = [menu_text, button_conversations, button_network, button_log, button_interfaces, button_config, button_guide, button_quit] columns = MenuColumns(buttons, dividechars=1) columns.handler = handler diff --git a/nomadnet/vendor/AsciiChart.py b/nomadnet/vendor/AsciiChart.py new file mode 100644 index 0000000..4689590 --- /dev/null +++ b/nomadnet/vendor/AsciiChart.py @@ -0,0 +1,87 @@ +from __future__ import division +from math import ceil, floor, isnan +# Derived from asciichartpy | https://github.com/kroitor/asciichart/blob/master/asciichartpy/__init__.py +class AsciiChart: + def __init__(self, glyphset="unicode"): + self.symbols = ['┼', '┤', '╶', '╴', '─', '╰', '╭', '╮', '╯', '│'] + if glyphset == "plain": + self.symbols = ['+', '|', '-', '-', '-', '\'', ',', '.', '`', '|'] + def plot(self, series, cfg=None): + if len(series) == 0: + return '' + if not isinstance(series[0], list): + if all(isnan(n) for n in series): + return '' + else: + series = [series] + cfg = cfg or {} + minimum = cfg.get('min', min(filter(lambda n: not isnan(n), [j for i in series for j in i]))) + maximum = cfg.get('max', max(filter(lambda n: not isnan(n), [j for i in series for j in i]))) + symbols = cfg.get('symbols', self.symbols) + if minimum > maximum: + raise ValueError('The min value cannot exceed the max value.') + interval = maximum - minimum + offset = cfg.get('offset', 3) + height = cfg.get('height', interval) + ratio = height / interval if interval > 0 else 1 + + min2 = int(floor(minimum * ratio)) + max2 = int(ceil(maximum * ratio)) + + def clamp(n): + return min(max(n, minimum), maximum) + + def scaled(y): + return int(round(clamp(y) * ratio) - min2) + + rows = max2 - min2 + + width = 0 + for i in range(0, len(series)): + width = max(width, len(series[i])) + width += offset + + placeholder = cfg.get('format', '{:8.2f} ') + + result = [[' '] * width for i in range(rows + 1)] + + for y in range(min2, max2 + 1): + label = placeholder.format(maximum - ((y - min2) * interval / (rows if rows else 1))) + result[y - min2][max(offset - len(label), 0)] = label + result[y - min2][offset - 1] = symbols[0] if y == 0 else symbols[1] + + d0 = series[0][0] + if not isnan(d0): + result[rows - scaled(d0)][offset - 1] = symbols[0] + + for i in range(0, len(series)): + for x in range(0, len(series[i]) - 1): + d0 = series[i][x + 0] + d1 = series[i][x + 1] + + if isnan(d0) and isnan(d1): + continue + + if isnan(d0) and not isnan(d1): + result[rows - scaled(d1)][x + offset] = symbols[2] + continue + + if not isnan(d0) and isnan(d1): + result[rows - scaled(d0)][x + offset] = symbols[3] + continue + + y0 = scaled(d0) + y1 = scaled(d1) + if y0 == y1: + result[rows - y0][x + offset] = symbols[4] + continue + + result[rows - y1][x + offset] = symbols[5] if y0 > y1 else symbols[6] + result[rows - y0][x + offset] = symbols[7] if y0 > y1 else symbols[8] + + start = min(y0, y1) + 1 + end = max(y0, y1) + for y in range(start, end): + result[rows - y][x + offset] = symbols[9] + + return '\n'.join([''.join(row).rstrip() for row in result]) \ No newline at end of file diff --git a/nomadnet/vendor/additional_urwid_widgets/FormWidgets.py b/nomadnet/vendor/additional_urwid_widgets/FormWidgets.py new file mode 100644 index 0000000..4e4809a --- /dev/null +++ b/nomadnet/vendor/additional_urwid_widgets/FormWidgets.py @@ -0,0 +1,283 @@ +import urwid + +class DialogLineBox(urwid.LineBox): + def __init__(self, body, parent=None, title="?"): + super().__init__(body, title=title) + self.parent = parent + + def keypress(self, size, key): + if key == "esc": + if self.parent and hasattr(self.parent, "dismiss_dialog"): + self.parent.dismiss_dialog() + return None + return super().keypress(size, key) + +class Placeholder(urwid.Edit): + def __init__(self, caption="", edit_text="", placeholder="", **kwargs): + super().__init__(caption, edit_text, **kwargs) + self.placeholder = placeholder + + def render(self, size, focus=False): + if not self.edit_text and not focus: + placeholder_widget = urwid.Text(("placeholder", self.placeholder)) + return placeholder_widget.render(size, focus) + else: + return super().render(size, focus) + +class Dropdown(urwid.WidgetWrap): + signals = ['change'] # emit for urwid.connect_signal fn + + def __init__(self, label, options, default=None): + self.label = label + self.options = options + self.selected = default if default is not None else options[0] + + self.main_text = f"{self.selected}" + self.main_button = urwid.SelectableIcon(self.main_text, 0) + self.main_button = urwid.AttrMap(self.main_button, "button_normal", "button_focus") + + self.option_widgets = [] + for opt in options: + icon = urwid.SelectableIcon(opt, 0) + icon = urwid.AttrMap(icon, "list_normal", "list_focus") + self.option_widgets.append(icon) + + self.options_walker = urwid.SimpleFocusListWalker(self.option_widgets) + self.options_listbox = urwid.ListBox(self.options_walker) + self.dropdown_box = None # will be created on open_dropdown + + self.pile = urwid.Pile([self.main_button]) + self.dropdown_visible = False + + super().__init__(self.pile) + + def open_dropdown(self): + if not self.dropdown_visible: + height = len(self.options) + self.dropdown_box = urwid.BoxAdapter(self.options_listbox, height) + self.pile.contents.append((self.dropdown_box, self.pile.options())) + self.dropdown_visible = True + self.pile.focus_position = 1 + self.options_walker.set_focus(0) + + def close_dropdown(self): + if self.dropdown_visible: + self.pile.contents.pop() # remove the dropdown_box + self.dropdown_visible = False + self.pile.focus_position = 0 + self.dropdown_box = None + + def keypress(self, size, key): + if not self.dropdown_visible: + if key == "enter": + self.open_dropdown() + return None + return self.main_button.keypress(size, key) + else: + if key == "enter": + focus_result = self.options_walker.get_focus() + if focus_result is not None: + focus_widget = focus_result[0] + new_val = focus_widget.base_widget.text + old_val = self.selected + self.selected = new_val + self.main_button.base_widget.set_text(f"{self.selected}") + + if old_val != new_val: + self._emit('change', new_val) + + self.close_dropdown() + return None + return self.dropdown_box.keypress(size, key) + + def get_value(self): + return self.selected + +class ValidationError(urwid.Text): + def __init__(self, message=""): + super().__init__(("error", message)) + +class FormField: + def __init__(self, config_key, transform=None): + self.config_key = config_key + self.transform = transform or (lambda x: x) + +class FormEdit(Placeholder, FormField): + def __init__(self, config_key, caption="", edit_text="", placeholder="", validation_types=None, transform=None, **kwargs): + Placeholder.__init__(self, caption, edit_text, placeholder, **kwargs) + FormField.__init__(self, config_key, transform) + self.validation_types = validation_types or [] + self.error_widget = urwid.Text("") + self.error = None + + def get_value(self): + return self.transform(self.edit_text.strip()) + + def validate(self): + value = self.edit_text.strip() + self.error = None + + for validation in self.validation_types: + if validation == "required": + if not value: + self.error = "This field is required" + break + elif validation == "number": + if value and not value.replace('-', '').replace('.', '').isdigit(): + self.error = "This field must be a number" + break + elif validation == "float": + try: + if value: + float(value) + except ValueError: + self.error = "This field must be decimal number" + break + + self.error_widget.set_text(("error", self.error or "")) + return self.error is None + +class FormCheckbox(urwid.CheckBox, FormField): + def __init__(self, config_key, label="", state=False, validation_types=None, transform=None, **kwargs): + urwid.CheckBox.__init__(self, label, state, **kwargs) + FormField.__init__(self, config_key, transform) + self.validation_types = validation_types or [] + self.error_widget = urwid.Text("") + self.error = None + + def get_value(self): + return self.transform(self.get_state()) + + def validate(self): + + value = self.get_state() + self.error = None + + for validation in self.validation_types: + if validation == "required": + if not value: + self.error = "This field is required" + break + + self.error_widget.set_text(("error", self.error or "")) + return self.error is None + +class FormDropdown(Dropdown, FormField): + signals = ['change'] + + def __init__(self, config_key, label, options, default=None, validation_types=None, transform=None): + self.options = [str(opt) for opt in options] + + if default is not None: + default_str = str(default) + if default_str in self.options: + default = default_str + elif transform: + try: + default_transformed = transform(default_str) + for opt in self.options: + if transform(opt) == default_transformed: + default = opt + break + except: + default = self.options[0] + else: + default = self.options[0] + else: + default = self.options[0] + + Dropdown.__init__(self, label, self.options, default) + FormField.__init__(self, config_key, transform) + + self.validation_types = validation_types or [] + self.error_widget = urwid.Text("") + self.error = None + + if hasattr(self, 'main_button'): + self.main_button.base_widget.set_text(str(default)) + + def get_value(self): + return self.transform(self.selected) + + def validate(self): + value = self.get_value() + self.error = None + + for validation in self.validation_types: + if validation == "required": + if not value: + self.error = "This field is required" + break + + self.error_widget.set_text(("error", self.error or "")) + return self.error is None + + def open_dropdown(self): + if not self.dropdown_visible: + super().open_dropdown() + try: + current_index = self.options.index(self.selected) + self.options_walker.set_focus(current_index) + except ValueError: + pass + +class FormMultiList(urwid.Pile, FormField): + def __init__(self, config_key, placeholder="", validation_types=None, transform=None, **kwargs): + self.entries = [] + self.error_widget = urwid.Text("") + self.error = None + self.placeholder = placeholder + self.validation_types = validation_types or [] + + first_entry = self.create_entry_row() + self.entries.append(first_entry) + + self.add_button = urwid.Button("+ Add Another", on_press=self.add_entry) + add_button_padded = urwid.Padding(self.add_button, left=2, right=2) + + pile_widgets = [first_entry, add_button_padded] + urwid.Pile.__init__(self, pile_widgets) + FormField.__init__(self, config_key, transform) + + def create_entry_row(self): + edit = urwid.Edit("", "") + entry_row = urwid.Columns([ + ('weight', 1, edit), + (3, urwid.Button("×", on_press=lambda button: self.remove_entry(button, entry_row))), + ]) + return entry_row + + def remove_entry(self, button, entry_row): + if len(self.entries) > 1: + self.entries.remove(entry_row) + self.contents = [(w, self.options()) for w in self.get_pile_widgets()] + + def add_entry(self, button): + new_entry = self.create_entry_row() + self.entries.append(new_entry) + + self.contents = [(w, self.options()) for w in self.get_pile_widgets()] + + def get_pile_widgets(self): + return self.entries + [urwid.Padding(self.add_button, left=2, right=2)] + + def get_value(self): + values = [] + for entry in self.entries: + edit_widget = entry.contents[0][0] + value = edit_widget.edit_text.strip() + if value: + values.append(value) + return self.transform(values) + + def validate(self): + values = self.get_value() + self.error = None + + for validation in self.validation_types: + if validation == "required" and not values: + self.error = "At least one entry is required" + break + + self.error_widget.set_text(("error", self.error or "")) + return self.error is None \ No newline at end of file From e4f57d62605c3aa41c6fc5be58b2976fff4f4cce Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Mon, 31 Mar 2025 15:03:44 +0200 Subject: [PATCH 49/71] Updated dependencies --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index a17efae..3a5416e 100644 --- a/setup.py +++ b/setup.py @@ -30,6 +30,6 @@ setuptools.setup( entry_points= { 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, - install_requires=["rns>=0.9.2", "lxmf>=0.6.2", "urwid>=2.6.16", "qrcode"], + install_requires=["rns>=0.9.3", "lxmf>=0.6.2", "urwid>=2.6.16", "qrcode"], python_requires=">=3.7", ) From e79689010ed3753d85d31c8542db4bc3ff0b98c1 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Tue, 8 Apr 2025 02:03:34 +0200 Subject: [PATCH 50/71] Fixed directory sorting bug --- nomadnet/Directory.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nomadnet/Directory.py b/nomadnet/Directory.py index ee0ef09..ac03155 100644 --- a/nomadnet/Directory.py +++ b/nomadnet/Directory.py @@ -345,7 +345,7 @@ class Directory: if e.hosts_node: node_list.append(e) - node_list.sort(key = lambda e: (e.sort_rank if e.sort_rank != None else 2^32, DirectoryEntry.TRUSTED-e.trust_level, e.display_name)) + node_list.sort(key = lambda e: (e.sort_rank if e.sort_rank != None else 2^32, DirectoryEntry.TRUSTED-e.trust_level, e.display_name if e.display_name != None else "_")) return node_list def number_of_known_nodes(self): From 42fdc30cf8f2d2c3d844e8136cc8c2eea0ed37f4 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Tue, 8 Apr 2025 02:05:02 +0200 Subject: [PATCH 51/71] Cleanup configobj --- nomadnet/NomadNetworkApp.py | 2 +- nomadnet/vendor/configobj.py | 2483 ---------------------------------- 2 files changed, 1 insertion(+), 2484 deletions(-) delete mode 100644 nomadnet/vendor/configobj.py diff --git a/nomadnet/NomadNetworkApp.py b/nomadnet/NomadNetworkApp.py index 37c3f1e..81dc68f 100644 --- a/nomadnet/NomadNetworkApp.py +++ b/nomadnet/NomadNetworkApp.py @@ -19,7 +19,7 @@ from datetime import datetime import RNS.vendor.umsgpack as msgpack from ._version import __version__ -from .vendor.configobj import ConfigObj +from RNS.vendor.configobj import ConfigObj class NomadNetworkApp: time_format = "%Y-%m-%d %H:%M:%S" diff --git a/nomadnet/vendor/configobj.py b/nomadnet/vendor/configobj.py deleted file mode 100644 index e0c01b6..0000000 --- a/nomadnet/vendor/configobj.py +++ /dev/null @@ -1,2483 +0,0 @@ -# configobj.py -# A config file reader/writer that supports nested sections in config files. -# Copyright (C) 2005-2014: -# (name) : (email) -# Michael Foord: fuzzyman AT voidspace DOT org DOT uk -# Nicola Larosa: nico AT tekNico DOT net -# Rob Dennis: rdennis AT gmail DOT com -# Eli Courtwright: eli AT courtwright DOT org - -# This software is licensed under the terms of the BSD license. -# http://opensource.org/licenses/BSD-3-Clause - -# ConfigObj 5 - main repository for documentation and issue tracking: -# https://github.com/DiffSK/configobj - -import os -import re -import sys - -from codecs import BOM_UTF8, BOM_UTF16, BOM_UTF16_BE, BOM_UTF16_LE - -import RNS.vendor.six as six -__version__ = '5.0.6' - -# imported lazily to avoid startup performance hit if it isn't used -compiler = None - -# A dictionary mapping BOM to -# the encoding to decode with, and what to set the -# encoding attribute to. -BOMS = { - BOM_UTF8: ('utf_8', None), - BOM_UTF16_BE: ('utf16_be', 'utf_16'), - BOM_UTF16_LE: ('utf16_le', 'utf_16'), - BOM_UTF16: ('utf_16', 'utf_16'), - } -# All legal variants of the BOM codecs. -# TODO: the list of aliases is not meant to be exhaustive, is there a -# better way ? -BOM_LIST = { - 'utf_16': 'utf_16', - 'u16': 'utf_16', - 'utf16': 'utf_16', - 'utf-16': 'utf_16', - 'utf16_be': 'utf16_be', - 'utf_16_be': 'utf16_be', - 'utf-16be': 'utf16_be', - 'utf16_le': 'utf16_le', - 'utf_16_le': 'utf16_le', - 'utf-16le': 'utf16_le', - 'utf_8': 'utf_8', - 'u8': 'utf_8', - 'utf': 'utf_8', - 'utf8': 'utf_8', - 'utf-8': 'utf_8', - } - -# Map of encodings to the BOM to write. -BOM_SET = { - 'utf_8': BOM_UTF8, - 'utf_16': BOM_UTF16, - 'utf16_be': BOM_UTF16_BE, - 'utf16_le': BOM_UTF16_LE, - None: BOM_UTF8 - } - - -def match_utf8(encoding): - return BOM_LIST.get(encoding.lower()) == 'utf_8' - - -# Quote strings used for writing values -squot = "'%s'" -dquot = '"%s"' -noquot = "%s" -wspace_plus = ' \r\n\v\t\'"' -tsquot = '"""%s"""' -tdquot = "'''%s'''" - -# Sentinel for use in getattr calls to replace hasattr -MISSING = object() - -__all__ = ( - 'DEFAULT_INDENT_TYPE', - 'DEFAULT_INTERPOLATION', - 'ConfigObjError', - 'NestingError', - 'ParseError', - 'DuplicateError', - 'ConfigspecError', - 'ConfigObj', - 'SimpleVal', - 'InterpolationError', - 'InterpolationLoopError', - 'MissingInterpolationOption', - 'RepeatSectionError', - 'ReloadError', - 'UnreprError', - 'UnknownType', - 'flatten_errors', - 'get_extra_values' -) - -DEFAULT_INTERPOLATION = 'configparser' -DEFAULT_INDENT_TYPE = ' ' -MAX_INTERPOL_DEPTH = 10 - -OPTION_DEFAULTS = { - 'interpolation': True, - 'raise_errors': False, - 'list_values': True, - 'create_empty': False, - 'file_error': False, - 'configspec': None, - 'stringify': True, - # option may be set to one of ('', ' ', '\t') - 'indent_type': None, - 'encoding': None, - 'default_encoding': None, - 'unrepr': False, - 'write_empty_values': False, -} - -# this could be replaced if six is used for compatibility, or there are no -# more assertions about items being a string - - -def getObj(s): - global compiler - if compiler is None: - import compiler - s = "a=" + s - p = compiler.parse(s) - return p.getChildren()[1].getChildren()[0].getChildren()[1] - - -class UnknownType(Exception): - pass - - -class Builder(object): - - def build(self, o): - if m is None: - raise UnknownType(o.__class__.__name__) - return m(o) - - def build_List(self, o): - return list(map(self.build, o.getChildren())) - - def build_Const(self, o): - return o.value - - def build_Dict(self, o): - d = {} - i = iter(map(self.build, o.getChildren())) - for el in i: - d[el] = next(i) - return d - - def build_Tuple(self, o): - return tuple(self.build_List(o)) - - def build_Name(self, o): - if o.name == 'None': - return None - if o.name == 'True': - return True - if o.name == 'False': - return False - - # An undefined Name - raise UnknownType('Undefined Name') - - def build_Add(self, o): - real, imag = list(map(self.build_Const, o.getChildren())) - try: - real = float(real) - except TypeError: - raise UnknownType('Add') - if not isinstance(imag, complex) or imag.real != 0.0: - raise UnknownType('Add') - return real+imag - - def build_Getattr(self, o): - parent = self.build(o.expr) - return getattr(parent, o.attrname) - - def build_UnarySub(self, o): - return -self.build_Const(o.getChildren()[0]) - - def build_UnaryAdd(self, o): - return self.build_Const(o.getChildren()[0]) - - -_builder = Builder() - - -def unrepr(s): - if not s: - return s - - # this is supposed to be safe - import ast - return ast.literal_eval(s) - - -class ConfigObjError(SyntaxError): - """ - This is the base class for all errors that ConfigObj raises. - It is a subclass of SyntaxError. - """ - def __init__(self, message='', line_number=None, line=''): - self.line = line - self.line_number = line_number - SyntaxError.__init__(self, message) - - -class NestingError(ConfigObjError): - """ - This error indicates a level of nesting that doesn't match. - """ - - -class ParseError(ConfigObjError): - """ - This error indicates that a line is badly written. - It is neither a valid ``key = value`` line, - nor a valid section marker line. - """ - - -class ReloadError(IOError): - """ - A 'reload' operation failed. - This exception is a subclass of ``IOError``. - """ - def __init__(self): - IOError.__init__(self, 'reload failed, filename is not set.') - - -class DuplicateError(ConfigObjError): - """ - The keyword or section specified already exists. - """ - - -class ConfigspecError(ConfigObjError): - """ - An error occured whilst parsing a configspec. - """ - - -class InterpolationError(ConfigObjError): - """Base class for the two interpolation errors.""" - - -class InterpolationLoopError(InterpolationError): - """Maximum interpolation depth exceeded in string interpolation.""" - - def __init__(self, option): - InterpolationError.__init__( - self, - 'interpolation loop detected in value "%s".' % option) - - -class RepeatSectionError(ConfigObjError): - """ - This error indicates additional sections in a section with a - ``__many__`` (repeated) section. - """ - - -class MissingInterpolationOption(InterpolationError): - """A value specified for interpolation was missing.""" - def __init__(self, option): - msg = 'missing option "%s" in interpolation.' % option - InterpolationError.__init__(self, msg) - - -class UnreprError(ConfigObjError): - """An error parsing in unrepr mode.""" - - - -class InterpolationEngine(object): - """ - A helper class to help perform string interpolation. - - This class is an abstract base class; its descendants perform - the actual work. - """ - - # compiled regexp to use in self.interpolate() - _KEYCRE = re.compile(r"%\(([^)]*)\)s") - _cookie = '%' - - def __init__(self, section): - # the Section instance that "owns" this engine - self.section = section - - - def interpolate(self, key, value): - # short-cut - if not self._cookie in value: - return value - - def recursive_interpolate(key, value, section, backtrail): - """The function that does the actual work. - - ``value``: the string we're trying to interpolate. - ``section``: the section in which that string was found - ``backtrail``: a dict to keep track of where we've been, - to detect and prevent infinite recursion loops - - This is similar to a depth-first-search algorithm. - """ - # Have we been here already? - if (key, section.name) in backtrail: - # Yes - infinite loop detected - raise InterpolationLoopError(key) - # Place a marker on our backtrail so we won't come back here again - backtrail[(key, section.name)] = 1 - - # Now start the actual work - match = self._KEYCRE.search(value) - while match: - # The actual parsing of the match is implementation-dependent, - # so delegate to our helper function - k, v, s = self._parse_match(match) - if k is None: - # That's the signal that no further interpolation is needed - replacement = v - else: - # Further interpolation may be needed to obtain final value - replacement = recursive_interpolate(k, v, s, backtrail) - # Replace the matched string with its final value - start, end = match.span() - value = ''.join((value[:start], replacement, value[end:])) - new_search_start = start + len(replacement) - # Pick up the next interpolation key, if any, for next time - # through the while loop - match = self._KEYCRE.search(value, new_search_start) - - # Now safe to come back here again; remove marker from backtrail - del backtrail[(key, section.name)] - - return value - - # Back in interpolate(), all we have to do is kick off the recursive - # function with appropriate starting values - value = recursive_interpolate(key, value, self.section, {}) - return value - - - def _fetch(self, key): - """Helper function to fetch values from owning section. - - Returns a 2-tuple: the value, and the section where it was found. - """ - # switch off interpolation before we try and fetch anything ! - save_interp = self.section.main.interpolation - self.section.main.interpolation = False - - # Start at section that "owns" this InterpolationEngine - current_section = self.section - while True: - # try the current section first - val = current_section.get(key) - if val is not None and not isinstance(val, Section): - break - # try "DEFAULT" next - val = current_section.get('DEFAULT', {}).get(key) - if val is not None and not isinstance(val, Section): - break - # move up to parent and try again - # top-level's parent is itself - if current_section.parent is current_section: - # reached top level, time to give up - break - current_section = current_section.parent - - # restore interpolation to previous value before returning - self.section.main.interpolation = save_interp - if val is None: - raise MissingInterpolationOption(key) - return val, current_section - - - def _parse_match(self, match): - """Implementation-dependent helper function. - - Will be passed a match object corresponding to the interpolation - key we just found (e.g., "%(foo)s" or "$foo"). Should look up that - key in the appropriate config file section (using the ``_fetch()`` - helper function) and return a 3-tuple: (key, value, section) - - ``key`` is the name of the key we're looking for - ``value`` is the value found for that key - ``section`` is a reference to the section where it was found - - ``key`` and ``section`` should be None if no further - interpolation should be performed on the resulting value - (e.g., if we interpolated "$$" and returned "$"). - """ - raise NotImplementedError() - - - -class ConfigParserInterpolation(InterpolationEngine): - """Behaves like ConfigParser.""" - _cookie = '%' - _KEYCRE = re.compile(r"%\(([^)]*)\)s") - - def _parse_match(self, match): - key = match.group(1) - value, section = self._fetch(key) - return key, value, section - - - -class TemplateInterpolation(InterpolationEngine): - """Behaves like string.Template.""" - _cookie = '$' - _delimiter = '$' - _KEYCRE = re.compile(r""" - \$(?: - (?P\$) | # Two $ signs - (?P[_a-z][_a-z0-9]*) | # $name format - {(?P[^}]*)} # ${name} format - ) - """, re.IGNORECASE | re.VERBOSE) - - def _parse_match(self, match): - # Valid name (in or out of braces): fetch value from section - key = match.group('named') or match.group('braced') - if key is not None: - value, section = self._fetch(key) - return key, value, section - # Escaped delimiter (e.g., $$): return single delimiter - if match.group('escaped') is not None: - # Return None for key and section to indicate it's time to stop - return None, self._delimiter, None - # Anything else: ignore completely, just return it unchanged - return None, match.group(), None - - -interpolation_engines = { - 'configparser': ConfigParserInterpolation, - 'template': TemplateInterpolation, -} - - -def __newobj__(cls, *args): - # Hack for pickle - return cls.__new__(cls, *args) - -class Section(dict): - """ - A dictionary-like object that represents a section in a config file. - - It does string interpolation if the 'interpolation' attribute - of the 'main' object is set to True. - - Interpolation is tried first from this object, then from the 'DEFAULT' - section of this object, next from the parent and its 'DEFAULT' section, - and so on until the main object is reached. - - A Section will behave like an ordered dictionary - following the - order of the ``scalars`` and ``sections`` attributes. - You can use this to change the order of members. - - Iteration follows the order: scalars, then sections. - """ - - - def __setstate__(self, state): - dict.update(self, state[0]) - self.__dict__.update(state[1]) - - def __reduce__(self): - state = (dict(self), self.__dict__) - return (__newobj__, (self.__class__,), state) - - - def __init__(self, parent, depth, main, indict=None, name=None): - """ - * parent is the section above - * depth is the depth level of this section - * main is the main ConfigObj - * indict is a dictionary to initialise the section with - """ - if indict is None: - indict = {} - dict.__init__(self) - # used for nesting level *and* interpolation - self.parent = parent - # used for the interpolation attribute - self.main = main - # level of nesting depth of this Section - self.depth = depth - # purely for information - self.name = name - # - self._initialise() - # we do this explicitly so that __setitem__ is used properly - # (rather than just passing to ``dict.__init__``) - for entry, value in indict.items(): - self[entry] = value - - - def _initialise(self): - # the sequence of scalar values in this Section - self.scalars = [] - # the sequence of sections in this Section - self.sections = [] - # for comments :-) - self.comments = {} - self.inline_comments = {} - # the configspec - self.configspec = None - # for defaults - self.defaults = [] - self.default_values = {} - self.extra_values = [] - self._created = False - - - def _interpolate(self, key, value): - try: - # do we already have an interpolation engine? - engine = self._interpolation_engine - except AttributeError: - # not yet: first time running _interpolate(), so pick the engine - name = self.main.interpolation - if name == True: # note that "if name:" would be incorrect here - # backwards-compatibility: interpolation=True means use default - name = DEFAULT_INTERPOLATION - name = name.lower() # so that "Template", "template", etc. all work - class_ = interpolation_engines.get(name, None) - if class_ is None: - # invalid value for self.main.interpolation - self.main.interpolation = False - return value - else: - # save reference to engine so we don't have to do this again - engine = self._interpolation_engine = class_(self) - # let the engine do the actual work - return engine.interpolate(key, value) - - - def __getitem__(self, key): - """Fetch the item and do string interpolation.""" - val = dict.__getitem__(self, key) - if self.main.interpolation: - if isinstance(val, six.string_types): - return self._interpolate(key, val) - if isinstance(val, list): - def _check(entry): - if isinstance(entry, six.string_types): - return self._interpolate(key, entry) - return entry - new = [_check(entry) for entry in val] - if new != val: - return new - return val - - - def __setitem__(self, key, value, unrepr=False): - """ - Correctly set a value. - - Making dictionary values Section instances. - (We have to special case 'Section' instances - which are also dicts) - - Keys must be strings. - Values need only be strings (or lists of strings) if - ``main.stringify`` is set. - - ``unrepr`` must be set when setting a value to a dictionary, without - creating a new sub-section. - """ - if not isinstance(key, six.string_types): - raise ValueError('The key "%s" is not a string.' % key) - - # add the comment - if key not in self.comments: - self.comments[key] = [] - self.inline_comments[key] = '' - # remove the entry from defaults - if key in self.defaults: - self.defaults.remove(key) - # - if isinstance(value, Section): - if key not in self: - self.sections.append(key) - dict.__setitem__(self, key, value) - elif isinstance(value, dict) and not unrepr: - # First create the new depth level, - # then create the section - if key not in self: - self.sections.append(key) - new_depth = self.depth + 1 - dict.__setitem__( - self, - key, - Section( - self, - new_depth, - self.main, - indict=value, - name=key)) - else: - if key not in self: - self.scalars.append(key) - if not self.main.stringify: - if isinstance(value, six.string_types): - pass - elif isinstance(value, (list, tuple)): - for entry in value: - if not isinstance(entry, six.string_types): - raise TypeError('Value is not a string "%s".' % entry) - else: - raise TypeError('Value is not a string "%s".' % value) - dict.__setitem__(self, key, value) - - - def __delitem__(self, key): - """Remove items from the sequence when deleting.""" - dict. __delitem__(self, key) - if key in self.scalars: - self.scalars.remove(key) - else: - self.sections.remove(key) - del self.comments[key] - del self.inline_comments[key] - - - def get(self, key, default=None): - """A version of ``get`` that doesn't bypass string interpolation.""" - try: - return self[key] - except KeyError: - return default - - - def update(self, indict): - """ - A version of update that uses our ``__setitem__``. - """ - for entry in indict: - self[entry] = indict[entry] - - - def pop(self, key, default=MISSING): - """ - 'D.pop(k[,d]) -> v, remove specified key and return the corresponding value. - If key is not found, d is returned if given, otherwise KeyError is raised' - """ - try: - val = self[key] - except KeyError: - if default is MISSING: - raise - val = default - else: - del self[key] - return val - - - def popitem(self): - """Pops the first (key,val)""" - sequence = (self.scalars + self.sections) - if not sequence: - raise KeyError(": 'popitem(): dictionary is empty'") - key = sequence[0] - val = self[key] - del self[key] - return key, val - - - def clear(self): - """ - A version of clear that also affects scalars/sections - Also clears comments and configspec. - - Leaves other attributes alone : - depth/main/parent are not affected - """ - dict.clear(self) - self.scalars = [] - self.sections = [] - self.comments = {} - self.inline_comments = {} - self.configspec = None - self.defaults = [] - self.extra_values = [] - - - def setdefault(self, key, default=None): - """A version of setdefault that sets sequence if appropriate.""" - try: - return self[key] - except KeyError: - self[key] = default - return self[key] - - - def items(self): - """D.items() -> list of D's (key, value) pairs, as 2-tuples""" - return list(zip((self.scalars + self.sections), list(self.values()))) - - - def keys(self): - """D.keys() -> list of D's keys""" - return (self.scalars + self.sections) - - - def values(self): - """D.values() -> list of D's values""" - return [self[key] for key in (self.scalars + self.sections)] - - - def iteritems(self): - """D.iteritems() -> an iterator over the (key, value) items of D""" - return iter(list(self.items())) - - - def iterkeys(self): - """D.iterkeys() -> an iterator over the keys of D""" - return iter((self.scalars + self.sections)) - - __iter__ = iterkeys - - - def itervalues(self): - """D.itervalues() -> an iterator over the values of D""" - return iter(list(self.values())) - - - def __repr__(self): - """x.__repr__() <==> repr(x)""" - def _getval(key): - try: - return self[key] - except MissingInterpolationOption: - return dict.__getitem__(self, key) - return '{%s}' % ', '.join([('%s: %s' % (repr(key), repr(_getval(key)))) - for key in (self.scalars + self.sections)]) - - __str__ = __repr__ - __str__.__doc__ = "x.__str__() <==> str(x)" - - - # Extra methods - not in a normal dictionary - - def dict(self): - """ - Return a deepcopy of self as a dictionary. - - All members that are ``Section`` instances are recursively turned to - ordinary dictionaries - by calling their ``dict`` method. - - >>> n = a.dict() - >>> n == a - 1 - >>> n is a - 0 - """ - newdict = {} - for entry in self: - this_entry = self[entry] - if isinstance(this_entry, Section): - this_entry = this_entry.dict() - elif isinstance(this_entry, list): - # create a copy rather than a reference - this_entry = list(this_entry) - elif isinstance(this_entry, tuple): - # create a copy rather than a reference - this_entry = tuple(this_entry) - newdict[entry] = this_entry - return newdict - - - def merge(self, indict): - """ - A recursive update - useful for merging config files. - - >>> a = '''[section1] - ... option1 = True - ... [[subsection]] - ... more_options = False - ... # end of file'''.splitlines() - >>> b = '''# File is user.ini - ... [section1] - ... option1 = False - ... # end of file'''.splitlines() - >>> c1 = ConfigObj(b) - >>> c2 = ConfigObj(a) - >>> c2.merge(c1) - >>> c2 - ConfigObj({'section1': {'option1': 'False', 'subsection': {'more_options': 'False'}}}) - """ - for key, val in list(indict.items()): - if (key in self and isinstance(self[key], dict) and - isinstance(val, dict)): - self[key].merge(val) - else: - self[key] = val - - - def rename(self, oldkey, newkey): - """ - Change a keyname to another, without changing position in sequence. - - Implemented so that transformations can be made on keys, - as well as on values. (used by encode and decode) - - Also renames comments. - """ - if oldkey in self.scalars: - the_list = self.scalars - elif oldkey in self.sections: - the_list = self.sections - else: - raise KeyError('Key "%s" not found.' % oldkey) - pos = the_list.index(oldkey) - # - val = self[oldkey] - dict.__delitem__(self, oldkey) - dict.__setitem__(self, newkey, val) - the_list.remove(oldkey) - the_list.insert(pos, newkey) - comm = self.comments[oldkey] - inline_comment = self.inline_comments[oldkey] - del self.comments[oldkey] - del self.inline_comments[oldkey] - self.comments[newkey] = comm - self.inline_comments[newkey] = inline_comment - - - def walk(self, function, raise_errors=True, - call_on_sections=False, **keywargs): - """ - Walk every member and call a function on the keyword and value. - - Return a dictionary of the return values - - If the function raises an exception, raise the errror - unless ``raise_errors=False``, in which case set the return value to - ``False``. - - Any unrecognised keyword arguments you pass to walk, will be pased on - to the function you pass in. - - Note: if ``call_on_sections`` is ``True`` then - on encountering a - subsection, *first* the function is called for the *whole* subsection, - and then recurses into it's members. This means your function must be - able to handle strings, dictionaries and lists. This allows you - to change the key of subsections as well as for ordinary members. The - return value when called on the whole subsection has to be discarded. - - See the encode and decode methods for examples, including functions. - - .. admonition:: caution - - You can use ``walk`` to transform the names of members of a section - but you mustn't add or delete members. - - >>> config = '''[XXXXsection] - ... XXXXkey = XXXXvalue'''.splitlines() - >>> cfg = ConfigObj(config) - >>> cfg - ConfigObj({'XXXXsection': {'XXXXkey': 'XXXXvalue'}}) - >>> def transform(section, key): - ... val = section[key] - ... newkey = key.replace('XXXX', 'CLIENT1') - ... section.rename(key, newkey) - ... if isinstance(val, (tuple, list, dict)): - ... pass - ... else: - ... val = val.replace('XXXX', 'CLIENT1') - ... section[newkey] = val - >>> cfg.walk(transform, call_on_sections=True) - {'CLIENT1section': {'CLIENT1key': None}} - >>> cfg - ConfigObj({'CLIENT1section': {'CLIENT1key': 'CLIENT1value'}}) - """ - out = {} - # scalars first - for i in range(len(self.scalars)): - entry = self.scalars[i] - try: - val = function(self, entry, **keywargs) - # bound again in case name has changed - entry = self.scalars[i] - out[entry] = val - except Exception: - if raise_errors: - raise - else: - entry = self.scalars[i] - out[entry] = False - # then sections - for i in range(len(self.sections)): - entry = self.sections[i] - if call_on_sections: - try: - function(self, entry, **keywargs) - except Exception: - if raise_errors: - raise - else: - entry = self.sections[i] - out[entry] = False - # bound again in case name has changed - entry = self.sections[i] - # previous result is discarded - out[entry] = self[entry].walk( - function, - raise_errors=raise_errors, - call_on_sections=call_on_sections, - **keywargs) - return out - - - def as_bool(self, key): - """ - Accepts a key as input. The corresponding value must be a string or - the objects (``True`` or 1) or (``False`` or 0). We allow 0 and 1 to - retain compatibility with Python 2.2. - - If the string is one of ``True``, ``On``, ``Yes``, or ``1`` it returns - ``True``. - - If the string is one of ``False``, ``Off``, ``No``, or ``0`` it returns - ``False``. - - ``as_bool`` is not case sensitive. - - Any other input will raise a ``ValueError``. - - >>> a = ConfigObj() - >>> a['a'] = 'fish' - >>> a.as_bool('a') - Traceback (most recent call last): - ValueError: Value "fish" is neither True nor False - >>> a['b'] = 'True' - >>> a.as_bool('b') - 1 - >>> a['b'] = 'off' - >>> a.as_bool('b') - 0 - """ - val = self[key] - if val == True: - return True - elif val == False: - return False - else: - try: - if not isinstance(val, six.string_types): - # TODO: Why do we raise a KeyError here? - raise KeyError() - else: - return self.main._bools[val.lower()] - except KeyError: - raise ValueError('Value "%s" is neither True nor False' % val) - - - def as_int(self, key): - """ - A convenience method which coerces the specified value to an integer. - - If the value is an invalid literal for ``int``, a ``ValueError`` will - be raised. - - >>> a = ConfigObj() - >>> a['a'] = 'fish' - >>> a.as_int('a') - Traceback (most recent call last): - ValueError: invalid literal for int() with base 10: 'fish' - >>> a['b'] = '1' - >>> a.as_int('b') - 1 - >>> a['b'] = '3.2' - >>> a.as_int('b') - Traceback (most recent call last): - ValueError: invalid literal for int() with base 10: '3.2' - """ - return int(self[key]) - - - def as_float(self, key): - """ - A convenience method which coerces the specified value to a float. - - If the value is an invalid literal for ``float``, a ``ValueError`` will - be raised. - - >>> a = ConfigObj() - >>> a['a'] = 'fish' - >>> a.as_float('a') #doctest: +IGNORE_EXCEPTION_DETAIL - Traceback (most recent call last): - ValueError: invalid literal for float(): fish - >>> a['b'] = '1' - >>> a.as_float('b') - 1.0 - >>> a['b'] = '3.2' - >>> a.as_float('b') #doctest: +ELLIPSIS - 3.2... - """ - return float(self[key]) - - - def as_list(self, key): - """ - A convenience method which fetches the specified value, guaranteeing - that it is a list. - - >>> a = ConfigObj() - >>> a['a'] = 1 - >>> a.as_list('a') - [1] - >>> a['a'] = (1,) - >>> a.as_list('a') - [1] - >>> a['a'] = [1] - >>> a.as_list('a') - [1] - """ - result = self[key] - if isinstance(result, (tuple, list)): - return list(result) - return [result] - - - def restore_default(self, key): - """ - Restore (and return) default value for the specified key. - - This method will only work for a ConfigObj that was created - with a configspec and has been validated. - - If there is no default value for this key, ``KeyError`` is raised. - """ - default = self.default_values[key] - dict.__setitem__(self, key, default) - if key not in self.defaults: - self.defaults.append(key) - return default - - - def restore_defaults(self): - """ - Recursively restore default values to all members - that have them. - - This method will only work for a ConfigObj that was created - with a configspec and has been validated. - - It doesn't delete or modify entries without default values. - """ - for key in self.default_values: - self.restore_default(key) - - for section in self.sections: - self[section].restore_defaults() - - -class ConfigObj(Section): - """An object to read, create, and write config files.""" - - _keyword = re.compile(r'''^ # line start - (\s*) # indentation - ( # keyword - (?:".*?")| # double quotes - (?:'.*?')| # single quotes - (?:[^'"=].*?) # no quotes - ) - \s*=\s* # divider - (.*) # value (including list values and comments) - $ # line end - ''', - re.VERBOSE) - - _sectionmarker = re.compile(r'''^ - (\s*) # 1: indentation - ((?:\[\s*)+) # 2: section marker open - ( # 3: section name open - (?:"\s*\S.*?\s*")| # at least one non-space with double quotes - (?:'\s*\S.*?\s*')| # at least one non-space with single quotes - (?:[^'"\s].*?) # at least one non-space unquoted - ) # section name close - ((?:\s*\])+) # 4: section marker close - \s*(\#.*)? # 5: optional comment - $''', - re.VERBOSE) - - # this regexp pulls list values out as a single string - # or single values and comments - # FIXME: this regex adds a '' to the end of comma terminated lists - # workaround in ``_handle_value`` - _valueexp = re.compile(r'''^ - (?: - (?: - ( - (?: - (?: - (?:".*?")| # double quotes - (?:'.*?')| # single quotes - (?:[^'",\#][^,\#]*?) # unquoted - ) - \s*,\s* # comma - )* # match all list items ending in a comma (if any) - ) - ( - (?:".*?")| # double quotes - (?:'.*?')| # single quotes - (?:[^'",\#\s][^,]*?)| # unquoted - (?:(? 1: - msg = "Parsing failed with several errors.\nFirst error %s" % info - error = ConfigObjError(msg) - else: - error = self._errors[0] - # set the errors attribute; it's a list of tuples: - # (error_type, message, line_number) - error.errors = self._errors - # set the config attribute - error.config = self - raise error - # delete private attributes - del self._errors - - if configspec is None: - self.configspec = None - else: - self._handle_configspec(configspec) - - - def _initialise(self, options=None): - if options is None: - options = OPTION_DEFAULTS - - # initialise a few variables - self.filename = None - self._errors = [] - self.raise_errors = options['raise_errors'] - self.interpolation = options['interpolation'] - self.list_values = options['list_values'] - self.create_empty = options['create_empty'] - self.file_error = options['file_error'] - self.stringify = options['stringify'] - self.indent_type = options['indent_type'] - self.encoding = options['encoding'] - self.default_encoding = options['default_encoding'] - self.BOM = False - self.newlines = None - self.write_empty_values = options['write_empty_values'] - self.unrepr = options['unrepr'] - - self.initial_comment = [] - self.final_comment = [] - self.configspec = None - - if self._inspec: - self.list_values = False - - # Clear section attributes as well - Section._initialise(self) - - - def __repr__(self): - def _getval(key): - try: - return self[key] - except MissingInterpolationOption: - return dict.__getitem__(self, key) - return ('ConfigObj({%s})' % - ', '.join([('%s: %s' % (repr(key), repr(_getval(key)))) - for key in (self.scalars + self.sections)])) - - - def _handle_bom(self, infile): - """ - Handle any BOM, and decode if necessary. - - If an encoding is specified, that *must* be used - but the BOM should - still be removed (and the BOM attribute set). - - (If the encoding is wrongly specified, then a BOM for an alternative - encoding won't be discovered or removed.) - - If an encoding is not specified, UTF8 or UTF16 BOM will be detected and - removed. The BOM attribute will be set. UTF16 will be decoded to - unicode. - - NOTE: This method must not be called with an empty ``infile``. - - Specifying the *wrong* encoding is likely to cause a - ``UnicodeDecodeError``. - - ``infile`` must always be returned as a list of lines, but may be - passed in as a single string. - """ - - if ((self.encoding is not None) and - (self.encoding.lower() not in BOM_LIST)): - # No need to check for a BOM - # the encoding specified doesn't have one - # just decode - return self._decode(infile, self.encoding) - - if isinstance(infile, (list, tuple)): - line = infile[0] - else: - line = infile - - if isinstance(line, six.text_type): - # it's already decoded and there's no need to do anything - # else, just use the _decode utility method to handle - # listifying appropriately - return self._decode(infile, self.encoding) - - if self.encoding is not None: - # encoding explicitly supplied - # And it could have an associated BOM - # TODO: if encoding is just UTF16 - we ought to check for both - # TODO: big endian and little endian versions. - enc = BOM_LIST[self.encoding.lower()] - if enc == 'utf_16': - # For UTF16 we try big endian and little endian - for BOM, (encoding, final_encoding) in list(BOMS.items()): - if not final_encoding: - # skip UTF8 - continue - if infile.startswith(BOM): - ### BOM discovered - ##self.BOM = True - # Don't need to remove BOM - return self._decode(infile, encoding) - - # If we get this far, will *probably* raise a DecodeError - # As it doesn't appear to start with a BOM - return self._decode(infile, self.encoding) - - # Must be UTF8 - BOM = BOM_SET[enc] - if not line.startswith(BOM): - return self._decode(infile, self.encoding) - - newline = line[len(BOM):] - - # BOM removed - if isinstance(infile, (list, tuple)): - infile[0] = newline - else: - infile = newline - self.BOM = True - return self._decode(infile, self.encoding) - - # No encoding specified - so we need to check for UTF8/UTF16 - for BOM, (encoding, final_encoding) in list(BOMS.items()): - if not isinstance(line, six.binary_type) or not line.startswith(BOM): - # didn't specify a BOM, or it's not a bytestring - continue - else: - # BOM discovered - self.encoding = final_encoding - if not final_encoding: - self.BOM = True - # UTF8 - # remove BOM - newline = line[len(BOM):] - if isinstance(infile, (list, tuple)): - infile[0] = newline - else: - infile = newline - # UTF-8 - if isinstance(infile, six.text_type): - return infile.splitlines(True) - elif isinstance(infile, six.binary_type): - return infile.decode('utf-8').splitlines(True) - else: - return self._decode(infile, 'utf-8') - # UTF16 - have to decode - return self._decode(infile, encoding) - - - if six.PY2 and isinstance(line, str): - # don't actually do any decoding, since we're on python 2 and - # returning a bytestring is fine - return self._decode(infile, None) - # No BOM discovered and no encoding specified, default to UTF-8 - if isinstance(infile, six.binary_type): - return infile.decode('utf-8').splitlines(True) - else: - return self._decode(infile, 'utf-8') - - - def _a_to_u(self, aString): - """Decode ASCII strings to unicode if a self.encoding is specified.""" - if isinstance(aString, six.binary_type) and self.encoding: - return aString.decode(self.encoding) - else: - return aString - - - def _decode(self, infile, encoding): - """ - Decode infile to unicode. Using the specified encoding. - - if is a string, it also needs converting to a list. - """ - if isinstance(infile, six.string_types): - return infile.splitlines(True) - if isinstance(infile, six.binary_type): - # NOTE: Could raise a ``UnicodeDecodeError`` - if encoding: - return infile.decode(encoding).splitlines(True) - else: - return infile.splitlines(True) - - if encoding: - for i, line in enumerate(infile): - if isinstance(line, six.binary_type): - # NOTE: The isinstance test here handles mixed lists of unicode/string - # NOTE: But the decode will break on any non-string values - # NOTE: Or could raise a ``UnicodeDecodeError`` - infile[i] = line.decode(encoding) - return infile - - - def _decode_element(self, line): - """Decode element to unicode if necessary.""" - if isinstance(line, six.binary_type) and self.default_encoding: - return line.decode(self.default_encoding) - else: - return line - - - # TODO: this may need to be modified - def _str(self, value): - """ - Used by ``stringify`` within validate, to turn non-string values - into strings. - """ - if not isinstance(value, six.string_types): - # intentially 'str' because it's just whatever the "normal" - # string type is for the python version we're dealing with - return str(value) - else: - return value - - - def _parse(self, infile): - """Actually parse the config file.""" - temp_list_values = self.list_values - if self.unrepr: - self.list_values = False - - comment_list = [] - done_start = False - this_section = self - maxline = len(infile) - 1 - cur_index = -1 - reset_comment = False - - while cur_index < maxline: - if reset_comment: - comment_list = [] - cur_index += 1 - line = infile[cur_index] - sline = line.strip() - # do we have anything on the line ? - if not sline or sline.startswith('#'): - reset_comment = False - comment_list.append(line) - continue - - if not done_start: - # preserve initial comment - self.initial_comment = comment_list - comment_list = [] - done_start = True - - reset_comment = True - # first we check if it's a section marker - mat = self._sectionmarker.match(line) - if mat is not None: - # is a section line - (indent, sect_open, sect_name, sect_close, comment) = mat.groups() - if indent and (self.indent_type is None): - self.indent_type = indent - cur_depth = sect_open.count('[') - if cur_depth != sect_close.count(']'): - self._handle_error("Cannot compute the section depth", - NestingError, infile, cur_index) - continue - - if cur_depth < this_section.depth: - # the new section is dropping back to a previous level - try: - parent = self._match_depth(this_section, - cur_depth).parent - except SyntaxError: - self._handle_error("Cannot compute nesting level", - NestingError, infile, cur_index) - continue - elif cur_depth == this_section.depth: - # the new section is a sibling of the current section - parent = this_section.parent - elif cur_depth == this_section.depth + 1: - # the new section is a child the current section - parent = this_section - else: - self._handle_error("Section too nested", - NestingError, infile, cur_index) - continue - - sect_name = self._unquote(sect_name) - if sect_name in parent: - self._handle_error('Duplicate section name', - DuplicateError, infile, cur_index) - continue - - # create the new section - this_section = Section( - parent, - cur_depth, - self, - name=sect_name) - parent[sect_name] = this_section - parent.inline_comments[sect_name] = comment - parent.comments[sect_name] = comment_list - continue - # - # it's not a section marker, - # so it should be a valid ``key = value`` line - mat = self._keyword.match(line) - if mat is None: - self._handle_error( - 'Invalid line ({0!r}) (matched as neither section nor keyword)'.format(line), - ParseError, infile, cur_index) - else: - # is a keyword value - # value will include any inline comment - (indent, key, value) = mat.groups() - if indent and (self.indent_type is None): - self.indent_type = indent - # check for a multiline value - if value[:3] in ['"""', "'''"]: - try: - value, comment, cur_index = self._multiline( - value, infile, cur_index, maxline) - except SyntaxError: - self._handle_error( - 'Parse error in multiline value', - ParseError, infile, cur_index) - continue - else: - if self.unrepr: - comment = '' - try: - value = unrepr(value) - except Exception as e: - if type(e) == UnknownType: - msg = 'Unknown name or type in value' - else: - msg = 'Parse error from unrepr-ing multiline value' - self._handle_error(msg, UnreprError, infile, - cur_index) - continue - else: - if self.unrepr: - comment = '' - try: - value = unrepr(value) - except Exception as e: - if isinstance(e, UnknownType): - msg = 'Unknown name or type in value' - else: - msg = 'Parse error from unrepr-ing value' - self._handle_error(msg, UnreprError, infile, - cur_index) - continue - else: - # extract comment and lists - try: - (value, comment) = self._handle_value(value) - except SyntaxError: - self._handle_error( - 'Parse error in value', - ParseError, infile, cur_index) - continue - # - key = self._unquote(key) - if key in this_section: - self._handle_error( - 'Duplicate keyword name', - DuplicateError, infile, cur_index) - continue - # add the key. - # we set unrepr because if we have got this far we will never - # be creating a new section - this_section.__setitem__(key, value, unrepr=True) - this_section.inline_comments[key] = comment - this_section.comments[key] = comment_list - continue - # - if self.indent_type is None: - # no indentation used, set the type accordingly - self.indent_type = '' - - # preserve the final comment - if not self and not self.initial_comment: - self.initial_comment = comment_list - elif not reset_comment: - self.final_comment = comment_list - self.list_values = temp_list_values - - - def _match_depth(self, sect, depth): - """ - Given a section and a depth level, walk back through the sections - parents to see if the depth level matches a previous section. - - Return a reference to the right section, - or raise a SyntaxError. - """ - while depth < sect.depth: - if sect is sect.parent: - # we've reached the top level already - raise SyntaxError() - sect = sect.parent - if sect.depth == depth: - return sect - # shouldn't get here - raise SyntaxError() - - - def _handle_error(self, text, ErrorClass, infile, cur_index): - """ - Handle an error according to the error settings. - - Either raise the error or store it. - The error will have occured at ``cur_index`` - """ - line = infile[cur_index] - cur_index += 1 - message = '{0} at line {1}.'.format(text, cur_index) - error = ErrorClass(message, cur_index, line) - if self.raise_errors: - # raise the error - parsing stops here - raise error - # store the error - # reraise when parsing has finished - self._errors.append(error) - - - def _unquote(self, value): - """Return an unquoted version of a value""" - if not value: - # should only happen during parsing of lists - raise SyntaxError - if (value[0] == value[-1]) and (value[0] in ('"', "'")): - value = value[1:-1] - return value - - - def _quote(self, value, multiline=True): - """ - Return a safely quoted version of a value. - - Raise a ConfigObjError if the value cannot be safely quoted. - If multiline is ``True`` (default) then use triple quotes - if necessary. - - * Don't quote values that don't need it. - * Recursively quote members of a list and return a comma joined list. - * Multiline is ``False`` for lists. - * Obey list syntax for empty and single member lists. - - If ``list_values=False`` then the value is only quoted if it contains - a ``\\n`` (is multiline) or '#'. - - If ``write_empty_values`` is set, and the value is an empty string, it - won't be quoted. - """ - if multiline and self.write_empty_values and value == '': - # Only if multiline is set, so that it is used for values not - # keys, and not values that are part of a list - return '' - - if multiline and isinstance(value, (list, tuple)): - if not value: - return ',' - elif len(value) == 1: - return self._quote(value[0], multiline=False) + ',' - return ', '.join([self._quote(val, multiline=False) - for val in value]) - if not isinstance(value, six.string_types): - if self.stringify: - # intentially 'str' because it's just whatever the "normal" - # string type is for the python version we're dealing with - value = str(value) - else: - raise TypeError('Value "%s" is not a string.' % value) - - if not value: - return '""' - - no_lists_no_quotes = not self.list_values and '\n' not in value and '#' not in value - need_triple = multiline and ((("'" in value) and ('"' in value)) or ('\n' in value )) - hash_triple_quote = multiline and not need_triple and ("'" in value) and ('"' in value) and ('#' in value) - check_for_single = (no_lists_no_quotes or not need_triple) and not hash_triple_quote - - if check_for_single: - if not self.list_values: - # we don't quote if ``list_values=False`` - quot = noquot - # for normal values either single or double quotes will do - elif '\n' in value: - # will only happen if multiline is off - e.g. '\n' in key - raise ConfigObjError('Value "%s" cannot be safely quoted.' % value) - elif ((value[0] not in wspace_plus) and - (value[-1] not in wspace_plus) and - (',' not in value)): - quot = noquot - else: - quot = self._get_single_quote(value) - else: - # if value has '\n' or "'" *and* '"', it will need triple quotes - quot = self._get_triple_quote(value) - - if quot == noquot and '#' in value and self.list_values: - quot = self._get_single_quote(value) - - return quot % value - - - def _get_single_quote(self, value): - if ("'" in value) and ('"' in value): - raise ConfigObjError('Value "%s" cannot be safely quoted.' % value) - elif '"' in value: - quot = squot - else: - quot = dquot - return quot - - - def _get_triple_quote(self, value): - if (value.find('"""') != -1) and (value.find("'''") != -1): - raise ConfigObjError('Value "%s" cannot be safely quoted.' % value) - if value.find('"""') == -1: - quot = tdquot - else: - quot = tsquot - return quot - - - def _handle_value(self, value): - """ - Given a value string, unquote, remove comment, - handle lists. (including empty and single member lists) - """ - if self._inspec: - # Parsing a configspec so don't handle comments - return (value, '') - # do we look for lists in values ? - if not self.list_values: - mat = self._nolistvalue.match(value) - if mat is None: - raise SyntaxError() - # NOTE: we don't unquote here - return mat.groups() - # - mat = self._valueexp.match(value) - if mat is None: - # the value is badly constructed, probably badly quoted, - # or an invalid list - raise SyntaxError() - (list_values, single, empty_list, comment) = mat.groups() - if (list_values == '') and (single is None): - # change this if you want to accept empty values - raise SyntaxError() - # NOTE: note there is no error handling from here if the regex - # is wrong: then incorrect values will slip through - if empty_list is not None: - # the single comma - meaning an empty list - return ([], comment) - if single is not None: - # handle empty values - if list_values and not single: - # FIXME: the '' is a workaround because our regex now matches - # '' at the end of a list if it has a trailing comma - single = None - else: - single = single or '""' - single = self._unquote(single) - if list_values == '': - # not a list value - return (single, comment) - the_list = self._listvalueexp.findall(list_values) - the_list = [self._unquote(val) for val in the_list] - if single is not None: - the_list += [single] - return (the_list, comment) - - - def _multiline(self, value, infile, cur_index, maxline): - """Extract the value, where we are in a multiline situation.""" - quot = value[:3] - newvalue = value[3:] - single_line = self._triple_quote[quot][0] - multi_line = self._triple_quote[quot][1] - mat = single_line.match(value) - if mat is not None: - retval = list(mat.groups()) - retval.append(cur_index) - return retval - elif newvalue.find(quot) != -1: - # somehow the triple quote is missing - raise SyntaxError() - # - while cur_index < maxline: - cur_index += 1 - newvalue += '\n' - line = infile[cur_index] - if line.find(quot) == -1: - newvalue += line - else: - # end of multiline, process it - break - else: - # we've got to the end of the config, oops... - raise SyntaxError() - mat = multi_line.match(line) - if mat is None: - # a badly formed line - raise SyntaxError() - (value, comment) = mat.groups() - return (newvalue + value, comment, cur_index) - - - def _handle_configspec(self, configspec): - """Parse the configspec.""" - # FIXME: Should we check that the configspec was created with the - # correct settings ? (i.e. ``list_values=False``) - if not isinstance(configspec, ConfigObj): - try: - configspec = ConfigObj(configspec, - raise_errors=True, - file_error=True, - _inspec=True) - except ConfigObjError as e: - # FIXME: Should these errors have a reference - # to the already parsed ConfigObj ? - raise ConfigspecError('Parsing configspec failed: %s' % e) - except IOError as e: - raise IOError('Reading configspec failed: %s' % e) - - self.configspec = configspec - - - - def _set_configspec(self, section, copy): - """ - Called by validate. Handles setting the configspec on subsections - including sections to be validated by __many__ - """ - configspec = section.configspec - many = configspec.get('__many__') - if isinstance(many, dict): - for entry in section.sections: - if entry not in configspec: - section[entry].configspec = many - - for entry in configspec.sections: - if entry == '__many__': - continue - if entry not in section: - section[entry] = {} - section[entry]._created = True - if copy: - # copy comments - section.comments[entry] = configspec.comments.get(entry, []) - section.inline_comments[entry] = configspec.inline_comments.get(entry, '') - - # Could be a scalar when we expect a section - if isinstance(section[entry], Section): - section[entry].configspec = configspec[entry] - - - def _write_line(self, indent_string, entry, this_entry, comment): - """Write an individual line, for the write method""" - # NOTE: the calls to self._quote here handles non-StringType values. - if not self.unrepr: - val = self._decode_element(self._quote(this_entry)) - else: - val = repr(this_entry) - return '%s%s%s%s%s' % (indent_string, - self._decode_element(self._quote(entry, multiline=False)), - self._a_to_u(' = '), - val, - self._decode_element(comment)) - - - def _write_marker(self, indent_string, depth, entry, comment): - """Write a section marker line""" - return '%s%s%s%s%s' % (indent_string, - self._a_to_u('[' * depth), - self._quote(self._decode_element(entry), multiline=False), - self._a_to_u(']' * depth), - self._decode_element(comment)) - - - def _handle_comment(self, comment): - """Deal with a comment.""" - if not comment: - return '' - start = self.indent_type - if not comment.startswith('#'): - start += self._a_to_u(' # ') - return (start + comment) - - - # Public methods - - def write(self, outfile=None, section=None): - """ - Write the current ConfigObj as a file - - tekNico: FIXME: use StringIO instead of real files - - >>> filename = a.filename - >>> a.filename = 'test.ini' - >>> a.write() - >>> a.filename = filename - >>> a == ConfigObj('test.ini', raise_errors=True) - 1 - >>> import os - >>> os.remove('test.ini') - """ - if self.indent_type is None: - # this can be true if initialised from a dictionary - self.indent_type = DEFAULT_INDENT_TYPE - - out = [] - cs = self._a_to_u('#') - csp = self._a_to_u('# ') - if section is None: - int_val = self.interpolation - self.interpolation = False - section = self - for line in self.initial_comment: - line = self._decode_element(line) - stripped_line = line.strip() - if stripped_line and not stripped_line.startswith(cs): - line = csp + line - out.append(line) - - indent_string = self.indent_type * section.depth - for entry in (section.scalars + section.sections): - if entry in section.defaults: - # don't write out default values - continue - for comment_line in section.comments[entry]: - comment_line = self._decode_element(comment_line.lstrip()) - if comment_line and not comment_line.startswith(cs): - comment_line = csp + comment_line - out.append(indent_string + comment_line) - this_entry = section[entry] - comment = self._handle_comment(section.inline_comments[entry]) - - if isinstance(this_entry, Section): - # a section - out.append(self._write_marker( - indent_string, - this_entry.depth, - entry, - comment)) - out.extend(self.write(section=this_entry)) - else: - out.append(self._write_line( - indent_string, - entry, - this_entry, - comment)) - - if section is self: - for line in self.final_comment: - line = self._decode_element(line) - stripped_line = line.strip() - if stripped_line and not stripped_line.startswith(cs): - line = csp + line - out.append(line) - self.interpolation = int_val - - if section is not self: - return out - - if (self.filename is None) and (outfile is None): - # output a list of lines - # might need to encode - # NOTE: This will *screw* UTF16, each line will start with the BOM - if self.encoding: - out = [l.encode(self.encoding) for l in out] - if (self.BOM and ((self.encoding is None) or - (BOM_LIST.get(self.encoding.lower()) == 'utf_8'))): - # Add the UTF8 BOM - if not out: - out.append('') - out[0] = BOM_UTF8 + out[0] - return out - - # Turn the list to a string, joined with correct newlines - newline = self.newlines or os.linesep - if (getattr(outfile, 'mode', None) is not None and outfile.mode == 'w' - and sys.platform == 'win32' and newline == '\r\n'): - # Windows specific hack to avoid writing '\r\r\n' - newline = '\n' - output = self._a_to_u(newline).join(out) - if not output.endswith(newline): - output += newline - - if isinstance(output, six.binary_type): - output_bytes = output - else: - output_bytes = output.encode(self.encoding or - self.default_encoding or - 'ascii') - - if self.BOM and ((self.encoding is None) or match_utf8(self.encoding)): - # Add the UTF8 BOM - output_bytes = BOM_UTF8 + output_bytes - - if outfile is not None: - outfile.write(output_bytes) - else: - with open(self.filename, 'wb') as h: - h.write(output_bytes) - - def validate(self, validator, preserve_errors=False, copy=False, - section=None): - """ - Test the ConfigObj against a configspec. - - It uses the ``validator`` object from *validate.py*. - - To run ``validate`` on the current ConfigObj, call: :: - - test = config.validate(validator) - - (Normally having previously passed in the configspec when the ConfigObj - was created - you can dynamically assign a dictionary of checks to the - ``configspec`` attribute of a section though). - - It returns ``True`` if everything passes, or a dictionary of - pass/fails (True/False). If every member of a subsection passes, it - will just have the value ``True``. (It also returns ``False`` if all - members fail). - - In addition, it converts the values from strings to their native - types if their checks pass (and ``stringify`` is set). - - If ``preserve_errors`` is ``True`` (``False`` is default) then instead - of a marking a fail with a ``False``, it will preserve the actual - exception object. This can contain info about the reason for failure. - For example the ``VdtValueTooSmallError`` indicates that the value - supplied was too small. If a value (or section) is missing it will - still be marked as ``False``. - - You must have the validate module to use ``preserve_errors=True``. - - You can then use the ``flatten_errors`` function to turn your nested - results dictionary into a flattened list of failures - useful for - displaying meaningful error messages. - """ - if section is None: - if self.configspec is None: - raise ValueError('No configspec supplied.') - if preserve_errors: - # We do this once to remove a top level dependency on the validate module - # Which makes importing configobj faster - from validate import VdtMissingValue - self._vdtMissingValue = VdtMissingValue - - section = self - - if copy: - section.initial_comment = section.configspec.initial_comment - section.final_comment = section.configspec.final_comment - section.encoding = section.configspec.encoding - section.BOM = section.configspec.BOM - section.newlines = section.configspec.newlines - section.indent_type = section.configspec.indent_type - - # - # section.default_values.clear() #?? - configspec = section.configspec - self._set_configspec(section, copy) - - - def validate_entry(entry, spec, val, missing, ret_true, ret_false): - section.default_values.pop(entry, None) - - try: - section.default_values[entry] = validator.get_default_value(configspec[entry]) - except (KeyError, AttributeError, validator.baseErrorClass): - # No default, bad default or validator has no 'get_default_value' - # (e.g. SimpleVal) - pass - - try: - check = validator.check(spec, - val, - missing=missing - ) - except validator.baseErrorClass as e: - if not preserve_errors or isinstance(e, self._vdtMissingValue): - out[entry] = False - else: - # preserve the error - out[entry] = e - ret_false = False - ret_true = False - else: - ret_false = False - out[entry] = True - if self.stringify or missing: - # if we are doing type conversion - # or the value is a supplied default - if not self.stringify: - if isinstance(check, (list, tuple)): - # preserve lists - check = [self._str(item) for item in check] - elif missing and check is None: - # convert the None from a default to a '' - check = '' - else: - check = self._str(check) - if (check != val) or missing: - section[entry] = check - if not copy and missing and entry not in section.defaults: - section.defaults.append(entry) - return ret_true, ret_false - - # - out = {} - ret_true = True - ret_false = True - - unvalidated = [k for k in section.scalars if k not in configspec] - incorrect_sections = [k for k in configspec.sections if k in section.scalars] - incorrect_scalars = [k for k in configspec.scalars if k in section.sections] - - for entry in configspec.scalars: - if entry in ('__many__', '___many___'): - # reserved names - continue - if (not entry in section.scalars) or (entry in section.defaults): - # missing entries - # or entries from defaults - missing = True - val = None - if copy and entry not in section.scalars: - # copy comments - section.comments[entry] = ( - configspec.comments.get(entry, [])) - section.inline_comments[entry] = ( - configspec.inline_comments.get(entry, '')) - # - else: - missing = False - val = section[entry] - - ret_true, ret_false = validate_entry(entry, configspec[entry], val, - missing, ret_true, ret_false) - - many = None - if '__many__' in configspec.scalars: - many = configspec['__many__'] - elif '___many___' in configspec.scalars: - many = configspec['___many___'] - - if many is not None: - for entry in unvalidated: - val = section[entry] - ret_true, ret_false = validate_entry(entry, many, val, False, - ret_true, ret_false) - unvalidated = [] - - for entry in incorrect_scalars: - ret_true = False - if not preserve_errors: - out[entry] = False - else: - ret_false = False - msg = 'Value %r was provided as a section' % entry - out[entry] = validator.baseErrorClass(msg) - for entry in incorrect_sections: - ret_true = False - if not preserve_errors: - out[entry] = False - else: - ret_false = False - msg = 'Section %r was provided as a single value' % entry - out[entry] = validator.baseErrorClass(msg) - - # Missing sections will have been created as empty ones when the - # configspec was read. - for entry in section.sections: - # FIXME: this means DEFAULT is not copied in copy mode - if section is self and entry == 'DEFAULT': - continue - if section[entry].configspec is None: - unvalidated.append(entry) - continue - if copy: - section.comments[entry] = configspec.comments.get(entry, []) - section.inline_comments[entry] = configspec.inline_comments.get(entry, '') - check = self.validate(validator, preserve_errors=preserve_errors, copy=copy, section=section[entry]) - out[entry] = check - if check == False: - ret_true = False - elif check == True: - ret_false = False - else: - ret_true = False - - section.extra_values = unvalidated - if preserve_errors and not section._created: - # If the section wasn't created (i.e. it wasn't missing) - # then we can't return False, we need to preserve errors - ret_false = False - # - if ret_false and preserve_errors and out: - # If we are preserving errors, but all - # the failures are from missing sections / values - # then we can return False. Otherwise there is a - # real failure that we need to preserve. - ret_false = not any(out.values()) - if ret_true: - return True - elif ret_false: - return False - return out - - - def reset(self): - """Clear ConfigObj instance and restore to 'freshly created' state.""" - self.clear() - self._initialise() - # FIXME: Should be done by '_initialise', but ConfigObj constructor (and reload) - # requires an empty dictionary - self.configspec = None - # Just to be sure ;-) - self._original_configspec = None - - - def reload(self): - """ - Reload a ConfigObj from file. - - This method raises a ``ReloadError`` if the ConfigObj doesn't have - a filename attribute pointing to a file. - """ - if not isinstance(self.filename, six.string_types): - raise ReloadError() - - filename = self.filename - current_options = {} - for entry in OPTION_DEFAULTS: - if entry == 'configspec': - continue - current_options[entry] = getattr(self, entry) - - configspec = self._original_configspec - current_options['configspec'] = configspec - - self.clear() - self._initialise(current_options) - self._load(filename, configspec) - - - -class SimpleVal(object): - """ - A simple validator. - Can be used to check that all members expected are present. - - To use it, provide a configspec with all your members in (the value given - will be ignored). Pass an instance of ``SimpleVal`` to the ``validate`` - method of your ``ConfigObj``. ``validate`` will return ``True`` if all - members are present, or a dictionary with True/False meaning - present/missing. (Whole missing sections will be replaced with ``False``) - """ - - def __init__(self): - self.baseErrorClass = ConfigObjError - - def check(self, check, member, missing=False): - """A dummy check method, always returns the value unchanged.""" - if missing: - raise self.baseErrorClass() - return member - - -def flatten_errors(cfg, res, levels=None, results=None): - """ - An example function that will turn a nested dictionary of results - (as returned by ``ConfigObj.validate``) into a flat list. - - ``cfg`` is the ConfigObj instance being checked, ``res`` is the results - dictionary returned by ``validate``. - - (This is a recursive function, so you shouldn't use the ``levels`` or - ``results`` arguments - they are used by the function.) - - Returns a list of keys that failed. Each member of the list is a tuple:: - - ([list of sections...], key, result) - - If ``validate`` was called with ``preserve_errors=False`` (the default) - then ``result`` will always be ``False``. - - *list of sections* is a flattened list of sections that the key was found - in. - - If the section was missing (or a section was expected and a scalar provided - - or vice-versa) then key will be ``None``. - - If the value (or section) was missing then ``result`` will be ``False``. - - If ``validate`` was called with ``preserve_errors=True`` and a value - was present, but failed the check, then ``result`` will be the exception - object returned. You can use this as a string that describes the failure. - - For example *The value "3" is of the wrong type*. - """ - if levels is None: - # first time called - levels = [] - results = [] - if res == True: - return sorted(results) - if res == False or isinstance(res, Exception): - results.append((levels[:], None, res)) - if levels: - levels.pop() - return sorted(results) - for (key, val) in list(res.items()): - if val == True: - continue - if isinstance(cfg.get(key), dict): - # Go down one level - levels.append(key) - flatten_errors(cfg[key], val, levels, results) - continue - results.append((levels[:], key, val)) - # - # Go up one level - if levels: - levels.pop() - # - return sorted(results) - - -def get_extra_values(conf, _prepend=()): - """ - Find all the values and sections not in the configspec from a validated - ConfigObj. - - ``get_extra_values`` returns a list of tuples where each tuple represents - either an extra section, or an extra value. - - The tuples contain two values, a tuple representing the section the value - is in and the name of the extra values. For extra values in the top level - section the first member will be an empty tuple. For values in the 'foo' - section the first member will be ``('foo',)``. For members in the 'bar' - subsection of the 'foo' section the first member will be ``('foo', 'bar')``. - - NOTE: If you call ``get_extra_values`` on a ConfigObj instance that hasn't - been validated it will return an empty list. - """ - out = [] - - out.extend([(_prepend, name) for name in conf.extra_values]) - for name in conf.sections: - if name not in conf.extra_values: - out.extend(get_extra_values(conf[name], _prepend + (name,))) - return out - - -"""*A programming language is a medium of expression.* - Paul Graham""" From ad985a2552fe84da3323ca007230fd425d891900 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Tue, 15 Apr 2025 20:23:24 +0200 Subject: [PATCH 52/71] Updated dependencies --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 3a5416e..f31b01a 100644 --- a/setup.py +++ b/setup.py @@ -30,6 +30,6 @@ setuptools.setup( entry_points= { 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, - install_requires=["rns>=0.9.3", "lxmf>=0.6.2", "urwid>=2.6.16", "qrcode"], + install_requires=["rns>=0.9.4", "lxmf>=0.6.3", "urwid>=2.6.16", "qrcode"], python_requires=">=3.7", ) From aa4feeb29c957defec74860e9d413ff6b32466fc Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Tue, 15 Apr 2025 20:24:48 +0200 Subject: [PATCH 53/71] Updated version --- nomadnet/_version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nomadnet/_version.py b/nomadnet/_version.py index 43c4ab0..22049ab 100644 --- a/nomadnet/_version.py +++ b/nomadnet/_version.py @@ -1 +1 @@ -__version__ = "0.6.1" +__version__ = "0.6.2" From dfa7adc21e63c21a4f694b04dc4631c9375722e3 Mon Sep 17 00:00:00 2001 From: RFNexus Date: Sun, 20 Apr 2025 09:18:56 -0400 Subject: [PATCH 54/71] Interface Management initial (2/2) --- nomadnet/_version.py | 2 +- nomadnet/ui/textui/Guide.py | 219 ++++- nomadnet/ui/textui/Interfaces.py | 749 +++++++++++++----- .../additional_urwid_widgets/FormWidgets.py | 255 ++++++ setup.py | 2 +- 5 files changed, 1016 insertions(+), 211 deletions(-) diff --git a/nomadnet/_version.py b/nomadnet/_version.py index 43c4ab0..22049ab 100644 --- a/nomadnet/_version.py +++ b/nomadnet/_version.py @@ -1 +1 @@ -__version__ = "0.6.1" +__version__ = "0.6.2" diff --git a/nomadnet/ui/textui/Guide.py b/nomadnet/ui/textui/Guide.py index 94f83d0..4b4ca2a 100644 --- a/nomadnet/ui/textui/Guide.py +++ b/nomadnet/ui/textui/Guide.py @@ -387,8 +387,223 @@ Links can be inserted into micron documents. See the `*Markup`* section of this ''' -TOPIC_INTERFACES = ''' ->TODO +TOPIC_INTERFACES = '''>Interfaces + +Reticulum supports using many kinds of devices as networking interfaces, and allows you to mix and match them in any way you choose. + +The number of distinct network topologies you can create with Reticulum is more or less endless, but common to them all is that you will need to define one or more interfaces for Reticulum to use. + +The `![ Interfaces ]`! section of NomadNet lets you add, monitor, and update interfaces configured for your Reticulum instance. + +If you are starting NomadNet for the first time you will find that an `!AutoInterface`! has been added by default. This interface will try to use your available network device to communicate with other peers discovered on your local network. + +Interfaces come in many different types and can interact with physical mediums like LoRa radios or standard IP networks. + +>>Viewing Interfaces + +To view more info about an interface, navigate using the `!Up`! and `!Down`! arrow keys or by clicking with the mouse. Pressing `! < Enter >`! on a selected interface will bring you to a detailed interface view, which will show configuration parameters and realtime charts. From here you can also disable or edit the interface. To change the orientation of the TX/RX charts, press `!< V >`! for a vertical layout, and `!< H >`! for a horizontal view. + +>>Updating Interfaces + +To edit an interface, select the interface and press `!< Ctrl + E >`!. + +To remove an interface, select the interface and press `!< Ctrl + X >`!. You can also perform both of these actions from the details view. + +>>Adding Interfaces + +To add a new interface, press `!< Ctrl + A >`!. From here you can select which type of interface you want to add. Each unique interface type will have different configuration options. + +`Ffff`! (!) Note:`! After adding or modifying interfaces, you will need to restart NomadNet or your Reticulum instance for changes to take effect.`f`b + + +>Interface Types + +>>AutoInterface + +The Auto Interface enables communication with other discoverable Reticulum nodes over autoconfigured IPv6 and UDP. It does not need any functional IP infrastructure like routers or DHCP servers, but will require at least some sort of switching medium between peers (a wired switch, a hub, a WiFi access point or similar). + +``` +Required Parameters: +Interface Name + +Optional Parameters: +Devices: Specific network devices to use +Ignored Devices: Network devices to exclude +Group ID: Create isolated networks on the same physical LAN +Discovery Scope: Can set to link, admin, site, organisation or global +``` + +The AutoInterface is ideal for quickly connecting to other Reticulum nodes on your local network without complex configuration. + +>>TCPClientInterface + +The TCP Client interface connects to remote TCP server interfaces, enabling communication over the Internet or private networks. + +``` +Required Parameters: +Target Host: Hostname or IP address of the server +Target Port: Port number to connect to + +Optional Parameters: +I2P Tunneled: Enable for connecting through I2P +KISS Framing: Enable for KISS framing for software modems +``` + +This interface is commonly used to connect to Reticulum testnets or other persistent nodes on the Internet. + +>>TCPServerInterface + +The TCP Server interface listens for incoming connections, allowing other Reticulum peers to connect to your node using TCPClientInterface. + +``` +Required Parameters: +Listen IP: IP address to bind to (0.0.0.0 for all interfaces) +Listen Port: Port number to listen on + +Optional Parameters: +Prefer IPv6: Bind to IPv6 address if available +I2P Tunneled: Enable for I2P tunnel support +Device: Specific network device to use (e,g +``` + +Useful when you want other nodes to be able to connect to your Transport instance over TCP/IP. + +>>UDPInterface + +The UDP interface allows communication over IP networks using UDP packets. + +``` +Required Parameters: +Listen IP: IP address to bind to +Listen Port: Port to listen on +Forward IP: IP address to forward to (Can be broadcast address) +Forward Port: Port to forward to + +Optional Parameters: +Device: Specific network device to use +``` + +>>I2PInterface + +The I2P interface enables connections over the Invisible Internet Protocol. The I2PInterface requires an I2P daemon to be running on your system, such as `!i2pd`! + +``` +Optional Parameters: +Peers: I2P addresses to connect to (Can be left as none if running as a Transport) +``` + + +>>RNodeInterface + +The RNode interface allows using LoRa transceivers running RNode firmware as Reticulum network interfaces. + +``` +Required Parameters: +Port: Serial port or BLE device path +Frequency: Operating frequency in MHz +Bandwidth: Channel bandwidth +TX Power: Transmit power in dBm +Spreading Factor: LoRa spreading factor (7-12) +Coding Rate: LoRa coding rate (4:5-4:8) + +Optional Parameters: +ID Callsign: Station identification +ID Interval: Identification interval in seconds +Airtime Limits: Control duty cycle +``` + +The interface includes a parameter calculator to estimate link budget, sensitivity, and data rate on the air based on your settings. + +>>RNodeMultiInterface + +The RNode Multi Interface is designed for use with specific hardware platforms that support multiple subinterfaces or virtual radios. For most LoRa hardware platforms, you will want to use the standard `!RNodeInterface`! instead. + +``` +Required Parameters: +Port: Serial port or BLE device path +Subinterfaces: Configuration for each subinterface / virtual radio port + +``` + +>>SerialInterface + +The Serial interface enables using direct serial connections as Reticulum interfaces. + +``` +Required Parameters: +Port: Serial port path +Speed: Baud rate of serial device +Databits: Number of data bits +Parity: Parity setting +Stopbits: Number of stop bits +``` + +>>KISSInterface + +The KISS interface supports packet radio modems and TNCs using the KISS protocol. + +``` +Required Parameters: + +Port: Serial port path +Speed: Baud rate of serial device +Databits: Number of data bits +Parity: Parity setting +Stopbits: Number of stop bits +Preamble: Modem preamble in milliseconds +TX Tail: Transmit tail in milliseconds +Slottime: CSMA slottime in milliseconds +Persistence: CSMA persistence value + +Optional Parameters: + +ID Callsign: Station identification +ID Interval: Identification interval in seconds +Flow Control: Enable packet flow control +``` + +>>PipeInterface + +The Pipe interface allows using external programs as Reticulum interfaces via stdin and stdout. + +``` +Required Parameters: + +Command: External command to execute + +Optional Parameters: +Respawn Delay: Seconds to wait before restarting after failure +``` + +< +>> +-∿ + For more information and to view the full Interface documentation consult the Reticulum manual or visit https://reticulum.network/manual/interfaces.html (Requires external Internet connection) + + +>Interface Access Code (IFAC) Settings + +Interface Access Codes create private networks and securely segment network traffic. Under `!Show more options`!, you'll find these IFAC settings: + +`!Virtual Network Name`! (network_name): +When added, creates a logical network that only communicates with other interfaces using the same name. This allows multiple separate Reticulum networks to exist on the same physical channel or medium. + +`!IFAC Passphrase`! (passphrase): +Sets an authentication passphrase for the interface. Only interfaces configured with the same passphrase will be able to communicate. Can be used with or without a network name. + +`!IFAC Size`! (ifac_size): +Controls the length of Interface Authentication Codes (8-512 bits). Larger sizes provide stronger security but add overhead to each packet. The default of `!8`! is usually appropriate for most uses. + +>Interface Modes + +When running a Transport node, you can configure interface modes that affect how Reticulum selects paths, propagates announces, and discovers routes: + +`!full`!: Default mode with all discovery, meshing and transport functionality +`!gateway`!: Discovers paths on behalf of other nodes +`!access_point`!: Operates as a network access point +`!roaming`!: For physically mobile interfaces +`!boundary`!: For interfaces connecting different network segments + ''' TOPIC_CONVERSATIONS = '''>Conversations diff --git a/nomadnet/ui/textui/Interfaces.py b/nomadnet/ui/textui/Interfaces.py index 281e505..b87698c 100644 --- a/nomadnet/ui/textui/Interfaces.py +++ b/nomadnet/ui/textui/Interfaces.py @@ -15,6 +15,13 @@ INTERFACE_GLYPHS = { } ### HELPER ### +PLATFORM_IS_LINUX = False +try: + PLATFORM_IS_LINUX = (RNS.vendor.platformutils.is_android() or + RNS.vendor.platformutils.is_linux()) +except Exception: + pass + def _get_interface_icon(glyphset, iface_type): glyphset_index = 1 # Default to unicode if glyphset == "plain": @@ -23,6 +30,7 @@ def _get_interface_icon(glyphset, iface_type): glyphset_index = 2 # nerdfont type_to_glyph_tuple = { + "BackboneInterface": "NetworkInterfaceType", "AutoInterface": "NetworkInterfaceType", "TCPClientInterface": "NetworkInterfaceType", "TCPServerInterface": "NetworkInterfaceType", @@ -46,10 +54,10 @@ def _get_interface_icon(glyphset, iface_type): return glyph_tuple[glyphset_index + 1] # Fallback - return "(#)" if glyphset == "plain" else "🙾" if glyphset == "unicode" else " " + return "(#)" if glyphset == "plain" else "\U0001f67e" if glyphset == "unicode" else "\ued95" def format_bytes(bytes_value): - units = ['bytes', 'KB/s', 'MB/s', 'GB/s', 'TB/s'] + units = ['bytes', 'KB', 'MB', 'GB', 'TB'] size = float(bytes_value) unit_index = 0 @@ -62,6 +70,7 @@ def format_bytes(bytes_value): else: return f"{size:.1f} {units[unit_index]}" + ### PORT FUNCTIONS ### PYSERIAL_AVAILABLE = False # If NomadNet is installed on environments with rnspure instead of rns, pyserial won't be available try: @@ -389,6 +398,66 @@ COMMON_INTERFACE_OPTIONS = [ ] INTERFACE_FIELDS = { + "BackboneInterface": [ + { + "config_key": "listen_on", + "type": "edit", + "label": "Listen On: ", + "default": "", + "placeholder": "e.g., 0.0.0.0", + "transform": lambda x: x.strip() + }, + { + "config_key": "port", + "type": "edit", + "label": "Port: ", + "default": "", + "placeholder": "e.g., 4242", + "validation": ["number"], + "transform": lambda x: int(x.strip()) if x.strip() else 4242 + }, + { + "config_key": "device", + "type": "edit", + "label": "Device: ", + "default": "", + "placeholder": "e.g., eth0", + "transform": lambda x: x.strip() + }, + { + "config_key": "remote", + "type": "edit", + "label": "Remote: ", + "default": "", + "placeholder": "e.g., a remote TCPServerInterface location", + "transform": lambda x: x.strip() + }, + { + "config_key": "target_host", + "type": "edit", + "label": "Target Host: ", + "default": "", + "placeholder": "e.g., 201:5d78:af73:5caf:a4de:a79f:3278:71e5", + "transform": lambda x: x.strip() + }, + { + "config_key": "port", + "type": "edit", + "label": "Target Port: ", + "default": "", + "placeholder": "e.g., 4242", + "validation": ["number"], + "transform": lambda x: int(x.strip()) if x.strip() else 4242 + }, + { + "config_key": "prefer_ipv6", + "type": "checkbox", + "label": "", + "default": False, + "validation": [], + "transform": lambda x: bool(x) + }, + ], "AutoInterface": [ { @@ -687,6 +756,73 @@ INTERFACE_FIELDS = { ] } ], + "RNodeMultiInterface": [ + get_port_field(), + { + "config_key": "subinterfaces", + "type": "multitable", + "fields": { + "frequency": { + "label": "Freq (Hz)", + "type": "edit", + "validation": ["required", "float"], + "transform": lambda x: int(x) if x else None + }, + "bandwidth": { + "label": "BW (Hz)", + "type": "edit", + "options": ["7800", "10400", "15600", "20800", "31250", "41700", "62500", "125000", "250000", "500000", "1625000"], + "transform": lambda x: int(x) if x else None + }, + "txpower": { + "label": "TX (dBm)", + "type": "edit", + "validation": ["required", "number"], + "transform": lambda x: int(x) if x else None + }, + "vport": { + "label": "V.Port", + "type": "edit", + "validation": ["required", "number"], + "transform": lambda x: int(x) if x else None + }, + "spreadingfactor": { + "label": "SF", + "type": "edit", + "transform": lambda x: int(x) if x else None + }, + "codingrate": { + "label": "CR", + "type": "edit", + "transform": lambda x: int(x) if x else None + } + }, + "validation": ["required"], + "transform": lambda x: x + }, + { + "additional_options": [ + { + "config_key": "id_callsign", + "type": "edit", + "label": "Callsign: ", + "default": "", + "placeholder": "e.g. MYCALL-0", + "validation": [""], + "transform": lambda x: x.strip() + }, + { + "config_key": "id_interval", + "type": "edit", + "label": "ID Interval (Seconds): ", + "placeholder": "e.g. 600", + "default": "", + "validation": ['number'], + "transform": lambda x: "" if x == "" else int(x) + } + ] + } + ], "SerialInterface": [ get_port_field(), { @@ -954,6 +1090,24 @@ INTERFACE_FIELDS = { ] } ], + "CustomInterface": [ + { + "config_key": "type", + "type": "edit", + "label": "Interface Type: ", + "default": "", + "placeholder": "Name of custom interface class", + "validation": ["required"], + "transform": lambda x: x.strip() + }, + { + "config_key": "custom_parameters", + "type": "keyvaluepairs", + "label": "Parameters: ", + "validation": [], + "transform": lambda x: x + }, + ], "default": [ { @@ -1059,7 +1213,18 @@ class SelectableInterfaceItem(urwid.WidgetWrap): return super().render(size, focus=focus) def keypress(self, size, key): - if key == "enter": + if key == "up": + listbox = self.parent.box_adapter._original_widget + walker = listbox.body + + interface_items = [i for i, item in enumerate(walker) + if isinstance(item, SelectableInterfaceItem)] + + if interface_items and walker[listbox.focus_position] is self and \ + listbox.focus_position == interface_items[0]: + self.parent.app.ui.main_display.frame.focus_position = "header" + return None + elif key == "enter": self.parent.switch_to_show_interface(self.name) return None return key @@ -1236,10 +1401,10 @@ class InterfaceFiller(urwid.WidgetWrap): # edit interface self.app.ui.main_display.sub_displays.interface_display.edit_selected_interface() return None - elif key == "tab": - # navigation - self.app.ui.main_display.frame.focus_position = "header" - return + elif key == "ctrl w": + # open config file editor + self.app.ui.main_display.sub_displays.interface_display.open_config_editor() + return None return super().keypress(size, key) @@ -1280,7 +1445,6 @@ class AddInterfaceView(urwid.WidgetWrap): form_pile = urwid.Pile(pile_items) form_filler = urwid.Filler(form_pile, valign="top") - #todo form_box = urwid.LineBox( form_filler, title="Add Interface", @@ -1298,7 +1462,6 @@ class AddInterfaceView(urwid.WidgetWrap): width=('relative', 85), valign='middle', height=('relative', 85), - ) super().__init__(self.overlay) @@ -1306,7 +1469,7 @@ class AddInterfaceView(urwid.WidgetWrap): if field["type"] == "dropdown": widget = FormDropdown( config_key=field["config_key"], - label=field["label"], + label=field.get("label", ""), options=field["options"], default=field.get("default"), validation_types=field.get("validation", []), @@ -1315,7 +1478,7 @@ class AddInterfaceView(urwid.WidgetWrap): elif field["type"] == "checkbox": widget = FormCheckbox( config_key=field["config_key"], - label=field["label"], + label=field.get("label", ""), state=field.get("default", False), validation_types=field.get("validation", []), transform=field.get("transform") @@ -1327,6 +1490,19 @@ class AddInterfaceView(urwid.WidgetWrap): validation_types=field.get("validation", []), transform=field.get("transform") ) + elif field["type"] == "multitable": + widget = FormMultiTable( + config_key=field["config_key"], + fields=field.get("fields", {}), + validation_types=field.get("validation", []), + transform=field.get("transform") + ) + elif field["type"] == "keyvaluepairs": + widget = FormKeyValuePairs( + config_key=field["config_key"], + validation_types=field.get("validation", []), + transform=field.get("transform") + ) else: widget = FormEdit( config_key=field["config_key"], @@ -1337,8 +1513,12 @@ class AddInterfaceView(urwid.WidgetWrap): transform=field.get("transform") ) + label = field.get("label", "") + if not label: + label = " ".join(word.capitalize() for word in field["config_key"].split('_')) + ": " + self.fields[field["config_key"]] = { - 'label': field["label"], + 'label': label, 'widget': widget } @@ -1349,7 +1529,7 @@ class AddInterfaceView(urwid.WidgetWrap): if option["type"] == "checkbox": widget = FormCheckbox( config_key=option["config_key"], - label=option["label"], + label=option.get("label", ""), state=option.get("default", False), validation_types=option.get("validation", []), transform=option.get("transform") @@ -1357,7 +1537,7 @@ class AddInterfaceView(urwid.WidgetWrap): elif option["type"] == "dropdown": widget = FormDropdown( config_key=option["config_key"], - label=option["label"], + label=option.get("label", ""), options=option["options"], default=option.get("default"), validation_types=option.get("validation", []), @@ -1380,44 +1560,47 @@ class AddInterfaceView(urwid.WidgetWrap): transform=option.get("transform") ) + label = option.get("label", "") + if not label: + label = " ".join(word.capitalize() for word in option["config_key"].split('_')) + ": " + self.additional_fields[option["config_key"]] = { - 'label': option["label"], + 'label': label, 'widget': widget, 'type': option["type"] } def _initialize_common_fields(self): - if self.parent.app.rns.transport_enabled(): # Transport mode options COMMON_INTERFACE_OPTIONS.extend([ - { - "config_key": "outgoing", - "type": "checkbox", - "label": "Allow outgoing traffic", - "default": True, - "validation": [], - "transform": lambda x: bool(x) - }, - { - "config_key": "mode", - "type": "dropdown", - "label": "Interface Mode: ", - "options": ["full", "gateway", "access_point", "roaming", "boundary"], - "default": "full", - "validation": [], - "transform": lambda x: x - }, - { - "config_key": "announce_cap", - "type": "edit", - "label": "Announce Cap: ", - "placeholder": "Default: 2.0", - "default": "", - "validation": ["float"], - "transform": lambda x: float(x) if x.strip() else 2.0 - } - ]) + { + "config_key": "outgoing", + "type": "checkbox", + "label": "Allow outgoing traffic", + "default": True, + "validation": [], + "transform": lambda x: bool(x) + }, + { + "config_key": "mode", + "type": "dropdown", + "label": "Interface Mode: ", + "options": ["full", "gateway", "access_point", "roaming", "boundary"], + "default": "full", + "validation": [], + "transform": lambda x: x + }, + { + "config_key": "announce_cap", + "type": "edit", + "label": "Announce Cap: ", + "placeholder": "Default: 2.0", + "default": "", + "validation": ["float"], + "transform": lambda x: float(x) if x.strip() else 2.0 + } + ]) for option in COMMON_INTERFACE_OPTIONS: if option["type"] == "checkbox": @@ -1447,8 +1630,6 @@ class AddInterfaceView(urwid.WidgetWrap): transform=option.get("transform") ) - - self.common_fields[option["config_key"]] = { 'label': option["label"], 'widget': widget, @@ -1461,13 +1642,22 @@ class AddInterfaceView(urwid.WidgetWrap): def _build_form_layout(self, iface_fields): pile_items = [] - pile_items.append(urwid.Text(("form_title", f"Add new {_get_interface_icon(self.parent.glyphset, self.iface_type)} {self.iface_type}"), align="center")) + pile_items.append(urwid.Text( + ("form_title", f"Add new {_get_interface_icon(self.parent.glyphset, self.iface_type)} {self.iface_type}"), + align="center")) pile_items.append(urwid.Divider("─")) for key in ["name"] + [f["config_key"] for f in iface_fields]: field = self.fields[key] widget = field["widget"] + # Special case for multitable and keyvaluepairs - they already have their own layout + if isinstance(widget, (FormMultiTable, FormKeyValuePairs)): + pile_items.append(urwid.Text(("key", field["label"]), align="left")) + pile_items.append(widget) + pile_items.append(urwid.Padding(widget.error_widget, left=2)) + continue + field_pile = urwid.Pile([ urwid.Columns([ (26, urwid.Text(("key", field["label"]), align="right")), @@ -1476,7 +1666,8 @@ class AddInterfaceView(urwid.WidgetWrap): urwid.Padding(widget.error_widget, left=24) ]) - if self.iface_type in ["RNodeInterface", "SerialInterface", "AX25KISSInterface", "KISSInterface"] and key == "port": + if self.iface_type in ["RNodeInterface", "RNodeMultiInterface", "SerialInterface", "AX25KISSInterface", + "KISSInterface"] and key == "port": refresh_btn = urwid.Button("Refresh Ports", on_press=self.refresh_ports) refresh_btn = urwid.AttrMap(refresh_btn, "button_normal", focus_map="button_focus") refresh_row = urwid.Padding(refresh_btn, left=26, width=20) @@ -1495,7 +1686,7 @@ class AddInterfaceView(urwid.WidgetWrap): self.ifac_options_button = urwid.AttrMap(self.ifac_options_button, "button_normal", focus_map="button_focus") self.ifac_options_widget = urwid.Pile([]) - if self.iface_type == "RNodeInterface": + if self.iface_type in ["RNodeInterface", "RNodeMultiInterface"]: self.calculator_button = urwid.Button("Show On-Air Calculations", on_press=self.toggle_calculator) self.calculator_button = urwid.AttrMap(self.calculator_button, "button_normal", focus_map="button_focus") @@ -1512,7 +1703,7 @@ class AddInterfaceView(urwid.WidgetWrap): self.more_options_button, self.more_options_widget, ]) - if self.iface_type == "RNodeInterface": + if self.iface_type in ["RNodeInterface", "RNodeMultiInterface"]: self.rnode_calculator = RNodeCalculator(self) self.calculator_visible = False self.calculator_widget = urwid.Pile([]) @@ -1564,7 +1755,6 @@ class AddInterfaceView(urwid.WidgetWrap): pile_contents.append(urwid.Divider("─")) if self.common_fields: - # pile_contents.append(urwid.Text(("interface_title", "Common "), align="center")) for key, field in self.common_fields.items(): widget = field['widget'] @@ -1697,18 +1887,36 @@ class AddInterfaceView(urwid.WidgetWrap): if not all_valid: return - interface_config = { - "type": self.iface_type, - "interface_enabled": True - } + if self.iface_type == "CustomInterface": + custom_type = self.fields.get('type', {}).get('widget').get_value() + interface_config = { + "type": custom_type, + "interface_enabled": True + } + else: + interface_config = { + "type": self.iface_type, + "interface_enabled": True + } for field_key, field in self.fields.items(): - if field_key != "name": + if field_key not in ["name", "custom_parameters", "type"]: widget = field["widget"] value = widget.get_value() - if value is not None and value != "": + + if field_key == "subinterfaces" and self.iface_type == "RNodeMultiInterface" and isinstance(value, + dict): + for subname, subconfig in value.items(): + interface_config[f"{subname}"] = subconfig + elif value is not None and value != "": interface_config[widget.config_key] = value + if self.iface_type == "CustomInterface" and "custom_parameters" in self.fields: + custom_params = self.fields["custom_parameters"]["widget"].get_value() + if isinstance(custom_params, dict): + for param_key, param_value in custom_params.items(): + interface_config[param_key] = param_value + for field_key, field in self.additional_fields.items(): widget = field["widget"] value = widget.get_value() @@ -1721,23 +1929,22 @@ class AddInterfaceView(urwid.WidgetWrap): if value is not None and value != "": interface_config[widget.config_key] = value - # Add interface to RNS config try: interfaces = self.parent.app.rns.config['interfaces'] - interfaces[name] = interface_config - self.parent.app.rns.config.write() - print(self.parent.glyphset) + + display_type = custom_type if self.iface_type == "CustomInterface" else self.iface_type + new_item = SelectableInterfaceItem( parent=self.parent, name=name, is_connected=False, # will always be false until restart is_enabled=True, - iface_type=self.iface_type, + iface_type=display_type, tx=0, rx=0, - icon=_get_interface_icon(self.parent.glyphset, self.iface_type), + icon=_get_interface_icon(self.parent.glyphset, display_type), iface_options=interface_config ) @@ -1754,7 +1961,6 @@ class AddInterfaceView(urwid.WidgetWrap): self.parent.switch_to_list() def show_message(self, message, title="Notice"): - def dismiss_dialog(button): self.parent.switch_to_list() @@ -1781,127 +1987,106 @@ class AddInterfaceView(urwid.WidgetWrap): self.parent.widget = overlay self.parent.app.ui.main_display.update_active_sub_display() + class EditInterfaceView(AddInterfaceView): def __init__(self, parent, iface_name): self.parent = parent self.iface_name = iface_name self.interface_config = parent.app.rns.config['interfaces'][iface_name] - self.iface_type = self.interface_config.get("type", "Unknown") + config_type = self.interface_config.get("type", "Unknown") + + # check if this is a custom interface type + known_types = list(INTERFACE_FIELDS.keys()) + if config_type not in known_types: + self.original_type = config_type + self.iface_type = "CustomInterface" + else: + self.original_type = None + self.iface_type = config_type super().__init__(parent, self.iface_type) self.overlay.top_w.title_widget.set_text(f"Edit Interface: {iface_name}") + self._populate_form_fields() def _populate_form_fields(self): - self.fields['name']['widget'].edit_text = self.iface_name + if self.original_type and self.iface_type == "CustomInterface": + if "type" in self.fields: + self.fields["type"]["widget"].edit_text = self.original_type + + if "custom_parameters" in self.fields: + custom_params = {} + standard_keys = ["type", "interface_enabled", "enabled", "description", + "network_name", "bitrate", "passphrase", "ifac_size", + "mode", "outgoing", "announce_cap"] + + for key, value in self.interface_config.items(): + if key not in standard_keys: + custom_params[key] = value + + self.fields["custom_parameters"]["widget"].set_value(custom_params) + for key, field in self.fields.items(): - if key != 'name' and key in self.interface_config: + if key not in ['name', 'type', 'custom_parameters']: widget = field['widget'] - value = self.interface_config[key] - if key == 'frequency': - # convert Hz back to MHz - value = float(value) / 1000000 - # decimal format - value = f"{value:.6f}".rstrip('0').rstrip('.') if '.' in f"{value:.6f}" else f"{value}" + if key == "subinterfaces" and isinstance(widget, FormMultiTable): + self._populate_subinterfaces(widget) + continue - if hasattr(widget, 'edit_text'): - # For text input fields, set edit_text - widget.edit_text = str(value) - elif hasattr(widget, 'set_state'): - # For checkboxes - widget.set_state(bool(value)) - elif isinstance(widget, FormDropdown): - # For dropdowns - update selected and update display - str_value = str(value) - if str_value in widget.options: - widget.selected = str_value - widget.main_button.base_widget.set_text(str_value) - else: - for opt in widget.options: - try: - if widget.transform(opt) == value: - widget.selected = opt - widget.main_button.base_widget.set_text(opt) - break - except: - pass - elif isinstance(widget, FormMultiList): - if isinstance(value, str): - items = [item.strip() for item in value.split(',') if item.strip()] - self._populate_multilist(widget, items) - elif isinstance(value, list): - self._populate_multilist(widget, value) + if key in self.interface_config: + value = self.interface_config[key] + + if key == 'frequency': + value = float(value) / 1000000 + value = f"{value:.6f}".rstrip('0').rstrip('.') if '.' in f"{value:.6f}" else f"{value}" + + self._set_field_value(widget, value) for key, field in self.additional_fields.items(): if key in self.interface_config: - widget = field['widget'] - value = self.interface_config[key] - - if hasattr(widget, 'edit_text'): - widget.edit_text = str(value) - elif hasattr(widget, 'set_state'): - # RNS.log(f"KEY: {key} VAL: {value}") - checkbox_state = value if isinstance(value, bool) else value.strip().lower() not in ('false', 'off', 'no', '0') - widget.set_state(checkbox_state) - elif isinstance(widget, FormDropdown): - str_value = str(value) - if str_value in widget.options: - widget.selected = str_value - widget.main_button.base_widget.set_text(str_value) - else: - # Try to match after transform - for opt in widget.options: - try: - if widget.transform(opt) == value: - widget.selected = opt - widget.main_button.base_widget.set_text(opt) - break - except: - pass - elif isinstance(widget, FormMultiList): - if isinstance(value, str): - items = [item.strip() for item in value.split(',') if item.strip()] - self._populate_multilist(widget, items) - elif isinstance(value, list): - self._populate_multilist(widget, value) + self._set_field_value(field['widget'], self.interface_config[key]) for key, field in self.common_fields.items(): if key in self.interface_config: - widget = field['widget'] - value = self.interface_config[key] + self._set_field_value(field['widget'], self.interface_config[key]) - if hasattr(widget, 'edit_text'): - widget.edit_text = str(value) - elif hasattr(widget, 'set_state'): - widget.set_state(bool(value)) - elif isinstance(widget, FormDropdown): - str_value = str(value) - if str_value in widget.options: - widget.selected = str_value - widget.main_button.base_widget.set_text(str_value) - else: - # Try to match after transform - for opt in widget.options: - try: - if widget.transform(opt) == value: - widget.selected = opt - widget.main_button.base_widget.set_text(opt) - break - except: - pass - elif isinstance(widget, FormMultiList): - if isinstance(value, str): - items = [item.strip() for item in value.split(',') if item.strip()] - self._populate_multilist(widget, items) - elif isinstance(value, list): - self._populate_multilist(widget, value) + def _set_field_value(self, widget, value): + if hasattr(widget, 'edit_text'): + widget.edit_text = str(value) + elif hasattr(widget, 'set_state'): + checkbox_state = value if isinstance(value, bool) else value.strip().lower() not in ( + 'false', 'off', 'no', '0') + widget.set_state(checkbox_state) + elif isinstance(widget, FormDropdown): + str_value = str(value) + if str_value in widget.options: + widget.selected = str_value + widget.main_button.base_widget.set_text(str_value) + else: + # Try to match after transform + for opt in widget.options: + try: + if widget.transform(opt) == value: + widget.selected = opt + widget.main_button.base_widget.set_text(opt) + break + except: + pass + elif isinstance(widget, FormMultiList): + self._populate_multilist(widget, value) + + def _populate_multilist(self, widget, value): + items = [] + if isinstance(value, str): + items = [item.strip() for item in value.split(',') if item.strip()] + elif isinstance(value, list): + items = value - def _populate_multilist(self, widget, items): while len(widget.entries) > 1: widget.remove_entry(None, widget.entries[-1]) @@ -1917,24 +2102,64 @@ class EditInterfaceView(AddInterfaceView): edit_widget = entry.contents[0][0] edit_widget.edit_text = items[i] + def _populate_subinterfaces(self, widget): + subinterfaces = {} + + for key, value in self.interface_config.items(): + if isinstance(value, dict): + if key.startswith('[[[') and key.endswith(']]]'): + clean_key = key[3:-3] # removes [[[...]]] + subinterfaces[clean_key] = value + elif key not in ["type", "interface_enabled", "enabled", "port", + "id_callsign", "id_interval"]: + subinterfaces[key] = value + + if subinterfaces: + widget.set_value(subinterfaces) + def on_save(self, button): if not self.validate_all(): return new_name = self.fields['name']["widget"].get_value() or self.iface_name + if new_name != self.iface_name and new_name in self.parent.app.rns.config['interfaces']: + self.fields['name']["widget"].error = f"Interface name '{new_name}' already exists" + self.fields['name']["widget"].error_widget.set_text(("error", self.fields['name']["widget"].error)) + return + + if self.iface_type == "CustomInterface": + interface_type = self.fields.get('type', {}).get('widget').get_value() + else: + interface_type = self.iface_type + updated_config = { - "type": self.iface_type, + "type": interface_type, "interface_enabled": True } for field_key, field in self.fields.items(): - if field_key != "name": + if field_key not in ["name", "custom_parameters", "type"]: widget = field["widget"] value = widget.get_value() if value is not None and value != "": updated_config[widget.config_key] = value + if self.iface_type == "CustomInterface" and "custom_parameters" in self.fields: + custom_params = self.fields["custom_parameters"]["widget"].get_value() + if isinstance(custom_params, dict): + for param_key, param_value in custom_params.items(): + updated_config[param_key] = param_value + + elif self.iface_type == "RNodeMultiInterface" and "subinterfaces" in self.fields: + subinterfaces = self.fields["subinterfaces"]["widget"].get_value() + + for subname, subconfig in subinterfaces.items(): + if any(k.startswith('[[[') for k in self.interface_config.keys()): + updated_config[f"[[[{subname}]]]"] = subconfig + else: + updated_config[subname] = subconfig + for field_key, field in self.additional_fields.items(): widget = field["widget"] value = widget.get_value() @@ -1963,13 +2188,14 @@ class EditInterfaceView(AddInterfaceView): self.parent.app.rns.config.write() + display_type = interface_type + for item in self.parent.interface_items: if item.name == new_name: - item.iface_type = self.iface_type + item.iface_type = display_type break self.parent._rebuild_list() - self.show_message(f"Interface {new_name} updated. Restart NomadNet for these changes to take effect") except Exception as e: @@ -1992,6 +2218,8 @@ class ShowInterface(urwid.WidgetWrap): self.config_rows = [] + self.history_length=60 + # get interface stats interface_stats = self.parent.app.rns.get_interface_stats() stats_lookup = {iface['short_name']: iface for iface in interface_stats['interfaces']} @@ -2070,7 +2298,7 @@ class ShowInterface(urwid.WidgetWrap): self.info_rows.append(self.stat_row) self.info_rows.append(urwid.Divider("-")) - self.bandwidth_chart = InterfaceBandwidthChart(history_length=60, glyphset=self.parent.glyphset) + self.bandwidth_chart = InterfaceBandwidthChart(history_length=self.history_length, glyphset=self.parent.glyphset) self.bandwidth_chart.update(self.rx, self.tx) self.rx_chart_text = urwid.Text("Loading RX data...", align='left') @@ -2117,7 +2345,8 @@ class ShowInterface(urwid.WidgetWrap): screen = urwid.raw_display.Screen() screen_cols, _ = screen.get_cols_rows() - if screen_cols >= 100: + # RNS.log(screen_cols) + if screen_cols >= 145: self.charts_widget = self.horizontal_charts self.is_horizontal = True @@ -2410,12 +2639,11 @@ class ShowInterface(urwid.WidgetWrap): self.frame.focus_position = 'footer' footer_pile = self.frame.footer if isinstance(footer_pile, urwid.Pile): - footer_pile.focus_position = 1 # button row + footer_pile.focus_position = 1 # button row button_row = footer_pile.contents[1][0] if isinstance(button_row, urwid.Columns): button_row.focus_position = 0 return None - # If we're currently in footer change the focus elif self.frame.focus_position == 'footer': footer_pile = self.frame.footer if isinstance(footer_pile, urwid.Pile): @@ -2451,6 +2679,33 @@ class ShowInterface(urwid.WidgetWrap): elif button_row.focus_position == 0: # back button self.frame.focus_position = 'body' return None + elif key == 'down': + if self.frame.focus_position == 'body': + result = super().keypress(size, key) + # if the key wasn't consumed, we're at the bottom + if result == 'down': + self.frame.focus_position = 'footer' + footer_pile = self.frame.footer + if isinstance(footer_pile, urwid.Pile): + footer_pile.focus_position = 1 # button row + button_row = footer_pile.contents[1][0] + if isinstance(button_row, urwid.Columns): + button_row.focus_position = 0 # focus on back button + return None + return result + elif key == 'up': + if self.frame.focus_position == 'footer': + self.frame.focus_position = 'body' + listbox = self.frame.body + if hasattr(listbox, 'body') and len(listbox.body) > 0: + listbox.focus_position = len(listbox.body) - 1 + return None + elif self.frame.focus_position == 'body': + result = super().keypress(size, key) + # if the key wasn't consumed, we're at the top + if result == 'up': + pass + return result elif key == "h" and self.is_connected: # horizontal layout if not self.is_horizontal: self.switch_to_horizontal() @@ -2496,37 +2751,60 @@ class ShowInterface(urwid.WidgetWrap): if not self.started: return - interface_stats = self.parent.app.rns.get_interface_stats() - stats_lookup = {iface['short_name']: iface for iface in interface_stats['interfaces']} - stats = stats_lookup.get(self.iface_name, {}) + try: + interface_stats = self.parent.app.rns.get_interface_stats() + stats_lookup = {iface['short_name']: iface for iface in interface_stats['interfaces']} + stats = stats_lookup.get(self.iface_name, {}) - tx = stats.get("txb", self.tx) - rx = stats.get("rxb", self.rx) + tx = stats.get("txb", self.tx) + rx = stats.get("rxb", self.rx) - new_connection_status = stats.get("status", False) - if new_connection_status != self.is_connected: - self.update_connection_display(new_connection_status) + new_connection_status = stats.get("status", False) + if new_connection_status != self.is_connected: + self.update_connection_display(new_connection_status) - if not self.is_connected: - return + if not self.is_connected: + return - self.tx_text.set_text(("value", format_bytes(tx))) - self.rx_text.set_text(("value", format_bytes(rx))) + self.tx_text.set_text(("value", format_bytes(tx))) + self.rx_text.set_text(("value", format_bytes(rx))) - self.bandwidth_chart.update(rx, tx) + self.bandwidth_chart.update(rx, tx) - rx_chart, tx_chart, peak_rx, peak_tx = self.bandwidth_chart.get_charts(height=8) + rx_chart, tx_chart, peak_rx, peak_tx = self.bandwidth_chart.get_charts(height=8) - self.rx_chart_text.set_text(rx_chart) - self.tx_chart_text.set_text(tx_chart) - self.rx_peak_text.set_text(f"Peak: {peak_rx}") - self.tx_peak_text.set_text(f"Peak: {peak_tx}") + self.rx_chart_text.set_text(rx_chart) + self.tx_chart_text.set_text(tx_chart) + self.rx_peak_text.set_text(f"Peak: {peak_rx}") + self.tx_peak_text.set_text(f"Peak: {peak_tx}") - self.tx = tx - self.rx = rx + self.tx = tx + self.rx = rx + except Exception as e: + if not hasattr(self.parent, + 'disconnect_overlay') or self.parent.widget is not self.parent.disconnect_overlay: + dialog_text = urwid.Pile([ + urwid.Text(("disconnected_status", "(!) RNS Instance Disconnected"), align="center"), + urwid.Text("Waiting to Reconnect...", align="center") + ]) + dialog_content = urwid.Filler(dialog_text) + dialog_box = urwid.LineBox(dialog_content) - if self.started: - loop.set_alarm_in(1, self.update_bandwidth_charts) + self.parent.disconnect_overlay = urwid.Overlay( + dialog_box, + self, + align='center', + width=35, + valign='middle', + height=4 + ) + + self.parent.widget = self.parent.disconnect_overlay + self.parent.app.ui.main_display.update_active_sub_display() + self.started = False + finally: + if self.started: + loop.set_alarm_in(1, self.update_bandwidth_charts) def on_back(self, button): self.started = False @@ -2666,18 +2944,44 @@ class InterfaceDisplay: loop.set_alarm_in(5, self.check_terminal_size) def poll_stats(self, loop, user_data): - interface_stats = self.app.rns.get_interface_stats() - stats_lookup = {iface['short_name']: iface for iface in interface_stats['interfaces']} - for item in self.interface_items: - # use interface name as the key - stats_for_interface = stats_lookup.get(item.name) - if stats_for_interface: - tx = stats_for_interface.get("txb", 0) - rx = stats_for_interface.get("rxb", 0) - item.update_stats(tx, rx) + try: + if hasattr(self, 'disconnect_overlay') and self.widget is self.disconnect_overlay: + self.widget = self.interfaces_display + self.app.ui.main_display.update_active_sub_display() - loop.set_alarm_in(1, self.poll_stats) + interface_stats = self.app.rns.get_interface_stats() + stats_lookup = {iface['short_name']: iface for iface in interface_stats['interfaces']} + for item in self.interface_items: + # use interface name as the key + stats_for_interface = stats_lookup.get(item.name) + if stats_for_interface: + tx = stats_for_interface.get("txb", 0) + rx = stats_for_interface.get("rxb", 0) + item.update_stats(tx, rx) + except Exception as e: + if not hasattr(self, 'disconnect_overlay') or self.widget is not self.disconnect_overlay: + dialog_text = urwid.Pile([ + urwid.Text(("disconnected_status", "(!) RNS Instance Disconnected"), align="center"), + urwid.Text(("Waiting to Reconnect..."), align="center") + ]) + dialog_content = urwid.Filler(dialog_text) + dialog_box = urwid.LineBox(dialog_content) + self.disconnect_overlay = urwid.Overlay( + dialog_box, + self.interfaces_display, + align='center', + width=35, + valign='middle', + height=4 + ) + + if self.widget is self.interfaces_display: + self.widget = self.disconnect_overlay + self.app.ui.main_display.update_active_sub_display() + finally: + if self.started: + loop.set_alarm_in(1, self.poll_stats) def shortcuts(self): return self.shortcuts_display @@ -2717,19 +3021,23 @@ class InterfaceDisplay: add_option("TCP Server Interface", "TCPServerInterface") add_option("UDP Interface", "UDPInterface") add_option("I2P Interface", "I2PInterface") + if PLATFORM_IS_LINUX: + add_option("Backbone Interface", "BackboneInterface") - add_heading(f"{rnode_icon} RNodes") - add_option("RNode Interface", "RNodeInterface") - # add_option("RNode Multi Interface", "RNodeMultiInterface") TODO + if PYSERIAL_AVAILABLE: + add_heading(f"{rnode_icon} RNodes") + add_option("RNode Interface", "RNodeInterface") + add_option("RNode Multi Interface", "RNodeMultiInterface") - add_heading(f"{serial_icon} Hardware") - add_option("Serial Interface", "SerialInterface") - add_option("KISS Interface", "KISSInterface") - add_option("AX.25 KISS Interface", "AX25KISSInterface") + add_heading(f"{serial_icon} Hardware") + add_option("Serial Interface", "SerialInterface") + add_option("KISS Interface", "KISSInterface") + add_option("AX.25 KISS Interface", "AX25KISSInterface") add_heading(f"{other_icon} Other") add_option("Pipe Interface", "PipeInterface") - # add_option("Custom Interface", "CustomInterface") TODO + add_option("Custom Interface", "CustomInterface") + listbox = urwid.ListBox(urwid.SimpleFocusListWalker(dialog_widgets)) dialog = DialogLineBox(listbox, parent=self, title="Select Interface Type") @@ -2834,11 +3142,38 @@ class InterfaceDisplay: self.box_adapter._original_widget.body = walker self.box_adapter._original_widget.focus_position = len(new_list) - 1 + def open_config_editor(self): + import platform + + editor_cmd = self.app.config["textui"]["editor"] + + if platform.system() == "Darwin" and editor_cmd == "editor": + editor_cmd = "nano" + + editor_term = urwid.Terminal( + (editor_cmd, self.app.rns.configpath), + encoding='utf-8', + main_loop=self.app.ui.loop, + ) + + def quit_term(*args, **kwargs): + self.widget = self.interfaces_display + self.app.ui.main_display.update_active_sub_display() + self.app.ui.main_display.request_redraw() + + urwid.connect_signal(editor_term, 'closed', quit_term) + + editor_box = urwid.LineBox(editor_term, title="Editing RNS Config") + self.widget = editor_box + self.app.ui.main_display.update_active_sub_display() + self.app.ui.main_display.frame.focus_position = "body" + editor_term.change_focus(True) + ### SHORTCUTS ### class InterfaceDisplayShortcuts: def __init__(self, app): self.app = app - self.default_shortcuts = "[C-a] Add Interface [C-e] Edit Interface [C-x] Remove Interface [Enter] Show Interface" + self.default_shortcuts = "[C-a] Add Interface [C-e] Edit Interface [C-x] Remove Interface [Enter] Show Interface [C-w] Open Text Editor" self.current_shortcuts = self.default_shortcuts self.widget = urwid.AttrMap( urwid.Text(self.current_shortcuts), @@ -2853,7 +3188,7 @@ class InterfaceDisplayShortcuts: self.update_shortcuts(self.default_shortcuts) def set_show_interface_shortcuts(self): - show_shortcuts = "[Back] Return to List [Tab] Navigate [Shift-tab] Change Focus [h] Horizontal Charts [v] Vertical Charts [Up/Down] Scroll" + show_shortcuts = "[Up/Down] Navigate [Tab] Switch Focus [h] Horizontal Charts [v] Vertical Charts " self.update_shortcuts(show_shortcuts) def set_add_interface_shortcuts(self): diff --git a/nomadnet/vendor/additional_urwid_widgets/FormWidgets.py b/nomadnet/vendor/additional_urwid_widgets/FormWidgets.py index 4e4809a..f3e95b7 100644 --- a/nomadnet/vendor/additional_urwid_widgets/FormWidgets.py +++ b/nomadnet/vendor/additional_urwid_widgets/FormWidgets.py @@ -279,5 +279,260 @@ class FormMultiList(urwid.Pile, FormField): self.error = "At least one entry is required" break + self.error_widget.set_text(("error", self.error or "")) + return self.error is None + + +class FormMultiTable(urwid.Pile, FormField): + def __init__(self, config_key, fields, validation_types=None, transform=None, **kwargs): + self.entries = [] + self.fields = fields + self.error_widget = urwid.Text("") + self.error = None + self.validation_types = validation_types or [] + + header_columns = [('weight', 3, urwid.Text(("list_focus", "Name")))] + for field_key, field_config in self.fields.items(): + header_columns.append(('weight', 2, urwid.Text(("list_focus", field_config.get("label", field_key))))) + header_columns.append((4, urwid.Text(("list_focus", "")))) + + self.header_row = urwid.Columns(header_columns) + + first_entry = self.create_entry_row() + self.entries.append(first_entry) + + self.add_button = urwid.Button("+ Add ", on_press=self.add_entry) + add_button_padded = urwid.Padding(self.add_button, left=2, right=2) + + pile_widgets = [ + self.header_row, + urwid.Divider("-"), + first_entry, + add_button_padded + ] + + urwid.Pile.__init__(self, pile_widgets) + FormField.__init__(self, config_key, transform) + + def create_entry_row(self, name="", values=None): + if values is None: + values = {} + + name_edit = urwid.Edit("", name) + + columns = [('weight', 3, name_edit)] + + field_widgets = {} + for field_key, field_config in self.fields.items(): + field_value = values.get(field_key, "") + + if field_config.get("type") == "checkbox": + widget = urwid.CheckBox("", state=bool(field_value)) + elif field_config.get("type") == "dropdown": + # TODO: dropdown in MultiTable + widget = urwid.Edit("", str(field_value)) + else: + widget = urwid.Edit("", str(field_value)) + + field_widgets[field_key] = widget + columns.append(('weight', 2, widget)) + + remove_button = urwid.Button("×", on_press=lambda button: self.remove_entry(button, entry_row)) + columns.append((4, remove_button)) + + entry_row = urwid.Columns(columns) + entry_row.name_edit = name_edit + entry_row.field_widgets = field_widgets + + return entry_row + + def remove_entry(self, button, entry_row): + if len(self.entries) > 1: + self.entries.remove(entry_row) + self.contents = [(w, self.options()) for w in self.get_pile_widgets()] + + def add_entry(self, button): + new_entry = self.create_entry_row() + self.entries.append(new_entry) + + self.contents = [(w, self.options()) for w in self.get_pile_widgets()] + + def get_pile_widgets(self): + return [ + self.header_row, + urwid.Divider("-") + ] + self.entries + [ + urwid.Padding(self.add_button, left=2, right=2) + ] + + def get_value(self): + values = {} + for entry in self.entries: + name = entry.name_edit.edit_text.strip() + if name: + subinterface = {} + subinterface["interface_enabled"] = True + + for field_key, widget in entry.field_widgets.items(): + field_config = self.fields.get(field_key, {}) + + if hasattr(widget, "get_state"): + value = widget.get_state() + elif hasattr(widget, "edit_text"): + value = widget.edit_text.strip() + + transform = field_config.get("transform") + if transform and value: + try: + value = transform(value) + except (ValueError, TypeError): + pass + value = "" + + if value: + subinterface[field_key] = value + + values[name] = subinterface + + return self.transform(values) if self.transform else values + + def set_value(self, value): + self.entries = [] + + if not value: + self.entries.append(self.create_entry_row()) + else: + for name, config in value.items(): + self.entries.append(self.create_entry_row(name=name, values=config)) + + self.contents = [(w, self.options()) for w in self.get_pile_widgets()] + + def validate(self): + values = self.get_value() + self.error = None + + for validation in self.validation_types: + if validation == "required" and not values: + self.error = "At least one subinterface is required" + break + + self.error_widget.set_text(("error", self.error or "")) + return self.error is None + + +class FormKeyValuePairs(urwid.Pile, FormField): + def __init__(self, config_key, validation_types=None, transform=None, **kwargs): + self.entries = [] + self.error_widget = urwid.Text("") + self.error = None + self.validation_types = validation_types or [] + + header_columns = [ + ('weight', 1, urwid.AttrMap(urwid.Text("Parameter Key"), "multitable_header")), + ('weight', 1, urwid.AttrMap(urwid.Text("Parameter Value"), "multitable_header")), + (4, urwid.AttrMap(urwid.Text("Action"), "multitable_header")) + ] + + self.header_row = urwid.AttrMap(urwid.Columns(header_columns), "multitable_header") + + first_entry = self.create_entry_row() + self.entries.append(first_entry) + + self.add_button = urwid.Button("+ Add Parameter", on_press=self.add_entry) + add_button_padded = urwid.Padding(self.add_button, left=2, right=2) + + pile_widgets = [ + self.header_row, + urwid.Divider("-"), + first_entry, + add_button_padded + ] + + urwid.Pile.__init__(self, pile_widgets) + FormField.__init__(self, config_key, transform) + + def create_entry_row(self, key="", value=""): + key_edit = urwid.Edit("", key) + value_edit = urwid.Edit("", value) + + remove_button = urwid.Button("×", on_press=lambda button: self.remove_entry(button, entry_row)) + + entry_row = urwid.Columns([ + ('weight', 1, key_edit), + ('weight', 1, value_edit), + (4, remove_button) + ]) + + entry_row.key_edit = key_edit + entry_row.value_edit = value_edit + + return entry_row + + def remove_entry(self, button, entry_row): + if len(self.entries) > 1: + self.entries.remove(entry_row) + self.contents = [(w, self.options()) for w in self.get_pile_widgets()] + + def add_entry(self, button): + new_entry = self.create_entry_row() + self.entries.append(new_entry) + + self.contents = [(w, self.options()) for w in self.get_pile_widgets()] + + def get_pile_widgets(self): + return [ + self.header_row, + urwid.Divider("-") + ] + self.entries + [ + urwid.Padding(self.add_button, left=2, right=2) + ] + + def get_value(self): + values = {} + for entry in self.entries: + key = entry.key_edit.edit_text.strip() + value = entry.value_edit.edit_text.strip() + + if key: + if value.isdigit(): + values[key] = int(value) + elif value.replace('.', '', 1).isdigit() and value.count('.') <= 1: + values[key] = float(value) + elif value.lower() == 'true': + values[key] = True + elif value.lower() == 'false': + values[key] = False + else: + values[key] = value + + return self.transform(values) if self.transform else values + + def set_value(self, value): + self.entries = [] + + if not value or not isinstance(value, dict): + self.entries.append(self.create_entry_row()) + else: + for key, val in value.items(): + self.entries.append(self.create_entry_row(key=key, value=str(val))) + + self.contents = [(w, self.options()) for w in self.get_pile_widgets()] + + def validate(self): + values = self.get_value() + self.error = None + + keys = [entry.key_edit.edit_text.strip() for entry in self.entries + if entry.key_edit.edit_text.strip()] + if len(keys) != len(set(keys)): + self.error = "Duplicate keys are not allowed" + self.error_widget.set_text(("error", self.error)) + return False + + for validation in self.validation_types: + if validation == "required" and not values: + self.error = "Atleast one parameter is required" + break + self.error_widget.set_text(("error", self.error or "")) return self.error is None \ No newline at end of file diff --git a/setup.py b/setup.py index 3a5416e..f31b01a 100644 --- a/setup.py +++ b/setup.py @@ -30,6 +30,6 @@ setuptools.setup( entry_points= { 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, - install_requires=["rns>=0.9.3", "lxmf>=0.6.2", "urwid>=2.6.16", "qrcode"], + install_requires=["rns>=0.9.4", "lxmf>=0.6.3", "urwid>=2.6.16", "qrcode"], python_requires=">=3.7", ) From a0d6b752a388e934fdeadb16daf4c0877f99c7c1 Mon Sep 17 00:00:00 2001 From: RFNexus Date: Sun, 20 Apr 2025 23:17:24 -0400 Subject: [PATCH 55/71] Fixes for RNodeMultiInterface --- nomadnet/ui/textui/Interfaces.py | 12 ++++-------- .../vendor/additional_urwid_widgets/FormWidgets.py | 3 +-- 2 files changed, 5 insertions(+), 10 deletions(-) diff --git a/nomadnet/ui/textui/Interfaces.py b/nomadnet/ui/textui/Interfaces.py index b87698c..0a4cc8b 100644 --- a/nomadnet/ui/textui/Interfaces.py +++ b/nomadnet/ui/textui/Interfaces.py @@ -1686,7 +1686,7 @@ class AddInterfaceView(urwid.WidgetWrap): self.ifac_options_button = urwid.AttrMap(self.ifac_options_button, "button_normal", focus_map="button_focus") self.ifac_options_widget = urwid.Pile([]) - if self.iface_type in ["RNodeInterface", "RNodeMultiInterface"]: + if self.iface_type in ["RNodeInterface"]: self.calculator_button = urwid.Button("Show On-Air Calculations", on_press=self.toggle_calculator) self.calculator_button = urwid.AttrMap(self.calculator_button, "button_normal", focus_map="button_focus") @@ -1703,7 +1703,7 @@ class AddInterfaceView(urwid.WidgetWrap): self.more_options_button, self.more_options_widget, ]) - if self.iface_type in ["RNodeInterface", "RNodeMultiInterface"]: + if self.iface_type in ["RNodeInterface"]: self.rnode_calculator = RNodeCalculator(self) self.calculator_visible = False self.calculator_widget = urwid.Pile([]) @@ -2139,7 +2139,7 @@ class EditInterfaceView(AddInterfaceView): } for field_key, field in self.fields.items(): - if field_key not in ["name", "custom_parameters", "type"]: + if field_key not in ["name", "custom_parameters", "type", "subinterfaces"]: widget = field["widget"] value = widget.get_value() if value is not None and value != "": @@ -2153,12 +2153,8 @@ class EditInterfaceView(AddInterfaceView): elif self.iface_type == "RNodeMultiInterface" and "subinterfaces" in self.fields: subinterfaces = self.fields["subinterfaces"]["widget"].get_value() - for subname, subconfig in subinterfaces.items(): - if any(k.startswith('[[[') for k in self.interface_config.keys()): - updated_config[f"[[[{subname}]]]"] = subconfig - else: - updated_config[subname] = subconfig + updated_config[subname] = subconfig for field_key, field in self.additional_fields.items(): widget = field["widget"] diff --git a/nomadnet/vendor/additional_urwid_widgets/FormWidgets.py b/nomadnet/vendor/additional_urwid_widgets/FormWidgets.py index f3e95b7..55f9a03 100644 --- a/nomadnet/vendor/additional_urwid_widgets/FormWidgets.py +++ b/nomadnet/vendor/additional_urwid_widgets/FormWidgets.py @@ -386,8 +386,7 @@ class FormMultiTable(urwid.Pile, FormField): try: value = transform(value) except (ValueError, TypeError): - pass - value = "" + value = "" if value: subinterface[field_key] = value From ab8b30999ab1f773944e9a124fae9a5d2510c7ea Mon Sep 17 00:00:00 2001 From: RFNexus Date: Tue, 22 Apr 2025 18:33:33 -0400 Subject: [PATCH 56/71] fixes for TCPServer, TCPClient, and UDPInterface field definitions --- nomadnet/ui/textui/Interfaces.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/nomadnet/ui/textui/Interfaces.py b/nomadnet/ui/textui/Interfaces.py index 0a4cc8b..b3d5f78 100644 --- a/nomadnet/ui/textui/Interfaces.py +++ b/nomadnet/ui/textui/Interfaces.py @@ -414,7 +414,7 @@ INTERFACE_FIELDS = { "default": "", "placeholder": "e.g., 4242", "validation": ["number"], - "transform": lambda x: int(x.strip()) if x.strip() else 4242 + "transform": lambda x: int(x.strip()) if x.strip() else None }, { "config_key": "device", @@ -447,7 +447,7 @@ INTERFACE_FIELDS = { "default": "", "placeholder": "e.g., 4242", "validation": ["number"], - "transform": lambda x: int(x.strip()) if x.strip() else 4242 + "transform": lambda x: int(x.strip()) if x.strip() else None }, { "config_key": "prefer_ipv6", @@ -525,8 +525,8 @@ INTERFACE_FIELDS = { "label": "Listen Port: ", "default": "", "placeholder": "e.g., 4242", - "validation": ["required", "number"], - "transform": lambda x: int(x.strip()) if x.strip() else 4242 + "validation": ["number"], + "transform": lambda x: int(x.strip()) if x.strip() else None }, { "additional_options": [ @@ -553,7 +553,7 @@ INTERFACE_FIELDS = { "placeholder": "A specific network device to listen on - e.g. eth0", "default": "", "validation": [], - "transform": lambda x: x.strip() + "transform": lambda x: x.strip() if x.strip() else None }, { "config_key": "port", @@ -562,7 +562,7 @@ INTERFACE_FIELDS = { "default": "", "placeholder": "e.g., 4242", "validation": ["number"], - "transform": lambda x: int(x.strip()) if x.strip() else 4242 + "transform": lambda x: int(x.strip()) if x.strip() else None }, ] } @@ -584,7 +584,7 @@ INTERFACE_FIELDS = { "default": "", "placeholder": "e.g., 8080", "validation": ["required", "number"], - "transform": lambda x: int(x.strip()) if x.strip() else 4242 + "transform": lambda x: int(x.strip()) if x.strip() else None }, { "additional_options": [ @@ -623,8 +623,8 @@ INTERFACE_FIELDS = { "label": "Listen Port: ", "default": "", "placeholder": "e.g., 4242", - "validation": ["required", "number"], - "transform": lambda x: int(x.strip()) if x.strip() else 4242 + "validation": ["number"], + "transform": lambda x: int(x.strip()) if x.strip() else None }, { "config_key": "forward_ip", @@ -642,7 +642,7 @@ INTERFACE_FIELDS = { "default": "", "placeholder": "e.g., 4242", "validation": ["required", "number"], - "transform": lambda x: int(x.strip()) if x.strip() else 4242 + "transform": lambda x: int(x.strip()) if x.strip() else None }, { "additional_options": [ @@ -662,7 +662,7 @@ INTERFACE_FIELDS = { "default": "", "placeholder": "e.g., 4242", "validation": ["number"], - "transform": lambda x: int(x.strip()) if x.strip() else 4242 + "transform": lambda x: int(x.strip()) if x.strip() else None }, ] } From 4eed5bab4851d254a1ca5ecc9e24ebdef0215833 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Tue, 29 Apr 2025 11:43:46 +0200 Subject: [PATCH 57/71] Updated readme --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 313c0af..416eb7c 100755 --- a/README.md +++ b/README.md @@ -146,13 +146,13 @@ You can help support the continued development of open, free and private communi ``` 84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w ``` -- Ethereum - ``` - 0xFDabC71AC4c0C78C95aDDDe3B4FA19d6273c5E73 - ``` - Bitcoin ``` - 35G9uWVzrpJJibzUwpNUQGQNFzLirhrYAH + bc1p4a6axuvl7n9hpapfj8sv5reqj8kz6uxa67d5en70vzrttj0fmcusgxsfk5 + ``` +- Ethereum + ``` + 0xae89F3B94fC4AD6563F0864a55F9a697a90261ff ``` - Ko-Fi: https://ko-fi.com/markqvist From b9ac735308f697ff0d98f572fc94c3e8202095cc Mon Sep 17 00:00:00 2001 From: Ivan Date: Thu, 8 May 2025 18:40:04 -0500 Subject: [PATCH 58/71] update to use super().__init__(widget) --- nomadnet/vendor/Scrollable.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/nomadnet/vendor/Scrollable.py b/nomadnet/vendor/Scrollable.py index eedb1ab..e54e1b0 100644 --- a/nomadnet/vendor/Scrollable.py +++ b/nomadnet/vendor/Scrollable.py @@ -50,7 +50,7 @@ class Scrollable(urwid.WidgetDecoration): self._old_cursor_coords = None self._rows_max_cached = 0 self.force_forward_keypress = force_forward_keypress - self.__super.__init__(widget) + super().__init__(widget) def render(self, size, focus=False): maxcol, maxrow = size @@ -340,7 +340,7 @@ class ScrollBar(urwid.WidgetDecoration): """ if BOX not in widget.sizing(): raise ValueError('Not a box widget: %r' % widget) - self.__super.__init__(widget) + super().__init__(widget) self._thumb_char = thumb_char self._trough_char = trough_char self.scrollbar_side = side From f107a9ea306d59cac2dc39ffb94fbe53a165d5d2 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 11 May 2025 16:42:50 +0200 Subject: [PATCH 59/71] Use RNS file responses for file downloads instead of reading entire file into memory --- nomadnet/Node.py | 15 ++++-------- nomadnet/ui/textui/Browser.py | 43 +++++++++++++++++++++++------------ 2 files changed, 34 insertions(+), 24 deletions(-) diff --git a/nomadnet/Node.py b/nomadnet/Node.py index 5c2a3e0..755c002 100644 --- a/nomadnet/Node.py +++ b/nomadnet/Node.py @@ -61,16 +61,14 @@ class Node: self.destination.register_request_handler( "/page/index.mu", response_generator = self.serve_default_index, - allow = RNS.Destination.ALLOW_ALL - ) + allow = RNS.Destination.ALLOW_ALL) for page in self.servedpages: request_path = "/page"+page.replace(self.app.pagespath, "") self.destination.register_request_handler( request_path, response_generator = self.serve_page, - allow = RNS.Destination.ALLOW_ALL - ) + allow = RNS.Destination.ALLOW_ALL) def register_files(self): # TODO: Deregister previously registered files @@ -83,8 +81,8 @@ class Node: self.destination.register_request_handler( request_path, response_generator = self.serve_file, - allow = RNS.Destination.ALLOW_ALL - ) + allow = RNS.Destination.ALLOW_ALL, + auto_compress = 32_000_000) def scan_pages(self, base_path): files = [file for file in os.listdir(base_path) if os.path.isfile(os.path.join(base_path, file)) and file[:1] != "."] @@ -205,10 +203,7 @@ class Node: file_name = path.replace("/file/", "", 1) try: RNS.log("Serving file: "+file_path, RNS.LOG_VERBOSE) - fh = open(file_path, "rb") - file_data = fh.read() - fh.close() - return [file_name, file_data] + return [open(file_path, "rb"), {"name": file_name.encode("utf-8")}] except Exception as e: RNS.log("Error occurred while handling request "+RNS.prettyhexrep(request_id)+" for: "+str(path), RNS.LOG_ERROR) diff --git a/nomadnet/ui/textui/Browser.py b/nomadnet/ui/textui/Browser.py index 5e412a4..c465dff 100644 --- a/nomadnet/ui/textui/Browser.py +++ b/nomadnet/ui/textui/Browser.py @@ -1,8 +1,10 @@ import RNS import LXMF +import io import os import time import urwid +import shutil import nomadnet import subprocess import threading @@ -1036,23 +1038,36 @@ class Browser: def file_received(self, request_receipt): try: - file_name = request_receipt.response[0] - file_data = request_receipt.response[1] - file_destination_name = file_name.split("/") - file_destination_name = file_destination_name[len(file_destination_name)-1] - file_destination = self.app.downloads_path+"/"+file_destination_name + if type(request_receipt.response) == io.BufferedReader: + if request_receipt.metadata != None: + file_name = os.path.basename(request_receipt.metadata["name"].decode("utf-8")) + file_handle = request_receipt.response + file_destination = self.app.downloads_path+"/"+file_name - - counter = 0 - while os.path.isfile(file_destination): - counter += 1 - file_destination = self.app.downloads_path+"/"+file_name+"."+str(counter) + counter = 0 + while os.path.isfile(file_destination): + counter += 1 + file_destination = self.app.downloads_path+"/"+file_name+"."+str(counter) - fh = open(file_destination, "wb") - fh.write(file_data) - fh.close() + shutil.move(file_handle.name, file_destination) - self.saved_file_name = file_destination.replace(self.app.downloads_path+"/", "", 1) + else: + file_name = request_receipt.response[0] + file_data = request_receipt.response[1] + file_destination_name = file_name.split("/") + file_destination_name = file_destination_name[len(file_destination_name)-1] + file_destination = self.app.downloads_path+"/"+file_destination_name + + counter = 0 + while os.path.isfile(file_destination): + counter += 1 + file_destination = self.app.downloads_path+"/"+file_name+"."+str(counter) + + fh = open(file_destination, "wb") + fh.write(file_data) + fh.close() + + self.saved_file_name = file_destination.replace(self.app.downloads_path+"/", "", 1) self.status = Browser.DONE self.response_progress = 0 From 8d464fcfe4f0ab249c5728a07f9f851f25b6f4d7 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 11 May 2025 16:43:19 +0200 Subject: [PATCH 60/71] Updated version --- nomadnet/_version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nomadnet/_version.py b/nomadnet/_version.py index 22049ab..63af887 100644 --- a/nomadnet/_version.py +++ b/nomadnet/_version.py @@ -1 +1 @@ -__version__ = "0.6.2" +__version__ = "0.6.3" From dfb234c3a98ecebc1a896e782ffa4553c676035d Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 11 May 2025 16:43:42 +0200 Subject: [PATCH 61/71] Updated RNS dependency --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index f31b01a..879fa6f 100644 --- a/setup.py +++ b/setup.py @@ -30,6 +30,6 @@ setuptools.setup( entry_points= { 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, - install_requires=["rns>=0.9.4", "lxmf>=0.6.3", "urwid>=2.6.16", "qrcode"], + install_requires=["rns>=0.9.6", "lxmf>=0.6.3", "urwid>=2.6.16", "qrcode"], python_requires=">=3.7", ) From d1c7f3dcfe885b17802f495aa553dab51a5afbcf Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 11 May 2025 17:21:43 +0200 Subject: [PATCH 62/71] Added transfer speed to progress bar --- nomadnet/ui/textui/Browser.py | 60 +++++++++++++++++++++++++++++++++-- 1 file changed, 58 insertions(+), 2 deletions(-) diff --git a/nomadnet/ui/textui/Browser.py b/nomadnet/ui/textui/Browser.py index c465dff..36e01e6 100644 --- a/nomadnet/ui/textui/Browser.py +++ b/nomadnet/ui/textui/Browser.py @@ -93,7 +93,10 @@ class Browser: self.link = None self.loopback = None self.status = Browser.DISCONECTED + self.progress_updated_at = None + self.previous_progress = 0 self.response_progress = 0 + self.response_speed = None self.response_size = None self.response_transfer_size = None self.saved_file_name = None @@ -318,7 +321,7 @@ class Browser: def make_status_widget(self): if self.response_progress > 0: - pb = ResponseProgressBar("progress_empty" , "progress_full", current=self.response_progress, done=1.0, satt=None) + pb = ResponseProgressBar("progress_empty" , "progress_full", current=self.response_progress, done=1.0, satt=None, owner=self) widget = urwid.Pile([urwid.Divider(self.g["divider1"]), pb]) else: widget = urwid.Pile([urwid.Divider(self.g["divider1"]), urwid.Text(self.status_text())]) @@ -427,6 +430,9 @@ class Browser: self.attr_maps = [] self.status = Browser.DISCONECTED self.response_progress = 0 + self.response_speed = None + self.progress_updated_at = None + self.previous_progress = 0 self.response_size = None self.response_transfer_size = None @@ -537,6 +543,9 @@ class Browser: self.status = Browser.DONE self.response_progress = 0 + self.response_speed = None + self.progress_updated_at = None + self.previous_progress = 0 except Exception as e: RNS.log("An error occurred while handling file response. The contained exception was: "+str(e), RNS.LOG_ERROR) @@ -586,6 +595,9 @@ class Browser: # Send the request self.status = Browser.REQUESTING self.response_progress = 0 + self.response_speed = None + self.progress_updated_at = None + self.previous_progress = 0 self.response_size = None self.response_transfer_size = None self.saved_file_name = None @@ -755,6 +767,9 @@ class Browser: self.attr_maps = markup_to_attrmaps(self.markup, url_delegate=self) self.response_progress = 0 + self.response_speed = None + self.progress_updated_at = None + self.previous_progress = 0 self.response_size = None self.response_transfer_size = None self.saved_file_name = None @@ -802,6 +817,9 @@ class Browser: self.attr_maps = markup_to_attrmaps(self.markup, url_delegate=self) self.response_progress = 0 + self.response_speed = None + self.progress_updated_at = None + self.previous_progress = 0 self.response_size = None self.response_transfer_size = None self.saved_file_name = None @@ -868,6 +886,9 @@ class Browser: # Send the request self.status = Browser.REQUESTING self.response_progress = 0 + self.response_speed = None + self.progress_updated_at = None + self.previous_progress = 0 self.response_size = None self.response_transfer_size = None self.saved_file_name = None @@ -913,6 +934,9 @@ class Browser: def link_establishment_timeout(self): self.status = Browser.LINK_TIMEOUT self.response_progress = 0 + self.response_speed = None + self.progress_updated_at = None + self.previous_progress = 0 self.response_size = None self.response_transfer_size = None self.link = None @@ -927,6 +951,9 @@ class Browser: self.markup = self.page_data.decode("utf-8") self.attr_maps = markup_to_attrmaps(self.markup, url_delegate=self) self.response_progress = 0 + self.response_speed = None + self.progress_updated_at = None + self.previous_progress = 0 self.loaded_from_cache = False # Simple header handling. Should be expanded when more @@ -1070,6 +1097,9 @@ class Browser: self.saved_file_name = file_destination.replace(self.app.downloads_path+"/", "", 1) self.status = Browser.DONE self.response_progress = 0 + self.response_speed = None + self.progress_updated_at = None + self.previous_progress = 0 self.update_display() except Exception as e: @@ -1081,6 +1111,9 @@ class Browser: if request_receipt.request_id == self.last_request_id: self.status = Browser.REQUEST_FAILED self.response_progress = 0 + self.response_speed = None + self.progress_updated_at = None + self.previous_progress = 0 self.response_size = None self.response_transfer_size = None @@ -1093,6 +1126,9 @@ class Browser: else: self.status = Browser.REQUEST_FAILED self.response_progress = 0 + self.response_speed = None + self.progress_updated_at = None + self.previous_progress = 0 self.response_size = None self.response_transfer_size = None @@ -1107,6 +1143,9 @@ class Browser: def request_timeout(self, request_receipt=None): self.status = Browser.REQUEST_TIMEOUT self.response_progress = 0 + self.response_speed = None + self.progress_updated_at = None + self.previous_progress = 0 self.response_size = None self.response_transfer_size = None @@ -1123,6 +1162,17 @@ class Browser: self.response_time = request_receipt.get_response_time() self.response_size = request_receipt.response_size self.response_transfer_size = request_receipt.response_transfer_size + + now = time.time() + if self.progress_updated_at == None: self.progress_updated_at = now + if now > self.progress_updated_at+1: + td = now - self.progress_updated_at + pd = self.response_progress - self.previous_progress + bd = pd*self.response_size + self.response_speed = (bd/td)*8 + self.previous_progress = self.response_progress + self.progress_updated_at = now + self.update_display() @@ -1173,8 +1223,14 @@ class Browser: class ResponseProgressBar(urwid.ProgressBar): + def __init__(self, empty, full, current=None, done=None, satt=None, owner=None): + super().__init__(empty, full, current=current, done=done, satt=satt) + self.owner = owner + def get_text(self): - return "Receiving response "+super().get_text() + if self.owner.response_speed: speed_str = " "+RNS.prettyspeed(self.owner.response_speed) + else: speed_str = "" + return "Receiving response "+super().get_text().replace(" %", "%")+speed_str # A convenience function for printing a human- # readable file size From b02263138219de3efcec899549ef31bd4987def2 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 11 May 2025 17:38:28 +0200 Subject: [PATCH 63/71] Fixed multiple urwid screen init calls --- nomadnet/ui/textui/Interfaces.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/nomadnet/ui/textui/Interfaces.py b/nomadnet/ui/textui/Interfaces.py index b3d5f78..367c682 100644 --- a/nomadnet/ui/textui/Interfaces.py +++ b/nomadnet/ui/textui/Interfaces.py @@ -1,5 +1,6 @@ import RNS import time +import nomadnet from math import log10, pow from nomadnet.vendor.additional_urwid_widgets.FormWidgets import * @@ -70,6 +71,9 @@ def format_bytes(bytes_value): else: return f"{size:.1f} {units[unit_index]}" +def _get_cols_rows(): + return nomadnet.NomadNetworkApp.get_shared_instance().ui.screen.get_cols_rows() + ### PORT FUNCTIONS ### PYSERIAL_AVAILABLE = False # If NomadNet is installed on environments with rnspure instead of rns, pyserial won't be available @@ -2215,6 +2219,7 @@ class ShowInterface(urwid.WidgetWrap): self.config_rows = [] self.history_length=60 + RNS.log(f"Col/rows: {_get_cols_rows()}") # get interface stats interface_stats = self.parent.app.rns.get_interface_stats() @@ -2339,8 +2344,7 @@ class ShowInterface(urwid.WidgetWrap): self.charts_widget = self.vertical_charts self.is_horizontal = False - screen = urwid.raw_display.Screen() - screen_cols, _ = screen.get_cols_rows() + screen_cols, _ = _get_cols_rows() # RNS.log(screen_cols) if screen_cols >= 145: self.charts_widget = self.horizontal_charts @@ -2819,7 +2823,7 @@ class InterfaceDisplay: self.glyphset = self.app.config["textui"]["glyphs"] self.g = self.app.ui.glyphs - self.terminal_cols, self.terminal_rows = urwid.raw_display.Screen().get_cols_rows() + self.terminal_cols, self.terminal_rows = _get_cols_rows() self.iface_row_offset = 4 self.list_rows = self.terminal_rows - self.iface_row_offset @@ -2926,7 +2930,7 @@ class InterfaceDisplay: self.switch_to_edit_interface(interface_name) def check_terminal_size(self, loop, user_data): - new_cols, new_rows = loop.screen.get_cols_rows() + new_cols, new_rows = _get_cols_rows() if new_rows != self.terminal_rows or new_cols != self.terminal_cols: self.terminal_cols, self.terminal_rows = new_cols, new_rows From 3ace3289183c36edec03ebb2d29086703ad5665e Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 11 May 2025 17:45:49 +0200 Subject: [PATCH 64/71] Scale interface graphs according to terminal size --- nomadnet/ui/textui/Interfaces.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/nomadnet/ui/textui/Interfaces.py b/nomadnet/ui/textui/Interfaces.py index 367c682..4134a5f 100644 --- a/nomadnet/ui/textui/Interfaces.py +++ b/nomadnet/ui/textui/Interfaces.py @@ -2218,8 +2218,12 @@ class ShowInterface(urwid.WidgetWrap): self.config_rows = [] - self.history_length=60 - RNS.log(f"Col/rows: {_get_cols_rows()}") + screen_cols, _ = _get_cols_rows() + margin = 22 + if screen_cols >= 145: + self.history_length = screen_cols//2-margin + else: + self.history_length = screen_cols-margin # get interface stats interface_stats = self.parent.app.rns.get_interface_stats() From c35f6418a2e97b20bc499ddc9eab9e42cefb1d12 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 11 May 2025 18:11:35 +0200 Subject: [PATCH 65/71] Added formatted bitrate values to interface charts --- nomadnet/ui/textui/Interfaces.py | 12 ++++++------ nomadnet/vendor/AsciiChart.py | 6 +++++- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/nomadnet/ui/textui/Interfaces.py b/nomadnet/ui/textui/Interfaces.py index 4134a5f..e0f24a9 100644 --- a/nomadnet/ui/textui/Interfaces.py +++ b/nomadnet/ui/textui/Interfaces.py @@ -1303,8 +1303,8 @@ class InterfaceBandwidthChart: self.rx_rates.pop(0) self.tx_rates.pop(0) - self.rx_rates.append(rx_delta) - self.tx_rates.append(tx_delta) + self.rx_rates.append(rx_delta*8) + self.tx_rates.append(tx_delta*8) if self.update_count >= self.stabilization_updates: self.initialization_complete = True @@ -1328,14 +1328,14 @@ class InterfaceBandwidthChart: peak_rx = self.peak_rx_for_display if self.initialization_complete else 0 peak_tx = self.peak_tx_for_display if self.initialization_complete else 0 - peak_rx_str = format_bytes(peak_rx) - peak_tx_str = format_bytes(peak_tx) + peak_rx_str = RNS.prettyspeed(peak_rx*8) + peak_tx_str = RNS.prettyspeed(peak_tx*8) rx_chart = chart.plot( [rx_data], { 'height': height, - 'format': '{:8.1f}', + 'format': RNS.prettyspeed, 'min': 0, 'max': self.max_rx_rate * 1.1, } @@ -1345,7 +1345,7 @@ class InterfaceBandwidthChart: [tx_data], { 'height': height, - 'format': '{:8.1f}', + 'format': RNS.prettyspeed, 'min': 0, 'max': self.max_tx_rate * 1.1, } diff --git a/nomadnet/vendor/AsciiChart.py b/nomadnet/vendor/AsciiChart.py index 4689590..cd24d56 100644 --- a/nomadnet/vendor/AsciiChart.py +++ b/nomadnet/vendor/AsciiChart.py @@ -46,7 +46,11 @@ class AsciiChart: result = [[' '] * width for i in range(rows + 1)] for y in range(min2, max2 + 1): - label = placeholder.format(maximum - ((y - min2) * interval / (rows if rows else 1))) + if callable(placeholder): + label = placeholder(maximum - ((y - min2) * interval / (rows if rows else 1))).rjust(12) + else: + label = placeholder.format(maximum - ((y - min2) * interval / (rows if rows else 1))) + result[y - min2][max(offset - len(label), 0)] = label result[y - min2][offset - 1] = symbols[0] if y == 0 else symbols[1] From b6e4d8441a47403c40494dea95ef716a08453bb7 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 11 May 2025 18:43:13 +0200 Subject: [PATCH 66/71] Handle first-char escape properly. Fixes #67. --- nomadnet/ui/textui/MicronParser.py | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/nomadnet/ui/textui/MicronParser.py b/nomadnet/ui/textui/MicronParser.py index bbda2c8..9f277ba 100644 --- a/nomadnet/ui/textui/MicronParser.py +++ b/nomadnet/ui/textui/MicronParser.py @@ -73,8 +73,9 @@ def markup_to_attrmaps(markup, url_delegate = None): return attrmaps - +import RNS def parse_line(line, state, url_delegate): + pre_escape = False if len(line) > 0: first_char = line[0] @@ -88,6 +89,7 @@ def parse_line(line, state, url_delegate): # Check if the command is an escape if first_char == "\\": line = line[1:] + pre_escape = True # Check for comments elif first_char == "#": @@ -142,7 +144,7 @@ def parse_line(line, state, url_delegate): else: return [urwid.Padding(urwid.Divider(divider_char), left=left_indent(state), right=right_indent(state))] - output = make_output(state, line, url_delegate) + output = make_output(state, line, url_delegate, pre_escape) if output != None: text_only = True @@ -425,7 +427,7 @@ def make_style(state): return name -def make_output(state, line, url_delegate): +def make_output(state, line, url_delegate, pre_escape=False): output = [] if state["literal"]: if line == "\\`=": @@ -434,8 +436,10 @@ def make_output(state, line, url_delegate): else: part = "" mode = "text" - escape = False + escape = pre_escape skip = 0 + + RNS.log(f"Line [ESC {escape}] [MODE {mode}: {line}") for i in range(0, len(line)): c = line[i] if skip > 0: @@ -666,6 +670,7 @@ def make_output(state, line, url_delegate): part = "" else: part += c + escape = False if i == len(line)-1: if len(part) > 0: From 96823c8546f86c2aeaa5fb21581e7b70475d5e2b Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 11 May 2025 20:59:26 +0200 Subject: [PATCH 67/71] Added page background and foreground headers to micron --- nomadnet/ui/textui/Browser.py | 93 ++++++++++++++++++++++++++++-- nomadnet/ui/textui/Guide.py | 4 ++ nomadnet/ui/textui/MicronParser.py | 44 ++++++++------ 3 files changed, 119 insertions(+), 22 deletions(-) diff --git a/nomadnet/ui/textui/Browser.py b/nomadnet/ui/textui/Browser.py index 36e01e6..b740023 100644 --- a/nomadnet/ui/textui/Browser.py +++ b/nomadnet/ui/textui/Browser.py @@ -8,7 +8,7 @@ import shutil import nomadnet import subprocess import threading -from .MicronParser import markup_to_attrmaps +from .MicronParser import markup_to_attrmaps, make_style, default_state from nomadnet.Directory import DirectoryEntry from nomadnet.vendor.Scrollable import * @@ -99,6 +99,8 @@ class Browser: self.response_speed = None self.response_size = None self.response_transfer_size = None + self.page_background_color = None + self.page_foreground_color = None self.saved_file_name = None self.page_data = None self.displayed_page_data = None @@ -157,10 +159,16 @@ class Browser: self.browser_footer = self.make_status_widget() self.frame.contents["footer"] = (self.browser_footer, self.frame.options()) self.link_status_showing = False + if self.page_background_color != None or self.page_foreground_color != None: + style_name = make_style(default_state(fg=self.page_foreground_color, bg=self.page_background_color)) + self.browser_footer.set_attr_map({None: style_name}) else: self.link_status_showing = True self.browser_footer = urwid.AttrMap(urwid.Pile([urwid.Divider(self.g["divider1"]), urwid.Text("Link to: "+str(link_target))]), "browser_controls") self.frame.contents["footer"] = (self.browser_footer, self.frame.options()) + if self.page_background_color != None or self.page_foreground_color != None: + style_name = make_style(default_state(fg=self.page_foreground_color, bg=self.page_background_color)) + self.browser_footer.set_attr_map({None: style_name}) def expand_shorthands(self, destination_type): if destination_type == "nnn": @@ -321,7 +329,14 @@ class Browser: def make_status_widget(self): if self.response_progress > 0: - pb = ResponseProgressBar("progress_empty" , "progress_full", current=self.response_progress, done=1.0, satt=None, owner=self) + if self.page_background_color != None or self.page_foreground_color != None: + style_name = make_style(default_state(fg=self.page_foreground_color, bg=self.page_background_color)) + style_name_inverted = make_style(default_state(bg=self.page_foreground_color, fg=self.page_background_color)) + else: + style_name = "progress_empty" + style_name_inverted = "progress_full" + + pb = ResponseProgressBar(style_name , style_name_inverted, current=self.response_progress, done=1.0, satt=None, owner=self) widget = urwid.Pile([urwid.Divider(self.g["divider1"]), pb]) else: widget = urwid.Pile([urwid.Divider(self.g["divider1"]), urwid.Text(self.status_text())]) @@ -368,6 +383,10 @@ class Browser: else: self.display_widget.set_attr_map({None: "body_text"}) self.browser_header = self.make_control_widget() + if self.page_background_color != None or self.page_foreground_color != None: + style_name = make_style(default_state(fg=self.page_foreground_color, bg=self.page_background_color)) + self.browser_header.set_attr_map({None: style_name}) + if self.destination_hash != None: remote_display_string = self.app.directory.simplest_display_str(self.destination_hash) else: @@ -381,6 +400,13 @@ class Browser: if self.status == Browser.DONE: self.browser_footer = self.make_status_widget() self.update_page_display() + + if self.page_background_color != None or self.page_foreground_color != None: + style_name = make_style(default_state(fg=self.page_foreground_color, bg=self.page_background_color)) + self.browser_body.set_attr_map({None: style_name}) + self.browser_footer.set_attr_map({None: style_name}) + self.browser_header.set_attr_map({None: style_name}) + self.display_widget.set_attr_map({None: style_name}) elif self.status == Browser.LINK_TIMEOUT: self.browser_body = self.make_request_failed_widget() @@ -394,6 +420,12 @@ class Browser: ) self.browser_footer = self.make_status_widget() + + if self.page_background_color != None or self.page_foreground_color != None: + style_name = make_style(default_state(fg=self.page_foreground_color, bg=self.page_background_color)) + self.browser_footer.set_attr_map({None: style_name}) + self.browser_header.set_attr_map({None: style_name}) + self.display_widget.set_attr_map({None: style_name}) elif self.status == Browser.REQUEST_FAILED: self.browser_body = self.make_request_failed_widget() @@ -764,7 +796,24 @@ class Browser: self.status = Browser.DONE self.page_data = cached self.markup = self.page_data.decode("utf-8") - self.attr_maps = markup_to_attrmaps(self.markup, url_delegate=self) + + self.page_background_color = None + bgpos = self.markup.find("#!bg=") + if bgpos: + endpos = self.markup.find("\n", bgpos) + if endpos-(bgpos+5) == 3: + bg = self.markup[bgpos+5:endpos] + self.page_background_color = bg + + self.page_foreground_color = None + fgpos = self.markup.find("#!fg=") + if fgpos: + endpos = self.markup.find("\n", fgpos) + if endpos-(fgpos+5) == 3: + fg = self.markup[fgpos+5:endpos] + self.page_foreground_color = fg + + self.attr_maps = markup_to_attrmaps(self.markup, url_delegate=self, fg_color=self.page_foreground_color, bg_color=self.page_background_color) self.response_progress = 0 self.response_speed = None @@ -814,7 +863,24 @@ class Browser: self.status = Browser.DONE self.page_data = page_data self.markup = self.page_data.decode("utf-8") - self.attr_maps = markup_to_attrmaps(self.markup, url_delegate=self) + + self.page_background_color = None + bgpos = self.markup.find("#!bg=") + if bgpos: + endpos = self.markup.find("\n", bgpos) + if endpos-(bgpos+5) == 3: + bg = self.markup[bgpos+5:endpos] + self.page_background_color = bg + + self.page_foreground_color = None + fgpos = self.markup.find("#!fg=") + if fgpos: + endpos = self.markup.find("\n", fgpos) + if endpos-(fgpos+5) == 3: + fg = self.markup[fgpos+5:endpos] + self.page_foreground_color = fg + + self.attr_maps = markup_to_attrmaps(self.markup, url_delegate=self, fg_color=self.page_foreground_color, bg_color=self.page_background_color) self.response_progress = 0 self.response_speed = None @@ -949,7 +1015,24 @@ class Browser: self.status = Browser.DONE self.page_data = request_receipt.response self.markup = self.page_data.decode("utf-8") - self.attr_maps = markup_to_attrmaps(self.markup, url_delegate=self) + + self.page_background_color = None + bgpos = self.markup.find("#!bg=") + if bgpos: + endpos = self.markup.find("\n", bgpos) + if endpos-(bgpos+5) == 3: + bg = self.markup[bgpos+5:endpos] + self.page_background_color = bg + + self.page_foreground_color = None + fgpos = self.markup.find("#!fg=") + if fgpos: + endpos = self.markup.find("\n", fgpos) + if endpos-(fgpos+5) == 3: + fg = self.markup[fgpos+5:endpos] + self.page_foreground_color = fg + + self.attr_maps = markup_to_attrmaps(self.markup, url_delegate=self, fg_color=self.page_foreground_color, bg_color=self.page_background_color) self.response_progress = 0 self.response_speed = None self.progress_updated_at = None diff --git a/nomadnet/ui/textui/Guide.py b/nomadnet/ui/textui/Guide.py index 4b4ca2a..352e71f 100644 --- a/nomadnet/ui/textui/Guide.py +++ b/nomadnet/ui/textui/Guide.py @@ -1268,6 +1268,9 @@ You can use `B5d5`F222 color `f`B333 `Ff00f`Ff80o`Ffd0r`F9f0m`F0f2a`F0fdt`F07ft` `` +>Page Foreground and Background Colors + +To specify a background color for the entire page, place the `!#!bg=X`! header on one of the first lines of your page, where `!X`! is the color you want to use, for example `!444`!. If you're also using the cache control header, the background specifier must come `*after`* the cache control header. Likewise, you can specify the default text color by using the `!#!fg=X`! header. >Links @@ -1385,6 +1388,7 @@ A masked input field: `B444``B333 Full control: `B444``B333 `b + >>> Checkboxes In addition to text fields, Checkboxes are another way of submitting data. They allow the user to make a single selection or select multiple options. diff --git a/nomadnet/ui/textui/MicronParser.py b/nomadnet/ui/textui/MicronParser.py index 9f277ba..70f9f0f 100644 --- a/nomadnet/ui/textui/MicronParser.py +++ b/nomadnet/ui/textui/MicronParser.py @@ -31,20 +31,14 @@ SYNTH_SPECS = {} SECTION_INDENT = 2 INDENT_RIGHT = 1 -def markup_to_attrmaps(markup, url_delegate = None): - global SELECTED_STYLES - if nomadnet.NomadNetworkApp.get_shared_instance().config["textui"]["theme"] == nomadnet.ui.TextUI.THEME_DARK: - SELECTED_STYLES = STYLES_DARK - else: - SELECTED_STYLES = STYLES_LIGHT - - attrmaps = [] - +def default_state(fg=None, bg=None): + if fg == None: fg = SELECTED_STYLES["plain"]["fg"] + if bg == None: bg = DEFAULT_BG state = { "literal": False, "depth": 0, - "fg_color": SELECTED_STYLES["plain"]["fg"], - "bg_color": DEFAULT_BG, + "fg_color": fg, + "bg_color": bg, "formatting": { "bold": False, "underline": False, @@ -54,7 +48,25 @@ def markup_to_attrmaps(markup, url_delegate = None): }, "default_align": "left", "align": "left", + "default_fg": fg, + "default_bg": bg, } + return state + +def markup_to_attrmaps(markup, url_delegate = None, fg_color=None, bg_color=None): + global SELECTED_STYLES + if nomadnet.NomadNetworkApp.get_shared_instance().config["textui"]["theme"] == nomadnet.ui.TextUI.THEME_DARK: + SELECTED_STYLES = STYLES_DARK + else: + SELECTED_STYLES = STYLES_LIGHT + + attrmaps = [] + + fgc = None; bgc = DEFAULT_BG + if bg_color != None: bgc = bg_color + if fg_color != None: fgc = fg_color + + state = default_state(fgc, bgc) # Split entire document into lines for # processing. @@ -73,7 +85,6 @@ def markup_to_attrmaps(markup, url_delegate = None): return attrmaps -import RNS def parse_line(line, state, url_delegate): pre_escape = False if len(line) > 0: @@ -439,7 +450,6 @@ def make_output(state, line, url_delegate, pre_escape=False): escape = pre_escape skip = 0 - RNS.log(f"Line [ESC {escape}] [MODE {mode}: {line}") for i in range(0, len(line)): c = line[i] if skip > 0: @@ -458,20 +468,20 @@ def make_output(state, line, url_delegate, pre_escape=False): state["fg_color"] = color skip = 3 elif c == "f": - state["fg_color"] = SELECTED_STYLES["plain"]["fg"] + state["fg_color"] = state["default_fg"] elif c == "B": if len(line) >= i+4: color = line[i+1:i+4] state["bg_color"] = color skip = 3 elif c == "b": - state["bg_color"] = DEFAULT_BG + state["bg_color"] = state["default_bg"] elif c == "`": state["formatting"]["bold"] = False state["formatting"]["underline"] = False state["formatting"]["italic"] = False - state["fg_color"] = SELECTED_STYLES["plain"]["fg"] - state["bg_color"] = DEFAULT_BG + state["fg_color"] = state["default_fg"] + state["bg_color"] = state["default_bg"] state["align"] = state["default_align"] elif c == "c": if state["align"] != "center": From c9de9244f437df0d1cf7435ae49443706c25eac6 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 11 May 2025 20:59:43 +0200 Subject: [PATCH 68/71] Updated version --- nomadnet/_version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nomadnet/_version.py b/nomadnet/_version.py index 63af887..49e0fc1 100644 --- a/nomadnet/_version.py +++ b/nomadnet/_version.py @@ -1 +1 @@ -__version__ = "0.6.3" +__version__ = "0.7.0" From 2c7b35033b1019309c3461d624d118e9aa7ff11b Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 11 May 2025 21:27:32 +0200 Subject: [PATCH 69/71] Fixed legacy mode download when file exists --- nomadnet/ui/textui/Browser.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nomadnet/ui/textui/Browser.py b/nomadnet/ui/textui/Browser.py index b740023..1962714 100644 --- a/nomadnet/ui/textui/Browser.py +++ b/nomadnet/ui/textui/Browser.py @@ -1164,20 +1164,20 @@ class Browser: else: file_name = request_receipt.response[0] file_data = request_receipt.response[1] - file_destination_name = file_name.split("/") - file_destination_name = file_destination_name[len(file_destination_name)-1] + file_destination_name = os.path.basename(file_name) file_destination = self.app.downloads_path+"/"+file_destination_name counter = 0 while os.path.isfile(file_destination): counter += 1 - file_destination = self.app.downloads_path+"/"+file_name+"."+str(counter) + file_destination = self.app.downloads_path+"/"+file_destination_name+"."+str(counter) fh = open(file_destination, "wb") fh.write(file_data) fh.close() self.saved_file_name = file_destination.replace(self.app.downloads_path+"/", "", 1) + self.status = Browser.DONE self.response_progress = 0 self.response_speed = None From 58407b9ec46044fbc496933cd5eeaef0e4f12c7e Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Mon, 12 May 2025 11:51:12 +0200 Subject: [PATCH 70/71] Mask IFAC passphrase in interface view --- nomadnet/ui/textui/Interfaces.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/nomadnet/ui/textui/Interfaces.py b/nomadnet/ui/textui/Interfaces.py index e0f24a9..85b9b12 100644 --- a/nomadnet/ui/textui/Interfaces.py +++ b/nomadnet/ui/textui/Interfaces.py @@ -2223,7 +2223,7 @@ class ShowInterface(urwid.WidgetWrap): if screen_cols >= 145: self.history_length = screen_cols//2-margin else: - self.history_length = screen_cols-margin + self.history_length = screen_cols-(margin+2) # get interface stats interface_stats = self.parent.app.rns.get_interface_stats() @@ -2402,6 +2402,8 @@ class ShowInterface(urwid.WidgetWrap): elif key == "bandwidth": int_value = int(value) value_str = f"{int_value / 1000:.1f} kHz" + elif key == "passphrase": + value_str = len(value)*"*" else: value_str = str(value) # format display keys: "listen_port" => Listen Port From 8e0f782df0e517b0e10e5aaedb234e629d4c450c Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Thu, 15 May 2025 22:20:03 +0200 Subject: [PATCH 71/71] Updated LXMF dependency --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 879fa6f..e5560a6 100644 --- a/setup.py +++ b/setup.py @@ -30,6 +30,6 @@ setuptools.setup( entry_points= { 'console_scripts': ['nomadnet=nomadnet.nomadnet:main'] }, - install_requires=["rns>=0.9.6", "lxmf>=0.6.3", "urwid>=2.6.16", "qrcode"], + install_requires=["rns>=0.9.6", "lxmf>=0.7.1", "urwid>=2.6.16", "qrcode"], python_requires=">=3.7", )