diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index caf3250..0000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1,11 +0,0 @@ -blank_issues_enabled: false -contact_links: - - name: ✨ Feature Request or Idea - url: https://github.com/markqvist/Reticulum/discussions/new?category=ideas - about: Propose and discuss features and ideas - - name: 💬 Questions, Help & Discussion - about: Ask anything, or get help - url: https://github.com/markqvist/Reticulum/discussions/new/choose - - name: 📖 Read the Reticulum Manual - url: https://markqvist.github.io/Reticulum/manual/ - about: The complete documentation for Reticulum diff --git a/.github/ISSUE_TEMPLATE/🐛-bug-report.md b/.github/ISSUE_TEMPLATE/🐛-bug-report.md deleted file mode 100644 index 65b492e..0000000 --- a/.github/ISSUE_TEMPLATE/🐛-bug-report.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: "\U0001F41B Bug Report" -about: Report a reproducible bug -title: '' -labels: '' -assignees: '' - ---- - -**Read the Contribution Guidelines** -Before creating a bug report on this issue tracker, you **must** read the [Contribution Guidelines](https://github.com/markqvist/Reticulum/blob/master/Contributing.md). Issues that do not follow the contribution guidelines **will be deleted without comment**. - -- 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 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. - -**To Reproduce** -Describe in detail how to reproduce the bug. - -**Expected Behavior** -A clear and concise description of what you expected to happen. - -**Logs & Screenshots** -Please include any relevant log output. If applicable, also add screenshots to help explain your problem. - -**System Information** -- OS and version -- Python version -- Program version - -**Additional context** -Add any other context about the problem here. diff --git a/Dockerfile b/Dockerfile index e9920e1..0944827 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -FROM python:3.12-alpine as build +FROM python:3.11-rc-alpine3.14 as build RUN apk add --no-cache build-base linux-headers libffi-dev cargo @@ -8,10 +8,10 @@ ENV PATH="/opt/venv/bin:$PATH" RUN pip3 install setuptools-rust pyopenssl cryptography COPY . /app/ -RUN cd /app/ && pip3 install . +RUN cd /app/ && python3 setup.py install # Use multi-stage build, as we don't need rust compilation on the final image -FROM python:3.12-alpine +FROM python:3.11-rc-alpine3.14 LABEL org.opencontainers.image.documentation="https://github.com/markqvist/NomadNet#nomad-network-daemon-with-docker" diff --git a/Dockerfile.build b/Dockerfile.build deleted file mode 100644 index e28e9bd..0000000 --- a/Dockerfile.build +++ /dev/null @@ -1,28 +0,0 @@ -FROM python:alpine -LABEL authors="Petr Blaha petr.blaha@cleverdata.cz" -USER root -RUN apk update -RUN apk add build-base libffi-dev cargo pkgconfig linux-headers py3-virtualenv - -RUN addgroup -S myuser && adduser -S -G myuser myuser -USER myuser -WORKDIR /home/myuser - -RUN pip install --upgrade pip -RUN pip install setuptools-rust pyopenssl cryptography - - -ENV PATH="/home/myuser/.local/bin:${PATH}" - -################### BEGIN NomadNet ########################################### - - -COPY --chown=myuser:myuser . . - -#Python create virtual environment -RUN virtualenv /home/myuser/NomadNet/venv -RUN source /home/myuser/NomadNet/venv/bin/activate - -RUN make all - -################### END NomadNet ########################################### diff --git a/Dockerfile.howto b/Dockerfile.howto deleted file mode 100644 index cfd4ee8..0000000 --- a/Dockerfile.howto +++ /dev/null @@ -1,6 +0,0 @@ -# Run docker command one by one(all four), it will build NomadNet artifact and copy to dist directory. -# No need to build locally and install dependencies -docker build -t nomadnetdockerimage -f Dockerfile.build . -docker run -d -it --name nomadnetdockercontainer nomadnetdockerimage /bin/sh -docker cp nomadnetdockercontainer:/home/myuser/dist . -docker rm -f nomadnetdockercontainer \ No newline at end of file diff --git a/README.md b/README.md index 416eb7c..0ab5dda 100755 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@ -# Nomad Network - Communicate Freely +Nomad Network - Communicate Freely +========== Off-grid, resilient mesh communication with strong encryption, forward secrecy and extreme privacy. ![Screenshot](https://github.com/markqvist/NomadNet/raw/master/docs/screenshots/1.png) -Nomad Network allows you to build private and resilient communications platforms that are in complete control and ownership of the people that use them. No signups, no agreements, no handover of any data, no permissions and gatekeepers. +Nomad Network Allows you to build private and resilient communications platforms that are in complete control and ownership of the people that use them. No signups, no agreements, no handover of any data, no permissions and gatekeepers. Nomad Network is build on [LXMF](https://github.com/markqvist/LXMF) and [Reticulum](https://github.com/markqvist/Reticulum), which together provides the cryptographic mesh functionality and peer-to-peer message routing that Nomad Network relies on. This foundation also makes it possible to use the program over a very wide variety of communication mediums, from packet radio to fiber optics. -Nomad Network does not need any connections to the public internet to work. In fact, it doesn't even need an IP or Ethernet network. You can use it entirely over packet radio, LoRa or even serial lines. But if you wish, you can bridge islanded networks over the Internet or private ethernet networks, or you can build networks running completely over the Internet. The choice is yours. Since Nomad Network uses Reticulum, it is efficient enough to run even over *extremely* low-bandwidth medium, and has been succesfully used over 300bps radio links. +Nomad Network does not need any connections to the public internet to work. In fact, it doesn't even need an IP or Ethernet network. You can use it entirely over packet radio, LoRa or even serial lines. But if you wish, you can bridge islanded networks over the Internet or private ethernet networks, or you can build networks running completely over the Internet. The choice is yours. If you'd rather want to use an LXMF client with a graphical user interface, you may want to take a look at [Sideband](https://github.com/markqvist/sideband), which is available for Linux, Android and macOS. @@ -22,12 +23,20 @@ If you'd rather want to use an LXMF client with a graphical user interface, you - An easy to use and bandwidth efficient markup language for writing pages - Page caching in browser +## Current Status +The current version of the program should be considered a beta release. The program works well, but there will most probably be bugs and possibly sub-optimal performance in some scenarios. On the other hand, this is the ideal time to have an influence on the direction of the development of Nomad Network. To do so, join the discussion, report bugs and request features here on the GitHub project. + +### Feature roadmap + - Network-wide propagated bulletins and discussion threads + - Collaborative maps and geospatial information sharing + - Facilitation of trade and barter + ## How do I get started? The easiest way to install Nomad Network is via pip: ```bash # Install Nomad Network and dependencies -pip install nomadnet +pip3 install nomadnet # Run the client nomadnet @@ -39,52 +48,23 @@ nomadnet --daemon nomadnet --help ``` -If you are using an operating system that blocks normal user package installation via `pip`, you can return `pip` to normal behaviour by editing the `~/.config/pip/pip.conf` file, and adding the following directive in the `[global]` section: - -```text -[global] -break-system-packages = true -``` - -Alternatively, you can use the `pipx` tool to install Nomad Network in an isolated environment: - -```bash -# Install Nomad Network -pipx install nomadnet - -# Optionally install Reticulum utilities -pipx install rns - -# Optionally install standalone LXMF utilities -pipx install lxmf - -# Run the client -nomadnet - -# Or alternatively run as a daemon, with no user interface -nomadnet --daemon - -# List options -nomadnet --help -``` - -**Please Note**: If this is the very first time you use pip to install a program on your system, you might need to reboot your system for the program to become available. If you get a "command not found" error or similar when running the program, reboot your system and try again. - The first time the program is running, you will be presented with the **Guide section**, which contains all the information you need to start using Nomad Network. To use Nomad Network on packet radio or LoRa, you will need to configure your Reticulum installation to use any relevant packet radio TNCs or LoRa devices on your system. See the [Reticulum documentation](https://markqvist.github.io/Reticulum/manual/interfaces.html) for info. For a general introduction on how to set up such a system, take a look at [this post](https://unsigned.io/private-messaging-over-lora/). If you want to try Nomad Network without building your own physical network, you can connect to the [Unsigned.io RNS Testnet](https://github.com/markqvist/Reticulum#public-testnet) over the Internet, where there is already some Nomad Network and LXMF activity. 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: - - `abb3ebcd03cb2388a838e70c001291f9` Dublin Hub Testnet Node - - `ea6a715f814bdc37e56f80c34da6ad51` Frankfurt Hub Testnet Node + - `464ddc8cd323648ef919a638923b4916` Dublin Hub Testnet Node + - `5cda089fc42675bdd904c6d06db87d49` Frankfurt Hub Testnet Node To browse pages on a node that is not currently known, open the URL dialog in the `Network` section of the program by pressing `Ctrl+U`, paste or enter the address and select `Go` or press enter. Nomadnet will attempt to discover and connect to the requested node. +**Please Note**: If this is the very first time you use pip to install a program on your system, you might need to reboot your system for the program to become available. If you get a "command not found" error or similar when running the program, reboot your system and try again. + ### Install on Android You can install Nomad Network on Android using Termux, but there's a few more commands involved than the above one-liner. The process is documented in the [Android Installation](https://markqvist.github.io/Reticulum/manual/gettingstartedfast.html#reticulum-on-android) section of the Reticulum Manual. Once the Reticulum has been installed according to the linked documentation, Nomad Network can be installed as usual with pip. -For a native Android application with a graphical user interface, have a look at [Sideband](https://github.com/markqvist/Sideband). +For a native Android application with a graphical user interface, have a look at [Sideband](https://unsigned.io/sideband). ### Docker Images @@ -118,23 +98,6 @@ $ docker run -d \ $ docker run -i ghcr.io/markqvist/nomadnet:master --daemon --console ``` -## Tools & Extensions - -Nomad Network is a very flexible and extensible platform, and a variety of community-provided tools, utilities and node-side extensions exist: - -- [NomadForum](https://codeberg.org/AutumnSpark1226/nomadForum) ([GitHub mirror](https://github.com/AutumnSpark1226/nomadForum)) -- [NomadForecast](https://github.com/faragher/NomadForecast) -- [micron-blog](https://github.com/randogoth/micron-blog) -- [md2mu](https://github.com/randogoth/md2mu) -- [Any2MicronConverter](https://github.com/SebastianObi/Any2MicronConverter) -- [Some nomadnet page examples](https://github.com/SebastianObi/NomadNet-Pages) -- [More nomadnet page examples](https://github.com/epenguins/NomadNet_pages) -- [LXMF-Bot](https://github.com/randogoth/lxmf-bot) -- [LXMF Messageboard](https://github.com/chengtripp/lxmf_messageboard) -- [LXMEvent](https://github.com/faragher/LXMEvent) -- [POPR](https://github.com/faragher/POPR) -- [LXMF Tools](https://github.com/SebastianObi/LXMF-Tools) - ## Help & Discussion For help requests, discussion, sharing ideas or anything else related to Nomad Network, please have a look at the [Nomad Network discussions pages](https://github.com/markqvist/Reticulum/discussions/categories/nomad-network). @@ -146,38 +109,16 @@ You can help support the continued development of open, free and private communi ``` 84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w ``` -- Bitcoin - ``` - bc1p4a6axuvl7n9hpapfj8sv5reqj8kz6uxa67d5en70vzrttj0fmcusgxsfk5 - ``` - Ethereum ``` - 0xae89F3B94fC4AD6563F0864a55F9a697a90261ff + 0x81F7B979fEa6134bA9FD5c701b3501A2e61E897a + ``` +- Bitcoin + ``` + 3CPmacGm34qYvR6XWLVEJmi2aNe3PZqUuq ``` - Ko-Fi: https://ko-fi.com/markqvist -## Development Roadmap - -- New major features - - Network-wide propagated bulletins and discussion threads - - Collaborative maps and geospatial information sharing -- Minor improvements and fixes - - Link status (RSSI and SNR) in conversation or conv list - - Ctrl-M shorcut for jumping to menu - - Share node with other users / send node info to user - - Fix internal editor failing on some OSes with no "editor" alias - - Possibly add a required-width header - - Improve browser handling of remote link close - - Better navigation handling when requests fail (also because of closed links) - - Retry failed messages mechanism - - Re-arrange buttons to be more consistent - - Input field for pages - - Post mechanism - - Term compatibility notice in readme - - Selected icon in conversation list - - Possibly a Search Local Nodes function - - Possibly add via entry in node info box, next to distance - ## Caveat Emptor Nomad Network is beta software, and should be considered as such. While it has been built with cryptography best-practices very foremost in mind, it _has not_ been externally security audited, and there could very well be privacy-breaking bugs. If you want to help out, or help sponsor an audit, please do get in touch. diff --git a/nomadnet/Conversation.py b/nomadnet/Conversation.py index 9b3f804..d36f2eb 100644 --- a/nomadnet/Conversation.py +++ b/nomadnet/Conversation.py @@ -27,13 +27,6 @@ class Conversation: if Conversation.created_callback != None: Conversation.created_callback() - # This reformats the new v0.5.0 announce data back to the expected format - # for nomadnets storage and other handling functions. - dn = LXMF.display_name_from_app_data(app_data) - app_data = b"" - if dn != None: - app_data = dn.encode("utf-8") - # Add the announce to the directory announce # stream logger app.directory.lxmf_announce_received(destination_hash, app_data) @@ -102,7 +95,7 @@ class Conversation: unread = True if display_name == None and app_data: - display_name = LXMF.display_name_from_app_data(app_data) + display_name = app_data.decode("utf-8") if display_name == None: sort_name = "" @@ -149,7 +142,7 @@ class Conversation: self.__changed_callback = None - if not RNS.Identity.recall(bytes.fromhex(self.source_hash)): + if not RNS.Transport.has_path(bytes.fromhex(source_hash)): RNS.Transport.request_path(bytes.fromhex(source_hash)) self.source_identity = RNS.Identity.recall(bytes.fromhex(self.source_hash)) @@ -216,16 +209,8 @@ 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: - dest_is_trusted = True - - lxm = LXMF.LXMessage(dest, source, content, title=title, desired_method=desired_method, include_ticket=dest_is_trusted) + lxm = LXMF.LXMessage(dest, source, content, title=title, desired_method=desired_method) lxm.register_delivery_callback(self.message_notification) lxm.register_failed_callback(self.message_notification) @@ -242,71 +227,15 @@ class Conversation: RNS.log("Destination is not known, cannot create LXMF Message.", RNS.LOG_VERBOSE) return False - def paper_output(self, content="", title="", mode="print_qr"): - if self.send_destination: - try: - dest = self.send_destination - source = self.app.lxmf_destination - desired_method = LXMF.LXMessage.PAPER - - lxm = LXMF.LXMessage(dest, source, content, title=title, desired_method=desired_method) - - if mode == "print_qr": - qr_code = lxm.as_qr() - qr_tmp_path = self.app.tmpfilespath+"/"+str(RNS.hexrep(lxm.hash, delimit=False)) - qr_code.save(qr_tmp_path) - - print_result = self.app.print_file(qr_tmp_path) - os.unlink(qr_tmp_path) - - if print_result: - message_path = Conversation.ingest(lxm, self.app, originator=True) - self.messages.append(ConversationMessage(message_path)) - - return print_result - - elif mode == "save_qr": - qr_code = lxm.as_qr() - qr_save_path = self.app.downloads_path+"/LXM_"+str(RNS.hexrep(lxm.hash, delimit=False)+".png") - qr_code.save(qr_save_path) - message_path = Conversation.ingest(lxm, self.app, originator=True) - self.messages.append(ConversationMessage(message_path)) - return qr_save_path - - elif mode == "save_uri": - lxm_uri = lxm.as_uri()+"\n" - uri_save_path = self.app.downloads_path+"/LXM_"+str(RNS.hexrep(lxm.hash, delimit=False)+".txt") - with open(uri_save_path, "wb") as f: - f.write(lxm_uri.encode("utf-8")) - - message_path = Conversation.ingest(lxm, self.app, originator=True) - self.messages.append(ConversationMessage(message_path)) - return uri_save_path - - elif mode == "return_uri": - return lxm.as_uri() - - except Exception as e: - RNS.log("An error occurred while generating paper message, the contained exception was: "+str(e), RNS.LOG_ERROR) - return False - - else: - RNS.log("Destination is not known, cannot create LXMF Message.", RNS.LOG_VERBOSE) - return False - def message_notification(self, message): if message.state == LXMF.LXMessage.FAILED and hasattr(message, "try_propagation_on_fail") and message.try_propagation_on_fail: - if hasattr(message, "stamp_generation_failed") and message.stamp_generation_failed == True: - RNS.log(f"Could not send {message} due to a stamp generation failure", RNS.LOG_ERROR) - else: - RNS.log("Direct delivery of "+str(message)+" failed. Retrying as propagated message.", RNS.LOG_VERBOSE) - message.try_propagation_on_fail = None - message.delivery_attempts = 0 - if hasattr(message, "next_delivery_attempt"): - del message.next_delivery_attempt - message.packed = None - message.desired_method = LXMF.LXMessage.PROPAGATED - self.app.message_router.handle_outbound(message) + RNS.log("Direct delivery of "+str(message)+" failed. Retrying as propagated message.", RNS.LOG_VERBOSE) + message.try_propagation_on_fail = None + message.delivery_attempts = 0 + del message.next_delivery_attempt + message.packed = None + message.desired_method = LXMF.LXMessage.PROPAGATED + self.app.message_router.handle_outbound(message) else: message_path = Conversation.ingest(message, self.app, originator=True) @@ -337,17 +266,12 @@ class ConversationMessage: self.timestamp = self.lxm.timestamp self.sort_timestamp = os.path.getmtime(self.file_path) - if self.lxm.state > LXMF.LXMessage.GENERATING and self.lxm.state < LXMF.LXMessage.SENT: + if self.lxm.state > LXMF.LXMessage.DRAFT and self.lxm.state < LXMF.LXMessage.SENT: found = False - for pending in nomadnet.NomadNetworkApp.get_shared_instance().message_router.pending_outbound: if pending.hash == self.lxm.hash: found = True - for pending_id in nomadnet.NomadNetworkApp.get_shared_instance().message_router.pending_deferred_stamps: - if pending_id == self.lxm.hash: - found = True - if not found: self.lxm.state = LXMF.LXMessage.FAILED diff --git a/nomadnet/Directory.py b/nomadnet/Directory.py index ac03155..875f621 100644 --- a/nomadnet/Directory.py +++ b/nomadnet/Directory.py @@ -3,72 +3,41 @@ import RNS import LXMF import time import nomadnet -import threading import RNS.vendor.umsgpack as msgpack -class PNAnnounceHandler: - def __init__(self, owner): - self.aspect_filter = "lxmf.propagation" - self.owner = owner - - def received_announce(self, destination_hash, announced_identity, app_data): - try: - if type(app_data) == bytes: - data = msgpack.unpackb(app_data) - - if data[0] == True: - RNS.log("Received active propagation node announce from "+RNS.prettyhexrep(destination_hash)) - - associated_peer = RNS.Destination.hash_from_name_and_identity("lxmf.delivery", announced_identity) - associated_node = RNS.Destination.hash_from_name_and_identity("nomadnetwork.node", announced_identity) - - self.owner.app.directory.pn_announce_received(destination_hash, app_data, associated_peer, associated_node) - self.owner.app.autoselect_propagation_node() - - except Exception as e: - RNS.log("Error while evaluating propagation node announce, ignoring announce.", RNS.LOG_DEBUG) - RNS.log("The contained exception was: "+str(e), RNS.LOG_DEBUG) - class Directory: - ANNOUNCE_STREAM_MAXLENGTH = 256 + ANNOUNCE_STREAM_MAXLENGTH = 64 aspect_filter = "nomadnetwork.node" @staticmethod def received_announce(destination_hash, announced_identity, app_data): - try: - app = nomadnet.NomadNetworkApp.get_shared_instance() + app = nomadnet.NomadNetworkApp.get_shared_instance() - if not destination_hash in app.ignored_list: - associated_peer = RNS.Destination.hash_from_name_and_identity("lxmf.delivery", announced_identity) + if not destination_hash in app.ignored_list: + destination_hash_text = RNS.hexrep(destination_hash, delimit=False) - app.directory.node_announce_received(destination_hash, app_data, associated_peer) - app.autoselect_propagation_node() - - else: - RNS.log("Ignored announce from "+RNS.prettyhexrep(destination_hash), RNS.LOG_DEBUG) + associated_peer = RNS.Destination.hash_from_name_and_identity("lxmf.delivery", announced_identity) - except Exception as e: - RNS.log("Error while evaluating LXMF destination announce, ignoring announce.", RNS.LOG_DEBUG) - RNS.log("The contained exception was: "+str(e), RNS.LOG_DEBUG) + app.directory.node_announce_received(destination_hash, app_data, associated_peer) + app.autoselect_propagation_node() + + else: + RNS.log("Ignored announce from "+RNS.prettyhexrep(destination_hash), RNS.LOG_DEBUG) def __init__(self, app): self.directory_entries = {} self.announce_stream = [] self.app = app - self.announce_lock = threading.Lock() self.load_from_disk() - self.pn_announce_handler = PNAnnounceHandler(self) - RNS.Transport.register_announce_handler(self.pn_announce_handler) - def save_to_disk(self): try: packed_list = [] for source_hash in self.directory_entries: e = self.directory_entries[source_hash] - packed_list.append((e.source_hash, e.display_name, e.trust_level, e.hosts_node, e.preferred_delivery, e.identify, e.sort_rank)) + packed_list.append((e.source_hash, e.display_name, e.trust_level, e.hosts_node, e.preferred_delivery, e.identify)) directory = { "entry_list": packed_list, @@ -92,10 +61,7 @@ class Directory: entries = {} for e in unpacked_list: - - if e[1] == None: - e[1] = "Undefined" - + if len(e) > 3: hosts_node = e[3] else: @@ -111,109 +77,41 @@ class Directory: else: identify = False - if len(e) > 6: - sort_rank = e[6] - else: - sort_rank = None - - entries[e[0]] = DirectoryEntry(e[0], e[1], e[2], hosts_node, preferred_delivery=preferred_delivery, identify_on_connect=identify, sort_rank=sort_rank) + entries[e[0]] = DirectoryEntry(e[0], e[1], e[2], hosts_node, preferred_delivery=preferred_delivery, identify_on_connect=identify) self.directory_entries = entries self.announce_stream = unpacked_directory["announce_stream"] + except Exception as e: 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): - 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) + if app_data != None: + timestamp = time.time() + self.announce_stream.insert(0, (timestamp, source_hash, app_data, False)) + while len(self.announce_stream) > Directory.ANNOUNCE_STREAM_MAXLENGTH: + self.announce_stream.pop() - 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() + 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) + if app_data != None: + timestamp = time.time() + self.announce_stream.insert(0, (timestamp, source_hash, app_data, True)) + while len(self.announce_stream) > Directory.ANNOUNCE_STREAM_MAXLENGTH: + self.announce_stream.pop() - 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): - 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 - - 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) - - 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") and hasattr(self.app.ui, "main_display"): - self.app.ui.main_display.sub_displays.network_display.directory_change_callback() + 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 remove_announce_with_timestamp(self, timestamp): selected_announce = None @@ -233,14 +131,7 @@ class Directory: def simplest_display_str(self, source_hash): trust_level = self.trust_level(source_hash) if trust_level == DirectoryEntry.WARNING or trust_level == DirectoryEntry.UNTRUSTED: - if source_hash in self.directory_entries: - dn = self.directory_entries[source_hash].display_name - if dn == None: - return RNS.prettyhexrep(source_hash) - else: - return dn+" <"+RNS.hexrep(source_hash, delimit=False)+">" - else: - return "<"+RNS.hexrep(source_hash, delimit=False)+">" + return "<"+RNS.hexrep(source_hash, delimit=False)+">" else: if source_hash in self.directory_entries: dn = self.directory_entries[source_hash].display_name @@ -263,29 +154,16 @@ class Directory: if announced_display_name == None: return self.directory_entries[source_hash].trust_level else: - if not self.directory_entries[source_hash].trust_level == DirectoryEntry.TRUSTED: - for entry in self.directory_entries: - e = self.directory_entries[entry] - if e.display_name == announced_display_name: - if e.source_hash != source_hash: - return DirectoryEntry.WARNING + for entry in self.directory_entries: + e = self.directory_entries[entry] + if e.display_name == announced_display_name: + if e.source_hash != source_hash: + return DirectoryEntry.WARNING return self.directory_entries[source_hash].trust_level else: return DirectoryEntry.UNKNOWN - def pn_trust_level(self, source_hash): - recalled_identity = RNS.Identity.recall(source_hash) - if recalled_identity != None: - associated_node = RNS.Destination.hash_from_name_and_identity("nomadnetwork.node", recalled_identity) - return self.trust_level(associated_node) - - def sort_rank(self, source_hash): - if source_hash in self.directory_entries: - return self.directory_entries[source_hash].sort_rank - else: - return None - def preferred_delivery(self, source_hash): if source_hash in self.directory_entries: return self.directory_entries[source_hash].preferred_delivery @@ -345,7 +223,6 @@ 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 if e.display_name != None else "_")) return node_list def number_of_known_nodes(self): @@ -370,11 +247,15 @@ class DirectoryEntry: DIRECT = 0x01 PROPAGATED = 0x02 - def __init__(self, source_hash, display_name=None, trust_level=UNKNOWN, hosts_node=False, preferred_delivery=None, identify_on_connect=False, sort_rank=None): + def __init__(self, source_hash, display_name=None, trust_level=UNKNOWN, hosts_node=False, preferred_delivery=None, identify_on_connect=False): if len(source_hash) == RNS.Identity.TRUNCATED_HASHLENGTH//8: self.source_hash = source_hash + + # TODO: Clean + # if display_name == None: + # display_name = source_hash + self.display_name = display_name - self.sort_rank = sort_rank if preferred_delivery == None: self.preferred_delivery = DirectoryEntry.DIRECT @@ -385,4 +266,4 @@ class DirectoryEntry: self.hosts_node = hosts_node self.identify = identify_on_connect else: - raise TypeError("Attempt to add invalid source hash to directory") + raise TypeError("Attempt to add invalid source hash to directory") \ No newline at end of file diff --git a/nomadnet/Node.py b/nomadnet/Node.py index 5c2a3e0..018d43b 100644 --- a/nomadnet/Node.py +++ b/nomadnet/Node.py @@ -1,6 +1,4 @@ import os -import sys - import RNS import time import threading @@ -17,11 +15,7 @@ class Node: self.identity = self.app.identity self.destination = RNS.Destination(self.identity, RNS.Destination.IN, RNS.Destination.SINGLE, "nomadnetwork", "node") self.last_announce = time.time() - self.last_file_refresh = time.time() - self.last_page_refresh = time.time() self.announce_interval = self.app.node_announce_interval - self.page_refresh_interval = self.app.page_refresh_interval - self.file_refresh_interval = self.app.file_refresh_interval self.job_interval = Node.JOB_INTERVAL self.should_run_jobs = True self.app_data = None @@ -52,8 +46,6 @@ class Node: def register_pages(self): - # TODO: Deregister previously registered pages - # that no longer exist. self.servedpages = [] self.scan_pages(self.app.pagespath) @@ -73,8 +65,6 @@ class Node: ) def register_files(self): - # TODO: Deregister previously registered files - # that no longer exist. self.servedfiles = [] self.scan_files(self.app.filespath) @@ -107,7 +97,7 @@ class Node: for directory in directories: self.scan_files(base_path+"/"+directory) - def serve_page(self, path, data, request_id, link_id, remote_identity, requested_at): + def serve_page(self, path, data, request_id, remote_identity, requested_at): RNS.log("Page request "+RNS.prettyhexrep(request_id)+" for: "+str(path), RNS.LOG_VERBOSE) try: self.app.peer_settings["served_page_requests"] += 1 @@ -161,21 +151,8 @@ class Node: try: if request_allowed: RNS.log("Serving page: "+file_path, RNS.LOG_VERBOSE) - 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"] - if link_id != None: - env_map["link_id"] = RNS.hexrep(link_id, delimit=False) - if remote_identity != None: - env_map["remote_identity"] = RNS.hexrep(remote_identity.hash, delimit=False) - - if data != None and isinstance(data, dict): - for e in data: - if isinstance(e, str) and (e.startswith("field_") or e.startswith("var_")): - env_map[e] = data[e] - - generated = subprocess.run([file_path], stdout=subprocess.PIPE, env=env_map) + if os.access(file_path, os.X_OK): + generated = subprocess.run([file_path], stdout=subprocess.PIPE) return generated.stdout else: fh = open(file_path, "rb") @@ -232,16 +209,6 @@ class Node: if now > self.last_announce + self.announce_interval*60: self.announce() - - if self.page_refresh_interval > 0: - if now > self.last_page_refresh + self.page_refresh_interval*60: - self.register_pages() - self.last_page_refresh = time.time() - - if self.file_refresh_interval > 0: - if now > self.last_file_refresh + self.file_refresh_interval*60: - self.register_files() - self.last_file_refresh = time.time() time.sleep(self.job_interval) @@ -270,4 +237,4 @@ If you are the node operator, you can define your own home page by creating a fi DEFAULT_NOTALLOWED = '''>Request Not Allowed You are not authorised to carry out the request. -''' +''' \ No newline at end of file diff --git a/nomadnet/NomadNetworkApp.py b/nomadnet/NomadNetworkApp.py index 81dc68f..bc972c0 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 RNS.vendor.configobj import ConfigObj +from .vendor.configobj import ConfigObj class NomadNetworkApp: time_format = "%Y-%m-%d %H:%M:%S" @@ -98,7 +98,6 @@ class NomadNetworkApp: self.ignoredpath = self.configdir+"/ignored" self.logfilepath = self.configdir+"/logfile" self.errorfilepath = self.configdir+"/errors" - self.pnannouncedpath = self.configdir+"/pnannounced" self.storagepath = self.configdir+"/storage" self.identitypath = self.configdir+"/storage/identity" self.cachepath = self.configdir+"/storage/cache" @@ -106,38 +105,24 @@ class NomadNetworkApp: self.conversationpath = self.configdir+"/storage/conversations" self.directorypath = self.configdir+"/storage/directory" self.peersettingspath = self.configdir+"/storage/peersettings" - self.tmpfilespath = self.configdir+"/storage/tmp" self.pagespath = self.configdir+"/storage/pages" self.filespath = self.configdir+"/storage/files" self.cachepath = self.configdir+"/storage/cache" - self.examplespath = self.configdir+"/examples" self.downloads_path = os.path.expanduser("~/Downloads") - self.firstrun = False - self.should_run_jobs = True - self.job_interval = 5 - self.defer_jobs = 90 - self.page_refresh_interval = 0 - self.file_refresh_interval = 0 + self.firstrun = False + self.should_run_jobs = True + self.job_interval = 5 + self.defer_jobs = 90 self.peer_announce_at_start = True self.try_propagation_on_fail = True - self.disable_propagation = False - self.notify_on_new_message = True - - self.lxmf_max_propagation_size = None - self.lxmf_max_incoming_size = None self.periodic_lxmf_sync = True 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) @@ -160,11 +145,6 @@ class NomadNetworkApp: if not os.path.isdir(self.cachepath): os.makedirs(self.cachepath) - if not os.path.isdir(self.tmpfilespath): - os.makedirs(self.tmpfilespath) - else: - self.clear_tmp_dir() - if os.path.isfile(self.configpath): try: self.config = ConfigObj(self.configpath) @@ -180,16 +160,6 @@ class NomadNetworkApp: RNS.log("Check your configuration file for errors!", RNS.LOG_ERROR) nomadnet.panic() else: - if not os.path.isdir(self.examplespath): - try: - import shutil - examplespath = os.path.join(os.path.dirname(__file__), "examples") - shutil.copytree(examplespath, self.examplespath, ignore=shutil.ignore_patterns("__pycache__")) - - except Exception as e: - RNS.log("Could not copy examples into the "+self.examplespath+" directory.", RNS.LOG_ERROR) - RNS.log("The contained exception was: "+str(e), RNS.LOG_ERROR) - RNS.log("Could not load config file, creating default configuration file...") self.createDefaultConfig() self.firstrun = True @@ -286,34 +256,18 @@ class NomadNetworkApp: RNS.log("The contained exception was: "+str(e), RNS.LOG_DEBUG) except Exception as e: - RNS.log("Error while loading list of ignored destinations: "+str(e), RNS.LOG_ERROR) + RNS.log("Error while fetching loading list of ignored destinations: "+str(e), RNS.LOG_ERROR) 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 = LXMF.LXMRouter(identity = self.identity, storagepath = self.storagepath, autopeer = True) self.message_router.register_delivery_callback(self.lxmf_delivery) 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"], stamp_cost=self.required_stamp_cost) - if not self.accept_invalid_stamps: - self.message_router.enforce_stamps() + 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) RNS.Identity.remember( packet_hash=None, @@ -335,37 +289,12 @@ class NomadNetworkApp: except Exception as e: RNS.log("Cannot prioritise "+str(dest_str)+", it is not a valid destination hash", RNS.LOG_ERROR) - if self.disable_propagation: - if os.path.isfile(self.pnannouncedpath): - try: - RNS.log("Sending indication to peered LXMF Propagation Node that this node is no longer participating", RNS.LOG_DEBUG) - self.message_router.disable_propagation() - os.unlink(self.pnannouncedpath) - except Exception as e: - RNS.log("An error ocurred while indicating that this LXMF Propagation Node is no longer participating. The contained exception was: "+str(e), RNS.LOG_ERROR) - else: - self.message_router.enable_propagation() - try: - with open(self.pnannouncedpath, "wb") as pnf: - pnf.write(msgpack.packb(time.time())) - pnf.close() + self.message_router.enable_propagation() - except Exception as e: - RNS.log("An error ocurred while writing Propagation Node announce timestamp. The contained exception was: "+str(e), RNS.LOG_ERROR) - - if not self.disable_propagation: - RNS.log("LXMF Propagation Node started on: "+RNS.prettyhexrep(self.message_router.propagation_destination.hash)) - + RNS.log("LXMF Propagation Node started on: "+RNS.prettyhexrep(self.message_router.propagation_destination.hash)) self.node = nomadnet.Node(self) else: self.node = None - if os.path.isfile(self.pnannouncedpath): - try: - RNS.log("Sending indication to peered LXMF Propagation Node that this node is no longer participating", RNS.LOG_DEBUG) - self.message_router.disable_propagation() - os.unlink(self.pnannouncedpath) - except Exception as e: - RNS.log("An error ocurred while indicating that this LXMF Propagation Node is no longer participating. The contained exception was: "+str(e), RNS.LOG_ERROR) RNS.Transport.register_announce_handler(nomadnet.Conversation) RNS.Transport.register_announce_handler(nomadnet.Directory) @@ -453,24 +382,16 @@ class NomadNetworkApp: return "Receiving messages" elif self.message_router.propagation_transfer_state == LXMF.LXMRouter.PR_RESPONSE_RECEIVED: return "Messages received" - elif self.message_router.propagation_transfer_state == LXMF.LXMRouter.PR_NO_PATH: - return "No path to node" - elif self.message_router.propagation_transfer_state == LXMF.LXMRouter.PR_LINK_FAILED: - return "Link establisment failed" - elif self.message_router.propagation_transfer_state == LXMF.LXMRouter.PR_TRANSFER_FAILED: - return "Sync request failed" - elif self.message_router.propagation_transfer_state == LXMF.LXMRouter.PR_NO_IDENTITY_RCVD: - return "Remote got no identity" - elif self.message_router.propagation_transfer_state == LXMF.LXMRouter.PR_NO_ACCESS: - return "Node rejected request" - elif self.message_router.propagation_transfer_state == LXMF.LXMRouter.PR_FAILED: - return "Sync failed" elif self.message_router.propagation_transfer_state == LXMF.LXMRouter.PR_COMPLETE: new_msgs = self.message_router.propagation_transfer_last_result if new_msgs == 0: return "Done, no new messages" else: return "Downloaded "+str(new_msgs)+" new messages" + elif self.message_router.propagation_transfer_state == LXMF.LXMRouter.PR_NO_IDENTITY_RCVD: + return "Node did not receive identification" + elif self.message_router.propagation_transfer_state == LXMF.LXMRouter.PR_NO_ACCESS: + return "Node did not allow request" else: return "Unknown" @@ -508,17 +429,15 @@ class NomadNetworkApp: self.message_router.cancel_propagation_node_requests() def announce_now(self): - 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.lxmf_destination.announce() self.peer_settings["last_announce"] = time.time() self.save_peer_settings() def autoselect_propagation_node(self): selected_node = None - if "propagation_node" in self.peer_settings and self.peer_settings["propagation_node"] != None: - selected_node = self.peer_settings["propagation_node"] + if "propagation_node" in self.peer_settings and self.directory.find(self.peer_settings["propagation_node"]): + selected_node = self.directory.find(self.peer_settings["propagation_node"]) else: nodes = self.directory.known_nodes() trusted_nodes = [] @@ -531,14 +450,19 @@ class NomadNetworkApp: if hops < best_hops: best_hops = hops - selected_node = node.source_hash + selected_node = node if selected_node == None: - 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) + RNS.log("Could not autoselect a propagation node! LXMF propagation will not be available until a trusted node announces on the network.", RNS.LOG_WARNING) else: - pn_name_str = "" - 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) + node_identity = RNS.Identity.recall(selected_node.source_hash) + if node_identity != None: + propagation_hash = RNS.Destination.hash_from_name_and_identity("lxmf.propagation", node_identity) + RNS.log("Selecting "+selected_node.display_name+" "+RNS.prettyhexrep(propagation_hash)+" as default LXMF propagation node", RNS.LOG_INFO) + self.message_router.set_outbound_propagation_node(propagation_hash) + else: + RNS.log("Could not recall identity for autoselected LXMF propagation node "+RNS.prettyhexrep(selected_node.source_hash), RNS.LOG_WARNING) + RNS.log("LXMF propagation will not be available until a trusted node announces on the network.", RNS.LOG_WARNING) def get_user_selected_propagation_node(self): if "propagation_node" in self.peer_settings: @@ -572,9 +496,6 @@ class NomadNetworkApp: nomadnet.Conversation.ingest(message, self) - if self.notify_on_new_message: - self.notify_message_recieved() - if self.should_print(message): self.print_message(message) @@ -597,26 +518,6 @@ class NomadNetworkApp: return False - def print_file(self, filename): - print_command = self.print_command+" "+filename - - try: - return_code = subprocess.call(shlex.split(print_command), stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL) - - except Exception as e: - RNS.log("An error occurred while executing print command: "+str(print_command), RNS.LOG_ERROR) - RNS.log("The contained exception was: "+str(e), RNS.LOG_ERROR) - return False - - if return_code == 0: - RNS.log("Successfully printed "+str(filename)+" using print command: "+print_command, RNS.LOG_DEBUG) - return True - - else: - RNS.log("Printing "+str(filename)+" failed using print command: "+print_command, RNS.LOG_DEBUG) - return False - - def print_message(self, message, received = None): try: template = self.printing_template_msg @@ -650,7 +551,8 @@ class NomadNetworkApp: f.write(output.encode("utf-8")) f.close() - self.print_file(filename) + print_command = "lp -d thermal -o cpi=16 -o lpi=8 "+filename + return_code = subprocess.call(shlex.split(print_command), stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL) os.unlink(filename) @@ -678,17 +580,6 @@ class NomadNetworkApp: if os.path.isfile(self.conversationpath + "/" + source_hash + "/unread"): os.unlink(self.conversationpath + "/" + source_hash + "/unread") - def notify_message_recieved(self): - if self.uimode == nomadnet.ui.UI_TEXT: - sys.stdout.write("\a") - sys.stdout.flush() - - def clear_tmp_dir(self): - if os.path.isdir(self.tmpfilespath): - for file in os.listdir(self.tmpfilespath): - fpath = self.tmpfilespath+"/"+file - os.unlink(fpath) - def createDefaultConfig(self): self.config = ConfigObj(__default_nomadnet_config__) self.config.filename = self.configpath @@ -756,40 +647,6 @@ class NomadNetworkApp: else: self.lxmf_sync_limit = None - if option == "required_stamp_cost": - value = self.config["client"][option] - 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) - - if value > 0: - self.lxmf_max_incoming_size = value - else: - self.lxmf_max_incoming_size = 500 - - if option == "compact_announce_stream": - value = self.config["client"].as_bool(option) - self.compact_stream = value - - if option == "notify_on_new_message": - value = self.config["client"].as_bool(option) - self.notify_on_new_message = value - if option == "user_interface": value = value.lower() if value == "none": @@ -808,7 +665,7 @@ class NomadNetworkApp: self.config["textui"]["intro_text"] = "Nomad Network" if not "editor" in self.config["textui"]: - self.config["textui"]["editor"] = "nano" + self.config["textui"]["editor"] = "editor" if not "glyphs" in self.config["textui"]: self.config["textui"]["glyphs"] = "unicode" @@ -875,19 +732,6 @@ class NomadNetworkApp: else: self.node_name = self.config["node"]["node_name"] - if not "disable_propagation" in self.config["node"]: - self.disable_propagation = False - else: - self.disable_propagation = self.config["node"].as_bool("disable_propagation") - - if not "max_transfer_size" in self.config["node"]: - self.lxmf_max_propagation_size = 256 - else: - value = self.config["node"].as_float("max_transfer_size") - if value < 1: - value = 1 - self.lxmf_max_propagation_size = value - if not "announce_at_start" in self.config["node"]: self.node_announce_at_start = False else: @@ -901,49 +745,18 @@ class NomadNetworkApp: if value < 1: value = 1 self.node_announce_interval = value - + if "pages_path" in self.config["node"]: self.pagespath = self.config["node"]["pages_path"] - - if not "page_refresh_interval" in self.config["node"]: - self.page_refresh_interval = 0 - else: - value = self.config["node"].as_int("page_refresh_interval") - if value < 0: - value = 0 - self.page_refresh_interval = value - if "files_path" in self.config["node"]: self.filespath = self.config["node"]["files_path"] - - if not "file_refresh_interval" in self.config["node"]: - self.file_refresh_interval = 0 - else: - value = self.config["node"].as_int("file_refresh_interval") - if value < 0: - value = 0 - self.file_refresh_interval = value - if "prioritise_destinations" in self.config["node"]: self.prioritised_lxmf_destinations = self.config["node"].as_list("prioritise_destinations") 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: @@ -1038,7 +851,6 @@ destination = file enable_client = yes user_interface = text downloads_path = ~/Downloads -notify_on_new_message = yes # By default, the peer is announced at startup # to let other peers reach it immediately. @@ -1066,37 +878,6 @@ 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 -# this will be rejected before the transfer -# begins. -max_accepted_size = 500 - -# The announce stream will only show one entry -# per destination or node by default. You can -# change this to show as many announces as have -# been received, for every destination. -compact_announce_stream = yes - [textui] # Amount of time to show intro screen @@ -1136,8 +917,10 @@ glyphs = unicode # application. On by default. mouse_enabled = True -# What editor to use for editing text. -editor = nano +# What editor to use for editing text. By +# default the operating systems "editor" +# alias will be used. +editor = editor # If you don't want the Guide section to # show up in the menu, you can disable it. @@ -1160,16 +943,6 @@ announce_interval = 360 # Whether to announce when the node starts. announce_at_start = Yes -# 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. -# 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, # specified in megabytes. When this limit @@ -1181,18 +954,6 @@ disable_propagation = Yes # and defaults to 2 gigabytes. # message_storage_limit = 2000 -# The maximum accepted transfer size per in- -# coming propagation transfer, in kilobytes. -# This also sets the upper limit for the size -# of single messages accepted onto this node. -# -# If a node wants to propagate a larger number -# of messages to this node, than what can fit -# within this limit, it will prioritise sending -# the smallest, newest messages first, and try -# with any remaining messages at a later point. -max_transfer_size = 256 - # You can tell the LXMF message router to # prioritise storage for one or more # destinations. If the message store reaches @@ -1202,29 +963,6 @@ 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 -# will only be scanned on startup. -# page_refresh_interval = 0 - -# You can specify the interval in minutes for -# rescanning the hosted files path. By default, -# this option is disabled, and the files path -# will only be scanned on startup. -# file_refresh_interval = 0 - [printing] # You can configure Nomad Network to print diff --git a/nomadnet/_version.py b/nomadnet/_version.py index 22049ab..b5fdc75 100644 --- a/nomadnet/_version.py +++ b/nomadnet/_version.py @@ -1 +1 @@ -__version__ = "0.6.2" +__version__ = "0.2.2" diff --git a/nomadnet/examples/messageboard/README.md b/nomadnet/examples/messageboard/README.md deleted file mode 100644 index 16e35e0..0000000 --- a/nomadnet/examples/messageboard/README.md +++ /dev/null @@ -1,18 +0,0 @@ -# lxmf_messageboard -Simple message board that can be hosted on a NomadNet node, messages can be posted by 'conversing' with a unique peer, all messages are then forwarded to the message board. - -## How Do I Use It? -A user can submit messages to the message board by initiating a chat with the message board peer, they are assigned a username (based on the first 5 characters of their address) and their messages are added directly to the message board. The message board can be viewed on a page hosted by a NomadNet node. - -An example message board can be found on the reticulum testnet hosted on the SolarExpress Node `` and the message board peer `` - -## How Does It Work? -The message board page itself is hosted on a NomadNet node, you can place the message_board.mu into the pages directory. You can then run the message_board.py script which provides the peer that the users can send messages to. The two parts are joined together using umsgpack and a flat file system similar to NomadNet and Reticulum and runs in the background. - -## How Do I Set It Up? -* Turn on node hosting in NomadNet -* Put the `message_board.mu` file into `pages` directory in the config file for `NomadNet`. Edit the file to customise from the default page. -* Run the `message_board.py` script (`python3 message_board.py` either in a `screen` or as a system service), this script uses `NomadNet` and `RNS` libraries and has no additional libraries that need to be installed. Take a note of the message boards address, it is printed on starting the board, you can then place this address in `message_board.mu` file to make it easier for users to interact the board. - -## Credits -* This example application was written and contributed by @chengtripp \ No newline at end of file diff --git a/nomadnet/examples/messageboard/messageboard.mu b/nomadnet/examples/messageboard/messageboard.mu deleted file mode 100644 index 24993d0..0000000 --- a/nomadnet/examples/messageboard/messageboard.mu +++ /dev/null @@ -1,41 +0,0 @@ -#!/bin/python3 -import time -import os -import RNS.vendor.umsgpack as msgpack - -message_board_peer = 'please_replace' -userdir = os.path.expanduser("~") - -if os.path.isdir("/etc/nomadmb") and os.path.isfile("/etc/nomadmb/config"): - configdir = "/etc/nomadmb" -elif os.path.isdir(userdir+"/.config/nomadmb") and os.path.isfile(userdir+"/.config/nomadmb/config"): - configdir = userdir+"/.config/nomadmb" -else: - configdir = userdir+"/.nomadmb" - -storagepath = configdir+"/storage" -if not os.path.isdir(storagepath): - os.makedirs(storagepath) - -boardpath = configdir+"/storage/board" - -print('`!`F222`Bddd`cNomadNet Message Board') - -print('-') -print('`a`b`f') -print("") -print("To add a message to the board just converse with the NomadNet Message Board at `[lxmf@{}]".format(message_board_peer)) -time_string = time.strftime("%Y-%m-%d %H:%M:%S", time.localtime(time.time())) -print("Last Updated: {}".format(time_string)) -print("") -print('>Messages') -print(" Date Time Username Message") -f = open(boardpath, "rb") -board_contents = msgpack.unpack(f) -board_contents.reverse() - -for content in board_contents: - print("`a{}".format(content.rstrip())) - print("") - -f.close() diff --git a/nomadnet/examples/messageboard/messageboard.py b/nomadnet/examples/messageboard/messageboard.py deleted file mode 100644 index 8a71cd1..0000000 --- a/nomadnet/examples/messageboard/messageboard.py +++ /dev/null @@ -1,187 +0,0 @@ -# Simple message board that can be hosted on a NomadNet node, messages can be posted by 'conversing' with a unique peer, all messages are then forwarded to the message board. -# https://github.com/chengtripp/lxmf_messageboard - -import RNS -import LXMF -import os, time -from queue import Queue -import RNS.vendor.umsgpack as msgpack - -display_name = "NomadNet Message Board" -max_messages = 20 - -def setup_lxmf(): - if os.path.isfile(identitypath): - identity = RNS.Identity.from_file(identitypath) - RNS.log('Loaded identity from file', RNS.LOG_INFO) - else: - RNS.log('No Primary Identity file found, creating new...', RNS.LOG_INFO) - identity = RNS.Identity() - identity.to_file(identitypath) - - return identity - -def lxmf_delivery(message): - # Do something here with a received message - RNS.log("A message was received: "+str(message.content.decode('utf-8'))) - - message_content = message.content.decode('utf-8') - source_hash_text = RNS.hexrep(message.source_hash, delimit=False) - - #Create username (just first 5 char of your addr) - username = source_hash_text[0:5] - - RNS.log('Username: {}'.format(username), RNS.LOG_INFO) - - time_string = time.strftime("%Y-%m-%d %H:%M:%S", time.localtime(message.timestamp)) - new_message = '{} {}: {}\n'.format(time_string, username, message_content) - - # Push message to board - # First read message board (if it exists - if os.path.isfile(boardpath): - f = open(boardpath, "rb") - message_board = msgpack.unpack(f) - f.close() - else: - message_board = [] - - #Check we aren't doubling up (this can sometimes happen if there is an error initially and it then gets fixed) - if new_message not in message_board: - # Append our new message to the list - message_board.append(new_message) - - # Prune the message board if needed - while len(message_board) > max_messages: - RNS.log('Pruning Message Board') - message_board.pop(0) - - # Now open the board and write the updated list - f = open(boardpath, "wb") - msgpack.pack(message_board, f) - f.close() - - # Send reply - message_reply = '{}_{}_Your message has been added to the messageboard'.format(source_hash_text, time.time()) - q.put(message_reply) - -def announce_now(lxmf_destination): - lxmf_destination.announce() - -def send_message(destination_hash, message_content): - try: - # Make a binary destination hash from a hexadecimal string - destination_hash = bytes.fromhex(destination_hash) - - except Exception as e: - RNS.log("Invalid destination hash", RNS.LOG_ERROR) - return - - # Check that size is correct - if not len(destination_hash) == RNS.Reticulum.TRUNCATED_HASHLENGTH//8: - RNS.log("Invalid destination hash length", RNS.LOG_ERROR) - - else: - # Length of address was correct, let's try to recall the - # corresponding Identity - destination_identity = RNS.Identity.recall(destination_hash) - - if destination_identity == None: - # No path/identity known, we'll have to abort or request one - RNS.log("Could not recall an Identity for the requested address. You have probably never received an announce from it. Try requesting a path from the network first. In fact, let's do this now :)", RNS.LOG_ERROR) - RNS.Transport.request_path(destination_hash) - RNS.log("OK, a path was requested. If the network knows a path, you will receive an announce with the Identity data shortly.", RNS.LOG_INFO) - - else: - # We know the identity for the destination hash, let's - # reconstruct a destination object. - lxmf_destination = RNS.Destination(destination_identity, RNS.Destination.OUT, RNS.Destination.SINGLE, "lxmf", "delivery") - - # Create a new message object - lxm = LXMF.LXMessage(lxmf_destination, local_lxmf_destination, message_content, title="Reply", desired_method=LXMF.LXMessage.DIRECT) - - # You can optionally tell LXMF to try to send the message - # as a propagated message if a direct link fails - lxm.try_propagation_on_fail = True - - # Send it - message_router.handle_outbound(lxm) - -def announce_check(): - if os.path.isfile(announcepath): - f = open(announcepath, "r") - announce = int(f.readline()) - f.close() - else: - RNS.log('failed to open announcepath', RNS.LOG_DEBUG) - announce = 1 - - if announce > int(time.time()): - RNS.log('Recent announcement', RNS.LOG_DEBUG) - else: - f = open(announcepath, "w") - next_announce = int(time.time()) + 1800 - f.write(str(next_announce)) - f.close() - announce_now(local_lxmf_destination) - RNS.log('Announcement sent, expr set 1800 seconds', RNS.LOG_INFO) - -#Setup Paths and Config Files -userdir = os.path.expanduser("~") - -if os.path.isdir("/etc/nomadmb") and os.path.isfile("/etc/nomadmb/config"): - configdir = "/etc/nomadmb" -elif os.path.isdir(userdir+"/.config/nomadmb") and os.path.isfile(userdir+"/.config/nomadmb/config"): - configdir = userdir+"/.config/nomadmb" -else: - configdir = userdir+"/.nomadmb" - -storagepath = configdir+"/storage" -if not os.path.isdir(storagepath): - os.makedirs(storagepath) - -identitypath = configdir+"/storage/identity" -announcepath = configdir+"/storage/announce" -boardpath = configdir+"/storage/board" - -# Message Queue -q = Queue(maxsize = 5) - -# Start Reticulum and print out all the debug messages -reticulum = RNS.Reticulum(loglevel=RNS.LOG_VERBOSE) - -# Create a Identity. -current_identity = setup_lxmf() - -# Init the LXMF router -message_router = LXMF.LXMRouter(identity = current_identity, storagepath = configdir) - -# Register a delivery destination (for yourself) -# In this example we use the same Identity as we used -# to instantiate the LXMF router. It could be a different one, -# but it can also just be the same, depending on what you want. -local_lxmf_destination = message_router.register_delivery_identity(current_identity, display_name=display_name) - -# Set a callback for when a message is received -message_router.register_delivery_callback(lxmf_delivery) - -# Announce node properties - -RNS.log('LXMF Router ready to receive on: {}'.format(RNS.prettyhexrep(local_lxmf_destination.hash)), RNS.LOG_INFO) -announce_check() - -while True: - - # Work through internal message queue - for i in list(q.queue): - message_id = q.get() - split_message = message_id.split('_') - destination_hash = split_message[0] - message = split_message[2] - RNS.log('{} {}'.format(destination_hash, message), RNS.LOG_INFO) - send_message(destination_hash, message) - - # Check whether we need to make another announcement - announce_check() - - #Sleep - time.sleep(10) diff --git a/nomadnet/examples/various/input_fields.py b/nomadnet/examples/various/input_fields.py deleted file mode 100644 index 5d1eccc..0000000 --- a/nomadnet/examples/various/input_fields.py +++ /dev/null @@ -1,62 +0,0 @@ -#!/usr/bin/env python3 -import os -env_string = "" -for e in os.environ: - env_string += "{}={}\n".format(e, os.environ[e]) - -template = """>Fields and Submitting Data - -Nomad Network let's you use simple input fields for submitting data to node-side applications. Submitted data, along with other session variables will be available to the node-side script / program as environment variables. This page contains a few examples. - ->> Read Environment Variables - -{@ENV} ->>Examples of Fields and Submissions - -The following section contains a simple set of fields, and a few different links that submit the field data in different ways. - --= - - ->>>Text Fields -An input field : `B444``b - -An masked field : `B444``b - -An small field : `B444`<8|small`test>`b, and some more text. - -Two fields : `B444`<8|one`One>`b `B444`<8|two`Two>`b - -The data can be `!`[submitted`:/page/input_fields.mu`username|two]`!. - ->> 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`*]`!. - -Submission links can also `!`[include pre-configured variables`:/page/input_fields.mu`username|two|entitiy_id=4611|action=view]`!. - -Or take all fields and `!`[pre-configured variables`:/page/input_fields.mu`*|entitiy_id=4611|action=view]`!. - -Or only `!`[pre-configured variables`:/page/input_fields.mu`entitiy_id=4688|task=something]`! - --= - -""" -print(template.replace("{@ENV}", env_string)) \ No newline at end of file diff --git a/nomadnet/ui/TextUI.py b/nomadnet/ui/TextUI.py index 3e4b3cf..ae3e17d 100644 --- a/nomadnet/ui/TextUI.py +++ b/nomadnet/ui/TextUI.py @@ -45,8 +45,6 @@ THEMES = { ("list_normal", "dark gray", "default", "default", "#bbb", "default"), ("list_untrusted", "dark red", "default", "default", "#a22", "default"), ("list_focus_untrusted", "black", "light gray", "standout", "#810", "#aaa"), - ("list_unresponsive", "yellow", "default", "default", "#b92", "default"), - ("list_focus_unresponsive", "black", "light gray", "standout", "#530", "#aaa"), ("topic_list_normal", "light gray", "default", "default", "#ddd", "default"), ("browser_controls", "light gray", "default", "default", "#bbb", "default"), ("progress_full", "black", "light gray", "standout", "#111", "#bbb"), @@ -80,8 +78,6 @@ THEMES = { ("list_normal", "dark gray", "default", "default", "#444", "default"), ("list_untrusted", "dark red", "default", "default", "#a22", "default"), ("list_focus_untrusted", "black", "dark gray", "standout", "#810", "#aaa"), - ("list_unresponsive", "yellow", "default", "default", "#b92", "default"), - ("list_focus_unresponsive", "black", "light gray", "standout", "#530", "#aaa"), ("topic_list_normal", "dark gray", "default", "default", "#222", "default"), ("browser_controls", "dark gray", "default", "default", "#444", "default"), ("progress_full", "black", "dark gray", "standout", "#111", "#bbb"), @@ -97,10 +93,10 @@ GLYPHSETS = { } if platform.system() == "Darwin": - urm_char = " \uf0e0" + urm_char = " \uf0e0 " ur_char = "\uf0e0 " else: - urm_char = " \uf003" + urm_char = " \uf003 " ur_char = "\uf003 " GLYPHS = { @@ -115,19 +111,17 @@ GLYPHS = { ("arrow_u", "/\\", "\u2191", "\u2191"), ("arrow_d", "\\/", "\u2193", "\u2193"), ("warning", "!", "\u26a0", "\uf12a"), - ("info", "i", "\u2139", "\U000f064e"), + ("info", "i", "\u2139", "\ufb4d"), ("unread", "[!]", "\u2709", ur_char), ("divider1", "-", "\u2504", "\u2504"), ("peer", "[P]", "\u24c5 ", "\uf415"), - ("node", "[N]", "\u24c3 ", "\U000f0002"), + ("node", "[N]", "\u24c3 ", "\uf502"), ("page", "", "\u25a4 ", "\uf719 "), - ("speed", "", "\u25F7 ", "\U000f04c5 "), - ("decoration_menu", " +", " +", " \U000f043b"), + ("speed", "", "\u25F7 ", "\uf9c4"), + ("decoration_menu", " +", " +", " \uf93a"), ("unread_menu", " !", " \u2709", urm_char), ("globe", "", "", "\uf484"), - ("sent", "/\\", "\u2191", "\U000f0cd8"), - ("papermsg", "P", "\u25a4", "\uf719"), - ("qrcode", "QR", "\u25a4", "\uf029"), + ("sent", "/\\", "\u2191", "\ufbf4") } class TextUI: @@ -221,8 +215,6 @@ class TextUI: def unhandled_input(self, key): if key == "ctrl q": raise urwid.ExitMainLoop - elif key == "ctrl e": - pass def display_main(self, loop, user_data): self.loop.widget = self.main_display.widget diff --git a/nomadnet/ui/textui/Browser.py b/nomadnet/ui/textui/Browser.py index 5e412a4..bdecffe 100644 --- a/nomadnet/ui/textui/Browser.py +++ b/nomadnet/ui/textui/Browser.py @@ -1,5 +1,4 @@ import RNS -import LXMF import os import time import urwid @@ -24,37 +23,16 @@ class BrowserFrame(urwid.Frame): self.delegate.url_dialog() elif key == "ctrl s": self.delegate.save_node_dialog() - elif key == "ctrl b": - self.delegate.save_node_dialog() elif key == "ctrl g": nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.sub_displays.network_display.toggle_fullscreen() - elif self.focus_position == "body": - if key == "down" or key == "up": - try: - if hasattr(self.delegate, "page_pile") and self.delegate.page_pile: - def df(loop, user_data): - st = None - nf = self.delegate.page_pile.focus - if hasattr(nf, "key_timeout"): - st = nf - elif hasattr(nf, "original_widget"): - no = nf.original_widget - if hasattr(no, "original_widget"): - st = no.original_widget - else: - if hasattr(no, "key_timeout"): - st = no - - if st and hasattr(st, "key_timeout") and hasattr(st, "keypress") and callable(st.keypress): - st.keypress(None, None) - - nomadnet.NomadNetworkApp.get_shared_instance().ui.loop.set_alarm_in(0.25, df) - - except Exception as e: - RNS.log("Error while setting up cursor timeout. The contained exception was: "+str(e), RNS.LOG_ERROR) - + elif self.get_focus() == "body": return super(BrowserFrame, self).keypress(size, key) - + # if key == "up" and self.delegate.messagelist.top_is_visible: + # nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.set_focus("header") + # elif key == "down" and self.delegate.messagelist.bottom_is_visible: + # self.set_focus("footer") + # else: + # return super(ConversationFrame, self).keypress(size, key) else: return super(BrowserFrame, self).keypress(size, key) @@ -84,7 +62,6 @@ class Browser: self.aspects = aspects self.destination_hash = destination_hash self.path = path - self.request_data = None self.timeout = Browser.DEFAULT_TIMEOUT self.last_keypress = None @@ -103,7 +80,6 @@ class Browser: self.link_target = None self.frame = None self.attr_maps = [] - self.page_pile = None self.build_display() self.history = [] @@ -165,66 +141,7 @@ class Browser: else: return destination_type - def handle_link(self, link_target, link_data = None): - request_data = None - if link_data != None: - link_fields = [] - request_data = {} - all_fields = True if "*" in link_data else False - - for e in link_data: - if "=" in e: - c = e.split("=") - if len(c) == 2: - request_data["var_"+str(c[0])] = str(c[1]) - else: - link_fields.append(e) - - 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) - + def handle_link(self, link_target): components = link_target.split("@") destination_type = None @@ -238,9 +155,8 @@ class Browser: if destination_type == "nomadnetwork.node": if self.status >= Browser.DISCONECTED: RNS.log("Browser handling link to: "+str(link_target), RNS.LOG_DEBUG) - self.browser_footer = urwid.Text("Opening link to: "+str(link_target)) try: - self.retrieve_url(link_target, request_data) + self.retrieve_url(link_target) except Exception as e: self.browser_footer = urwid.Text("Could not open link: "+str(e)) self.frame.contents["footer"] = (self.browser_footer, self.frame.options()) @@ -277,7 +193,7 @@ class Browser: display_name = None if display_name_data != None: - display_name = LXMF.display_name_from_app_data(display_name_data) + display_name = display_name_data.decode("utf-8") if not source_hash_text in [c[0] for c in existing_conversations]: entry = DirectoryEntry(bytes.fromhex(source_hash_text), display_name=display_name) @@ -303,11 +219,7 @@ class Browser: self.browser_header = urwid.Text("") self.browser_footer = urwid.Text("") - self.page_pile = None - self.browser_body = urwid.Filler( - urwid.Text("Disconnected\n"+self.g["arrow_l"]+" "+self.g["arrow_r"], align=urwid.CENTER), - urwid.MIDDLE, - ) + self.browser_body = urwid.Filler(urwid.Text("Disconnected\n"+self.g["arrow_l"]+" "+self.g["arrow_r"], align="center"), "middle") self.frame = BrowserFrame(self.browser_body, header=self.browser_header, footer=self.browser_footer) self.frame.delegate = self @@ -334,29 +246,27 @@ class Browser: self.update_display() columns = urwid.Columns([ - (urwid.WEIGHT, 0.5, urwid.Text(" ")), + ("weight", 0.5, urwid.Text(" ")), (8, urwid.Button("Back", on_press=back_action)), - (urwid.WEIGHT, 0.5, urwid.Text(" ")), + ("weight", 0.5, urwid.Text(" ")) ]) if len(self.attr_maps) > 0: pile = urwid.Pile([ - urwid.Text("!\n\n"+self.status_text()+"\n", align=urwid.CENTER), - columns + urwid.Text("!\n\n"+self.status_text()+"\n", align="center"), + columns ]) else: - pile = urwid.Pile([urwid.Text("!\n\n"+self.status_text(), align=urwid.CENTER)]) + pile = urwid.Pile([ + urwid.Text("!\n\n"+self.status_text(), align="center") + ]) - return urwid.Filler(pile, urwid.MIDDLE) + return urwid.Filler(pile, "middle") def update_display(self): if self.status == Browser.DISCONECTED: self.display_widget.set_attr_map({None: "inactive_text"}) - self.page_pile = None - self.browser_body = urwid.Filler( - urwid.Text("Disconnected\n"+self.g["arrow_l"]+" "+self.g["arrow_r"], align=urwid.CENTER), - urwid.MIDDLE, - ) + self.browser_body = urwid.Filler(urwid.Text("Disconnected\n"+self.g["arrow_l"]+" "+self.g["arrow_r"], align="center"), "middle") self.browser_footer = urwid.Text("") self.browser_header = urwid.Text("") self.linebox.set_title("Remote Node") @@ -383,10 +293,7 @@ class Browser: elif self.status <= Browser.REQUEST_SENT: if len(self.attr_maps) == 0: - self.browser_body = urwid.Filler( - urwid.Text("Retrieving\n["+self.current_url()+"]", align=urwid.CENTER), - urwid.MIDDLE, - ) + self.browser_body = urwid.Filler(urwid.Text("Retrieving\n["+self.current_url()+"]", align="center"), "middle") self.browser_footer = self.make_status_widget() @@ -407,8 +314,6 @@ class Browser: def update_page_display(self): pile = urwid.Pile(self.attr_maps) - pile.automove_cursor_on_scroll = True - self.page_pile = pile self.browser_body = urwid.AttrMap(ScrollBar(Scrollable(pile, force_forward_keypress=True), thumb_char="\u2503", trough_char=" "), "scrollbar") def identify(self): @@ -421,7 +326,6 @@ class Browser: if self.link != None: self.link.teardown() - self.request_data = None self.attr_maps = [] self.status = Browser.DISCONECTED self.response_progress = 0 @@ -436,7 +340,7 @@ class Browser: self.update_display() - def retrieve_url(self, url, request_data = None): + def retrieve_url(self, url): self.previous_destination_hash = self.destination_hash self.previous_path = self.path @@ -489,7 +393,6 @@ class Browser: else: self.set_destination_hash(destination_hash) self.set_path(path) - self.set_request_data(request_data) self.load_page() def set_destination_hash(self, destination_hash): @@ -503,8 +406,6 @@ class Browser: def set_path(self, path): self.path = path - def set_request_data(self, request_data): - self.request_data = request_data def set_timeout(self, timeout): self.timeout = timeout @@ -549,7 +450,7 @@ class Browser: self.status = Browser.PATH_REQUESTED self.update_display() - pr_time = time.time()+RNS.Transport.first_hop_timeout(self.destination_hash) + pr_time = time.time() while not RNS.Transport.has_path(self.destination_hash): now = time.time() if now > pr_time+self.timeout: @@ -640,7 +541,7 @@ class Browser: self.load_page() def close_dialogs(self): - options = self.delegate.columns.options(urwid.WEIGHT, self.delegate.right_area_width) + options = self.delegate.columns.options("weight", self.delegate.right_area_width) self.delegate.columns.contents[1] = (self.display_widget, options) def url_dialog(self): @@ -661,11 +562,7 @@ class Browser: dialog = UrlDialogLineBox( urwid.Pile([ e_url, - urwid.Columns([ - (urwid.WEIGHT, 0.45, urwid.Button("Cancel", on_press=dismiss_dialog)), - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.45, urwid.Button("Go", on_press=confirmed)), - ]) + urwid.Columns([("weight", 0.45, urwid.Button("Cancel", on_press=dismiss_dialog)), ("weight", 0.1, urwid.Text("")), ("weight", 0.45, urwid.Button("Go", on_press=confirmed))]) ]), title="Enter URL" ) e_url.confirmed = confirmed @@ -673,79 +570,49 @@ class Browser: dialog.delegate = self bottom = self.display_widget - overlay = urwid.Overlay( - dialog, - bottom, - align=urwid.CENTER, - width=(urwid.RELATIVE, 65), - valign=urwid.MIDDLE, - height=urwid.PACK, - left=2, - right=2, - ) + overlay = urwid.Overlay(dialog, bottom, align="center", width=("relative", 65), valign="middle", height="pack", left=2, right=2) - options = self.delegate.columns.options(urwid.WEIGHT, self.delegate.right_area_width) + options = self.delegate.columns.options("weight", self.delegate.right_area_width) self.delegate.columns.contents[1] = (overlay, options) self.delegate.columns.focus_position = 1 def save_node_dialog(self): - if self.destination_hash != None: - try: - def dismiss_dialog(sender): - self.close_dialogs() + def dismiss_dialog(sender): + self.close_dialogs() - display_name = RNS.Identity.recall_app_data(self.destination_hash) - disp_str = "" - if display_name != None: - display_name = display_name.decode("utf-8") - disp_str = " \""+display_name+"\"" - - def confirmed(sender): - node_entry = DirectoryEntry(self.destination_hash, display_name=display_name, hosts_node=True) - self.app.directory.remember(node_entry) - self.app.ui.main_display.sub_displays.network_display.directory_change_callback() + display_name = RNS.Identity.recall_app_data(self.destination_hash) + disp_str = "" + if display_name != None: + display_name = display_name.decode("utf-8") + disp_str = " \""+display_name+"\"" + + def confirmed(sender): + node_entry = DirectoryEntry(self.destination_hash, display_name=display_name, hosts_node=True) + self.app.directory.remember(node_entry) + self.app.ui.main_display.sub_displays.network_display.directory_change_callback() - self.close_dialogs() + self.close_dialogs() - dialog = UrlDialogLineBox( - urwid.Pile([ - urwid.Text("Save connected node"+disp_str+" "+RNS.prettyhexrep(self.destination_hash)+" to Known Nodes?\n"), - urwid.Columns([ - (urwid.WEIGHT, 0.45, urwid.Button("Cancel", on_press=dismiss_dialog)), - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.45, urwid.Button("Save", on_press=confirmed)), - ]) - ]), title="Save Node" - ) + dialog = UrlDialogLineBox( + urwid.Pile([ + urwid.Text("Save connected node"+disp_str+" "+RNS.prettyhexrep(self.destination_hash)+" to Known Nodes?\n"), + urwid.Columns([("weight", 0.45, urwid.Button("Cancel", on_press=dismiss_dialog)), ("weight", 0.1, urwid.Text("")), ("weight", 0.45, urwid.Button("Save", on_press=confirmed))]) + ]), title="Save Node" + ) - dialog.confirmed = confirmed - dialog.delegate = self - bottom = self.display_widget + dialog.confirmed = confirmed + dialog.delegate = self + bottom = self.display_widget - overlay = urwid.Overlay( - dialog, - bottom, - align=urwid.CENTER, - width=(urwid.RELATIVE, 50), - valign=urwid.MIDDLE, - height=urwid.PACK, - left=2, - right=2, - ) + overlay = urwid.Overlay(dialog, bottom, align="center", width=("relative", 50), valign="middle", height="pack", left=2, right=2) - options = self.delegate.columns.options(urwid.WEIGHT, self.delegate.right_area_width) - self.delegate.columns.contents[1] = (overlay, options) - self.delegate.columns.focus_position = 1 + options = self.delegate.columns.options("weight", self.delegate.right_area_width) + self.delegate.columns.contents[1] = (overlay, options) + self.delegate.columns.focus_position = 1 - except Exception as e: - pass def load_page(self): - if self.request_data == None: - cached = self.get_cached(self.current_url()) - else: - cached = None - + cached = self.get_cached(self.current_url()) if cached: self.status = Browser.DONE self.page_data = cached @@ -779,15 +646,7 @@ class Browser: page_data = b"The requested local page did not exist in the file system" if os.path.isfile(page_path): if os.access(page_path, os.X_OK): - if self.request_data != None: - env_map = self.request_data - else: - env_map = {} - - if "PATH" in os.environ: - env_map["PATH"] = os.environ["PATH"] - - generated = subprocess.run([page_path], stdout=subprocess.PIPE, env=env_map) + generated = subprocess.run([page_path], stdout=subprocess.PIPE) page_data = generated.stdout else: file = open(page_path, "rb") @@ -818,7 +677,7 @@ class Browser: def __load(self): # If an established link exists, but it doesn't match the target # destination, we close and clear it. - if self.link != None and (self.link.destination.hash != self.destination_hash or self.link.status != RNS.Link.ACTIVE): + if self.link != None and self.link.destination.hash != self.destination_hash: self.link.teardown() self.link = None @@ -832,7 +691,7 @@ class Browser: self.status = Browser.PATH_REQUESTED self.update_display() - pr_time = time.time()+RNS.Transport.first_hop_timeout(self.destination_hash) + pr_time = time.time() while not RNS.Transport.has_path(self.destination_hash): now = time.time() if now > pr_time+self.timeout: @@ -874,7 +733,7 @@ class Browser: self.update_display() receipt = self.link.request( self.path, - data = self.request_data, + data = None, response_callback = self.response_received, failed_callback = self.request_failed, progress_callback = self.response_progressed @@ -1038,10 +897,7 @@ class Browser: 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 - + file_destination = self.app.downloads_path+"/"+file_name counter = 0 while os.path.isfile(file_destination): @@ -1070,11 +926,6 @@ class Browser: self.response_transfer_size = None self.update_display() - if self.link != None: - try: - self.link.teardown() - except Exception as e: - pass else: self.status = Browser.REQUEST_FAILED self.response_progress = 0 @@ -1082,11 +933,6 @@ class Browser: self.response_transfer_size = None self.update_display() - if self.link != None: - try: - self.link.teardown() - except Exception as e: - pass def request_timeout(self, request_receipt=None): @@ -1096,11 +942,6 @@ class Browser: self.response_transfer_size = None self.update_display() - if self.link != None: - try: - self.link.teardown() - except Exception as e: - pass def response_progressed(self, request_receipt): @@ -1194,4 +1035,4 @@ class UrlEdit(urwid.Edit): if key == "enter": self.confirmed(self) else: - return super(UrlEdit, self).keypress(size, key) + return super(UrlEdit, self).keypress(size, key) \ No newline at end of file diff --git a/nomadnet/ui/textui/Config.py b/nomadnet/ui/textui/Config.py index 36d92a5..6b7039f 100644 --- a/nomadnet/ui/textui/Config.py +++ b/nomadnet/ui/textui/Config.py @@ -12,13 +12,13 @@ class ConfigDisplayShortcuts(): class ConfigFiller(urwid.WidgetWrap): def __init__(self, widget, app): self.app = app - self.filler = urwid.Filler(widget, urwid.TOP) - super().__init__(self.filler) + self.filler = urwid.Filler(widget, "top") + urwid.WidgetWrap.__init__(self, self.filler) def keypress(self, size, key): if key == "up": - self.app.ui.main_display.frame.focus_position = "header" + self.app.ui.main_display.frame.set_focus("header") return super(ConfigFiller, self).keypress(size, key) @@ -31,20 +31,12 @@ class ConfigDisplay(): self.editor_term = EditorTerminal(self.app, self) self.widget = urwid.LineBox(self.editor_term) self.app.ui.main_display.update_active_sub_display() - self.app.ui.main_display.frame.focus_position = "body" + self.app.ui.main_display.frame.set_focus("body") self.editor_term.term.change_focus(True) pile = urwid.Pile([ - urwid.Text( - ( - "body_text", - "\nTo change the configuration, edit the config file located at:\n\n" - +self.app.configpath - +"\n\nRestart Nomad Network for changes to take effect\n", - ), - align=urwid.CENTER, - ), - urwid.Padding(urwid.Button("Open Editor", on_press=open_editor), width=15, align=urwid.CENTER), + urwid.Text(("body_text", "\nTo change the configuration, edit the config file located at:\n\n"+self.app.configpath+"\n\nRestart Nomad Network for changes to take effect\n"), align="center"), + urwid.Padding(urwid.Button("Open Editor", on_press=open_editor), width=15, align="center"), ]) self.config_explainer = ConfigFiller(pile, self.app) @@ -79,11 +71,11 @@ class EditorTerminal(urwid.WidgetWrap): urwid.connect_signal(self.term, 'closed', quit_term) - super().__init__(self.term) + urwid.WidgetWrap.__init__(self, self.term) def keypress(self, size, key): # TODO: Decide whether there should be a way to get out while editing #if key == "up": - # nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.focus_position = "header" + # nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.set_focus("header") return super(EditorTerminal, self).keypress(size, key) \ No newline at end of file diff --git a/nomadnet/ui/textui/Conversations.py b/nomadnet/ui/textui/Conversations.py index 9a5405d..12645e5 100644 --- a/nomadnet/ui/textui/Conversations.py +++ b/nomadnet/ui/textui/Conversations.py @@ -14,13 +14,13 @@ class ConversationListDisplayShortcuts(): def __init__(self, app): self.app = app - self.widget = urwid.AttrMap(urwid.Text("[C-e] Peer Info [C-x] Delete [C-r] Sync [C-n] New [C-u] Ingest URI [C-g] Fullscreen"), "shortcutbar") + self.widget = urwid.AttrMap(urwid.Text("[C-e] Peer Info [C-x] Delete [C-r] Sync [C-n] New [C-g] Fullscreen"), "shortcutbar") class ConversationDisplayShortcuts(): def __init__(self, app): self.app = app - self.widget = urwid.AttrMap(urwid.Text("[C-d] Send [C-p] Paper Msg [C-t] Title [C-k] Clear [C-w] Close [C-u] Purge [C-x] Clear History [C-o] Sort"), "shortcutbar") + self.widget = urwid.AttrMap(urwid.Text("[C-d] Send [C-k] Clear [C-w] Close [C-t] Title [C-p] Purge [C-x] Clear History [C-o] Sort"), "shortcutbar") class ConversationsArea(urwid.LineBox): def keypress(self, size, key): @@ -30,16 +30,14 @@ class ConversationsArea(urwid.LineBox): self.delegate.delete_selected_conversation() elif key == "ctrl n": self.delegate.new_conversation() - elif key == "ctrl u": - self.delegate.ingest_lxm_uri() elif key == "ctrl r": self.delegate.sync_conversations() elif key == "ctrl g": self.delegate.toggle_fullscreen() elif key == "tab": - self.delegate.app.ui.main_display.frame.focus_position = "header" + self.delegate.app.ui.main_display.frame.set_focus("header") elif key == "up" and (self.delegate.ilb.first_item_is_selected() or self.delegate.ilb.body_is_empty()): - self.delegate.app.ui.main_display.frame.focus_position = "header" + self.delegate.app.ui.main_display.frame.set_focus("header") else: return super(ConversationsArea, self).keypress(size, key) @@ -69,10 +67,10 @@ class ConversationsDisplay(): self.columns_widget = urwid.Columns( [ - # (urwid.WEIGHT, ConversationsDisplay.list_width, self.listbox), - # (urwid.WEIGHT, 1-ConversationsDisplay.list_width, self.make_conversation_widget(None)) + # ("weight", ConversationsDisplay.list_width, self.listbox), + # ("weight", 1-ConversationsDisplay.list_width, self.make_conversation_widget(None)) (ConversationsDisplay.given_list_width, self.listbox), - (urwid.WEIGHT, 1, self.make_conversation_widget(None)) + ("weight", 1, self.make_conversation_widget(None)) ], dividechars=0, focus_column=0, box_columns=[0] ) @@ -105,15 +103,12 @@ class ConversationsDisplay(): highlight_offFocus="list_off_focus" ) - self.listbox = ConversationsArea(urwid.Filler(self.ilb, height=urwid.RELATIVE_100), title="Conversations") + self.listbox = ConversationsArea(urwid.Filler(self.ilb, height=("relative", 100)), title="Conversations") self.listbox.delegate = self def delete_selected_conversation(self): self.dialog_open = True - item = self.ilb.get_selected_item() - if item == None: - return - source_hash = item.source_hash + source_hash = self.ilb.get_selected_item().source_hash def dismiss_dialog(sender): self.update_conversation_list() @@ -127,42 +122,23 @@ class ConversationsDisplay(): dialog = DialogLineBox( urwid.Pile([ - urwid.Text( - "Delete conversation with\n"+self.app.directory.simplest_display_str(bytes.fromhex(source_hash))+"\n", - align=urwid.CENTER, - ), - urwid.Columns([ - (urwid.WEIGHT, 0.45, urwid.Button("Yes", on_press=confirmed)), - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.45, urwid.Button("No", on_press=dismiss_dialog)), - ]) + urwid.Text("Delete conversation with\n"+self.app.directory.simplest_display_str(bytes.fromhex(source_hash))+"\n", align="center"), + urwid.Columns([("weight", 0.45, urwid.Button("Yes", on_press=confirmed)), ("weight", 0.1, urwid.Text("")), ("weight", 0.45, urwid.Button("No", on_press=dismiss_dialog))]) ]), title="?" ) dialog.delegate = self bottom = self.listbox - overlay = urwid.Overlay( - dialog, - bottom, - align=urwid.CENTER, - width=urwid.RELATIVE_100, - valign=urwid.MIDDLE, - height=urwid.PACK, - left=2, - right=2, - ) + overlay = urwid.Overlay(dialog, bottom, align="center", width=("relative", 100), valign="middle", height="pack", left=2, right=2) - # options = self.columns_widget.options(urwid.WEIGHT, ConversationsDisplay.list_width) - options = self.columns_widget.options(urwid.GIVEN, ConversationsDisplay.given_list_width) + # options = self.columns_widget.options("weight", ConversationsDisplay.list_width) + options = self.columns_widget.options("given", ConversationsDisplay.given_list_width) self.columns_widget.contents[0] = (overlay, options) def edit_selected_in_directory(self): g = self.app.ui.glyphs self.dialog_open = True - item = self.ilb.get_selected_item() - if item == None: - return - source_hash_text = item.source_hash + source_hash_text = self.ilb.get_selected_item().source_hash display_name = self.ilb.get_selected_item().display_name if display_name == None: display_name = "" @@ -239,12 +215,9 @@ class ConversationsDisplay(): RNS.log("Could not save directory entry. The contained exception was: "+str(e), RNS.LOG_VERBOSE) if not dialog_pile.error_display: dialog_pile.error_display = True - options = dialog_pile.options(height_type=urwid.PACK) + options = dialog_pile.options(height_type="pack") dialog_pile.contents.append((urwid.Text(""), options)) - dialog_pile.contents.append(( - urwid.Text(("error_text", "Could not save entry. Check your input."), align=urwid.CENTER), - options,) - ) + dialog_pile.contents.append((urwid.Text(("error_text", "Could not save entry. Check your input."), align="center"), options)) source_is_known = self.app.directory.is_known(bytes.fromhex(source_hash_text)) if source_is_known: @@ -253,23 +226,13 @@ class ConversationsDisplay(): def query_action(sender, user_data): self.close_conversation_by_hash(user_data) nomadnet.Conversation.query_for_peer(user_data) - options = dialog_pile.options(height_type=urwid.PACK) + options = dialog_pile.options(height_type="pack") dialog_pile.contents = [ (urwid.Text("Query sent"), options), (urwid.Button("OK", on_press=dismiss_dialog), options) ] query_button = urwid.Button("Query network for keys", on_press=query_action, user_data=source_hash_text) - known_section = urwid.Pile([ - urwid.Divider(g["divider1"]), - urwid.Text(g["info"]+"\n", align=urwid.CENTER), - urwid.Text( - "The identity of this peer is not known, and you cannot currently send messages to it. " - "You can query the network to obtain the identity.\n", - align=urwid.CENTER, - ), - query_button, - urwid.Divider(g["divider1"]), - ]) + known_section = urwid.Pile([urwid.Divider(g["divider1"]), urwid.Text(g["info"]+"\n", align="center"), urwid.Text("The identity of this peer is not known, and you cannot currently send messages to it. You can query the network to obtain the identity.\n", align="center"), query_button, urwid.Divider(g["divider1"])]) dialog_pile = urwid.Pile([ selected_id_widget, @@ -282,11 +245,7 @@ class ConversationsDisplay(): r_direct, r_propagated, known_section, - urwid.Columns([ - (urwid.WEIGHT, 0.45, urwid.Button("Save", on_press=confirmed)), - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.45, urwid.Button("Back", on_press=dismiss_dialog)), - ]) + urwid.Columns([("weight", 0.45, urwid.Button("Save", on_press=confirmed)), ("weight", 0.1, urwid.Text("")), ("weight", 0.45, urwid.Button("Back", on_press=dismiss_dialog))]) ]) dialog_pile.error_display = False @@ -294,19 +253,10 @@ class ConversationsDisplay(): dialog.delegate = self bottom = self.listbox - overlay = urwid.Overlay( - dialog, - bottom, - align=urwid.CENTER, - width=urwid.RELATIVE_100, - valign=urwid.MIDDLE, - height=urwid.PACK, - left=2, - right=2, - ) + overlay = urwid.Overlay(dialog, bottom, align="center", width=("relative", 100), valign="middle", height="pack", left=2, right=2) - # options = self.columns_widget.options(urwid.WEIGHT, ConversationsDisplay.list_width) - options = self.columns_widget.options(urwid.GIVEN, ConversationsDisplay.given_list_width) + # options = self.columns_widget.options("weight", ConversationsDisplay.list_width) + options = self.columns_widget.options("given", ConversationsDisplay.given_list_width) self.columns_widget.contents[0] = (overlay, options) def new_conversation(self): @@ -354,15 +304,9 @@ class ConversationsDisplay(): RNS.log("Could not start conversation. The contained exception was: "+str(e), RNS.LOG_VERBOSE) if not dialog_pile.error_display: dialog_pile.error_display = True - options = dialog_pile.options(height_type=urwid.PACK) + options = dialog_pile.options(height_type="pack") dialog_pile.contents.append((urwid.Text(""), options)) - dialog_pile.contents.append(( - urwid.Text( - ("error_text", "Could not start conversation. Check your input."), - align=urwid.CENTER, - ), - options, - )) + dialog_pile.contents.append((urwid.Text(("error_text", "Could not start conversation. Check your input."), align="center"), options)) dialog_pile = urwid.Pile([ e_id, @@ -372,11 +316,7 @@ class ConversationsDisplay(): r_unknown, r_trusted, urwid.Text(""), - urwid.Columns([ - (urwid.WEIGHT, 0.45, urwid.Button("Create", on_press=confirmed)), - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.45, urwid.Button("Back", on_press=dismiss_dialog)), - ]) + urwid.Columns([("weight", 0.45, urwid.Button("Create", on_press=confirmed)), ("weight", 0.1, urwid.Text("")), ("weight", 0.45, urwid.Button("Back", on_press=dismiss_dialog))]) ]) dialog_pile.error_display = False @@ -384,172 +324,10 @@ class ConversationsDisplay(): dialog.delegate = self bottom = self.listbox - overlay = urwid.Overlay( - dialog, - bottom, - align=urwid.CENTER, - width=urwid.RELATIVE_100, - valign=urwid.MIDDLE, - height=urwid.PACK, - left=2, - right=2, - ) + overlay = urwid.Overlay(dialog, bottom, align="center", width=("relative", 100), valign="middle", height="pack", left=2, right=2) - # options = self.columns_widget.options(urwid.WEIGHT, ConversationsDisplay.list_width) - options = self.columns_widget.options(urwid.GIVEN, ConversationsDisplay.given_list_width) - self.columns_widget.contents[0] = (overlay, options) - - def ingest_lxm_uri(self): - self.dialog_open = True - lxm_uri = "" - e_uri = urwid.Edit(caption="URI : ",edit_text=lxm_uri) - - def dismiss_dialog(sender): - self.update_conversation_list() - self.dialog_open = False - - def confirmed(sender): - try: - local_delivery_signal = "local_delivery_occurred" - duplicate_signal = "duplicate_lxm" - lxm_uri = e_uri.get_edit_text() - - ingest_result = self.app.message_router.ingest_lxm_uri( - lxm_uri, - signal_local_delivery=local_delivery_signal, - signal_duplicate=duplicate_signal - ) - - if ingest_result == False: - raise ValueError("The URI contained no decodable messages") - - elif ingest_result == local_delivery_signal: - rdialog_pile = urwid.Pile([ - urwid.Text("Message was decoded, decrypted successfully, and added to your conversation list."), - urwid.Text(""), - urwid.Columns([ - (urwid.WEIGHT, 0.6, urwid.Text("")), - (urwid.WEIGHT, 0.4, urwid.Button("OK", on_press=dismiss_dialog)), - ]) - ]) - rdialog_pile.error_display = False - - rdialog = DialogLineBox(rdialog_pile, title="Ingest message URI") - rdialog.delegate = self - bottom = self.listbox - - roverlay = urwid.Overlay( - rdialog, - bottom, - align=urwid.CENTER, - width=urwid.RELATIVE_100, - valign=urwid.MIDDLE, - height=urwid.PACK, - left=2, - right=2, - ) - - options = self.columns_widget.options(urwid.GIVEN, ConversationsDisplay.given_list_width) - self.columns_widget.contents[0] = (roverlay, options) - - elif ingest_result == duplicate_signal: - rdialog_pile = urwid.Pile([ - urwid.Text("The decoded message has already been processed by the LXMF Router, and will not be ingested again."), - urwid.Text(""), - urwid.Columns([ - (urwid.WEIGHT, 0.6, urwid.Text("")), - (urwid.WEIGHT, 0.4, urwid.Button("OK", on_press=dismiss_dialog)), - ]) - ]) - rdialog_pile.error_display = False - - rdialog = DialogLineBox(rdialog_pile, title="Ingest message URI") - rdialog.delegate = self - bottom = self.listbox - - roverlay = urwid.Overlay( - rdialog, - bottom, - align=urwid.CENTER, - width=urwid.RELATIVE_100, - valign=urwid.MIDDLE, - height=urwid.PACK, - left=2, - right=2, - ) - - options = self.columns_widget.options(urwid.GIVEN, ConversationsDisplay.given_list_width) - self.columns_widget.contents[0] = (roverlay, options) - - else: - if self.app.enable_node: - propagation_text = "The decoded message was not addressed to this LXMF address, but has been added to the propagation node queues, and will be distributed on the propagation network." - else: - propagation_text = "The decoded message was not addressed to this LXMF address, and has been discarded." - - rdialog_pile = urwid.Pile([ - urwid.Text(propagation_text), - urwid.Text(""), - urwid.Columns([ - (urwid.WEIGHT, 0.6, urwid.Text("")), - (urwid.WEIGHT, 0.4, urwid.Button("OK", on_press=dismiss_dialog)), - ]) - ]) - rdialog_pile.error_display = False - - rdialog = DialogLineBox(rdialog_pile, title="Ingest message URI") - rdialog.delegate = self - bottom = self.listbox - - roverlay = urwid.Overlay( - rdialog, - bottom, - align=urwid.CENTER, - width=urwid.RELATIVE_100, - valign=urwid.MIDDLE, - height=urwid.PACK, - left=2, - right=2, - ) - - options = self.columns_widget.options(urwid.GIVEN, ConversationsDisplay.given_list_width) - self.columns_widget.contents[0] = (roverlay, options) - - except Exception as e: - RNS.log("Could not ingest LXM URI. The contained exception was: "+str(e), RNS.LOG_VERBOSE) - if not dialog_pile.error_display: - dialog_pile.error_display = True - options = dialog_pile.options(height_type=urwid.PACK) - dialog_pile.contents.append((urwid.Text(""), options)) - dialog_pile.contents.append((urwid.Text(("error_text", "Could ingest LXM from URI data. Check your input."), align=urwid.CENTER), options)) - - dialog_pile = urwid.Pile([ - e_uri, - urwid.Text(""), - urwid.Columns([ - (urwid.WEIGHT, 0.45, urwid.Button("Ingest", on_press=confirmed)), - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.45, urwid.Button("Back", on_press=dismiss_dialog)), - ]) - ]) - dialog_pile.error_display = False - - dialog = DialogLineBox(dialog_pile, title="Ingest message URI") - dialog.delegate = self - bottom = self.listbox - - overlay = urwid.Overlay( - dialog, - bottom, - align=urwid.CENTER, - width=urwid.RELATIVE_100, - valign=urwid.MIDDLE, - height=urwid.PACK, - left=2, - right=2, - ) - - options = self.columns_widget.options(urwid.GIVEN, ConversationsDisplay.given_list_width) + # options = self.columns_widget.options("weight", ConversationsDisplay.list_width) + options = self.columns_widget.options("given", ConversationsDisplay.given_list_width) self.columns_widget.contents[0] = (overlay, options) def delete_conversation(self, source_hash): @@ -581,7 +359,7 @@ class ConversationsDisplay(): r_mall = urwid.RadioButton(max_messages_group, "Download all", state=True) r_mlim = urwid.RadioButton(max_messages_group, "Limit to", state=False) ie_lim = urwid.IntEdit("", 5) - rbs = urwid.GridFlow([r_mlim, ie_lim], 12, 1, 0, align=urwid.LEFT) + rbs = urwid.GridFlow([r_mlim, ie_lim], 12, 1, 0, align="left") def sync_now(sender): limit = None @@ -605,11 +383,7 @@ class ConversationsDisplay(): else: sync_button = hidden_sync_button - button_columns = urwid.Columns([ - (urwid.WEIGHT, 0.45, sync_button), - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.45, cancel_button), - ]) + button_columns = urwid.Columns([("weight", 0.45, sync_button), ("weight", 0.1, urwid.Text("")), ("weight", 0.45, cancel_button)]) real_sync_button.bc = button_columns pn_ident = None @@ -624,15 +398,10 @@ class ConversationsDisplay(): if pn_ident != None: node_hash = RNS.Destination.hash_from_name_and_identity("nomadnetwork.node", pn_ident) pn_entry = self.app.directory.find(node_hash) - pn_display_str = " " - if pn_entry != None: - pn_display_str += " "+str(pn_entry.display_name) - else: - pn_display_str += " "+RNS.prettyhexrep(pn_hash) dialog = DialogLineBox( urwid.Pile([ - urwid.Text(""+g["node"]+pn_display_str, align=urwid.CENTER), + urwid.Text(""+g["node"]+" "+str(pn_entry.display_name), align="center"), urwid.Divider(g["divider1"]), sync_progress, urwid.Divider(g["divider1"]), @@ -643,23 +412,12 @@ class ConversationsDisplay(): ]), title="Message Sync" ) else: - button_columns = urwid.Columns([ - (urwid.WEIGHT, 0.45, urwid.Text("" )), - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.45, cancel_button), - ]) + button_columns = urwid.Columns([("weight", 0.45, urwid.Text("" )), ("weight", 0.1, urwid.Text("")), ("weight", 0.45, cancel_button)]) dialog = DialogLineBox( urwid.Pile([ urwid.Text(""), - urwid.Text("No trusted nodes found, cannot sync!\n", align=urwid.CENTER), - urwid.Text( - "To synchronise messages from the network, " - "one or more nodes must be marked as trusted in the Known Nodes list, " - "or a node must manually be selected as the default propagation node. " - "Nomad Network will then automatically sync from the nearest trusted node, " - "or the manually selected one.", - align=urwid.LEFT, - ), + urwid.Text("No trusted nodes found, cannot sync!\n", align="center"), + urwid.Text("To syncronise messages from the network, one or more nodes must be marked as trusted in the Known Nodes list. Nomad Network will then automatically sync from the nearest trusted node.", align="left"), urwid.Text(""), button_columns ]), title="Message Sync" @@ -675,19 +433,10 @@ class ConversationsDisplay(): self.sync_dialog = dialog bottom = self.listbox - overlay = urwid.Overlay( - dialog, - bottom, - align=urwid.CENTER, - width=urwid.RELATIVE_100, - valign=urwid.MIDDLE, - height=urwid.PACK, - left=2, - right=2, - ) + overlay = urwid.Overlay(dialog, bottom, align="center", width=("relative", 100), valign="middle", height="pack", left=2, right=2) - # options = self.columns_widget.options(urwid.WEIGHT, ConversationsDisplay.list_width) - options = self.columns_widget.options(urwid.GIVEN, ConversationsDisplay.given_list_width) + # options = self.columns_widget.options("weight", ConversationsDisplay.list_width) + options = self.columns_widget.options("given", ConversationsDisplay.given_list_width) self.columns_widget.contents[0] = (overlay, options) def update_sync_dialog(self, loop = None, sender = None): @@ -695,9 +444,9 @@ class ConversationsDisplay(): self.sync_dialog.sync_progress.set_completion(self.app.get_sync_progress()) if self.app.get_sync_status() == "Idle" or self.app.message_router.propagation_transfer_state >= LXMF.LXMRouter.PR_COMPLETE: - self.sync_dialog.bc.contents[0] = (self.sync_dialog.real_sync_button, self.sync_dialog.bc.options(urwid.WEIGHT, 0.45)) + self.sync_dialog.bc.contents[0] = (self.sync_dialog.real_sync_button, self.sync_dialog.bc.options("weight", 0.45)) else: - self.sync_dialog.bc.contents[0] = (self.sync_dialog.hidden_sync_button, self.sync_dialog.bc.options(urwid.WEIGHT, 0.45)) + self.sync_dialog.bc.contents[0] = (self.sync_dialog.hidden_sync_button, self.sync_dialog.bc.options("weight", 0.45)) self.app.ui.loop.set_alarm_in(0.2, self.update_sync_dialog) @@ -708,22 +457,13 @@ class ConversationsDisplay(): def update_conversation_list(self): ilb_position = self.ilb.get_selected_position() self.update_listbox() - # options = self.columns_widget.options(urwid.WEIGHT, ConversationsDisplay.list_width) - options = self.columns_widget.options(urwid.GIVEN, ConversationsDisplay.given_list_width) + # options = self.columns_widget.options("weight", ConversationsDisplay.list_width) + options = self.columns_widget.options("given", ConversationsDisplay.given_list_width) if not (self.dialog_open and self.sync_dialog != None): self.columns_widget.contents[0] = (self.listbox, options) else: bottom = self.listbox - overlay = urwid.Overlay( - self.sync_dialog, - bottom, - align=urwid.CENTER, - width=urwid.RELATIVE_100, - valign=urwid.MIDDLE, - height=urwid.PACK, - left=2, - right=2, - ) + overlay = urwid.Overlay(self.sync_dialog, bottom, align="center", width=("relative", 100), valign="middle", height="pack", left=2, right=2) self.columns_widget.contents[0] = (overlay, options) if ilb_position != None: @@ -749,17 +489,17 @@ class ConversationsDisplay(): self.app.mark_conversation_read(self.currently_displayed_conversation) self.currently_displayed_conversation = source_hash - # options = self.widget.options(urwid.WEIGHT, 1-ConversationsDisplay.list_width) - options = self.widget.options(urwid.WEIGHT, 1) + # options = self.widget.options("weight", 1-ConversationsDisplay.list_width) + options = self.widget.options("weight", 1) self.widget.contents[1] = (self.make_conversation_widget(source_hash), options) if source_hash == None: - self.widget.focus_position = 0 + self.widget.set_focus_column(0) else: if self.app.conversation_is_unread(source_hash): self.app.mark_conversation_read(source_hash) self.update_conversation_list() - self.widget.focus_position = 1 + self.widget.set_focus_column(1) conversation_position = None index = 0 for widget in self.list_widgets: @@ -891,17 +631,15 @@ class MessageEdit(urwid.Edit): def keypress(self, size, key): if key == "ctrl d": self.delegate.send_message() - elif key == "ctrl p": - self.delegate.paper_message() elif key == "ctrl k": self.delegate.clear_editor() elif key == "up": y = self.get_cursor_coords(size)[1] if y == 0: if self.delegate.full_editor_active and self.name == "title_editor": - self.delegate.frame.focus_position = "body" + self.delegate.frame.set_focus("body") elif not self.delegate.full_editor_active and self.name == "content_editor": - self.delegate.frame.focus_position = "body" + self.delegate.frame.set_focus("body") else: return super(MessageEdit, self).keypress(size, key) else: @@ -912,11 +650,11 @@ class MessageEdit(urwid.Edit): class ConversationFrame(urwid.Frame): def keypress(self, size, key): - if self.focus_position == "body": + if self.get_focus() == "body": if key == "up" and self.delegate.messagelist.top_is_visible: - nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.focus_position = "header" + nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.set_focus("header") elif key == "down" and self.delegate.messagelist.bottom_is_visible: - self.focus_position = "footer" + self.set_focus("footer") else: return super(ConversationFrame, self).keypress(size, key) elif key == "ctrl k": @@ -931,7 +669,7 @@ class ConversationWidget(urwid.WidgetWrap): if source_hash == None: self.frame = None display_widget = urwid.LineBox(urwid.Filler(urwid.Text("\n No conversation selected"), "top")) - super().__init__(display_widget) + urwid.WidgetWrap.__init__(self, display_widget) else: if source_hash in ConversationsDisplay.cached_conversation_widgets: return ConversationsDisplay.cached_conversation_widgets[source_hash] @@ -958,11 +696,7 @@ class ConversationWidget(urwid.WidgetWrap): header = None if self.conversation.trust_level == DirectoryEntry.UNTRUSTED: - header = urwid.AttrMap( - urwid.Padding( - urwid.Text(g["warning"]+" Warning: Conversation with untrusted peer "+g["warning"], align=urwid.CENTER)), - "msg_warning_untrusted", - ) + header = urwid.AttrMap(urwid.Padding(urwid.Text(g["warning"]+" Warning: Conversation with untrusted peer "+g["warning"], align="center")), "msg_warning_untrusted") self.minimal_editor = urwid.AttrMap(msg_editor, "msg_editor") self.minimal_editor.name = "minimal_editor" @@ -999,7 +733,7 @@ class ConversationWidget(urwid.WidgetWrap): self.frame ) - super().__init__(self.display_widget) + urwid.WidgetWrap.__init__(self, self.display_widget) def clear_history_dialog(self): def dismiss_dialog(sender): @@ -1014,30 +748,17 @@ class ConversationWidget(urwid.WidgetWrap): dialog = DialogLineBox( urwid.Pile([ - urwid.Text("Clear conversation history\n", align=urwid.CENTER), - urwid.Columns([ - (urwid.WEIGHT, 0.45, urwid.Button("Yes", on_press=confirmed)), - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.45, urwid.Button("No", on_press=dismiss_dialog)), - ]) + urwid.Text("Clear conversation history\n", align="center"), + urwid.Columns([("weight", 0.45, urwid.Button("Yes", on_press=confirmed)), ("weight", 0.1, urwid.Text("")), ("weight", 0.45, urwid.Button("No", on_press=dismiss_dialog))]) ]), title="?" ) dialog.delegate = self bottom = self.messagelist - overlay = urwid.Overlay( - dialog, - bottom, - align=urwid.CENTER, - width=34, - valign=urwid.MIDDLE, - height=urwid.PACK, - left=2, - right=2, - ) + overlay = urwid.Overlay(dialog, bottom, align="center", width=34, valign="middle", height="pack", left=2, right=2) self.frame.contents["body"] = (overlay, self.frame.options()) - self.frame.focus_position = "body" + self.frame.set_focus("body") def toggle_editor(self): if self.full_editor_active: @@ -1054,17 +775,7 @@ class ConversationWidget(urwid.WidgetWrap): if allowed: self.frame.contents["footer"] = (self.minimal_editor, None) else: - warning = urwid.AttrMap( - urwid.Padding(urwid.Text( - "\n"+g["info"]+"\n\nYou cannot currently message this peer, since its identity keys are not known. " - "The keys have been requested from the network and should arrive shortly, if available. " - "Close this conversation and reopen it to try again.\n\n" - "To query the network manually, select this conversation in the conversation list, " - "press Ctrl-E, and use the query button.\n", - align=urwid.CENTER, - )), - "msg_header_caution", - ) + warning = urwid.AttrMap(urwid.Padding(urwid.Text("\n"+g["info"]+"\n\nYou cannot currently message this peer, since it's identity keys are not known.\n\nWait for an announce to arrive from the peer, or query the network for it.\n\nTo query the network, select this conversation in the conversation list, press Ctrl-E, and use the query button.\n", align="center")), "msg_header_caution") self.frame.contents["footer"] = (warning, None) def toggle_focus_area(self): @@ -1075,16 +786,16 @@ class ConversationWidget(urwid.WidgetWrap): pass if name == "messagelist": - self.frame.focus_position = "footer" + self.frame.set_focus("footer") elif name == "minimal_editor" or name == "full_editor": - self.frame.focus_position = "body" + self.frame.set_focus("body") def keypress(self, size, key): if key == "tab": self.toggle_focus_area() elif key == "ctrl w": self.close() - elif key == "ctrl u": + elif key == "ctrl p": self.conversation.purge_failed() self.conversation_changed(None) elif key == "ctrl t": @@ -1144,127 +855,6 @@ class ConversationWidget(urwid.WidgetWrap): else: pass - def paper_message_saved(self, path): - g = self.app.ui.glyphs - def dismiss_dialog(sender): - self.dialog_open = False - self.conversation_changed(None) - - dialog = DialogLineBox( - urwid.Pile([ - urwid.Text("The paper message was saved to:\n\n"+str(path)+"\n", align=urwid.CENTER), - urwid.Columns([ - (urwid.WEIGHT, 0.6, urwid.Text("")), - (urwid.WEIGHT, 0.4, urwid.Button("OK", on_press=dismiss_dialog)), - ]) - ]), title=g["papermsg"].replace(" ", "") - ) - dialog.delegate = self - bottom = self.messagelist - - overlay = urwid.Overlay(dialog, bottom, align=urwid.CENTER, width=60, valign=urwid.MIDDLE, height=urwid.PACK, left=2, right=2) - - self.frame.contents["body"] = (overlay, self.frame.options()) - self.frame.focus_position = "body" - - def print_paper_message_qr(self): - content = self.content_editor.get_edit_text() - title = self.title_editor.get_edit_text() - if not content == "": - if self.conversation.paper_output(content, title): - self.clear_editor() - else: - self.paper_message_failed() - - def save_paper_message_qr(self): - content = self.content_editor.get_edit_text() - title = self.title_editor.get_edit_text() - if not content == "": - output_result = self.conversation.paper_output(content, title, mode="save_qr") - if output_result != False: - self.clear_editor() - self.paper_message_saved(output_result) - else: - self.paper_message_failed() - - def save_paper_message_uri(self): - content = self.content_editor.get_edit_text() - title = self.title_editor.get_edit_text() - if not content == "": - output_result = self.conversation.paper_output(content, title, mode="save_uri") - if output_result != False: - self.clear_editor() - self.paper_message_saved(output_result) - else: - self.paper_message_failed() - - def paper_message(self): - def dismiss_dialog(sender): - self.dialog_open = False - self.conversation_changed(None) - - def print_qr(sender): - dismiss_dialog(self) - self.print_paper_message_qr() - - def save_qr(sender): - dismiss_dialog(self) - self.save_paper_message_qr() - - def save_uri(sender): - dismiss_dialog(self) - self.save_paper_message_uri() - - dialog = DialogLineBox( - urwid.Pile([ - urwid.Text( - "Select the desired paper message output method.\nSaved files will be written to:\n\n"+str(self.app.downloads_path)+"\n", - align=urwid.CENTER, - ), - urwid.Columns([ - (urwid.WEIGHT, 0.5, urwid.Button("Print QR", on_press=print_qr)), - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.5, urwid.Button("Save QR", on_press=save_qr)), - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.5, urwid.Button("Save URI", on_press=save_uri)), - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.5, urwid.Button("Cancel", on_press=dismiss_dialog)) - ]) - ]), title="Create Paper Message" - ) - dialog.delegate = self - bottom = self.messagelist - - overlay = urwid.Overlay(dialog, bottom, align=urwid.CENTER, width=60, valign=urwid.MIDDLE, height=urwid.PACK, left=2, right=2) - - self.frame.contents["body"] = (overlay, self.frame.options()) - self.frame.focus_position = "body" - - def paper_message_failed(self): - def dismiss_dialog(sender): - self.dialog_open = False - self.conversation_changed(None) - - dialog = DialogLineBox( - urwid.Pile([ - urwid.Text( - "Could not output paper message,\ncheck your settings. See the log\nfile for any error messages.\n", - align=urwid.CENTER, - ), - urwid.Columns([ - (urwid.WEIGHT, 0.6, urwid.Text("")), - (urwid.WEIGHT, 0.4, urwid.Button("OK", on_press=dismiss_dialog)), - ]) - ]), title="!" - ) - dialog.delegate = self - bottom = self.messagelist - - overlay = urwid.Overlay(dialog, bottom, align=urwid.CENTER, width=34, valign=urwid.MIDDLE, height=urwid.PACK, left=2, right=2) - - self.frame.contents["body"] = (overlay, self.frame.options()) - self.frame.focus_position = "body" - def close(self): self.delegate.close_conversation(self) @@ -1295,9 +885,6 @@ class LXMessageWidget(urwid.WidgetWrap): elif message.lxm.method == LXMF.LXMessage.PROPAGATED and message.lxm.state == LXMF.LXMessage.SENT: header_style = "msg_header_propagated" title_string = g["sent"]+" "+title_string - elif message.lxm.method == LXMF.LXMessage.PAPER and message.lxm.state == LXMF.LXMessage.PAPER: - header_style = "msg_header_propagated" - title_string = g["papermsg"]+" "+title_string elif message.lxm.state == LXMF.LXMessage.SENT: header_style = "msg_header_sent" title_string = g["sent"]+" "+title_string @@ -1323,7 +910,7 @@ class LXMessageWidget(urwid.WidgetWrap): urwid.Text("") ]) - super().__init__(display_widget) + urwid.WidgetWrap.__init__(self, display_widget) class SyncProgressBar(urwid.ProgressBar): def get_text(self): diff --git a/nomadnet/ui/textui/Directory.py b/nomadnet/ui/textui/Directory.py index 3ff090b..aeec463 100644 --- a/nomadnet/ui/textui/Directory.py +++ b/nomadnet/ui/textui/Directory.py @@ -15,7 +15,7 @@ class DirectoryDisplay(): ]) self.shortcuts_display = DirectoryDisplayShortcuts(self.app) - self.widget = urwid.Filler(pile, urwid.TOP) + self.widget = urwid.Filler(pile, 'top') def shortcuts(self): return self.shortcuts_display \ No newline at end of file diff --git a/nomadnet/ui/textui/Extras.py b/nomadnet/ui/textui/Extras.py index 54b4fec..75327d4 100644 --- a/nomadnet/ui/textui/Extras.py +++ b/nomadnet/ui/textui/Extras.py @@ -6,13 +6,13 @@ class IntroDisplay(): font = urwid.font.HalfBlock5x4Font() big_text = urwid.BigText(("intro_title", self.app.config["textui"]["intro_text"]), font) - big_text = urwid.Padding(big_text, align=urwid.CENTER, width=urwid.CLIP) + big_text = urwid.Padding(big_text, align="center", width="clip") intro = urwid.Pile([ big_text, - urwid.Text(("Version %s" % (str(self.app.version))), align=urwid.CENTER), + urwid.Text(("Version %s" % (str(self.app.version))), align="center"), urwid.Divider(), - urwid.Text(("-= Starting =- "), align=urwid.CENTER), + urwid.Text(("-= Starting =- "), align="center"), ]) self.widget = urwid.Filler(intro) diff --git a/nomadnet/ui/textui/Guide.py b/nomadnet/ui/textui/Guide.py index 6308edc..1452bec 100644 --- a/nomadnet/ui/textui/Guide.py +++ b/nomadnet/ui/textui/Guide.py @@ -10,7 +10,7 @@ class GuideDisplayShortcuts(): self.app = app g = app.ui.glyphs - self.widget = urwid.AttrMap(urwid.Padding(urwid.Text(""), align=urwid.LEFT), "shortcutbar") + self.widget = urwid.AttrMap(urwid.Padding(urwid.Text(""), align="left"), "shortcutbar") class ListEntry(urwid.Text): _selectable = True @@ -75,7 +75,7 @@ class GuideEntry(urwid.WidgetWrap): style = "topic_list_normal" focus_style = "list_focus" self.display_widget = urwid.AttrMap(widget, style, focus_style) - super().__init__(self.display_widget) + urwid.WidgetWrap.__init__(self, self.display_widget) def display_topic(self, event, topic): markup = TOPICS[topic] @@ -125,12 +125,12 @@ class TopicList(urwid.WidgetWrap): highlight_offFocus="list_off_focus" ) - super().__init__(urwid.LineBox(self.ilb, title="Topics")) + urwid.WidgetWrap.__init__(self, urwid.LineBox(self.ilb, title="Topics")) def keypress(self, size, key): if key == "up" and (self.ilb.first_item_is_selected()): - nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.focus_position = "header" + nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.set_focus("header") return super(TopicList, self).keypress(size, key) @@ -141,16 +141,16 @@ class GuideDisplay(): self.app = app g = self.app.ui.glyphs - topic_text = urwid.Text("\n No topic selected", align=urwid.LEFT) + topic_text = urwid.Text("\n No topic selected", align="left") self.left_area = TopicList(self.app, self) - self.right_area = urwid.LineBox(urwid.Filler(topic_text, urwid.TOP)) + self.right_area = urwid.LineBox(urwid.Filler(topic_text, "top")) self.columns = urwid.Columns( [ - (urwid.WEIGHT, GuideDisplay.list_width, self.left_area), - (urwid.WEIGHT, 1-GuideDisplay.list_width, self.right_area) + ("weight", GuideDisplay.list_width, self.left_area), + ("weight", 1-GuideDisplay.list_width, self.right_area) ], dividechars=0, focus_column=0 ) @@ -163,8 +163,9 @@ class GuideDisplay(): entry.display_topic(entry.display_topic, entry.topic_name) def set_content_widgets(self, new_content): - options = self.columns.options(width_type=urwid.WEIGHT, width_amount=1-GuideDisplay.list_width, box_widget=True) + options = self.columns.options(width_type="weight", width_amount=1-GuideDisplay.list_width) pile = urwid.Pile(new_content) + #content = urwid.LineBox(urwid.Filler(pile, "top")) content = urwid.LineBox(urwid.AttrMap(ScrollBar(Scrollable(pile), thumb_char="\u2503", trough_char=" "), "scrollbar")) self.columns.contents[1] = (content, options) @@ -216,15 +217,6 @@ The different sections of the program has a number of keyboard shortcuts mapped, - Ctrl-W Close conversation >>`!Network Window`! ->>>Browser - - Ctrl-D Back - - Ctrl-F Forward - - Ctrl-R Reload page - - Ctrl-U Open URL entry dialog - - Ctrl-S Save connected node - - Ctrl-G Toggle fullscreen browser window - - Ctrl-W Disconnect from node - >>>Announce Stream - Ctrl-L Switch to Known Nodes list - Ctrl-X Delete selected announce @@ -235,10 +227,14 @@ The different sections of the program has a number of keyboard shortcuts mapped, - Ctrl-X Delete selected node entry - Ctrl-P Display peered LXMF Propagation Nodes ->>>Peered LXMF Propagation Nodes - - Ctrl-L Switch to Announce Stream or Known Nodes - - Ctrl-X Break peering with selected node entry - - Ctrl-R Request immediate delivery sync of unhandled LXMs +>>>Browser + - Ctrl-D Back + - Ctrl-F Forward + - Ctrl-R Reload page + - Ctrl-U Open URL entry dialog + - Ctrl-S Save connected node + - Ctrl-G Toggle fullscreen browser window + - Ctrl-W Disconnect from node ''' TOPIC_CONCEPTS = '''>Concepts and Terminology @@ -276,7 +272,7 @@ In the `![ Conversations ]`! part of the program you can view and interact with By default, Nomad Network will attempt to deliver messages to a peer directly. This happens by first establishing an encrypted link directly to the peer, and then delivering the message over it. -If the desired peer is not available because it has disconnected from the network, this method will obviously fail. In this case, Nomad Network will attempt to deliver the message to a node, which will store and forward it over the network, for later retrieval by the destination peer. The message is encrypted before being transmitted to the network, and is only readable by the intended recipient. +If the desired peer is not available because it has disconnected from the network, this method will obviously fail. In this case, Nomad Network will attempt to deliver the message to a node, which will store and forward it over the network, for later retrieval by the destination peer. The message is encrypted with an ephemeral key before being transmitted to the network, and is only readable by the intended recipient. For propagated delivery to work, one or more nodes must be available on the network. If one or more trusted nodes are available, Nomad Network will automatically select the most suitable node to send the message via, but you can also manually specify what node to use. @@ -300,59 +296,43 @@ To learn how to host your own node, read the `*Hosting a Node`* section of this TOPIC_HOSTING = '''>Hosting a Node -To host a node on the network, you must enable it in the configuration file, by setting the `*enable_node`* directive to `*yes`*. You should also configure the other node-related parameters such as the node name and announce interval settings. Once node hosting has been enabled in the configuration, Nomad Network will start hosting your node as soon as the program is launched, and other peers on the network will be able to connect and interact with content on your node. +To host a node on the network, you must enable it in the configuration file, by setting `*enable_node`* directive to `*yes`*. You should also configure the other node-related parameters such as the node name and announce interval settings. Once node hosting has been enabled in the configuration, Nomad Network will start hosting your node as soon as the program is launched, and other peers on the network will be able to connect and interact with content on your node. By default, no content is defined, apart from a short placeholder home page. To learn how to add your own content, read on. >>Distributed Message Store -All nodes on the network will automatically participate in a distributed message store that allows users to exchange messages, even when they are not connected to the network at the same time. +All nodes on the network automatically form a distributed message store that allows users to exchange messages, even when they are not available at the same time. -When Nomad Network is configured to host a node, by default it also configures itself as an LXMF Propagation Node, and automatically discovers and peers with other propagation nodes on the network. This process is completely automatic and requires no configuration from the node operator. +When Nomad Network is configured to host a node, it also configures itself as an LXMF Propagation Node, and automatically discovers and peers with other propagation nodes on the network. This process is completely automatic and requires no configuration from the node operator. -`!However`!, if there is already an abundance of Propagation Nodes on the network, or the operator simply wishes to host a pageserving-only node, Propagation Node hosting can be disabled in the configuration file. - -To view LXMF Propagation nodes that are currently peered with your node, go to the `![ Network ]`! part of the program and press `!Ctrl-P`!. In the list of peered Propagation Nodes, it is possible to: - - - Immediately break peering with a node by pressing `!Ctrl-X`! - - Request an immediate delivery sync of all unhandled messages for a node, by pressing `!Ctrl-R`! +To view LXMF Propagation nodes that are currently peered with your node, go to the `![ Network ]`! part of the program and press `!Ctrl-P`!. The distributed message store is resilient to intermittency, and will remain functional as long as at least one node remains on the network. Nodes that were offline for a time will automatically be synced up to date when they regain connectivity. >>Pages -Nomad Network nodes can host pages similar to web pages, that other peers can read and interact with. Pages are written in a compact markup language called `*micron`*. To learn how to write formatted pages with micron, see the `*Markup`* section of this guide (which is, itself, written in micron). Pages can be linked together with hyperlinks, that can also link to pages (or other resources) on other nodes. +Nomad Network nodes can host pages similar to web pages, that other peers can read and interact with. Pages are written in a compact markup language called `*micron`*. To learn how to write formatted pages with micron, see the `*Markup`* section of this guide (which is, itself, written in micron). Pages can be linked arbitrarily with hyperlinks, that can also link to pages (or other resources) on other nodes. To add pages to your node, place micron files in the `*pages`* directory of your Nomad Network programs `*storage`* directory. By default, the path to this will be `!~/.nomadnetwork/storage/pages`!. You should probably create the file `!index.mu`! first, as this is the page that will get served by default to a connecting peer. You can control how long a peer will cache your pages by including the cache header in a page. To do so, the first line of your page must start with `!#!c=X`!, where `!X`! is the cache time in seconds. To tell the peer to always load the page from your node, and never cache it, set the cache time to zero. You should only do this if there is a real need, for example if your page displays dynamic content that `*must`* be updated at every page view. The default caching time is 12 hours. In most cases, you should not need to include the cache control header in your pages. ->> Dynamic Pages - -You can use a preprocessor such as PHP, bash, Python (or whatever you prefer) to generate dynamic pages and fully interactive applications running over Nomad Network. To do so, just set executable permissions on the relevant page file, and be sure to include the interpreter at the beginning of the file, for example `!#!/usr/bin/python3`!. - -Data from fields and link variables will be passed to these scipts or programs as environment variables, and can simply be read by any method for accessing such. - -In the `!examples`! directory, you can find various small examples for the use of this feature. The currently included examples are: - - - A messageboard that receives messages over LXMF, contributed by trippcheng - - A simple demonstration on how to create fields and read entered data in node-side scripts - -By default, you can find the examples in `!~/.nomadnetwork/examples`!. If you build something neat, that you feel would fit here, you are more than welcome to contribute it. +You can use a preprocessor such as PHP, bash, Python (or whatever you prefer) to generate dynamic pages. To do so, just set executable permissions on the relevant page file, and be sure to include the interpreter at the beginning of the file, for example `!#!/usr/bin/python3`!. >>Authenticating Users Sometimes, you don't want everyone to be able to view certain pages or execute certain scripts. In such cases, you can use `*authentication`* to control who gets to run certain requests. -To enable authentication for any page, simply add a new file to your pages directory with ".allowed" added to the file-name of the page. If your page is named "secret_page.mu", just add a file named "secret_page.allowed". +To enable authentication for any page, simply add a new file to your pages directory with ".allowed" added to the file-name of the page. If your page is named "secret_page.mu", just add a file named "secret_page.mu.allowed". For each user allowed to access the page, add a line to this file, containing the hash of that users primary identity. Users can find their own identity hash in the `![ Network ]`! part of the program, under `!Local Peer Info`!. If you want to allow access for three different users, your file would look like this: `Faaa `= -d454bcdac0e64fb68ba8e267543ae110 -2b9ff3fb5902c9ca5ff97bdfb239ef50 -7106d5abbc7208bfb171f2dd84b36490 +24c2dc2248953e0a3c21 +564a476410f4fca2ae93 +8bb864743f12f53395a1 `= `` @@ -368,7 +348,7 @@ Like pages, you can place files you want to make available in the `!~/.nomadnetw Links to pages and resources in Nomad Network use a simple URL format. Here is an example: -`!18176ffddcc8cce1ddf8e3f72068f4a6:/page/index.mu`! +`!1385edace36466a6b3dd:/page/index.mu`! The first part is the 10 byte destination address of the node (represented as readable hexadecimal), followed by the `!:`! character. Everything after the `!:`! represents the request path. @@ -400,7 +380,7 @@ You're currently located in the guide section of the program. I'm sorry I had to To get the most out of Nomad Network, you will need a terminal that supports UTF-8 and at least 256 colors, ideally true-color. If your terminal supports true-color, you can go to the `![ Config ]`! menu item, launch the editor and change the configuration. -It is recommended to use a terminal size of at least 135x32. Nomad Network will work with smaller terminal sizes, but the interface might feel a bit cramped. +It is recommended to use a terminal size of at least 122x32. Nomad Network will work with smaller terminal sizes, but the interface might feel a bit cramped. If you don't already have a Nerd Font installed (see https://www.nerdfonts.com/), I also highly recommend to do so, since it will greatly expand the amount of glyphs, icons and graphics that Nomad Network can use. Once you have your terminal set up with a Nerd Font, go to the `![ Config ]`! menu item and enable Nerd Fonts in the configuration instead of normal unicode glyphs. @@ -485,12 +465,6 @@ Selects which interface to use. Currently, only the `!text`! interface is availa Sets the filesystem path to store downloaded files in. < ->>> -`!notify_on_new_message = yes`! ->>>> -Sets whether to output a notification character (bell or flash) to the terminal when a new message is received. -< - >>> `!announce_at_start = yes`! >>>> @@ -521,30 +495,6 @@ 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`! ->>>> -The maximum accepted unpacked size for messages received directly from other peers, specified in kilobytes. Messages larger than this will be rejected before the transfer begins. -< - ->>> -`!compact_announce_stream = yes`! ->>>> -With this option enabled, Nomad Network will only display one entry in the announce stream per destination. Older announces are culled when a new one arrives. -< - >> Text UI Section This section hold configuration directives related to the look and feel of the text-based user interface of the program. It is delimited by the `![textui]`! header in the configuration file. Available directives, along with their default values, are as follows: @@ -647,60 +597,24 @@ Determines how often, in minutes, your node is announced on the network. Default Determines where the node server will look for hosted pages. Must be a readable filesystem path. < ->>> -`!page_refresh_interval = 0`! ->>>> -Determines the interval in minutes for rescanning the hosted pages path. By default, this option is disabled, and the pages path will only be scanned on startup. -< - >>> `!files_path = ~/.nomadnetwork/storage/files`! >>>> Determines where the node server will look for downloadable files. Must be a readable filesystem path. < ->>> -`!file_refresh_interval = 0`! ->>>> -Determines the interval in minutes for rescanning the hosted files path. By default, this option is disabled, and the files path will only be scanned on startup. -< - ->>> -`!disable_propagation = yes`! ->>>> -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. -< - >>> `!message_storage_limit = 2000`! >>>> Configures the maximum amount of storage, in megabytes, that the LXMF Propagation Node will use to store messages. < ->>> -`!max_transfer_size = 256`! ->>>> -The maximum accepted transfer size per incoming propagation transfer, in kilobytes. This also sets the upper limit for the size of single messages accepted onto this propagation node. If a node wants to propagate a larger number of messages to this node, than what can fit within this limit, it will prioritise sending the smallest, newest messages first, and try with any remaining messages at a later point. -< - >>> `!prioritise_destinations = 41d20c727598a3fbbdf9106133a3a0ed, d924b81822ca24e68e2effea99bcb8cf`! >>>> 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: @@ -756,24 +670,25 @@ For future reference, you can download the Reticulum Manual in PDF format here: It might be nice to keep that handy when you are not connected to the Internet, as it is full of information and examples that are also very relevant to Nomad Network. ->The Reticulum Testnet +>The Unsigned.io Testnet If you have Internet access, and just want to get started experimenting, you are welcome to join the Unsigned.io RNS Testnet. The testnet is just that, an informal network for testing and experimenting. It will be up most of the time, and anyone can join, but it also means that there's no guarantees for service availability. 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 Dublin]] +[[RNS Testnet Frankfurt]] type = TCPClientInterface - enabled = yes - target_host = dublin.connect.reticulum.network + interface_enabled = yes + outgoing = True + target_host = frankfurt.rns.unsigned.io 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: - - Dublin Hub Testnet Node : `!`[abb3ebcd03cb2388a838e70c001291f9]`! - - Frankfurt Hub Testnet Node : `!`[ea6a715f814bdc37e56f80c34da6ad51]`! + - Dublin Hub Testnet Node : `!`[464ddc8cd323648ef919a638923b4916]`! + - Frankfurt Hub Testnet Node : `!`[5cda089fc42675bdd904c6d06db87d49]`! To browse pages on a node that is not currently known, open the URL dialog in the `![ Network ]`! section of the program by pressing `!Ctrl+U`!, paste or enter the address and select `!< Go >`! or press enter. Nomadnet will attempt to discover and connect to the requested node. You can save the currently connected node by pressing `!Ctrl+S`!. ''' @@ -812,7 +727,7 @@ The following line should contain a grayscale gradient bar: Unicode Glyphs : \u2713 \u2715 \u26a0 \u24c3 \u2193 -Nerd Font Glyphs : \uf484 \U000f04c5 \U000f0219 \U000f0002 \uf415 \uf023 \uf06e +Nerd Font Glyphs : \uf484 \uf9c4 \uf719 \uf502 \uf415 \uf023 \uf06e ''' @@ -1079,135 +994,6 @@ Here is `F00f`_`[a more visible link`72914442a3689add83a09a767963f57c:/page/inde When links like these are displayed in the built-in browser, clicking on them or activating them using the keyboard will cause the browser to load the specified URL. ->Fields & Requests - -Nomad Network let's you use simple input fields for submitting data to node-side applications. Submitted data, along with other session variables will be available to the node-side script / program as environment variables. - ->>Request Links - -Links can contain request variables and a list of fields to submit to the node-side application. You can include all fields on the page, only specific ones, and any number of request variables. To simply submit all fields on a page to a specified node-side page, create a link like this: - -`Faaa -`= -`[Submit Fields`:/page/fields.mu`*] -`= -`` - -Note the `!*`! following the extra `!\\``! at the end of the path. This `!*`! denotes `*all fields`*. You can also specify a list of fields to include: - -`Faaa -`= -`[Submit Fields`:/page/fields.mu`username|auth_token] -`= -`` - -If you want to include pre-set variables, you can do it like this: - -`Faaa -`= -`[Query the System`:/page/fields.mu`username|auth_token|action=view|amount=64] -`= -`` - ->> Fields - -Here's an example of creating a field. We'll create a field named `!user_input`! and fill it with the text `!Pre-defined data`!. Note that we are using background color tags to make the field more visible to the user: - -`Faaa -`= -A simple input field: `B444``b -`= -`` - -You must always set a field `*name`*, but you can of course omit the pre-defined value of the field: - -`Faaa -`= -An empty input field: `B444``b -`= -`` - -You can set the size of the field like this: - -`Faaa -`= -A sized input field: `B444`<16|with_size`>`b -`= -`` - -It is possible to mask fields, for example for use with passwords and similar: - -`Faaa -`= -A masked input field: `B444``b -`= -`` - -And you can of course control all parameters at the same time: - -`Faaa -`= -Full control: `B444``b -`= -`` - -Collecting the above markup produces the following output: - -`Faaa`B333 - -A simple input field: `B444``B333 - -An empty input field: `B444``B333 - -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` - -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. - -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. - -`` - >Comments You can insert comments that will not be displayed in the output by starting a line with the # character. @@ -1240,7 +1026,7 @@ To display literal content, for example source-code, or blocks of text that shou `= ''' TOPIC_MARKUP += TOPIC_MARKUP.replace("`=", "\\`=") + "[ micron source for document goes here, we don't want infinite recursion now, do we? ]\n\\`=" -TOPIC_MARKUP += "\n`=\n\n>Closing Remarks\n\nIf you made it all the way here, you should be well equipped to write documents, pages and applications using micron and Nomad Network. Thank you for staying with me.\n" +TOPIC_MARKUP += "\n`=\n\n>Closing Remarks\n\nIf you made it all the way here, you should be well equipped to write documents and pages using micron. Thank you for staying with me.\n\n`c\U0001F332\n" TOPICS = { diff --git a/nomadnet/ui/textui/Log.py b/nomadnet/ui/textui/Log.py index bea98ef..b38e4b3 100644 --- a/nomadnet/ui/textui/Log.py +++ b/nomadnet/ui/textui/Log.py @@ -1,11 +1,6 @@ -import os -import sys -import itertools -import mmap import urwid import nomadnet - class LogDisplayShortcuts(): def __init__(self, app): import urwid @@ -13,115 +8,31 @@ class LogDisplayShortcuts(): self.widget = urwid.AttrMap(urwid.Text(""), "shortcutbar") - class LogDisplay(): def __init__(self, app): + import urwid self.app = app + self.log_term = LogTerminal(self.app) self.shortcuts_display = LogDisplayShortcuts(self.app) - self.widget = None - - @property - def log_term(self): - return self.widget - - def show(self): - if self.widget is None: - self.widget = log_widget(self.app) - - def kill(self): - if self.widget is not None: - self.widget.terminate() - self.widget = None + self.widget = urwid.LineBox(self.log_term) def shortcuts(self): return self.shortcuts_display - class LogTerminal(urwid.WidgetWrap): def __init__(self, app): self.app = app self.log_term = urwid.Terminal( ("tail", "-fn50", self.app.logfilepath), encoding='utf-8', - escape_sequence="up", - main_loop=self.app.ui.loop, + escape_sequence="up" ) - self.widget = urwid.LineBox(self.log_term) - super().__init__(self.widget) - - def terminate(self): - self.log_term.terminate() + urwid.WidgetWrap.__init__(self, self.log_term) def keypress(self, size, key): if key == "up": - nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.focus_position = "header" + nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.set_focus("header") - return super(LogTerminal, self).keypress(size, key) - - -class LogTail(urwid.WidgetWrap): - def __init__(self, app): - self.app = app - self.log_tail = urwid.Text(tail(self.app.logfilepath, 50)) - self.log = urwid.Scrollable(self.log_tail) - self.log.set_scrollpos(-1) - self.log_scrollbar = urwid.ScrollBar(self.log) - # We have this here because ui.textui.Main depends on this field to kill it - self.log_term = None - - super().__init__(self.log_scrollbar) - - def terminate(self): - pass - - -def log_widget(app, platform=sys.platform): - if platform == "win32": - return LogTail(app) - else: - return LogTerminal(app) - -# https://stackoverflow.com/a/34029605/3713120 -def _tail(f_name, n, offset=0): - def skip_back_lines(mm: mmap.mmap, numlines: int, startidx: int) -> int: - '''Factored out to simplify handling of n and offset''' - for _ in itertools.repeat(None, numlines): - startidx = mm.rfind(b'\n', 0, startidx) - if startidx < 0: - break - return startidx - - # Open file in binary mode - with open(f_name, 'rb') as binf, mmap.mmap(binf.fileno(), 0, access=mmap.ACCESS_READ) as mm: - # len(mm) - 1 handles files ending w/newline by getting the prior line - startofline = skip_back_lines(mm, offset, len(mm) - 1) - if startofline < 0: - return [] # Offset lines consumed whole file, nothing to return - # If using a generator function (yield-ing, see below), - # this should be a plain return, no empty list - - endoflines = startofline + 1 # Slice end to omit offset lines - - # Find start of lines to capture (add 1 to move from newline to beginning of following line) - startofline = skip_back_lines(mm, n, startofline) + 1 - - # Passing True to splitlines makes it return the list of lines without - # removing the trailing newline (if any), so list mimics f.readlines() - # return mm[startofline:endoflines].splitlines(True) - # If Windows style \r\n newlines need to be normalized to \n - return mm[startofline:endoflines].replace(os.linesep.encode(sys.getdefaultencoding()), b'\n').splitlines(True) - - -def tail(f_name, n): - """ - Return the last n lines of a given file name, f_name. - Akin to `tail - ` - """ - def decode(b): - return b.decode(encoding) - - encoding = sys.getdefaultencoding() - lines = map(decode, _tail(f_name=f_name, n=n)) - return ''.join(lines) + return super(LogTerminal, self).keypress(size, key) \ No newline at end of file diff --git a/nomadnet/ui/textui/Main.py b/nomadnet/ui/textui/Main.py index 303024a..deca22a 100644 --- a/nomadnet/ui/textui/Main.py +++ b/nomadnet/ui/textui/Main.py @@ -1,4 +1,5 @@ import RNS +import time from .Network import * from .Conversations import * @@ -115,7 +116,6 @@ class MainDisplay(): def show_log(self, user_data): self.sub_displays.active_display = self.sub_displays.log_display - self.sub_displays.log_display.show() self.update_active_sub_display() def show_guide(self, user_data): @@ -125,8 +125,6 @@ class MainDisplay(): def update_active_sub_display(self): self.frame.contents["body"] = (self.sub_displays.active().widget, None) self.update_active_shortcuts() - if self.sub_displays.active_display != self.sub_displays.log_display: - self.sub_displays.log_display.kill() def update_active_shortcuts(self): self.frame.contents["footer"] = (self.sub_displays.active().shortcuts().widget, None) @@ -142,22 +140,13 @@ class MainDisplay(): self.menu_display.start() def quit(self, sender=None): - logterm_pid = None - if True or RNS.vendor.platformutils.is_android(): - if self.sub_displays.log_display != None and self.sub_displays.log_display.log_term != None: - if self.sub_displays.log_display.log_term.log_term != None: - logterm_pid = self.sub_displays.log_display.log_term.log_term.pid - if logterm_pid != None: - import os, signal - os.kill(logterm_pid, signal.SIGKILL) - raise urwid.ExitMainLoop class MenuColumns(urwid.Columns): def keypress(self, size, key): if key == "tab" or key == "down": - self.handler.frame.focus_position = "body" + self.handler.frame.set_focus("body") return super(MenuColumns, self).keypress(size, key) @@ -171,7 +160,7 @@ class MenuDisplay(): self.menu_indicator = urwid.Text("") - menu_text = (urwid.PACK, self.menu_indicator) + menu_text = ("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)) diff --git a/nomadnet/ui/textui/Map.py b/nomadnet/ui/textui/Map.py index b2ef4dd..3d4a03d 100644 --- a/nomadnet/ui/textui/Map.py +++ b/nomadnet/ui/textui/Map.py @@ -15,7 +15,7 @@ class MapDisplay(): ]) self.shortcuts_display = MapDisplayShortcuts(self.app) - self.widget = urwid.Filler(pile, urwid.TOP) + self.widget = urwid.Filler(pile, 'top') def shortcuts(self): return self.shortcuts_display \ No newline at end of file diff --git a/nomadnet/ui/textui/MicronParser.py b/nomadnet/ui/textui/MicronParser.py index bbda2c8..7a8ff7e 100644 --- a/nomadnet/ui/textui/MicronParser.py +++ b/nomadnet/ui/textui/MicronParser.py @@ -1,9 +1,9 @@ import nomadnet import urwid -import random import time from urwid.util import is_mouse_press from urwid.text_layout import calc_coords +import re DEFAULT_FG_DARK = "ddd" DEFAULT_FG_LIGHT = "222" @@ -62,14 +62,13 @@ def markup_to_attrmaps(markup, url_delegate = None): for line in lines: if len(line) > 0: - display_widgets = parse_line(line, state, url_delegate) + display_widget = parse_line(line, state, url_delegate) else: - display_widgets = [urwid.Text("")] + display_widget = urwid.Text("") - if display_widgets != None and len(display_widgets) != 0: - for display_widget in display_widgets: - attrmap = urwid.AttrMap(display_widget, make_style(state)) - attrmaps.append(attrmap) + if display_widget != None: + attrmap = urwid.AttrMap(display_widget, make_style(state)) + attrmaps.append(attrmap) return attrmaps @@ -125,7 +124,7 @@ def parse_line(line, state, url_delegate): heading_style = first_style output.insert(0, " "*left_indent(state)) - return [urwid.AttrMap(urwid.Text(output, align=state["align"]), heading_style)] + return urwid.AttrMap(urwid.Text(output, align=state["align"]), heading_style) else: return None else: @@ -138,85 +137,22 @@ def parse_line(line, state, url_delegate): else: divider_char = "\u2500" if state["depth"] == 0: - return [urwid.Divider(divider_char)] + return urwid.Divider(divider_char) else: - return [urwid.Padding(urwid.Divider(divider_char), left=left_indent(state), right=right_indent(state))] + return urwid.Padding(urwid.Divider(divider_char), left=left_indent(state), right=right_indent(state)) output = make_output(state, line, url_delegate) if output != None: - text_only = True - for o in output: - if not isinstance(o, tuple): - text_only = False - break - - if not text_only: - widgets = [] - for o in output: - if isinstance(o, tuple): - if url_delegate != None: - tw = LinkableText(o, align=state["align"], delegate=url_delegate) - tw.in_columns = True - else: - tw = urwid.Text(o, align=state["align"]) - widgets.append((urwid.PACK, tw)) - else: - if o["type"] == "field": - fw = o["width"] - fd = o["data"] - 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.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"] - fprechecked = o.get("prechecked", False) - f = urwid.CheckBox(flabel, state=fprechecked) - 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"] - fprechecked = o.get("prechecked", False) - if "radio_groups" not in state: - 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=fprechecked, 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 - # text_widget = urwid.Text("<"+output+">", align=state["align"]) - + if url_delegate != None: + text_widget = LinkableText(output, align=state["align"], delegate=url_delegate) else: - if url_delegate != None: - text_widget = LinkableText(output, align=state["align"], delegate=url_delegate) - else: - text_widget = urwid.Text(output, align=state["align"]) + text_widget = urwid.Text(output, align=state["align"]) if state["depth"] == 0: - return [text_widget] + return text_widget else: - return [urwid.Padding(text_widget, left=left_indent(state), right=right_indent(state))] + return urwid.Padding(text_widget, left=left_indent(state), right=right_indent(state)) else: return None else: @@ -487,100 +423,6 @@ def make_output(state, line, url_delegate): elif c == "a": state["align"] = state["default_align"] - elif c == '<': - if len(part) > 0: - output.append(make_part(state, part)) - part = "" - try: - field_start = i + 1 # position after '<' - backtick_pos = line.find('`', field_start) - if backtick_pos == -1: - pass # No '`', invalid field - else: - field_content = line[field_start:backtick_pos] - field_masked = False - field_width = 24 - field_type = "field" - field_name = field_content - field_value = "" - field_data = "" - field_prechecked = False - - # check if field_content contains '|' - if '|' in field_content: - f_components = field_content.split('|') - field_flags = f_components[0] - field_name = f_components[1] - - # 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 - - # Handle field width - if len(field_flags) > 0: - try: - field_width = min(int(field_flags), 256) - 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) - 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, - "prechecked": field_prechecked, - "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: @@ -592,20 +434,13 @@ def make_output(state, line, url_delegate): link_components = link_data.split("`") if len(link_components) == 1: link_label = "" - link_fields = "" link_url = link_data elif len(link_components) == 2: link_label = link_components[0] link_url = link_components[1] - link_fields = "" - elif len(link_components) == 3: - link_label = link_components[0] - link_url = link_components[1] - link_fields = link_components[2] else: link_url = "" link_label = "" - link_fields = "" if len(link_url) != 0: if link_label == "": @@ -633,11 +468,6 @@ def make_output(state, line, url_delegate): if url_delegate != None: linkspec = LinkSpec(link_url, orig_spec) - if link_fields != "": - lf = link_fields.split("|") - if len(lf) > 0: - linkspec.link_fields = lf - output.append((linkspec, link_label)) else: output.append(make_part(state, link_label)) @@ -650,11 +480,7 @@ def make_output(state, line, url_delegate): elif mode == "text": if c == "\\": - if escape: - part += c - escape = False - else: - escape = True + escape = True elif c == "`": if escape: part += c @@ -680,9 +506,8 @@ def make_output(state, line, url_delegate): class LinkSpec(urwid.AttrSpec): def __init__(self, link_target, orig_spec): self.link_target = link_target - self.link_fields = None - super().__init__(orig_spec.foreground, orig_spec.background) + urwid.AttrSpec.__init__(self, orig_spec.foreground, orig_spec.background) class LinkableText(urwid.Text): @@ -692,17 +517,16 @@ class LinkableText(urwid.Text): signals = ["click", "change"] def __init__(self, text, align=None, cursor_position=0, delegate=None): - super().__init__(text, align=align) + self.__super.__init__(text, align=align) self.delegate = delegate self._cursor_position = 0 self.key_timeout = 3 - self.in_columns = False if self.delegate != None: self.delegate.last_keypress = 0 - def handle_link(self, link_target, link_fields): + def handle_link(self, link_target): if self.delegate != None: - self.delegate.handle_link(link_target, link_fields) + self.delegate.handle_link(link_target) def find_next_part_pos(self, pos, part_positions): for position in part_positions: @@ -760,7 +584,7 @@ class LinkableText(urwid.Text): item = self.find_item_at_pos(self._cursor_position) if item != None: if isinstance(item, LinkSpec): - self.handle_link(item.link_target, item.link_fields) + self.handle_link(item.link_target) elif key == "up": self._cursor_position = 0 @@ -773,23 +597,16 @@ class LinkableText(urwid.Text): elif key == "right": old = self._cursor_position self._cursor_position = self.find_next_part_pos(self._cursor_position, part_positions) - if self._cursor_position == old: - if self.in_columns: - return "right" - else: - self._cursor_position = 0 - return "down" + self._cursor_position = 0 + return "down" self._invalidate() elif key == "left": if self._cursor_position > 0: - if self.in_columns: - return "left" - else: - self._cursor_position = self.find_prev_part_pos(self._cursor_position, part_positions) - self._invalidate() + self._cursor_position = self.find_prev_part_pos(self._cursor_position, part_positions) + self._invalidate() else: if self.delegate != None: @@ -803,7 +620,7 @@ class LinkableText(urwid.Text): def render(self, size, focus=False): now = time.time() - c = super().render(size, focus) + c = self.__super.render(size, focus) if focus and (self.delegate == None or now < self.delegate.last_keypress+self.key_timeout): c = urwid.CompositeCanvas(c) @@ -825,45 +642,41 @@ class LinkableText(urwid.Text): return x, y def mouse_event(self, size, event, button, x, y, focus): - try: - if button != 1 or not is_mouse_press(event): - return False + if button != 1 or not is_mouse_press(event): + return False + else: + (maxcol,) = size + translation = self.get_line_translation(maxcol) + line_offset = 0 + + if self.align == "center": + line_offset = translation[y][1][1]-translation[y][0][0] + if x < translation[y][0][0]: + x = translation[y][0][0] + + if x > translation[y][1][0]+translation[y][0][0]: + x = translation[y][1][0]+translation[y][0][0] + + elif self.align == "right": + line_offset = translation[y][1][1]-translation[y][0][0] + if x < translation[y][0][0]: + x = translation[y][0][0] + else: - (maxcol,) = size - translation = self.get_line_translation(maxcol) - line_offset = 0 + line_offset = translation[y][0][1] + if x > translation[y][0][0]: + x = translation[y][0][0] - if self.align == "center": - line_offset = translation[y][1][1]-translation[y][0][0] - if x < translation[y][0][0]: - x = translation[y][0][0] + pos = line_offset+x - if x > translation[y][1][0]+translation[y][0][0]: - x = translation[y][1][0]+translation[y][0][0] + self._cursor_position = pos + item = self.find_item_at_pos(self._cursor_position) - elif self.align == "right": - line_offset = translation[y][1][1]-translation[y][0][0] - if x < translation[y][0][0]: - x = translation[y][0][0] + if item != None: + if isinstance(item, LinkSpec): + self.handle_link(item.link_target) - else: - line_offset = translation[y][0][1] - if x > translation[y][0][0]: - x = translation[y][0][0] - - pos = line_offset+x - - self._cursor_position = pos - item = self.find_item_at_pos(self._cursor_position) - - if item != None: - if isinstance(item, LinkSpec): - self.handle_link(item.link_target, item.link_fields) - - self._invalidate() - self._emit("change") - - return True + self._invalidate() + self._emit("change") - except Exception as e: - return False \ No newline at end of file + return True \ No newline at end of file diff --git a/nomadnet/ui/textui/Network.py b/nomadnet/ui/textui/Network.py index 63f00ec..525fc0b 100644 --- a/nomadnet/ui/textui/Network.py +++ b/nomadnet/ui/textui/Network.py @@ -2,7 +2,6 @@ import RNS import urwid import nomadnet import time -import threading from datetime import datetime from nomadnet.Directory import DirectoryEntry from nomadnet.vendor.additional_urwid_widgets import IndicativeListBox, MODIFIER_KEY @@ -14,7 +13,9 @@ class NetworkDisplayShortcuts(): self.app = app g = app.ui.glyphs - self.widget = urwid.AttrMap(urwid.Text("[C-l] Nodes/Announces [C-x] Remove [C-w] Disconnect [C-d] Back [C-f] Forward [C-r] Reload [C-u] URL [C-g] Fullscreen [C-s / C-b] Save Node"), "shortcutbar") + self.widget = urwid.AttrMap(urwid.Text("[C-l] Nodes/Announces [C-x] Remove [C-w] Disconnect [C-d] Back [C-f] Forward [C-r] Reload [C-u] URL [C-g] Fullscreen"), "shortcutbar") + # "[C-"+g["arrow_u"]+g["arrow_d"]+"] Navigate Lists" + class DialogLineBox(urwid.LineBox): def keypress(self, size, key): @@ -52,7 +53,7 @@ class ListEntry(urwid.Text): class AnnounceInfo(urwid.WidgetWrap): def keypress(self, size, key): if key == "esc": - options = self.parent.left_pile.options(height_type=urwid.WEIGHT, height_amount=1) + options = self.parent.left_pile.options(height_type="weight", height_amount=1) self.parent.left_pile.contents[0] = (self.parent.announce_stream_display, options) else: return super(AnnounceInfo, self).keypress(size, key) @@ -70,17 +71,11 @@ class AnnounceInfo(urwid.WidgetWrap): trust_str = "" display_str = self.app.directory.simplest_display_str(source_hash) addr_str = "<"+RNS.hexrep(source_hash, delimit=False)+">" - info_type = announce[3] + is_node = announce[3] - is_node = False - is_pn = False - if info_type == "node" or info_type == True: - type_string = "Nomad Network Node " + g["node"] - is_node = True - elif info_type == "pn": - type_string = "LXMF Propagation Node " + g["sent"] - is_pn = True - elif info_type == "peer" or info_type == False: + if is_node: + type_string = "Node " + g["node"] + else: type_string = "Peer " + g["peer"] try: @@ -115,7 +110,7 @@ class AnnounceInfo(urwid.WidgetWrap): style = "list_untrusted" def show_announce_stream(sender): - options = self.parent.left_pile.options(height_type=urwid.WEIGHT, height_amount=1) + options = self.parent.left_pile.options(height_type="weight", height_amount=1) self.parent.left_pile.contents[0] = (self.parent.announce_stream_display, options) def connect(sender): @@ -141,7 +136,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 +157,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 @@ -179,78 +174,44 @@ class AnnounceInfo(urwid.WidgetWrap): except Exception as e: RNS.log("Error while starting conversation from announce. The contained exception was: "+str(e), RNS.LOG_ERROR) - def use_pn(sender): - show_announce_stream(None) - try: - self.app.set_user_selected_propagation_node(source_hash) - except Exception as e: - RNS.log("Error while setting active propagation node from announce. The contained exception was: "+str(e), RNS.LOG_ERROR) - if is_node: - type_button = (urwid.WEIGHT, 0.45, urwid.Button("Connect", on_press=connect)) - msg_button = (urwid.WEIGHT, 0.45, urwid.Button("Msg Op", on_press=msg_op)) - save_button = (urwid.WEIGHT, 0.45, urwid.Button("Save", on_press=save_node)) - elif is_pn: - type_button = (urwid.WEIGHT, 0.45, urwid.Button("Use as default", on_press=use_pn)) - save_button = None + type_button = ("weight", 0.45, urwid.Button("Connect", on_press=connect)) + msg_button = ("weight", 0.45, urwid.Button("Msg Op", on_press=msg_op)) + save_button = ("weight", 0.45, urwid.Button("Save", on_press=save_node)) else: - type_button = (urwid.WEIGHT, 0.45, urwid.Button("Converse", on_press=converse)) + type_button = ("weight", 0.45, urwid.Button("Converse", on_press=converse)) save_button = None if is_node: - button_columns = urwid.Columns([ - (urwid.WEIGHT, 0.45, urwid.Button("Back", on_press=show_announce_stream)), - (urwid.WEIGHT, 0.1, urwid.Text("")), - type_button, - (urwid.WEIGHT, 0.1, urwid.Text("")), - msg_button, - (urwid.WEIGHT, 0.1, urwid.Text("")), - save_button, - ]) + button_columns = urwid.Columns([("weight", 0.45, urwid.Button("Back", on_press=show_announce_stream)), ("weight", 0.1, urwid.Text("")), type_button, ("weight", 0.1, urwid.Text("")), msg_button, ("weight", 0.1, urwid.Text("")), save_button]) else: - button_columns = urwid.Columns([ - (urwid.WEIGHT, 0.45, urwid.Button("Back", on_press=show_announce_stream)), - (urwid.WEIGHT, 0.1, urwid.Text("")), - type_button, - ]) + button_columns = urwid.Columns([("weight", 0.45, urwid.Button("Back", on_press=show_announce_stream)), ("weight", 0.1, urwid.Text("")), type_button]) - pile_widgets = [] + pile_widgets = [ + urwid.Text("Time : "+ts_string, align="left"), + urwid.Text("Addr : "+addr_str, align="left"), + urwid.Text("Type : "+type_string, align="left"), + urwid.Text("Name : "+display_str, align="left"), + urwid.Text(["Trust : ", (style, trust_str)], align="left"), + urwid.Divider(g["divider1"]), + urwid.Text(["Announce Data: \n", (data_style, data_str)], align="left"), + urwid.Divider(g["divider1"]), + button_columns + ] - if is_pn: - pile_widgets = [ - urwid.Text("Time : "+ts_string, align=urwid.LEFT), - urwid.Text("Addr : "+addr_str, align=urwid.LEFT), - urwid.Text("Type : "+type_string, align=urwid.LEFT), - urwid.Divider(g["divider1"]), - button_columns - ] - - else: - pile_widgets = [ - urwid.Text("Time : "+ts_string, align=urwid.LEFT), - urwid.Text("Addr : "+addr_str, align=urwid.LEFT), - urwid.Text("Type : "+type_string, align=urwid.LEFT), - urwid.Text("Name : "+display_str, align=urwid.LEFT), - urwid.Text(["Trust : ", (style, trust_str)], align=urwid.LEFT), - urwid.Divider(g["divider1"]), - urwid.Text(["Announce Data: \n", (data_style, data_str)], align=urwid.LEFT), - urwid.Divider(g["divider1"]), - button_columns - ] - - if is_node: - operator_entry = urwid.Text("Oprtr : "+op_str, align=urwid.LEFT) - pile_widgets.insert(4, operator_entry) + if is_node: + operator_entry = urwid.Text("Oprtr : "+op_str, align="left") + pile_widgets.insert(4, operator_entry) pile = urwid.Pile(pile_widgets) - self.display_widget = urwid.Filler(pile, valign=urwid.TOP, height=urwid.PACK) + self.display_widget = urwid.Filler(pile, valign="top", height="pack") - super().__init__(urwid.LineBox(self.display_widget, title="Announce Info")) + urwid.WidgetWrap.__init__(self, urwid.LineBox(self.display_widget, title="Announce Info")) class AnnounceStreamEntry(urwid.WidgetWrap): - def __init__(self, app, announce, delegate): + def __init__(self, app, announce): full_time_format = "%Y-%m-%d %H:%M:%S" date_time_format = "%Y-%m-%d" time_time_format = "%H:%M:%S" @@ -259,9 +220,8 @@ class AnnounceStreamEntry(urwid.WidgetWrap): timestamp = announce[0] source_hash = announce[1] - announce_type = announce[3] + is_node = announce[3] self.app = app - self.delegate = delegate self.timestamp = timestamp time_format = app.time_format dt = datetime.fromtimestamp(self.timestamp) @@ -297,81 +257,26 @@ class AnnounceStreamEntry(urwid.WidgetWrap): style = "list_untrusted" focus_style = "list_focus_untrusted" - if announce_type == "node" or announce_type == True: + if is_node: type_symbol = g["node"] - elif announce_type == "peer" or announce_type == False: + else: type_symbol = g["peer"] - elif announce_type == "pn": - type_symbol = g["sent"] widget = ListEntry(ts_string+" "+type_symbol+" "+display_str) urwid.connect_signal(widget, "click", self.display_announce, announce) self.display_widget = urwid.AttrMap(widget, style, focus_style) - super().__init__(self.display_widget) + urwid.WidgetWrap.__init__(self, self.display_widget) def display_announce(self, event, announce): - try: parent = self.app.ui.main_display.sub_displays.network_display info_widget = AnnounceInfo(announce, parent, self.app) - options = parent.left_pile.options(height_type=urwid.WEIGHT, height_amount=1) + options = parent.left_pile.options(height_type="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() - - def confirmed(sender): - def close_req(sender): - self.delegate.parent.close_list_dialogs() - - dialog_pile.contents[0] = (urwid.Text("\nKeys requested from network\n", align=urwid.CENTER), options) - RNS.Transport.request_path(announce[1]) - - confirmed_button = urwid.Button("Request keys", on_press=confirmed) - - dialog_pile = urwid.Pile([ - urwid.Text( - "The keys for the announced destination could not be recalled. " - "You can wait for an announce to arrive, or request the keys from the network.\n", - align=urwid.CENTER, - ), - urwid.Columns([ - (urwid.WEIGHT, 0.45, confirmed_button), - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.45, urwid.Button("Close", on_press=dismiss_dialog)), - ]) - ]) - - dialog = ListDialogLineBox( - dialog_pile, - title="Keys Unknown" - ) - confirmed_button.dialog_pile = dialog_pile - dialog.delegate = self.delegate.parent - bottom = self.delegate - - overlay = urwid.Overlay( - dialog, - bottom, - align=urwid.CENTER, - width=urwid.RELATIVE_100, - valign=urwid.MIDDLE, - height=urwid.PACK, - left=2, - right=2, - ) - - options = self.delegate.parent.left_pile.options(urwid.WEIGHT, 1) - self.delegate.parent.left_pile.contents[0] = (overlay, options) - 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 @@ -380,24 +285,11 @@ 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 = TabButton("Nodes", on_press=self.show_nodes_tab) - self.tab_peers = TabButton("Peers", on_press=self.show_peers_tab) - self.tab_pn = TabButton("Propagation Nodes", on_press=self.show_pn_tab) - - # 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, @@ -406,21 +298,15 @@ class AnnounceStream(urwid.WidgetWrap): #highlight_offFocus="list_off_focus" ) - # 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")) + self.display_widget = self.ilb + urwid.WidgetWrap.__init__(self, urwid.LineBox(self.display_widget, title="Announce Stream")) def keypress(self, size, key): if key == "up" and (self.no_content or self.ilb.first_item_is_selected()): - nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.focus_position = "header" + nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.set_focus("header") elif key == "ctrl x": self.delete_selected_entry() - + return super(AnnounceStream, self).keypress(size, key) def delete_selected_entry(self): @@ -435,45 +321,28 @@ 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: - 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) + 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: - nw = AnnounceStreamEntry(self.app, e, self) + nw = AnnounceStreamEntry(self.app, e) nw.timestamp = e[0] - self.widget_list.append(nw) + self.widget_list.insert(0, nw) if len(new_entries) > 0: self.no_content = False + if self.ilb != None: + self.ilb.set_body(self.widget_list) else: - self.no_content = True - self.widget_list = [urwid.Text(f"No {self.current_tab} announces", align='center')] + if len(self.widget_list) == 0: + self.no_content = True + + if self.ilb != None: + self.ilb.set_body(self.widget_list) - if self.ilb: - self.ilb.set_body(self.widget_list) - - def show_nodes_tab(self, button): - self.current_tab = "nodes" - self.update_widget_list() - - def show_peers_tab(self, button): - self.current_tab = "peers" - self.update_widget_list() - - def show_pn_tab(self, button): - self.current_tab = "pn" - self.update_widget_list() def list_selection(self, arg1, arg2): pass @@ -529,7 +398,7 @@ class ListDialogLineBox(urwid.LineBox): class KnownNodeInfo(urwid.WidgetWrap): def keypress(self, size, key): if key == "esc": - options = self.parent.left_pile.options(height_type=urwid.WEIGHT, height_amount=1) + options = self.parent.left_pile.options(height_type="weight", height_amount=1) self.parent.left_pile.contents[0] = (self.parent.known_nodes_display, options) else: return super(KnownNodeInfo, self).keypress(size, key) @@ -546,12 +415,6 @@ class KnownNodeInfo(urwid.WidgetWrap): trust_level = self.app.directory.trust_level(source_hash) trust_str = "" node_entry = self.app.directory.find(source_hash) - sort_str = self.app.directory.sort_rank(source_hash) - if sort_str == None: - sort_str = "None" - else: - sort_str = str(sort_str) - if node_entry == None: display_str = self.app.directory.simplest_display_str(source_hash) else: @@ -562,15 +425,13 @@ class KnownNodeInfo(urwid.WidgetWrap): if display_str == None: display_str = addr_str - pn_hash = RNS.Destination.hash_from_name_and_identity("lxmf.propagation", node_ident) - if node_ident != None: - lxmf_addr_str = g["sent"]+" LXMF Propagation Node Address is "+RNS.prettyhexrep(pn_hash) + lxmf_addr_str = g["sent"]+" LXMF Propagation Node Address is "+RNS.prettyhexrep(RNS.Destination.hash_from_name_and_identity("lxmf.propagation", node_ident)) else: lxmf_addr_str = "No associated Propagation Node known" - type_string = "Nomad Network Node " + g["node"] + type_string = "Node " + g["node"] if trust_level == DirectoryEntry.UNTRUSTED: trust_str = "Untrusted" @@ -612,7 +473,6 @@ class KnownNodeInfo(urwid.WidgetWrap): r_trusted = urwid.RadioButton(trust_button_group, "Trusted", state=trusted_selected) e_name = urwid.Edit(caption="Name : ",edit_text=display_str) - e_sort = urwid.Edit(caption="Sort Rank : ",edit_text=sort_str) node_ident = RNS.Identity.recall(source_hash) op_hash = None @@ -624,7 +484,7 @@ class KnownNodeInfo(urwid.WidgetWrap): op_str = "Unknown" def show_known_nodes(sender): - options = self.parent.left_pile.options(height_type=urwid.WEIGHT, height_amount=1) + options = self.parent.left_pile.options(height_type="weight", height_amount=1) self.parent.left_pile.contents[0] = (self.parent.known_nodes_display, options) def connect(sender): @@ -636,7 +496,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 @@ -659,57 +519,44 @@ class KnownNodeInfo(urwid.WidgetWrap): def ident_change(sender, userdata): pass - propagation_node_checkbox = urwid.CheckBox("Use as default propagation node", state=(self.app.get_user_selected_propagation_node() == pn_hash), on_state_change=pn_change) + propagation_node_checkbox = urwid.CheckBox("Use as default propagation node", state=(self.app.get_user_selected_propagation_node() == source_hash), on_state_change=pn_change) connect_identify_checkbox = urwid.CheckBox("Identify when connecting", state=self.app.directory.should_identify_on_connect(source_hash), on_state_change=ident_change) def save_node(sender): if self.pn_changed: if propagation_node_checkbox.get_state(): - self.app.set_user_selected_propagation_node(pn_hash) + self.app.set_user_selected_propagation_node(source_hash) else: self.app.set_user_selected_propagation_node(None) trust_level = DirectoryEntry.UNTRUSTED if r_unknown.get_state() == True: trust_level = DirectoryEntry.UNKNOWN - + if r_trusted.get_state() == True: trust_level = DirectoryEntry.TRUSTED display_str = e_name.get_edit_text() - sort_rank = e_sort.get_edit_text() - try: - if int(sort_rank) >= 0: - sort_rank = int(sort_rank) - else: - sort_rank = None - except: - sort_rank = None - node_entry = DirectoryEntry(source_hash, display_name=display_str, trust_level=trust_level, hosts_node=True, identify_on_connect=connect_identify_checkbox.get_state(), sort_rank=sort_rank) + node_entry = DirectoryEntry(source_hash, display_name=display_str, trust_level=trust_level, hosts_node=True, identify_on_connect=connect_identify_checkbox.get_state()) self.app.directory.remember(node_entry) self.app.ui.main_display.sub_displays.network_display.directory_change_callback() - - if trust_level == DirectoryEntry.TRUSTED: - self.app.autoselect_propagation_node() - show_known_nodes(None) - back_button = (urwid.WEIGHT, 0.2, urwid.Button("Back", on_press=show_known_nodes)) - connect_button = (urwid.WEIGHT, 0.2, urwid.Button("Connect", on_press=connect)) - save_button = (urwid.WEIGHT, 0.2, urwid.Button("Save", on_press=save_node)) - msg_button = (urwid.WEIGHT, 0.2, urwid.Button("Msg Op", on_press=msg_op)) - bdiv = (urwid.WEIGHT, 0.02, urwid.Text("")) + back_button = ("weight", 0.2, urwid.Button("Back", on_press=show_known_nodes)) + connect_button = ("weight", 0.2, urwid.Button("Connect", on_press=connect)) + save_button = ("weight", 0.2, urwid.Button("Save", on_press=save_node)) + msg_button = ("weight", 0.2, urwid.Button("Msg Op", on_press=msg_op)) + bdiv = ("weight", 0.02, urwid.Text("")) button_columns = urwid.Columns([back_button, bdiv, connect_button, bdiv, msg_button, bdiv, save_button]) pile_widgets = [ - urwid.Text("Type : "+type_string, align=urwid.LEFT), + urwid.Text("Type : "+type_string, align="left"), e_name, - urwid.Text("Node Addr : "+addr_str, align=urwid.LEFT), - e_sort, + urwid.Text("Node Addr : "+addr_str, align="left"), urwid.Divider(g["divider1"]), - urwid.Text(lxmf_addr_str, align=urwid.CENTER), + urwid.Text(lxmf_addr_str, align="center"), urwid.Divider(g["divider1"]), propagation_node_checkbox, connect_identify_checkbox, @@ -721,7 +568,7 @@ class KnownNodeInfo(urwid.WidgetWrap): button_columns ] - operator_entry = urwid.Text("Operator : "+op_str, align=urwid.LEFT) + operator_entry = urwid.Text("Operator : "+op_str, align="left") pile_widgets.insert(3, operator_entry) hops = RNS.Transport.hops_to(source_hash) @@ -735,18 +582,18 @@ class KnownNodeInfo(urwid.WidgetWrap): else: hops_str = "Unknown" - operator_entry = urwid.Text("Distance : "+hops_str, align=urwid.LEFT) + operator_entry = urwid.Text("Distance : "+hops_str, align="left") pile_widgets.insert(4, operator_entry) pile = urwid.Pile(pile_widgets) - + pile.focus_position = len(pile.contents)-1 button_columns.focus_position = 0 - self.display_widget = urwid.Filler(pile, valign=urwid.TOP, height=urwid.PACK) + self.display_widget = urwid.Filler(pile, valign="top", height="pack") - super().__init__(urwid.LineBox(self.display_widget, title="Node Info")) + urwid.WidgetWrap.__init__(self, urwid.LineBox(self.display_widget, title="Node Info")) # Yes, this is weird. There is a bug in Urwid/ILB that causes @@ -759,9 +606,9 @@ class ExceptionHandlingListBox(IndicativeListBox): except Exception as e: if key == "up": - nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.focus_position = "header" + nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.set_focus("header") elif key == "down": - nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.sub_displays.network_display.left_pile.focus_position = 1 + nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.sub_displays.network_display.left_pile.set_focus(1) else: RNS.log("An error occurred while processing an interface event. The contained exception was: "+str(e), RNS.LOG_ERROR) @@ -773,7 +620,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, @@ -788,26 +635,17 @@ class KnownNodes(urwid.WidgetWrap): else: self.no_content = True widget_style = "inactive_text" - self.pile = urwid.Pile([ - urwid.Text(("warning_text", g["info"]+"\n"), align=urwid.CENTER), - SelectText( - ( - "warning_text", - "Currently, no nodes are saved\n\nCtrl+L to view the announce stream\n\n", - ), - align=urwid.CENTER, - ), - ]) - self.display_widget = urwid.Filler(self.pile, valign=urwid.TOP, height=urwid.PACK) + self.pile = urwid.Pile([urwid.Text(("warning_text", g["info"]+"\n"), align="center"), SelectText(("warning_text", "Currently, no nodes are known\n\n"), align="center")]) + self.display_widget = urwid.Filler(self.pile, valign="top", height="pack") - super().__init__(urwid.AttrMap(urwid.LineBox(self.display_widget, title="Saved Nodes"), widget_style)) + urwid.WidgetWrap.__init__(self, urwid.AttrMap(urwid.LineBox(self.display_widget, title="Saved Nodes"), widget_style)) def keypress(self, size, key): if key == "up" and (self.no_content or self.ilb.first_item_is_selected()): - nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.focus_position = "header" + nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.set_focus("header") elif key == "ctrl x": self.delete_selected_entry() - + return super(KnownNodes, self).keypress(size, key) @@ -831,27 +669,27 @@ class KnownNodes(urwid.WidgetWrap): def show_info(sender): info_widget = KnownNodeInfo(source_hash) - options = parent.left_pile.options(height_type=urwid.WEIGHT, height_amount=1) + options = parent.left_pile.options(height_type="weight", height_amount=1) parent.left_pile.contents[0] = (info_widget, options) dialog = ListDialogLineBox( urwid.Pile([ - urwid.Text("Connect to node\n"+self.app.directory.simplest_display_str(source_hash)+"\n", align=urwid.CENTER), + urwid.Text("Connect to node\n"+self.app.directory.simplest_display_str(source_hash)+"\n", align="center"), urwid.Columns([ - (urwid.WEIGHT, 0.45, urwid.Button("Yes", on_press=confirmed)), - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.45, urwid.Button("No", on_press=dismiss_dialog)), - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.45, urwid.Button("Info", on_press=show_info))]) + ("weight", 0.45, urwid.Button("Yes", on_press=confirmed)), + ("weight", 0.1, urwid.Text("")), + ("weight", 0.45, urwid.Button("No", on_press=dismiss_dialog)), + ("weight", 0.1, urwid.Text("")), + ("weight", 0.45, urwid.Button("Info", on_press=show_info))]) ]), title="?" ) dialog.delegate = self.delegate bottom = self - overlay = urwid.Overlay(dialog, bottom, align=urwid.CENTER, width=urwid.RELATIVE_100, valign=urwid.MIDDLE, height=urwid.PACK, left=2, right=2) + overlay = urwid.Overlay(dialog, bottom, align="center", width=("relative", 100), valign="middle", height="pack", left=2, right=2) - options = self.delegate.left_pile.options(urwid.WEIGHT, 1) + options = self.delegate.left_pile.options("weight", 1) self.delegate.left_pile.contents[0] = (overlay, options) def delete_selected_entry(self): @@ -870,29 +708,16 @@ class KnownNodes(urwid.WidgetWrap): dialog = ListDialogLineBox( urwid.Pile([ - urwid.Text("Delete Node\n"+self.app.directory.simplest_display_str(source_hash)+"\n", align=urwid.CENTER), - urwid.Columns([ - (urwid.WEIGHT, 0.45, urwid.Button("Yes", on_press=confirmed)), - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.45, urwid.Button("No", on_press=dismiss_dialog)), - ]) + urwid.Text("Delete Node\n"+self.app.directory.simplest_display_str(source_hash)+"\n", align="center"), + urwid.Columns([("weight", 0.45, urwid.Button("Yes", on_press=confirmed)), ("weight", 0.1, urwid.Text("")), ("weight", 0.45, urwid.Button("No", on_press=dismiss_dialog))]) ]), title="?" ) dialog.delegate = self.delegate bottom = self - overlay = urwid.Overlay( - dialog, - bottom, - align=urwid.CENTER, - width=urwid.RELATIVE_100, - valign=urwid.MIDDLE, - height=urwid.PACK, - left=2, - right=2, - ) + overlay = urwid.Overlay(dialog, bottom, align="center", width=("relative", 100), valign="middle", height="pack", left=2, right=2) - options = self.delegate.left_pile.options(urwid.WEIGHT, 1) + options = self.delegate.left_pile.options("weight", 1) self.delegate.left_pile.contents[0] = (overlay, options) @@ -950,13 +775,13 @@ 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) self.display_widget = urwid.AttrMap(widget, style, focus_style) self.display_widget.source_hash = source_hash - super().__init__(self.display_widget) + urwid.WidgetWrap.__init__(self, self.display_widget) class AnnounceTime(urwid.WidgetWrap): @@ -967,7 +792,7 @@ class AnnounceTime(urwid.WidgetWrap): self.display_widget = urwid.Text("") self.update_time() - super().__init__(self.display_widget) + urwid.WidgetWrap.__init__(self, self.display_widget) def update_time(self): self.last_announce_string = "Never" @@ -999,7 +824,7 @@ class NodeAnnounceTime(urwid.WidgetWrap): self.display_widget = urwid.Text("") self.update_time() - super().__init__(self.display_widget) + urwid.WidgetWrap.__init__(self, self.display_widget) def update_time(self): self.last_announce_string = "Never" @@ -1030,14 +855,14 @@ class NodeActiveConnections(urwid.WidgetWrap): self.display_widget = urwid.Text("") self.update_stat() - super().__init__(self.display_widget) + urwid.WidgetWrap.__init__(self, self.display_widget) def update_stat(self): self.stat_string = "None" if self.app.node != None: self.stat_string = str(len(self.app.node.destination.links)) - self.display_widget.set_text("Connected Now : "+self.stat_string) + self.display_widget.set_text("Conneced Now : "+self.stat_string) def update_stat_callback(self, loop=None, user_data=None): self.update_stat() @@ -1061,16 +886,16 @@ class NodeStorageStats(urwid.WidgetWrap): self.display_widget = urwid.Text("") self.update_stat() - super().__init__(self.display_widget) + urwid.WidgetWrap.__init__(self, self.display_widget) def update_stat(self): self.stat_string = "None" - if self.app.node != None and not self.app.disable_propagation: + if self.app.node != None: limit = self.app.message_router.message_storage_limit used = self.app.message_router.message_storage_size() - if limit != None and used != None: + if limit != None: pct = round((used/limit)*100, 1) pct_str = str(pct)+"%, " limit_str = " of "+RNS.prettysize(limit) @@ -1104,7 +929,7 @@ class NodeTotalConnections(urwid.WidgetWrap): self.display_widget = urwid.Text("") self.update_stat() - super().__init__(self.display_widget) + urwid.WidgetWrap.__init__(self, self.display_widget) def update_stat(self): self.stat_string = "None" @@ -1136,7 +961,7 @@ class NodeTotalPages(urwid.WidgetWrap): self.display_widget = urwid.Text("") self.update_stat() - super().__init__(self.display_widget) + urwid.WidgetWrap.__init__(self, self.display_widget) def update_stat(self): self.stat_string = "None" @@ -1168,7 +993,7 @@ class NodeTotalFiles(urwid.WidgetWrap): self.display_widget = urwid.Text("") self.update_stat() - super().__init__(self.display_widget) + urwid.WidgetWrap.__init__(self, self.display_widget) def update_stat(self): self.stat_string = "None" @@ -1217,45 +1042,45 @@ class LocalPeer(urwid.WidgetWrap): dialog = DialogLineBox( urwid.Pile([ - urwid.Text("\n\n\nSaved\n\n", align=urwid.CENTER), + urwid.Text("\n\n\nSaved\n\n", align="center"), urwid.Button("OK", on_press=dismiss_dialog) ]), title=g["info"] ) dialog.delegate = self bottom = self - #overlay = urwid.Overlay(dialog, bottom, align=urwid.CENTER, width=urwid.RELATIVE_100, valign=urwid.MIDDLE, height=urwid.PACK, left=4, right=4) + #overlay = urwid.Overlay(dialog, bottom, align="center", width=("relative", 100), valign="middle", height="pack", left=4, right=4) overlay = dialog - options = self.parent.left_pile.options(height_type=urwid.PACK, height_amount=None) + options = self.parent.left_pile.options(height_type="pack", height_amount=None) self.dialog_open = True self.parent.left_pile.contents[1] = (overlay, options) def announce_query(sender): def dismiss_dialog(sender): self.dialog_open = False - options = self.parent.left_pile.options(height_type=urwid.PACK, height_amount=None) + options = self.parent.left_pile.options(height_type="pack", height_amount=None) self.parent.left_pile.contents[1] = (LocalPeer(self.app, self.parent), options) self.app.announce_now() dialog = DialogLineBox( urwid.Pile([ - urwid.Text("\n\n\nAnnounce Sent\n\n\n", align=urwid.CENTER), + urwid.Text("\n\n\nAnnounce Sent\n\n\n", align="center"), urwid.Button("OK", on_press=dismiss_dialog) ]), title=g["info"] ) dialog.delegate = self bottom = self - #overlay = urwid.Overlay(dialog, bottom, align=urwid.CENTER, width=urwid.RELATIVE_100, valign=urwid.MIDDLE, height=urwid.PACK, left=4, right=4) + #overlay = urwid.Overlay(dialog, bottom, align="center", width=("relative", 100), valign="middle", height="pack", left=4, right=4) overlay = dialog - + self.dialog_open = True - options = self.parent.left_pile.options(height_type=urwid.PACK, height_amount=None) + options = self.parent.left_pile.options(height_type="pack", height_amount=None) self.parent.left_pile.contents[1] = (overlay, options) def node_info_query(sender): - options = self.parent.left_pile.options(height_type=urwid.PACK, height_amount=None) + options = self.parent.left_pile.options(height_type="pack", height_amount=None) self.parent.left_pile.contents[1] = (self.parent.node_info_display, options) if LocalPeer.announce_timer == None: @@ -1266,7 +1091,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, @@ -1276,15 +1101,11 @@ class LocalPeer(urwid.WidgetWrap): self.t_last_announce, announce_button, urwid.Divider(g["divider1"]), - urwid.Columns([ - (urwid.WEIGHT, 0.45, urwid.Button("Save", on_press=save_query)), - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.45, urwid.Button("Node Info", on_press=node_info_query)), - ]) + urwid.Columns([("weight", 0.45, urwid.Button("Save", on_press=save_query)), ("weight", 0.1, urwid.Text("")), ("weight", 0.45, urwid.Button("Node Info", on_press=node_info_query))]) ] ) - super().__init__(urwid.LineBox(self.display_widget, title="Local Peer Info")) + urwid.WidgetWrap.__init__(self, urwid.LineBox(self.display_widget, title="Local Peer Info")) def start(self): self.t_last_announce.start() @@ -1308,15 +1129,15 @@ class NodeInfo(urwid.WidgetWrap): widget_style = "" def show_peer_info(sender): - options = self.parent.left_pile.options(height_type=urwid.PACK, height_amount=None) + options = self.parent.left_pile.options(height_type="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 = "" @@ -1332,25 +1153,25 @@ class NodeInfo(urwid.WidgetWrap): def announce_query(sender): def dismiss_dialog(sender): self.dialog_open = False - options = self.parent.left_pile.options(height_type=urwid.PACK, height_amount=None) + options = self.parent.left_pile.options(height_type="pack", height_amount=None) self.parent.left_pile.contents[1] = (NodeInfo(self.app, self.parent), options) self.app.node.announce() dialog = DialogLineBox( urwid.Pile([ - urwid.Text("\n\n\nAnnounce Sent\n\n", align=urwid.CENTER), + urwid.Text("\n\n\nAnnounce Sent\n\n", align="center"), urwid.Button("OK", on_press=dismiss_dialog) ]), title=g["info"] ) dialog.delegate = self bottom = self - #overlay = urwid.Overlay(dialog, bottom, align=urwid.CENTER, width=urwid.RELATIVE_100, valign=urwid.MIDDLE, height=urwid.PACK, left=4, right=4) + #overlay = urwid.Overlay(dialog, bottom, align="center", width=("relative", 100), valign="middle", height="pack", left=4, right=4) overlay = dialog - + self.dialog_open = True - options = self.parent.left_pile.options(height_type=urwid.PACK, height_amount=None) + options = self.parent.left_pile.options(height_type="pack", height_amount=None) self.parent.left_pile.contents[1] = (overlay, options) def connect_query(sender): @@ -1399,41 +1220,18 @@ class NodeInfo(urwid.WidgetWrap): self.t_total_files.update_stat() lxmf_addr_str = g["sent"]+" LXMF Propagation Node Address is "+RNS.prettyhexrep(RNS.Destination.hash_from_name_and_identity("lxmf.propagation", self.app.node.destination.identity)) - e_lxmf = urwid.Text(lxmf_addr_str, align=urwid.CENTER) + e_lxmf = urwid.Text(lxmf_addr_str, align="center") announce_button = urwid.Button("Announce", on_press=announce_query) connect_button = urwid.Button("Browse", on_press=connect_query) reset_button = urwid.Button("Rst Stats", on_press=stats_query) - if not self.app.disable_propagation: - pile = urwid.Pile([ - t_id, - e_name, - urwid.Divider(g["divider1"]), - e_lxmf, - urwid.Divider(g["divider1"]), - self.t_last_announce, - self.t_storage_stats, - self.t_active_links, - self.t_total_connections, - self.t_total_pages, - self.t_total_files, - urwid.Divider(g["divider1"]), - urwid.Columns([ - (urwid.WEIGHT, 5, urwid.Button("Back", on_press=show_peer_info)), - (urwid.WEIGHT, 0.5, urwid.Text("")), - (urwid.WEIGHT, 6, connect_button), - (urwid.WEIGHT, 0.5, urwid.Text("")), - (urwid.WEIGHT, 8, reset_button), - (urwid.WEIGHT, 0.5, urwid.Text("")), - (urwid.WEIGHT, 7, announce_button), - ]) - ]) - else: - pile = urwid.Pile([ + pile = urwid.Pile([ t_id, e_name, urwid.Divider(g["divider1"]), + e_lxmf, + urwid.Divider(g["divider1"]), self.t_last_announce, self.t_storage_stats, self.t_active_links, @@ -1442,25 +1240,25 @@ class NodeInfo(urwid.WidgetWrap): self.t_total_files, urwid.Divider(g["divider1"]), urwid.Columns([ - (urwid.WEIGHT, 5, urwid.Button("Back", on_press=show_peer_info)), - (urwid.WEIGHT, 0.5, urwid.Text("")), - (urwid.WEIGHT, 6, connect_button), - (urwid.WEIGHT, 0.5, urwid.Text("")), - (urwid.WEIGHT, 8, reset_button), - (urwid.WEIGHT, 0.5, urwid.Text("")), - (urwid.WEIGHT, 7, announce_button), + ("weight", 5, urwid.Button("Back", on_press=show_peer_info)), + ("weight", 0.5, urwid.Text("")), + ("weight", 6, connect_button), + ("weight", 0.5, urwid.Text("")), + ("weight", 8, reset_button), + ("weight", 0.5, urwid.Text("")), + ("weight", 7, announce_button), ]) ]) else: pile = urwid.Pile([ - urwid.Text("\n"+g["info"], align=urwid.CENTER), - urwid.Text("\nThis instance is not hosting a node\n\n", align=urwid.CENTER), - urwid.Padding(urwid.Button("Back", on_press=show_peer_info), urwid.CENTER, urwid.PACK) + urwid.Text("\n"+g["info"], align="center"), + urwid.Text("\nThis instance is not hosting a node\n\n", align="center"), + urwid.Padding(urwid.Button("Back", on_press=show_peer_info), "center", "pack") ]) self.display_widget = pile - super().__init__(urwid.AttrMap(urwid.LineBox(self.display_widget, title="Local Node Info"), widget_style)) + urwid.WidgetWrap.__init__(self, urwid.AttrMap(urwid.LineBox(self.display_widget, title="Local Node Info"), widget_style)) def start(self): if self.app.node != None: @@ -1483,7 +1281,7 @@ class UpdatingText(urwid.WidgetWrap): self.append_text = append_text self.update() - super().__init__(self.display_widget) + urwid.WidgetWrap.__init__(self, self.display_widget) def update(self): self.value = self.value_method() @@ -1525,7 +1323,7 @@ class NetworkStats(urwid.WidgetWrap): self.display_widget = urwid.LineBox(pile, title="Network Stats") - super().__init__(self.display_widget) + urwid.WidgetWrap.__init__(self, self.display_widget) def start(self): self.w_heard_peers.start() @@ -1577,9 +1375,9 @@ class NetworkDisplay(): self.list_display = 1 self.left_pile = NetworkLeftPile([ - (urwid.WEIGHT, 1, self.known_nodes_display), - # (urwid.PACK, self.network_stats_display), - (urwid.PACK, self.local_peer_display), + ("weight", 1, self.known_nodes_display), + # ("pack", self.network_stats_display), + ("pack", self.local_peer_display), ]) self.left_pile.parent = self @@ -1590,10 +1388,10 @@ class NetworkDisplay(): self.columns = urwid.Columns( [ - # (urwid.WEIGHT, NetworkDisplay.list_width, self.left_area), - # (urwid.WEIGHT, self.right_area_width, self.right_area) + # ("weight", NetworkDisplay.list_width, self.left_area), + # ("weight", self.right_area_width, self.right_area) (NetworkDisplay.given_list_width, self.left_area), - (urwid.WEIGHT, 1, self.right_area) + ("weight", 1, self.right_area) ], dividechars=0, focus_column=0 ) @@ -1603,11 +1401,11 @@ class NetworkDisplay(): def toggle_list(self): if self.list_display != 0: - options = self.left_pile.options(height_type=urwid.WEIGHT, height_amount=1) + options = self.left_pile.options(height_type="weight", height_amount=1) self.left_pile.contents[0] = (self.announce_stream_display, options) self.list_display = 0 else: - options = self.left_pile.options(height_type=urwid.WEIGHT, height_amount=1) + options = self.left_pile.options(height_type="weight", height_amount=1) self.left_pile.contents[0] = (self.known_nodes_display, options) self.list_display = 1 @@ -1622,7 +1420,7 @@ class NetworkDisplay(): self.widget.contents[0] = (self.left_area, options) def show_peers(self): - options = self.left_pile.options(height_type=urwid.WEIGHT, height_amount=1) + options = self.left_pile.options(height_type="weight", height_amount=1) self.left_pile.contents[0] = (self.lxmf_peers_display, options) if self.list_display != 0: @@ -1634,14 +1432,14 @@ 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 is not None: - selected_node_hash = selected_node_entry.base_widget.display_widget.source_hash - - if selected_node_hash is not None: + if selected_node_entry != None: + selected_node_hash = selected_node_entry._get_base_widget().display_widget.source_hash + + if selected_node_hash != None: info_widget = KnownNodeInfo(selected_node_hash) - options = parent.left_pile.options(height_type=urwid.WEIGHT, height_amount=1) + options = parent.left_pile.options(height_type="weight", height_amount=1) parent.left_pile.contents[0] = (info_widget, options) - + def focus_lists(self): self.columns.focus_position = 0 @@ -1652,28 +1450,26 @@ 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: - options = self.left_pile.options(height_type=urwid.WEIGHT, height_amount=1) + options = self.left_pile.options(height_type="weight", height_amount=1) self.left_pile.contents[0] = (self.announce_stream_display, options) else: - options = self.left_pile.options(height_type=urwid.WEIGHT, height_amount=1) + options = self.left_pile.options(height_type="weight", height_amount=1) self.left_pile.contents[0] = (self.known_nodes_display, options) def start(self): self.local_peer_display.start() self.node_info_display.start() self.network_stats_display.start() + # There seems to be an intermittent memory leak somewhere + # in the periodic updating here. The periodic updater should + # not be needed anymore, so dis + #self.announce_stream_display.start() def shortcuts(self): return self.shortcuts_display @@ -1710,26 +1506,17 @@ class LXMFPeers(urwid.WidgetWrap): else: self.no_content = True widget_style = "inactive_text" - self.pile = urwid.Pile([ - urwid.Text(("warning_text", g["info"]+"\n"), align=urwid.CENTER), - SelectText(("warning_text", "Currently, no LXMF nodes are peered\n\n"), align=urwid.CENTER), - ]) - self.display_widget = urwid.Filler(self.pile, valign=urwid.TOP, height=urwid.PACK) + self.pile = urwid.Pile([urwid.Text(("warning_text", g["info"]+"\n"), align="center"), SelectText(("warning_text", "Currently, no LXMF nodes are peered\n\n"), align="center")]) + self.display_widget = urwid.Filler(self.pile, valign="top", height="pack") - if hasattr(self, "peer_list") and self.peer_list: - pl = len(self.peer_list) - else: - pl = 0 - super().__init__(urwid.AttrMap(urwid.LineBox(self.display_widget, title=f"LXMF Propagation Peers ({pl})"), widget_style)) + urwid.WidgetWrap.__init__(self, urwid.AttrMap(urwid.LineBox(self.display_widget, title="LXMF Propagation Peers"), widget_style)) def keypress(self, size, key): if key == "up" and (self.no_content or self.ilb.first_item_is_selected()): - nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.focus_position = "header" + nomadnet.NomadNetworkApp.get_shared_instance().ui.main_display.frame.set_focus("header") elif key == "ctrl x": self.delete_selected_entry() - elif key == "ctrl r": - self.sync_selected_entry() - + return super(LXMFPeers, self).keypress(size, key) @@ -1744,48 +1531,6 @@ class LXMFPeers(urwid.WidgetWrap): self.delegate.reinit_lxmf_peers() self.delegate.show_peers() - def sync_selected_entry(self): - sync_grace = 10 - si = self.ilb.get_selected_item() - if si != None: - destination_hash = si.original_widget.destination_hash - if destination_hash in self.app.message_router.peers: - 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() - - time.sleep(0.25) - - def dismiss_dialog(sender): - self.close_list_dialogs() - - dialog = ListDialogLineBox( - urwid.Pile([ - urwid.Text("A delivery sync of all unhandled LXMs was manually requested for the selected node\n", align=urwid.CENTER), - urwid.Columns([ - (urwid.WEIGHT, 0.1, urwid.Text("")), - (urwid.WEIGHT, 0.45, urwid.Button("OK", on_press=dismiss_dialog)), - ]) - ]), - title="!", - - ) - dialog.delegate = self.delegate - bottom = self - - overlay = urwid.Overlay(dialog, bottom, align=urwid.CENTER, width=urwid.RELATIVE_100, valign=urwid.MIDDLE, height=urwid.PACK, left=2, right=2) - - options = self.delegate.left_pile.options(urwid.WEIGHT, 1) - self.delegate.left_pile.contents[0] = (overlay, options) - - - def close_list_dialogs(self): - self.delegate.reinit_lxmf_peers() - self.delegate.show_peers() def rebuild_widget_list(self): self.peer_list = self.app.message_router.peers @@ -1799,18 +1544,17 @@ 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].sync_transfer_rate), reverse=True) - for peer_id in sorted_peers: + for peer_id in self.peer_list: peer = self.peer_list[peer_id] - trust_level = self.app.directory.pn_trust_level(peer_id) - pe = LXMFPeerEntry(self.app, peer, self, trust_level) + pe = LXMFPeerEntry(self.app, peer, self) pe.destination_hash = peer.destination_hash widget_list.append(pe) + # TODO: Sort list return widget_list class LXMFPeerEntry(urwid.WidgetWrap): - def __init__(self, app, peer, delegate, trust_level): + def __init__(self, app, peer, delegate): destination_hash = peer.destination_hash self.app = app @@ -1818,44 +1562,22 @@ 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: - display_str = str(display_name)+"\n "+display_str + display_str += " "+str(display_name) sym = g["sent"] style = "list_unknown" focus_style = "list_focus" - alive_string = "Unknown" - if hasattr(peer, "alive"): - if peer.alive: - alive_string = "Available" - if trust_level == DirectoryEntry.TRUSTED: - style = "list_trusted" - focus_style = "list_focus_trusted" - else: - style = "list_normal" - focus_style = "list_focus" - else: - alive_string = "Unresponsive" - style = "list_unresponsive" - focus_style = "list_focus_unresponsive" + widget = ListEntry(sym+" "+display_str+"\n "+str(len(peer.unhandled_messages))+" unhandled LXMs - "+"Last heard "+pretty_date(int(peer.last_heard))) + # urwid.connect_signal(widget, "click", delegate.connect_node, node) - if peer.propagation_transfer_limit: - 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, {ar}% AR\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) + urwid.WidgetWrap.__init__(self, self.display_widget) def pretty_date(time=False): diff --git a/nomadnet/vendor/Scrollable.py b/nomadnet/vendor/Scrollable.py index eedb1ab..ee28a46 100644 --- a/nomadnet/vendor/Scrollable.py +++ b/nomadnet/vendor/Scrollable.py @@ -107,51 +107,6 @@ class Scrollable(urwid.WidgetDecoration): if canv_full.cursor is not None: # Full canvas contains the cursor, but scrolled out of view self._forward_keypress = False - - # Reset cursor position on page/up down scrolling - try: - if hasattr(ow, "automove_cursor_on_scroll") and ow.automove_cursor_on_scroll: - pwi = 0 - ch = 0 - last_hidden = False - first_visible = False - for w,o in ow.contents: - wcanv = w.render((maxcol,)) - wh = wcanv.rows() - if wh: - ch += wh - - if not last_hidden and ch >= self._trim_top: - last_hidden = True - - elif last_hidden: - if not first_visible: - first_visible = True - - if w.selectable(): - ow.focus_item = pwi - - st = None - nf = ow.get_focus() - if hasattr(nf, "key_timeout"): - st = nf - elif hasattr(nf, "original_widget"): - no = nf.original_widget - if hasattr(no, "original_widget"): - st = no.original_widget - else: - if hasattr(no, "key_timeout"): - st = no - - if st and hasattr(st, "key_timeout") and hasattr(st, "keypress") and callable(st.keypress): - st.keypress(None, None) - - break - - pwi += 1 - except Exception as e: - pass - else: # Original widget does not have a cursor, but may be selectable @@ -268,10 +223,10 @@ class Scrollable(urwid.WidgetDecoration): def _get_original_widget_size(self, size): ow = self._original_widget sizing = ow.sizing() - if FLOW in sizing: - return (size[0],) - elif FIXED in sizing: + if FIXED in sizing: return () + elif FLOW in sizing: + return (size[0],) def get_scrollpos(self, size=None, focus=False): """Current scrolling position diff --git a/nomadnet/vendor/additional_urwid_widgets/widgets/indicative_listbox.py b/nomadnet/vendor/additional_urwid_widgets/widgets/indicative_listbox.py index 9797319..d4f18dc 100644 --- a/nomadnet/vendor/additional_urwid_widgets/widgets/indicative_listbox.py +++ b/nomadnet/vendor/additional_urwid_widgets/widgets/indicative_listbox.py @@ -269,13 +269,11 @@ class IndicativeListBox(urwid.WidgetWrap): # mousewheel up elif button == 4.0: - # was_handeled = self._pass_key_to_contained_listbox(modified_size, "page up") - was_handeled = self._pass_key_to_contained_listbox(modified_size, "up") + was_handeled = self._pass_key_to_contained_listbox(modified_size, "page up") # mousewheel down elif button == 5.0: - # was_handeled = self._pass_key_to_contained_listbox(modified_size, "page down") - was_handeled = self._pass_key_to_contained_listbox(modified_size, "down") + was_handeled = self._pass_key_to_contained_listbox(modified_size, "page down") focus_position_after_input = self.get_selected_position() diff --git a/nomadnet/vendor/configobj.py b/nomadnet/vendor/configobj.py new file mode 100644 index 0000000..e0c01b6 --- /dev/null +++ b/nomadnet/vendor/configobj.py @@ -0,0 +1,2483 @@ +# 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""" diff --git a/nomadnet/vendor/quotes.py b/nomadnet/vendor/quotes.py index 4c87571..ee142f7 100644 --- a/nomadnet/vendor/quotes.py +++ b/nomadnet/vendor/quotes.py @@ -3,5 +3,4 @@ quotes = [ ("That's enough entropy for you my friend", "Unknown"), ("Any time two people connect online, it's financed by a third person who believes they can manipulate the first two", "Jaron Lanier"), ("The landscape of the future is set, but how one will march across it is not determined", "Terence McKenna") - ("Freedom originates in the division of power, despotism in its concentration.", "John Acton") ] \ No newline at end of file diff --git a/setup.py b/setup.py index f31b01a..46bf51d 100644 --- a/setup.py +++ b/setup.py @@ -5,12 +5,6 @@ exec(open("nomadnet/_version.py", "r").read()) with open("README.md", "r") as fh: long_description = fh.read() -package_data = { -"": [ - "examples/messageboard/*", - ] -} - setuptools.setup( name="nomadnet", version=__version__, @@ -21,7 +15,6 @@ setuptools.setup( long_description_content_type="text/markdown", url="https://github.com/markqvist/nomadnet", packages=setuptools.find_packages(), - package_data=package_data, classifiers=[ "Programming Language :: Python :: 3", "License :: OSI Approved :: MIT License", @@ -30,6 +23,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"], - python_requires=">=3.7", + install_requires=['rns>=0.3.12', 'lxmf>=0.1.8', 'urwid>=2.1.2'], + python_requires='>=3.6', )