Removed old scripts

+ Added SIGUSR1 handler to dump stacktrace of all active threads

.dockerignore

@@ -1,3 +1,6 @@
 onionr/data/**/*
 onionr/data
 MY-RUN.sh
+Dockerfile
+.dockerignore
+.git

.env

@@ -1 +1 @@
-PYTHONPATH=./venv/bin/python3.8
+PYTHONPATH=./venv/bin/python310:./src/

.gitignore

@@ -17,7 +17,7 @@ daemon-true.txt
 .vscode/tags
 .vscode/settings.json
 
-venv/*
+venv*
 src/fs*
 src/tmp/*
 testdata/*

AUTHORS.MD

@@ -1,12 +0,0 @@
-# Incomplete List of Contributors
-
-Onionr is created by a team of hard working volunteers.
-
-In no order of importance, these people make Onionr happen:
-
-* [Beardog (Kevin Froman)](https://www.chaoswebs.net/) - Project founder, owner and core developer
-* [InvisaMage](https://invisamage.com/) - Web UI Bulma design
-* [Arinerron](https://arinerron.com/) - Logger and config modules, testing and other contributions
-* [Anhar Ismail](https://github.com/anharismail) - Created Onionr's logo
-
-+ Other contributors and testers

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [8.0.1] - 2020-12-22
+
+* Fix subprocess in 3.9x with dumb hack
+* Dependency bumps
 
 ## [8.0.0] - 2020-12-04
 

Dockerfile

@@ -1,12 +1,12 @@
-FROM python:3.7
+FROM python:3.10
+EXPOSE 8080
 
 USER root
 
 RUN mkdir /app
 WORKDIR /app
 
-ENV PORT=8080
-EXPOSE 8080
+ENV ONIONR_DOCKER=true
 
 #Install needed packages
 RUN apt-get update && apt-get install -y tor locales
@@ -15,7 +15,7 @@ RUN sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen && \
     locale-gen
 ENV LANG=en_US.UTF-8 LANGUAGE=en_US:en LC_ALL=en_US.UTF-8
 
-ADD ./requirements.txt /app/requirements.txt
+ADD ./requirements-x86-all-plugins.txt /app/requirements.txt
 RUN pip3 install --require-hashes -r requirements.txt
 
 #Add Onionr source
@@ -26,5 +26,6 @@ VOLUME /app/data/
 #Default to running as nonprivileged user
 RUN chmod g=u -R /app
 USER 1000
+ENV HOME=/app
 
-CMD ["bash", "./onionr.sh"]
+CMD ["bash", "./onionr.sh", "start"]

ISSUE_TEMPLATE.md

@@ -5,8 +5,9 @@
 # Steps to Reproduce
 
 # Version Information
-Onionr: 
-OS: 
-Python: 
-Tor: 
-I2P: 
+
+* Onionr: 
+* OS: 
+* Python: 
+* Tor: 
+* CPU:

README.md

@@ -8,92 +8,73 @@
     Privacy Respecting Communication Network 📡
 </p>
 <p align="center">
-    Anonymous social platform, mail, file sharing.
+    WIP anonymous social platform, mail, file sharing and marketplace
 </p>
 
-<img src='https://img.shields.io/github/license/beardog108/onionr'> <img src="https://img.shields.io/github/repo-size/beardog108/onionr"> <img src='https://img.shields.io/badge/python%20version%20%F0%9F%90%8D-3.7+-blue'> <img src='https://img.shields.io/github/commit-activity/m/beardog108/onionr'>
+<img src="https://img.shields.io/badge/License-aGPLv3-yellow"> <img src='https://img.shields.io/badge/python%20version%20%F0%9F%90%8D-3.10+-blue'>
 
-<a href='https://www.reddit.com/r/onionr'><img src = 'https://img.shields.io/reddit/subreddit-subscribers/onionr?style=social'></a> <a href='https://twitter.com/onionrnet'><img src='https://img.shields.io/twitter/follow/onionrnet?style=social'></a>
+<a href='https://twitter.com/onionrnet'><img src='https://img.shields.io/twitter/follow/onionrnet?style=social'></a> - [Discord](https://discord.gg/DVF2bEAzrt) - Matrix: #onionr:amorgan.xyz
 
 |                                      |                            |                            |
 | -----------                          | -----------                | -----------                |
 | [Install](#install-and-run-on-linux) | [Features](#main-features) | [Screenshots](#screenshots)|
-| [Docs](#documentation)/[web copy](https://beardog108.github.io/onionr/)               | [Get involved](#help-out)  | [Onionr.net](https://onionr.net/)/[.onion](http://onionrbak72t5zhbzuey2fdkpczlvhowgcpqc6uoyrd3uxztzxwz5cyd.onion/)                  |
+| [Docs](#documentation)               | [Get involved](#help-out)  | [Onionr.net](https://onionr.net/)/[.onion](http://onionrbak72t5zhbzuey2fdkpczlvhowgcpqc6uoyrd3uxztzxwz5cyd.onion/)                  |
 
 
-<hr>
+---
 
-**The main repository for this software is at https://git.VoidNet.tech/kev/onionr/**
+**The main repository for this software is at https://gitlab.com/beardog/onionr/**
 
-Mirrors: [Github](https://github.com/beardog108/onionr), [Gitlab](https://gitlab.com/beardog/onionr)
+***Note that this README reflects the state of the rewrite, and not the original alpha network***
+
+Mirrors [Gitea](https://git.voidnet.tech/kev/onionr)
 
 
 Onionr ("Onion Relay") is a decentralized/distributed peer-to-peer communication network, designed to be anonymous and resistant to (meta)data analysis, spam, and corruption.
 
-Onionr stores data in independent packages referred to as 'blocks'. The blocks are distributed to all interested nodes. Blocks and user IDs cannot be easily proven to have been created by a particular user. Even if there is enough evidence to believe that a specific user created a block, nodes still operate behind Tor and as such cannot be trivially unmasked. Anonymity is achieved by a stateless network, with no given indication of what node a block originates from. In fact, since one is not required to participate in routing or storage to insert a message, blocks often do not originate from any identifiable node.
-
-Through message mixing and key privacy, it is intended to be nigh impossible to discover the identity of a message creator or recipient. Via long-term traffic analysis, a well funded adversary may discover the most probable node(s) to be creating a set of related blocks, however doing so would only lead them to a node behind Tor. As the first node that a block appears on is almost always not the creator of the block, there is plausible deniability regarding the true creator of the block.
-
 Onionr gives the individual the ability to speak freely, without fear of surveillance and censorship.
 
+---
+
+# Onionr internals
+
+## Blocks
+
+At the core, Onionr is an anonymous Distributed Hash Table (DHT) syncing prepackaged blocks using a simple Gossip protocol with Dandelion++ as an overlay network on top of Tor and I2P.
+
+Onionr stores data in independent packages referred to as 'blocks'. The blocks are distributed to all nodes, but are not required to be stored. Blocks and user IDs cannot be easily proven to have been created by a particular user. Even if Dandelion++ is defeated and there is enough evidence to believe that a specific node is linked to a block's creation, nodes still operate behind Tor or I2P and as such cannot be trivially unmasked. Anonymity is achieved by a stateless network, with no given indication of what node a block originates from. In fact, since one is not required to participate in routing or storage to insert a message, blocks often do not originate from any identifiable node, similar to how Bitcoin transactions do not necessarily originate from a wallet directly associated with a node.
+
+## Onionr Gossip
+
+Onionr works via epidemic/gossip style routing, with message delivery taking roughly log<sub>C</sub>(N) cycles where C is the number of nodes to send a message to each cycle and N is the number of connected nodes. So a network of 100 million nodes can deliver messages in a few minutes even with high packet loss and malfunctioning nodes.
+
+Through Dandelion++ message forwarding and key privacy, it is intended to be nigh impossible to discover the identity of a message creator or recipient. Via long-term traffic analysis, a well funded adversary may discover the most probable node(s) to be creating a set of related blocks, however doing so would only lead them to a node behind Tor. As the first node that a block appears on is almost always not the creator of the block, there is plausible deniability regarding the true creator of the block.
+
 Users are identified by ed25519/curve25519 public keys, which can be used to sign blocks or send encrypted data.
 
 Onionr can be used for mail, as a social network, instant messenger, file sharing software, or for encrypted group discussion.
 
-Due to the nature of anonymity, the graph as implemented in this reference network is dense, undirected, cyclic and can be disconnected. As a result, current scalability is poor but sufficient for high latency communications. As the need arises isolated stream solutions may be implemented (in a manner similar to described in the Bitmessage whitepaper). Since Onionr is technically just a data format, any routing scheme can be used to pass messages.
+Since Onionr is technically just a data format, any routing scheme can  technically be used to pass messages.
 
 The whitepaper is available [here](docs/whitepaper.md).
 
-## Main Features
+---
+
+# Main Features
 
 * [X] 🌐 Fully p2p/decentralized, no trackers or other single points of failure
-* [X] 🔒 End to end encryption of user data
-* [X] 📢 Optional non-encrypted blocks, useful for blog posts or public file sharing
-* [X] 💻 Easy HTTP API for integration to websites
 * [X] 🕵️ Metadata analysis resistance and anonymity
 * [X] 📡 Transport agnosticism (no internet required)
 
-Onionr ships with various application plugins ready for use out of the box:
 
-Currently usable:
+# Roadmap
 
-* Mail
-* Public anonymous chat/message board
-* Simple webpage hosting - Will be greatly extended
-* File sharing (Work in progress)
-
-Not yet usable:
-
-* Instant messaging
-
-
-
-## Watch the talk from BSidesPDX 2019
-
-<a href="https://www.youtube.com/watch?v=mrULtmSkKxg">
-<img src="docs/talk.png" alt="improving anonymous networking talk link" width="600">
-</a>
-
-# Screenshots
-
-<img alt='Node statistics page screenshot' src='docs/onionr-1.png' width=600>
-
-Home screen
-
-<img alt='Friend/contact manager screenshot' src='docs/onionr-2.png' width=600>
-
-Friend/contact manager
-
-<img alt='Encrypted, metadata-masking mail application screenshot' src='docs/onionr-3.png' width=600>
-
-Encrypted, metadata-masking mail application. One of the first distributed mail systems to have basic forward secrecy.
+See [ROADMAP.md](ROADMAP.md)
 
 # Documentation
 
 More docs coming soon.
 
-* [Block specification](docs/dev/specs/block-spec.md)
-* [HTTP API](docs/dev/http-api.md)
 
 # Install and Run on Linux
 
@@ -103,25 +84,27 @@ Master may be unstable, you should use the latest release tag. (checkout via git
 
 `$ sudo apt install python3-pip python3-dev tor`
 
-* Have python3.7+, python3-pip, Tor (daemon, not browser) installed. python3-dev is recommended.
+* Have python3.10, python3-pip, Tor (daemon, not browser) installed. python3-dev is recommended.
+* You may need build-essentials or the equivalent of your platform
 * Clone the git repo: `$ git clone https://gitlab.com/beardog/onionr --tags`
 * cd into install direction: `$ cd onionr/`
-* Install the Python dependencies ([virtualenv strongly recommended](https://virtualenv.pypa.io/en/stable/userguide/)): `$ pip3 install --require-hashes -r requirements.txt`
-* (Optional): Install desktop notification dependencies: `$ pip3 install --require-hashes -r requirements-notifications.txt`
+* Install the Python dependencies ([virtualenv strongly recommended](https://virtualenv.pypa.io/en/stable/userguide/)): `$ pip3 install --require-hashes -r requirements-x86-all-plugins.txt`
 
-(--require-hashes is intended to prevent exploitation via compromise of PyPi/CA certificates)
+Require-hashes is suggested for supply-chain security but is optional. The hashes are not correct for ARM machines. If you are just running a node or want a bare-bones install you can use requirements-base-x86.txt and selectively install the requirements.txt files in static-data/official-plugins/ subdirectories
 
 ## Run Onionr
 
 * Run Onionr normally:  `$ ./onionr.sh start`
 * Run Onionr in background as daemon: `$ ./start-daemon.sh`
-* Open Onionr web interface  `$ ./onionr.sh openhome`
 * Gracefully stop Onionr from CLI `$ ./onionr.sh stop`
 
 
-# Contact
+# Contact/Community
 
-Email: beardog [ at ] mailbox.org
+* Email: onionr [ at ] voidnet.tech
+* Twitter: [@onionrnet](https://twitter.com/onionrnet)
+* Matrix: #onionr:amorgan.xyz
+* Discord: https://discord.gg/DVF2bEAzrt (Discord is bad for freedom and privacy, this is only provided for convenience)
 
 # Help out
 
@@ -130,7 +113,7 @@ Everyone is welcome to contribute. Help is wanted for the following:
 * Development (Get in touch first)
     * Creation of a shared lib for use from other languages and faster proof-of-work
     * Android and IOS development
-    * Mac support (already partially supported, testers needed)
+    * Mac support (testers needed)
     * Bug fixes and development of new features
 * Testing
 * Translations/localizations
@@ -139,6 +122,12 @@ Everyone is welcome to contribute. Help is wanted for the following:
 * Security review/audit
 * I2P support
 
+## Watch the talk from BSidesPDX 2019
+
+<a href="https://www.youtube.com/watch?v=mrULtmSkKxg">
+<img src="docs/talk.png" alt="improving anonymous networking talk link" width="600">
+</a>
+
 ## Contribute money:
 
 Donating at least $3 gets you cool Onionr stickers. Get in touch if you want them.
@@ -146,13 +135,15 @@ Donating at least $3 gets you cool Onionr stickers. Get in touch if you want the
 ![sticker](docs/sticker.png)
 
 
-Bitcoin: [1onion55FXzm6h8KQw3zFw2igpHcV7LPq](bitcoin:1onion55FXzm6h8KQw3zFw2igpHcV7LPq) (Contact us for a unique address or for other coins)
+* Bitcoin: [bc1qpayme9rlpkch0qp3r79lvm5racr7t6llauwfmg](bitcoin:bc1qpayme9rlpkch0qp3r79lvm5racr7t6llauwfmg) (Contact us for a unique address or for other coins)
 
-Monero: 4B5BA24d1P3R5aWEpkGY5TP7buJJcn2aSGBVRQCHhpiahxeB4aWsu15XwmuTjC6VF62NApZeJGTS248RMVECP8aW73Uj2ax
+* Monero: 4B5BA24d1P3R5aWEpkGY5TP7buJJcn2aSGBVRQCHhpiahxeB4aWsu15XwmuTjC6VF62NApZeJGTS248RMVECP8aW73Uj2ax
 
-USD (Card/Paypal): [Ko-Fi](https://www.ko-fi.com/beardogkf)
+* USD (Card/Paypal (no account required)): [Ko-Fi](https://www.ko-fi.com/beardogkf)
 
-Note: probably not tax deductible
+* Sign up for [privacy.com (refferal link)](https://privacy.com/join/FNNDF) to protect your personal information when contributing or shopping elsewhere, we both get $5 USD.
+
+Note: not tax deductible
 
 # Security
 

ROADMAP.md

@@ -0,0 +1,46 @@
+# Onionr Roadmap
+
+
+## Taraxacum Release (9.0)
+
+
+* [ X ] Implement new block format with verifiable delay function
+
+* [ X ] Implement overhauled gossip system with dandelion++
+
+    The new system is separated from the underlying networks used and makes it much easier to implement new transport methods. Dandelion++ is also better than the old block mixing we did.
+
+
+## Misc
+
+* [  ] Spruce up documentation
+* [  ] Restore LAN transport
+* [  ] Restore webUI as a plugin
+* [  ] Restore static site/file sharing plugin
+* [  ] Restore/reimplement mail plugin
+* [  ] Restore/reimplement friends plugin
+* [  ] Refresh test suite
+* [  ] Revamped key/encrypted messaging (encrypted blocks)
+
+
+
+## Web of trust release (~10.0)
+
+To facilitate the below market plugin/application, Onionr will need a web of trust system.
+
+* [ ] Web of trust plugin or module
+
+
+## Market Plugin Release (~10.1)
+
+The Onionr team believes the Monero community is currently lacking a good p2p market, and as such we hope to build a solution using Onionr as a transport. This may be a separate project and as opposed to a plugin.
+
+
+* A new marketplace plugin will be developed with the following *tenative* features:
+
+* [ ] Account management
+* [ ] Monero management
+* [ ] Store front discovery and search
+* [ ] Product listing search
+* [ ] User reviews
+

base-requirements.in

@@ -0,0 +1,8 @@
+PyNaCl==1.5.0
+psutil==5.9.1
+filenuke==0.0.0
+ujson==5.4.0
+cffi==1.15.1
+onionrblocks==7.0.0
+ordered-set==4.1.0
+json-rpc==1.13.0

docs/TODO.txt

@@ -1,18 +0,0 @@
-* add GUI config editor
-* add multi-device forward secrecy
-
-* document anonymity & security theory
-* document usage
-
-* ensure accessibility for Onionr web UI
-* make forward secrecy compatible with multiple devices
-* add way to mark key as dead
-* add hashable set password for web ui
-* add edits to circles posts
-* make node "speed" setting such as when ui is open to reduce bandwidth usage
-* localization support
-
-* add BCC support to mail
-
-
-* truncate last N blocks when sharing list

docs/dev/generating-requirements.txt.md

@@ -0,0 +1,19 @@
+# Generating requirements.txt
+
+To generate a requirements.txt file, install pip-tools from pip
+
+Onionr requirements files should have hashes to prevent backdooring by the pypi server.
+
+Put your package versions in requirements.in like normal. Child dependencies are usually not necessary:
+
+```
+requests==0.1.1
+flask==0.1.1
+```
+
+Then generate the requirements.txt:
+
+`$ pip-compile requirements.in --generate-hashes -o requirements.txt`
+
+
+Your requirements.txt will have hash-pinned requirements of all dependencies and child dependencies.

docs/dev/http-api.md

@@ -1,124 +0,0 @@
-# Onionr HTTP API
-
-All HTTP interfaces in the Onionr reference client use the [Flask](http://flask.pocoo.org/) web framework with the [gevent](http://www.gevent.org/) WSGI server.
-
-## Client & Public difference
-
-The client API server is a locked down interface intended for authenticated local communication.
-
-The public API server is available only remotely from Tor & I2P. It is the interface in which peers use to communicate with one another.
-
-# Client API
-
-Please note: endpoints that simply provide static web app files are not documented here.
-
-* /serviceactive/pubkey
-    - Methods: GET
-    - Returns true or false based on if a given public key has an active direct connection service.
-* /queueResponseAdd/key (DEPRECATED)
-    - Methods: POST
-    - Accepts form key 'data' to set queue response information from a plugin
-    - Returns success if no error occurs
-* /queueResponse/key (DEPRECATED)
-    - Methods: GET
-    - Returns the queue response for a key. Returns failure with a 404 code if a code is not set.
-* /ping
-    - Methods: GET
-    - Returns "pong!"
-* /getblocksbytype/type
-    - Methods: GET
-    - Returns a list of stored blocks by a given type
-* /getblockbody/hash
-    - Methods: GET
-    - Returns the main data section of a block
-* /getblockdata/hash
-    - Methods: GET
-    - Returns the entire data contents of a block, including metadata.
-* /getblockheader/hash
-    - Methods: GET
-    - Returns the header (metadata section) of a block.
-* /gethidden/
-    - Methods: GET
-    - Returns line separated list of hidden blocks
-* /hitcount
-    - Methods: GET
-    - Return the amount of requests the public api server has received this session
-* /lastconnect
-    - Methods: GET
-    - Returns the epoch timestamp of when the last incoming connection to the public API server was logged
-* /site/hash
-    - Methods: GET
-    - Returns HTML content out of a block
-* /waitforshare/hash
-    - Methods: POST
-    - Prevents the public API server from listing or sharing a block until it has been uploaded to at least 1 peer.
-* /shutdown
-    - Methods: GET
-    - Shutdown Onionr. You should probably use /shutdownclean instead.
-* /shutdownclean
-    - Methods: GET
-    - Tells the communicator daemon to shutdown Onionr. Slower but cleaner.
-* /getstats
-    - Methods: GET
-    - Returns some JSON serialized statistics
-* /getuptime
-    - Methods: GET
-    - Returns uptime in seconds
-* /getActivePubkey
-    - Methods: GET
-    - Returns the current active public key in base32 format
-* /getHumanReadable/pubkey
-    - Methods: GET
-    - Echos the specified public key in mnemonic format
-* /insertblock
-    - Methods: POST
-    - Accepts JSON data for creating a new block. 'message' contains the block data, 'to' specifies the peer's public key to encrypt the data to, 'sign' is a boolean for signing the message.
-* /torready
-    - Methods: POST
-    - Returns boolean if Tor is started or not
-
-# Public API
-
-v0
-
-* /
-    - Methods: GET
-    - Returns a basic HTML informational banner describing Onionr.
-* /getblocklist
-    - Methods: GET
-    - URI Parameters:
-        - date: unix epoch timestamp for offset
-    - Returns a list of block hashes stored on the node since an offset (all blocks if no timestamp is specified)
-* /getdata/block-hash
-    - Methods: GET
-    - Returns data for a block based on a provided hash
-* /www/file-path
-    - Methods: GET
-    - Returns file data. Intended for manually sharing file data directly from an Onionr node.
-* /ping
-    - Methods: GET
-    - Returns 'pong!'
-* /pex
-    - Methods: GET
-    - Returns a list of peer addresses reached within recent time
-* /announce
-    - Methods: POST
-    - Accepts form data for 'node' (valid node address) and 'random' which is a nonce when hashed (blake2b_256) in the format `hash(peerAddress+serverAddress+nonce)`, begins with at least 5 zeros.
-    - Returns 200 with 'Success' if no error occurs. If the post is invalid, 'failure' with code 406 is returned.
-* /upload
-    - Methods: POST
-    - Accepts form data for 'block' as a 'file' upload.
-    - Returns 200 with 'success' if no error occurs. If the block cannot be accepted, 'failure' with 400 is returned.
-
-# Direct Connection API
-
-These are constant endpoints available on direct connection servers. Plugin endpoints for direct connections are not documented here.
-
-* /ping
-    - Methods: GET
-    - Returns 200 with 'pong!'
-
-* /close
-    - Methods: GET
-    - Kills the direct connection server, destroying the onion address.
-    - Returns 200 with 'goodbye'

docs/dev/running-tests.md

@@ -0,0 +1,44 @@
+# Running Onionr tests
+
+Onionr has four types of tests:
+
+* unittests
+* integration tests
+* selenium tests (web tests)
+* runtime-tests
+
+
+## unittests
+
+Onionr uses Python's built in unittest module. These tests are located in tests/ (top level)
+
+Run all tests with `$ make test`, which will also run integration tests.
+
+Please note that one unittest tests if runtime-tests have passed recently. This is simply a forceful reminder to run those tests as well.
+
+You can also run a single unittest in a loop by using the script scripts/run-unit-test-by-name.py
+
+## integration tests
+
+These tests are pretty basic and test on stdout of Onionr commands.
+
+They are also run from `$ make test`
+
+The runtime-tests do most of the actual integration testing.
+
+## selenium tests
+
+These are browser automation tests to test if the UI is working as how it should for a user.
+
+There's only a couple and they're incomplete, so they can be ignored for now (test manually)
+
+## runtime-tests
+
+These are important. They look into the Onionr client Flask app when Onionr daemon is running and test a bunch of things.
+
+If you do it a lot you should make your own Onionr network (disable official bootstrap)
+
+You run this while the daemon is running (probably should make sure onboarding is done), with `$ onionr.sh runtime-test`
+
+It's necessary to do this before running `$ make test` for unittesting
+

docs/dev/security-mechanisms.md

@@ -0,0 +1,43 @@
+# Onionr Security Mechanisms
+
+
+## bigbrother 👁️
+
+Bigbrother is a cheeky module that uses Python3.8+ sys auditing events to log and/or block certain sensitive events.
+
+It has a little overhead, so one can disable it in config in general.security_auditing
+
+[ChaosWebs.net/blog/preventing-arbitrary-code-execution-in-python38-with-auditing.html](https://chaoswebs.net/blog/preventing-arbitrary-code-execution-in-python38-with-auditing.html)
+
+### Threat model
+
+It is intended to log bugs leaking private file system information, block+log network leaks, and block+log eval-like arbitrary code execution. It is not intended to block malicious browser scripts or malicious Python plugins. It cannot work with subprocesses that do not activate the module.
+
+It's not intended to be bulletproof by any means, but it helps.
+
+### What big brother does
+
+* Disk access checks for disk access outside. Only logs, does not block
+* Network leaks. (Non Tor/LAN) Blocks and logs
+* Arbitrary code execution: logs and blocks non-whitelisted bytecode importing/compiling and subprocesses.
+
+
+## Sybil attacks
+
+As with any decentralized network, sybil nodes could collude to spy or cause mayhem. Due to the gossip nature of Onionr, sybil nodes would have a hard time fully stopping the network. In terms of spying, they could not conclusively prove the origin of messages due to the multiple transport nature of the network and layering behind Tor/etc.
+
+## Tor configuration
+
+When managed by Onionr, Tor has a control port password that gets stored in Onionr config.
+
+Tor is also configured to reject requests to non-onion services, which helps to stop redirect based denial of service attacks.
+
+## Web security
+
+Onionr secures both it's main web APIs with anti-dns-rebinding logic, which validates the host header used in connections to it. This is to prevent exfiltration of data and side channel deanonymization.
+
+Onionr secures the client API with a token that must be passed in most requests, with the exception of static API files. This is to prevent CSRF and side channel deanonymization.
+
+Onionr binds most services to random loopback addresses to reduce all cross-site web attacks, including discovery of Onionr on a computer from a normal website. This is not supported on Mac because Mac does not support non 'typical' loopback addresses.
+
+Onionr has a strict content-security-policy, rejecting all non-localhost requests and denying inline scripts and similar insecure sources.

docs/dev/selected-papers.md

@@ -0,0 +1,9 @@
+# Interesting papers related to Onionr development
+
+A paper being listed here is not end-all-be-all endorsement of every detail inside.
+
+* [Epidemic Routing for Partially-Connected Ad Hoc Networks](https://web.archive.org/web/20200208074703/http://issg.cs.duke.edu/epidemic/epidemic.pdf)
+* [Freenet: A distibuted decentralized information storage and retrieval system](https://freenetproject.org/assets/papers/ddisrs.pdf)
+* [Protecting Free Expression Online with Freenet](https://freenetproject.org/assets/papers/ddisrs.pdf)
+* [Bitmessage: A Peer‐to‐Peer Message Authentication and Delivery System](https://archive.org/details/BitmessageWhitepaper/)
+* [MuON: Epidemic based Mutual Anonymity](https://web.archive.org/web/20060901153544/http://www.csl.mtu.edu/cs6461/www/Reading/MuON_ICNP2005.pdf)

docs/dev/setup.md

@@ -1,13 +1,72 @@
+<h1 align="center">Onionr Developer Guide</h1>
+
 This page assumes that Onionr is already installed and normal user requirements are setup.
 
 The Onionr development environment is simple. All one really needs is a supported Python version (currently 3.7-3.8 as of writing).
 
 There are additional requirements specified in requirements-dev.txt
 
-Intended to be used from VSCode, there are scripts in scripts/ named enable/disable-dev-config.py.
+**Developers agree to the [CoC](../../CODE_OF_CONDUCT.md) and to contribute new code under GPLv3 or later**. Developers should stick to PEP8 in most cases, and write unittests or integration tests where possible.
+
+## Developer Scripts
+
+run-onionr-node.py can be used to start a node with specific parameters
+
+Intended to be used from VSCode (but could work otherwise), there are scripts in scripts/ named enable/disable-dev-config.py.
 These make modifications to the default config for the purpose of making testing Onionr nodes easier.
 Be sure to disable it again before pushing work.
 
-Generally, one should disable bootstrap list usage when making non trivial changes. This is a config option: general.use_bootstrap_list.
+There are also scripts to generate new tests.
+
+*When adjusting PoW, it will make your node not compatible with the existing network*
+
+Generally, one should disable bootstrap list usage when testing non trivial changes. This is a config option: general.use_bootstrap_list. and can be configured through enable-dev-config.py and run-onionr-node.py
+
+
+# Current state of Onionr [2021-01-14]
+
+Onionr in it's current form is functional, albeit buggy.
+
+
+## Current major components
+
+Onionr runs via two main HTTP gevent servers serving Flask apps.
+
+Dir: apiservers
+
+* 1 Parent app hosts all public API endpoints for the Tor transport.
+* 1 Parent app hosts all UI-related files and endpoints. Some commands and internal modules interact with this API as well
+* The HTTP servers have strict anti-dns-rebinding and CSRF countermeasures, so there is a script to craft requests to the UI-related API in scripts/
+* Block storage is currently handled via metadata in sqlite (mostly defunct now), and block data storage in a different database. This is in blocks/ in running Onionr daemon data directory
+* cryptography is currently handled in onionrcrypto/ except for ephemeral messages which are handled by onionr
+* Transport clients run from looping threads mostly created in communicator/__init__.py, this includes block lookups and uploading on the Tor transport
+
+## Road map
+
+There are several big ways Onionr will be improved in the next major version:
+
+* Migration to the [new modular block system](https://git.voidnet.tech/kev/onionrblocks)
+    * Probability proof of work -> verifiable delay function
+    * Friend system built on top of signing proofs (Private networks?)
+* Gossip transport improvements such as with neighbor improvements. See streamfill/ and [simple gossip](https://github.com/onion-sudo/simplegossip) for incomplete experiments
+
+* Finish removing "communicator"
+* I2P transports
+    * Gossip
+    * Torrents (patch for sha1?)
+* Modular transports
+    * Currently transports are just threads coupled together.
+    * It would be better if there was a generic way to tell any loaded transport what blocks are wanted and feed back received blocks to the database
+* Migrate to SafeDB for peers and blocks
+    * SafeDB wrapper that contacts http endpoint to store if it is running, otherwise directly open DB
+* Separate UI logic from daemon. Refactor code to
+* Improve cryptography
+    * Restore phrases or deterministic keys (generate key from password, be very careful)
+    * Change identities to be dual keys (ed25519+curve25519)
+    * Finish treasurechest
+        * Interact via [named pipes](https://en.wikipedia.org/wiki/Named_pipe)
+        * Ephemeral key management
+        * Encrypt/decrypt/sign/verify functions to keep key out of main memory
+        * PGP-like symmetric messages
 
 

docs/docker.md

@@ -0,0 +1,28 @@
+# Running Onionr in Docker
+
+A Dockerfile is included in the root directory of Onionr.
+
+In Docker version 20.10 (and probably others), there is a strange bug where Onionr must be run with -it or stdout will be garbled and it may hang.
+
+## Clone and build the image
+
+`$ git clone https://git.voidnet.tech/kev/onionr/`
+`$ cd onionr`
+`$ sudo docker build -t onionr .`
+
+
+## Run Onionr
+
+`$ sudo docker run -it -p 8080:8080 onionr`
+
+Onionr will be accessible over any network interface by default, so make sure to either change the entry point bind-address argument or set a firewall rule.
+
+That said, Onionr does protect it's interface by default with a web token, which will be shown in stdout.
+
+**However, anyone who can access the port may be able to see what Onionr sites you have saved and potentially deanonymize your node**
+
+## View the UI
+
+Visit the address and port for the machine Onionr is running on, for example: http://192.168.1.5:8080/#<long-token-taken-from-stdout>
+
+If you want a secure connection to the interface, either use a proxy such as nginx or caddy, or use [SSH tunneling](./vps-cloud-guide.md).

docs/html/index.html

@@ -1 +0,0 @@
-<meta http-equiv="refresh" content="0;URL='src/index.html'">

docs/html/src/apiservers/index.html

@@ -1,88 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.apiservers API documentation</title>
-<meta name="description" content="Flask WSGI apps for the public and private API servers …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.apiservers</code></h1>
-</header>
-<section id="section-intro">
-<p>Flask WSGI apps for the public and private API servers.</p>
-<p>Public is net-facing server meant for other nodes
-Private is meant for controlling and accessing this node</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Flask WSGI apps for the public and private API servers.
-
-Public is net-facing server meant for other nodes
-Private is meant for controlling and accessing this node
-&#34;&#34;&#34;
-
-from . import public, private
-
-PublicAPI = public.PublicAPI
-ClientAPI = private.PrivateAPI</code></pre>
-</details>
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.apiservers.private" href="private/index.html">src.apiservers.private</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.apiservers.public" href="public/index.html">src.apiservers.public</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src" href="../index.html">src</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.apiservers.private" href="private/index.html">src.apiservers.private</a></code></li>
-<li><code><a title="src.apiservers.public" href="public/index.html">src.apiservers.public</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/apiservers/private/index.html

@@ -1,411 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.apiservers.private API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.apiservers.private</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>This file handles all incoming http requests to the client, using Flask</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-This file handles all incoming http requests to the client, using Flask
-&#34;&#34;&#34;
-from typing import Dict
-import hmac
-
-import flask
-from gevent.pywsgi import WSGIServer
-
-from onionrutils import epoch
-import httpapi
-from filepaths import private_API_host_file
-import logger
-
-from etc import waitforsetvar
-from . import register_private_blueprints
-import config
-from .. import public
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-class PrivateAPI:
-    &#34;&#34;&#34;Client HTTP api for controlling onionr and using UI.&#34;&#34;&#34;
-
-    callbacks: Dict[str, Dict] = {&#39;public&#39;: {}, &#39;private&#39;: {}}
-
-    def __init__(self):
-        &#34;&#34;&#34;Initialize the api server, preping variables for later use.
-
-        This initialization defines all of the API entry points
-        and handlers for the endpoints and errors
-        This also saves the used host (random localhost IP address)
-        to the data folder in host.txt
-        &#34;&#34;&#34;
-        self.config = config
-
-        self.startTime = epoch.get_epoch()
-        app = flask.Flask(__name__)
-        bind_port = int(config.get(&#39;client.client.port&#39;, 59496))
-        self.bindPort = bind_port
-
-        self.clientToken = config.get(&#39;client.webpassword&#39;)
-
-        self.host = httpapi.apiutils.setbindip.set_bind_IP(
-            private_API_host_file)
-        logger.info(&#39;Running api on %s:%s&#39; % (self.host, self.bindPort))
-        self.httpServer = &#39;&#39;
-
-        self.queueResponse = {}
-        self.get_block_data = httpapi.apiutils.GetBlockData(self)
-        register_private_blueprints.register_private_blueprints(self, app)
-        httpapi.load_plugin_blueprints(app)
-        self.app = app
-
-    def start(self):
-        &#34;&#34;&#34;Start client gevent API web server with flask client app.&#34;&#34;&#34;
-        waitforsetvar.wait_for_set_var(self, &#34;_too_many&#34;)
-        fd_handler = httpapi.fdsafehandler.FDSafeHandler
-        self.publicAPI = self._too_many.get(  # pylint: disable=E1101
-            public.PublicAPI)
-        self.httpServer = WSGIServer((self.host, self.bindPort),
-                                     self.app, log=None,
-                                     handler_class=fd_handler)
-        self.httpServer.serve_forever()
-
-    def setPublicAPIInstance(self, inst):
-        &#34;&#34;&#34;Dynamically set public API instance.&#34;&#34;&#34;
-        self.publicAPI = inst
-
-    def validateToken(self, token):
-        &#34;&#34;&#34;Validate that the client token matches the given token.
-
-        Used to prevent CSRF and other attacks.
-        &#34;&#34;&#34;
-        if not self.clientToken:
-            logger.error(&#34;client password needs to be set&#34;)
-            return False
-        try:
-            return hmac.compare_digest(self.clientToken, token)
-        except TypeError:
-            return False
-
-    def getUptime(self) -&gt; int:
-        &#34;&#34;&#34;Safely wait for uptime to be set and return it.&#34;&#34;&#34;
-        while True:
-            try:
-                return epoch.get_epoch() - self.startTime
-            except (AttributeError, NameError):
-                # Don&#39;t error on race condition with startup
-                pass
-
-    def getBlockData(self, bHash, decrypt=False, raw=False,
-                     headerOnly=False) -&gt; bytes:
-        &#34;&#34;&#34;Returns block data bytes.&#34;&#34;&#34;
-        return self.get_block_data.get_block_data(bHash,
-                                                  decrypt=decrypt,
-                                                  raw=raw,
-                                                  headerOnly=headerOnly)</code></pre>
-</details>
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.apiservers.private.register_private_blueprints" href="register_private_blueprints.html">src.apiservers.private.register_private_blueprints</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="src.apiservers.private.PrivateAPI"><code class="flex name class">
-<span>class <span class="ident">PrivateAPI</span></span>
-</code></dt>
-<dd>
-<section class="desc"><p>Client HTTP api for controlling onionr and using UI.</p>
-<p>Initialize the api server, preping variables for later use.</p>
-<p>This initialization defines all of the API entry points
-and handlers for the endpoints and errors
-This also saves the used host (random localhost IP address)
-to the data folder in host.txt</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class PrivateAPI:
-    &#34;&#34;&#34;Client HTTP api for controlling onionr and using UI.&#34;&#34;&#34;
-
-    callbacks: Dict[str, Dict] = {&#39;public&#39;: {}, &#39;private&#39;: {}}
-
-    def __init__(self):
-        &#34;&#34;&#34;Initialize the api server, preping variables for later use.
-
-        This initialization defines all of the API entry points
-        and handlers for the endpoints and errors
-        This also saves the used host (random localhost IP address)
-        to the data folder in host.txt
-        &#34;&#34;&#34;
-        self.config = config
-
-        self.startTime = epoch.get_epoch()
-        app = flask.Flask(__name__)
-        bind_port = int(config.get(&#39;client.client.port&#39;, 59496))
-        self.bindPort = bind_port
-
-        self.clientToken = config.get(&#39;client.webpassword&#39;)
-
-        self.host = httpapi.apiutils.setbindip.set_bind_IP(
-            private_API_host_file)
-        logger.info(&#39;Running api on %s:%s&#39; % (self.host, self.bindPort))
-        self.httpServer = &#39;&#39;
-
-        self.queueResponse = {}
-        self.get_block_data = httpapi.apiutils.GetBlockData(self)
-        register_private_blueprints.register_private_blueprints(self, app)
-        httpapi.load_plugin_blueprints(app)
-        self.app = app
-
-    def start(self):
-        &#34;&#34;&#34;Start client gevent API web server with flask client app.&#34;&#34;&#34;
-        waitforsetvar.wait_for_set_var(self, &#34;_too_many&#34;)
-        fd_handler = httpapi.fdsafehandler.FDSafeHandler
-        self.publicAPI = self._too_many.get(  # pylint: disable=E1101
-            public.PublicAPI)
-        self.httpServer = WSGIServer((self.host, self.bindPort),
-                                     self.app, log=None,
-                                     handler_class=fd_handler)
-        self.httpServer.serve_forever()
-
-    def setPublicAPIInstance(self, inst):
-        &#34;&#34;&#34;Dynamically set public API instance.&#34;&#34;&#34;
-        self.publicAPI = inst
-
-    def validateToken(self, token):
-        &#34;&#34;&#34;Validate that the client token matches the given token.
-
-        Used to prevent CSRF and other attacks.
-        &#34;&#34;&#34;
-        if not self.clientToken:
-            logger.error(&#34;client password needs to be set&#34;)
-            return False
-        try:
-            return hmac.compare_digest(self.clientToken, token)
-        except TypeError:
-            return False
-
-    def getUptime(self) -&gt; int:
-        &#34;&#34;&#34;Safely wait for uptime to be set and return it.&#34;&#34;&#34;
-        while True:
-            try:
-                return epoch.get_epoch() - self.startTime
-            except (AttributeError, NameError):
-                # Don&#39;t error on race condition with startup
-                pass
-
-    def getBlockData(self, bHash, decrypt=False, raw=False,
-                     headerOnly=False) -&gt; bytes:
-        &#34;&#34;&#34;Returns block data bytes.&#34;&#34;&#34;
-        return self.get_block_data.get_block_data(bHash,
-                                                  decrypt=decrypt,
-                                                  raw=raw,
-                                                  headerOnly=headerOnly)</code></pre>
-</details>
-<h3>Class variables</h3>
-<dl>
-<dt id="src.apiservers.private.PrivateAPI.callbacks"><code class="name">var <span class="ident">callbacks</span></code></dt>
-<dd>
-<section class="desc"><p>dict() -&gt; new empty dictionary
-dict(mapping) -&gt; new dictionary initialized from a mapping object's
-(key, value) pairs
-dict(iterable) -&gt; new dictionary initialized as if via:
-d = {}
-for k, v in iterable:
-d[k] = v
-dict(**kwargs) -&gt; new dictionary initialized with the name=value pairs
-in the keyword argument list.
-For example:
-dict(one=1, two=2)</p></section>
-</dd>
-</dl>
-<h3>Methods</h3>
-<dl>
-<dt id="src.apiservers.private.PrivateAPI.getBlockData"><code class="name flex">
-<span>def <span class="ident">getBlockData</span></span>(<span>self, bHash, decrypt=False, raw=False, headerOnly=False)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Returns block data bytes.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def getBlockData(self, bHash, decrypt=False, raw=False,
-                 headerOnly=False) -&gt; bytes:
-    &#34;&#34;&#34;Returns block data bytes.&#34;&#34;&#34;
-    return self.get_block_data.get_block_data(bHash,
-                                              decrypt=decrypt,
-                                              raw=raw,
-                                              headerOnly=headerOnly)</code></pre>
-</details>
-</dd>
-<dt id="src.apiservers.private.PrivateAPI.getUptime"><code class="name flex">
-<span>def <span class="ident">getUptime</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Safely wait for uptime to be set and return it.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def getUptime(self) -&gt; int:
-    &#34;&#34;&#34;Safely wait for uptime to be set and return it.&#34;&#34;&#34;
-    while True:
-        try:
-            return epoch.get_epoch() - self.startTime
-        except (AttributeError, NameError):
-            # Don&#39;t error on race condition with startup
-            pass</code></pre>
-</details>
-</dd>
-<dt id="src.apiservers.private.PrivateAPI.setPublicAPIInstance"><code class="name flex">
-<span>def <span class="ident">setPublicAPIInstance</span></span>(<span>self, inst)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Dynamically set public API instance.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def setPublicAPIInstance(self, inst):
-    &#34;&#34;&#34;Dynamically set public API instance.&#34;&#34;&#34;
-    self.publicAPI = inst</code></pre>
-</details>
-</dd>
-<dt id="src.apiservers.private.PrivateAPI.start"><code class="name flex">
-<span>def <span class="ident">start</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Start client gevent API web server with flask client app.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def start(self):
-    &#34;&#34;&#34;Start client gevent API web server with flask client app.&#34;&#34;&#34;
-    waitforsetvar.wait_for_set_var(self, &#34;_too_many&#34;)
-    fd_handler = httpapi.fdsafehandler.FDSafeHandler
-    self.publicAPI = self._too_many.get(  # pylint: disable=E1101
-        public.PublicAPI)
-    self.httpServer = WSGIServer((self.host, self.bindPort),
-                                 self.app, log=None,
-                                 handler_class=fd_handler)
-    self.httpServer.serve_forever()</code></pre>
-</details>
-</dd>
-<dt id="src.apiservers.private.PrivateAPI.validateToken"><code class="name flex">
-<span>def <span class="ident">validateToken</span></span>(<span>self, token)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Validate that the client token matches the given token.</p>
-<p>Used to prevent CSRF and other attacks.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def validateToken(self, token):
-    &#34;&#34;&#34;Validate that the client token matches the given token.
-
-    Used to prevent CSRF and other attacks.
-    &#34;&#34;&#34;
-    if not self.clientToken:
-        logger.error(&#34;client password needs to be set&#34;)
-        return False
-    try:
-        return hmac.compare_digest(self.clientToken, token)
-    except TypeError:
-        return False</code></pre>
-</details>
-</dd>
-</dl>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.apiservers" href="../index.html">src.apiservers</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.apiservers.private.register_private_blueprints" href="register_private_blueprints.html">src.apiservers.private.register_private_blueprints</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="src.apiservers.private.PrivateAPI" href="#src.apiservers.private.PrivateAPI">PrivateAPI</a></code></h4>
-<ul class="">
-<li><code><a title="src.apiservers.private.PrivateAPI.callbacks" href="#src.apiservers.private.PrivateAPI.callbacks">callbacks</a></code></li>
-<li><code><a title="src.apiservers.private.PrivateAPI.getBlockData" href="#src.apiservers.private.PrivateAPI.getBlockData">getBlockData</a></code></li>
-<li><code><a title="src.apiservers.private.PrivateAPI.getUptime" href="#src.apiservers.private.PrivateAPI.getUptime">getUptime</a></code></li>
-<li><code><a title="src.apiservers.private.PrivateAPI.setPublicAPIInstance" href="#src.apiservers.private.PrivateAPI.setPublicAPIInstance">setPublicAPIInstance</a></code></li>
-<li><code><a title="src.apiservers.private.PrivateAPI.start" href="#src.apiservers.private.PrivateAPI.start">start</a></code></li>
-<li><code><a title="src.apiservers.private.PrivateAPI.validateToken" href="#src.apiservers.private.PrivateAPI.validateToken">validateToken</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/apiservers/private/register_private_blueprints.html

@@ -1,175 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.apiservers.private.register_private_blueprints API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.apiservers.private.register_private_blueprints</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>This file registers blueprints for the private api server</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-This file registers blueprints for the private api server
-&#34;&#34;&#34;
-from threading import Thread
-from gevent import spawn
-from gevent import sleep
-
-from httpapi import security, friendsapi, profilesapi, configapi, insertblock
-from httpapi import miscclientapi, onionrsitesapi, apiutils
-from httpapi import directconnections
-from httpapi import themeapi
-from httpapi.sse.private import private_sse_blueprint
-
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def register_private_blueprints(private_api, app):
-    &#34;&#34;&#34;Register private API plask blueprints.&#34;&#34;&#34;
-    app.register_blueprint(security.client.ClientAPISecurity(
-        private_api).client_api_security_bp)
-    app.register_blueprint(friendsapi.friends)
-    app.register_blueprint(profilesapi.profile_BP)
-    app.register_blueprint(configapi.config_BP)
-    app.register_blueprint(insertblock.ib)
-    app.register_blueprint(miscclientapi.getblocks.client_get_blocks)
-    app.register_blueprint(miscclientapi.endpoints.PrivateEndpoints(
-        private_api).private_endpoints_bp)
-    app.register_blueprint(miscclientapi.motd.bp)
-    app.register_blueprint(onionrsitesapi.site_api)
-    app.register_blueprint(apiutils.shutdown.shutdown_bp)
-    app.register_blueprint(miscclientapi.staticfiles.static_files_bp)
-    app.register_blueprint(directconnections.DirectConnectionManagement(
-        private_api).direct_conn_management_bp)
-    app.register_blueprint(themeapi.theme_blueprint)
-    app.register_blueprint(private_sse_blueprint)
-
-    def _add_events_bp():
-        while True:
-            try:
-                private_api._too_many
-                break
-            except AttributeError:
-                sleep(0.2)
-        app.register_blueprint(
-            private_api._too_many.get_by_string(&#39;DaemonEventsBP&#39;).flask_bp)
-
-    Thread(target=_add_events_bp).start()
-
-    return app</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.apiservers.private.register_private_blueprints.register_private_blueprints"><code class="name flex">
-<span>def <span class="ident">register_private_blueprints</span></span>(<span>private_api, app)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Register private API plask blueprints.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def register_private_blueprints(private_api, app):
-    &#34;&#34;&#34;Register private API plask blueprints.&#34;&#34;&#34;
-    app.register_blueprint(security.client.ClientAPISecurity(
-        private_api).client_api_security_bp)
-    app.register_blueprint(friendsapi.friends)
-    app.register_blueprint(profilesapi.profile_BP)
-    app.register_blueprint(configapi.config_BP)
-    app.register_blueprint(insertblock.ib)
-    app.register_blueprint(miscclientapi.getblocks.client_get_blocks)
-    app.register_blueprint(miscclientapi.endpoints.PrivateEndpoints(
-        private_api).private_endpoints_bp)
-    app.register_blueprint(miscclientapi.motd.bp)
-    app.register_blueprint(onionrsitesapi.site_api)
-    app.register_blueprint(apiutils.shutdown.shutdown_bp)
-    app.register_blueprint(miscclientapi.staticfiles.static_files_bp)
-    app.register_blueprint(directconnections.DirectConnectionManagement(
-        private_api).direct_conn_management_bp)
-    app.register_blueprint(themeapi.theme_blueprint)
-    app.register_blueprint(private_sse_blueprint)
-
-    def _add_events_bp():
-        while True:
-            try:
-                private_api._too_many
-                break
-            except AttributeError:
-                sleep(0.2)
-        app.register_blueprint(
-            private_api._too_many.get_by_string(&#39;DaemonEventsBP&#39;).flask_bp)
-
-    Thread(target=_add_events_bp).start()
-
-    return app</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.apiservers.private" href="index.html">src.apiservers.private</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.apiservers.private.register_private_blueprints.register_private_blueprints" href="#src.apiservers.private.register_private_blueprints.register_private_blueprints">register_private_blueprints</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/apiservers/public/index.html

@@ -1,220 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.apiservers.public API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.apiservers.public</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>This file handles all incoming http requests
-to the public api server, using Flask</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-This file handles all incoming http requests
-to the public api server, using Flask
-&#34;&#34;&#34;
-import time
-import threading
-import flask
-from gevent.pywsgi import WSGIServer
-from httpapi import apiutils, security, fdsafehandler, miscpublicapi
-import logger
-import config
-import filepaths
-from utils import gettransports
-from etc import onionrvalues, waitforsetvar
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def _get_tor_adder(pub_api):
-    transports = []
-    while len(transports) == 0:
-        transports = gettransports.get()
-        time.sleep(0.3)
-    pub_api.torAdder = transports[0]
-
-
-class PublicAPI:
-    &#34;&#34;&#34;The new client api server, isolated from the public api.&#34;&#34;&#34;
-
-    def __init__(self):
-        &#34;&#34;&#34;Setup the public api app.&#34;&#34;&#34;
-        app = flask.Flask(&#39;PublicAPI&#39;)
-        app.config[&#39;MAX_CONTENT_LENGTH&#39;] = 5 * 1024 * 1024
-        self.i2pEnabled = config.get(&#39;i2p.host&#39;, False)
-        self.hideBlocks = []  # Blocks to be denied sharing
-        self.host = apiutils.setbindip.set_bind_IP(
-            filepaths.public_API_host_file)
-
-        threading.Thread(target=_get_tor_adder,
-                         args=[self], daemon=True).start()
-
-        self.torAdder = &#34;&#34;
-        self.bindPort = config.get(&#39;client.public.port&#39;)
-        self.lastRequest = 0
-        # total rec requests to public api since server started
-        self.hitCount = 0
-        self.config = config
-        self.API_VERSION = onionrvalues.API_VERSION
-        logger.info(&#39;Running public api on %s:%s&#39; % (self.host, self.bindPort))
-
-        app.register_blueprint(
-            security.public.PublicAPISecurity(self).public_api_security_bp)
-        app.register_blueprint(
-            miscpublicapi.endpoints.PublicEndpoints(self).public_endpoints_bp)
-        self.app = app
-
-    def start(self):
-        &#34;&#34;&#34;Start the Public API server.&#34;&#34;&#34;
-        waitforsetvar.wait_for_set_var(self, &#34;_too_many&#34;)
-        self.httpServer = WSGIServer((self.host, self.bindPort),
-                                     self.app, log=None,
-                                     handler_class=fdsafehandler.FDSafeHandler)
-        self.httpServer.serve_forever()</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="src.apiservers.public.PublicAPI"><code class="flex name class">
-<span>class <span class="ident">PublicAPI</span></span>
-</code></dt>
-<dd>
-<section class="desc"><p>The new client api server, isolated from the public api.</p>
-<p>Setup the public api app.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class PublicAPI:
-    &#34;&#34;&#34;The new client api server, isolated from the public api.&#34;&#34;&#34;
-
-    def __init__(self):
-        &#34;&#34;&#34;Setup the public api app.&#34;&#34;&#34;
-        app = flask.Flask(&#39;PublicAPI&#39;)
-        app.config[&#39;MAX_CONTENT_LENGTH&#39;] = 5 * 1024 * 1024
-        self.i2pEnabled = config.get(&#39;i2p.host&#39;, False)
-        self.hideBlocks = []  # Blocks to be denied sharing
-        self.host = apiutils.setbindip.set_bind_IP(
-            filepaths.public_API_host_file)
-
-        threading.Thread(target=_get_tor_adder,
-                         args=[self], daemon=True).start()
-
-        self.torAdder = &#34;&#34;
-        self.bindPort = config.get(&#39;client.public.port&#39;)
-        self.lastRequest = 0
-        # total rec requests to public api since server started
-        self.hitCount = 0
-        self.config = config
-        self.API_VERSION = onionrvalues.API_VERSION
-        logger.info(&#39;Running public api on %s:%s&#39; % (self.host, self.bindPort))
-
-        app.register_blueprint(
-            security.public.PublicAPISecurity(self).public_api_security_bp)
-        app.register_blueprint(
-            miscpublicapi.endpoints.PublicEndpoints(self).public_endpoints_bp)
-        self.app = app
-
-    def start(self):
-        &#34;&#34;&#34;Start the Public API server.&#34;&#34;&#34;
-        waitforsetvar.wait_for_set_var(self, &#34;_too_many&#34;)
-        self.httpServer = WSGIServer((self.host, self.bindPort),
-                                     self.app, log=None,
-                                     handler_class=fdsafehandler.FDSafeHandler)
-        self.httpServer.serve_forever()</code></pre>
-</details>
-<h3>Methods</h3>
-<dl>
-<dt id="src.apiservers.public.PublicAPI.start"><code class="name flex">
-<span>def <span class="ident">start</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Start the Public API server.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def start(self):
-    &#34;&#34;&#34;Start the Public API server.&#34;&#34;&#34;
-    waitforsetvar.wait_for_set_var(self, &#34;_too_many&#34;)
-    self.httpServer = WSGIServer((self.host, self.bindPort),
-                                 self.app, log=None,
-                                 handler_class=fdsafehandler.FDSafeHandler)
-    self.httpServer.serve_forever()</code></pre>
-</details>
-</dd>
-</dl>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.apiservers" href="../index.html">src.apiservers</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="src.apiservers.public.PublicAPI" href="#src.apiservers.public.PublicAPI">PublicAPI</a></code></h4>
-<ul class="">
-<li><code><a title="src.apiservers.public.PublicAPI.start" href="#src.apiservers.public.PublicAPI.start">start</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/bigbrother/index.html

@@ -1,166 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.bigbrother API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.bigbrother</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>Processes interpreter hook events to detect security leaks</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-Processes interpreter hook events to detect security leaks
-&#34;&#34;&#34;
-import sys
-from typing import Iterable
-
-from onionrexceptions import PythonVersion
-from . import ministry
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def _auditing_supported():
-    try:
-        sys.audit
-        sys.addaudithook
-    except AttributeError:
-        raise PythonVersion(&#39;Auditing not supported interpreter&#39;)
-
-
-def sys_hook_entrypoint(event, info):
-    &#34;&#34;&#34;Entrypoint for big brother sys auditors.&#34;&#34;&#34;
-    if event == &#39;socket.connect&#39;:
-        ministry.ofcommunication.detect_socket_leaks(info)
-    elif event == &#39;exec&#39;:
-        # logs and block both exec and eval
-        ministry.ofexec.block_exec(event, info)
-    elif event == &#39;system&#39;:
-        ministry.ofexec.block_system(info)
-
-
-def enable_ministries(disable_hooks: Iterable = None):
-    &#34;&#34;&#34;Enable auditors.&#34;&#34;&#34;
-    disable_hooks = disable_hooks or []
-    _auditing_supported()  # raises PythonVersion exception if &lt;3.8
-    sys.addaudithook(sys_hook_entrypoint)</code></pre>
-</details>
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.bigbrother.ministry" href="ministry/index.html">src.bigbrother.ministry</a></code></dt>
-<dd>
-<section class="desc"></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.bigbrother.enable_ministries"><code class="name flex">
-<span>def <span class="ident">enable_ministries</span></span>(<span>disable_hooks=None)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Enable auditors.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def enable_ministries(disable_hooks: Iterable = None):
-    &#34;&#34;&#34;Enable auditors.&#34;&#34;&#34;
-    disable_hooks = disable_hooks or []
-    _auditing_supported()  # raises PythonVersion exception if &lt;3.8
-    sys.addaudithook(sys_hook_entrypoint)</code></pre>
-</details>
-</dd>
-<dt id="src.bigbrother.sys_hook_entrypoint"><code class="name flex">
-<span>def <span class="ident">sys_hook_entrypoint</span></span>(<span>event, info)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Entrypoint for big brother sys auditors.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def sys_hook_entrypoint(event, info):
-    &#34;&#34;&#34;Entrypoint for big brother sys auditors.&#34;&#34;&#34;
-    if event == &#39;socket.connect&#39;:
-        ministry.ofcommunication.detect_socket_leaks(info)
-    elif event == &#39;exec&#39;:
-        # logs and block both exec and eval
-        ministry.ofexec.block_exec(event, info)
-    elif event == &#39;system&#39;:
-        ministry.ofexec.block_system(info)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src" href="../index.html">src</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.bigbrother.ministry" href="ministry/index.html">src.bigbrother.ministry</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.bigbrother.enable_ministries" href="#src.bigbrother.enable_ministries">enable_ministries</a></code></li>
-<li><code><a title="src.bigbrother.sys_hook_entrypoint" href="#src.bigbrother.sys_hook_entrypoint">sys_hook_entrypoint</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/bigbrother/ministry/index.html

@@ -1,77 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.bigbrother.ministry API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.bigbrother.ministry</code></h1>
-</header>
-<section id="section-intro">
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">from . import ofcommunication  # noqa
-from . import ofexec  # noqa</code></pre>
-</details>
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.bigbrother.ministry.ofcommunication" href="ofcommunication.html">src.bigbrother.ministry.ofcommunication</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.bigbrother.ministry.ofexec" href="ofexec.html">src.bigbrother.ministry.ofexec</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.bigbrother" href="../index.html">src.bigbrother</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.bigbrother.ministry.ofcommunication" href="ofcommunication.html">src.bigbrother.ministry.ofcommunication</a></code></li>
-<li><code><a title="src.bigbrother.ministry.ofexec" href="ofexec.html">src.bigbrother.ministry.ofexec</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/bigbrother/ministry/ofcommunication.html

@@ -1,149 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.bigbrother.ministry.ofcommunication API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.bigbrother.ministry.ofcommunication</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>Ensure sockets don't get made to non localhost</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-Ensure sockets don&#39;t get made to non localhost
-&#34;&#34;&#34;
-import ipaddress
-
-import logger
-from onionrexceptions import NetworkLeak
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def detect_socket_leaks(socket_event):
-    &#34;&#34;&#34;Is called by the big brother broker whenever.
-
-    a socket connection happens.
-    raises exception &amp; logs if not to loopback
-    &#34;&#34;&#34;
-    ip_address = socket_event[1][0]
-
-    # validate is valid ip address (no hostname, etc)
-    # raises NetworkLeak if not
-    try:
-        ipaddress.ip_address(ip_address)
-    except ValueError:
-        logger.warn(f&#39;Conn made to {ip_address} outside of Tor/similar&#39;)
-        raise \
-            NetworkLeak(&#39;Conn to host/non local IP, this is a privacy issue!&#39;)
-
-    # Validate that the IP is localhost ipv4
-
-    if not ip_address.startswith(&#39;127&#39;):
-        logger.warn(f&#39;Conn made to {ip_address} outside of Tor/similar&#39;)
-        raise NetworkLeak(&#39;Conn to non local IP, this is a privacy concern!&#39;)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.bigbrother.ministry.ofcommunication.detect_socket_leaks"><code class="name flex">
-<span>def <span class="ident">detect_socket_leaks</span></span>(<span>socket_event)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Is called by the big brother broker whenever.</p>
-<p>a socket connection happens.
-raises exception &amp; logs if not to loopback</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def detect_socket_leaks(socket_event):
-    &#34;&#34;&#34;Is called by the big brother broker whenever.
-
-    a socket connection happens.
-    raises exception &amp; logs if not to loopback
-    &#34;&#34;&#34;
-    ip_address = socket_event[1][0]
-
-    # validate is valid ip address (no hostname, etc)
-    # raises NetworkLeak if not
-    try:
-        ipaddress.ip_address(ip_address)
-    except ValueError:
-        logger.warn(f&#39;Conn made to {ip_address} outside of Tor/similar&#39;)
-        raise \
-            NetworkLeak(&#39;Conn to host/non local IP, this is a privacy issue!&#39;)
-
-    # Validate that the IP is localhost ipv4
-
-    if not ip_address.startswith(&#39;127&#39;):
-        logger.warn(f&#39;Conn made to {ip_address} outside of Tor/similar&#39;)
-        raise NetworkLeak(&#39;Conn to non local IP, this is a privacy concern!&#39;)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.bigbrother.ministry" href="index.html">src.bigbrother.ministry</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.bigbrother.ministry.ofcommunication.detect_socket_leaks" href="#src.bigbrother.ministry.ofcommunication.detect_socket_leaks">detect_socket_leaks</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/bigbrother/ministry/ofexec.html

@@ -1,227 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.bigbrother.ministry.ofexec API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.bigbrother.ministry.ofexec</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>Prevent eval/exec/os.system and log it</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-Prevent eval/exec/os.system and log it
-&#34;&#34;&#34;
-import base64
-import platform
-
-import logger
-from utils import identifyhome
-from onionrexceptions import ArbitraryCodeExec
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def block_system(cmd):
-    &#34;&#34;&#34;Prevent os.system except for whitelisted commands+contexts.&#34;&#34;&#34;
-    allowed = &#39;taskkill /PID &#39;
-    is_ok = False
-    if platform.system() == &#39;Windows&#39;:
-        if cmd.startswith(allowed):
-            for c in cmd.split(allowed)[1]:
-                if not c.isalnum() or c not in (&#39;/&#39;, &#39;F&#39;, &#39; &#39;):
-                    break
-            else:
-                is_ok = True
-    if not is_ok:
-        logger.warn(&#39;POSSIBLE EXPLOIT DETECTED, SEE LOGS&#39;, terminal=True)
-        logger.warn(f&#39;POSSIBLE EXPLOIT: shell command not in whitelist: {cmd}&#39;)
-        raise ArbitraryCodeExec(&#39;os.system command not in whitelist&#39;)
-
-
-def block_exec(event, info):
-    &#34;&#34;&#34;Prevent arbitrary code execution in eval/exec and log it.&#34;&#34;&#34;
-    # because libraries have stupid amounts of compile/exec/eval,
-    # We have to use a whitelist where it can be tolerated
-    # Generally better than nothing, not a silver bullet
-    whitelisted_code = [
-                        &#39;netrc.py&#39;,
-                        &#39;shlex.py&#39;,
-                        &#39;gzip.py&#39;,
-                        &#39;&lt;werkzeug routing&gt;&#39;,
-                        &#39;werkzeug/test.py&#39;,
-                        &#39;multiprocessing/popen_fork.py&#39;,
-                        &#39;multiprocessing/util.py&#39;,
-                        &#39;multiprocessing/connection.py&#39;,
-                        &#39;onionrutils/escapeansi.py&#39;,
-                        &#39;stem/connection.py&#39;,
-                        &#39;stem/response/add_onion.py&#39;,
-                        &#39;stem/response/authchallenge.py&#39;,
-                        &#39;stem/response/getinfo.py&#39;,
-                        &#39;stem/response/getconf.py&#39;,
-                        &#39;stem/response/mapaddress.py&#39;,
-                        &#39;stem/response/protocolinfo.py&#39;
-                       ]
-    home = identifyhome.identify_home()
-
-    code_b64 = base64.b64encode(info[0].co_code).decode()
-
-    for source in whitelisted_code:
-        if info[0].co_filename.endswith(source):
-            return
-
-    if home + &#39;plugins/&#39; in info[0].co_filename:
-        return
-
-    logger.warn(&#39;POSSIBLE EXPLOIT DETECTED, SEE LOGS&#39;, terminal=True)
-    logger.warn(&#39;POSSIBLE EXPLOIT DETECTED: &#39; + info[0].co_filename)
-    logger.warn(&#39;Prevented exec/eval. Report this with the sample below&#39;)
-    logger.warn(f&#39;{event} code in base64 format: {code_b64}&#39;)
-    raise ArbitraryCodeExec(&#34;Arbitrary code (eval/exec) detected.&#34;)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.bigbrother.ministry.ofexec.block_exec"><code class="name flex">
-<span>def <span class="ident">block_exec</span></span>(<span>event, info)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Prevent arbitrary code execution in eval/exec and log it.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def block_exec(event, info):
-    &#34;&#34;&#34;Prevent arbitrary code execution in eval/exec and log it.&#34;&#34;&#34;
-    # because libraries have stupid amounts of compile/exec/eval,
-    # We have to use a whitelist where it can be tolerated
-    # Generally better than nothing, not a silver bullet
-    whitelisted_code = [
-                        &#39;netrc.py&#39;,
-                        &#39;shlex.py&#39;,
-                        &#39;gzip.py&#39;,
-                        &#39;&lt;werkzeug routing&gt;&#39;,
-                        &#39;werkzeug/test.py&#39;,
-                        &#39;multiprocessing/popen_fork.py&#39;,
-                        &#39;multiprocessing/util.py&#39;,
-                        &#39;multiprocessing/connection.py&#39;,
-                        &#39;onionrutils/escapeansi.py&#39;,
-                        &#39;stem/connection.py&#39;,
-                        &#39;stem/response/add_onion.py&#39;,
-                        &#39;stem/response/authchallenge.py&#39;,
-                        &#39;stem/response/getinfo.py&#39;,
-                        &#39;stem/response/getconf.py&#39;,
-                        &#39;stem/response/mapaddress.py&#39;,
-                        &#39;stem/response/protocolinfo.py&#39;
-                       ]
-    home = identifyhome.identify_home()
-
-    code_b64 = base64.b64encode(info[0].co_code).decode()
-
-    for source in whitelisted_code:
-        if info[0].co_filename.endswith(source):
-            return
-
-    if home + &#39;plugins/&#39; in info[0].co_filename:
-        return
-
-    logger.warn(&#39;POSSIBLE EXPLOIT DETECTED, SEE LOGS&#39;, terminal=True)
-    logger.warn(&#39;POSSIBLE EXPLOIT DETECTED: &#39; + info[0].co_filename)
-    logger.warn(&#39;Prevented exec/eval. Report this with the sample below&#39;)
-    logger.warn(f&#39;{event} code in base64 format: {code_b64}&#39;)
-    raise ArbitraryCodeExec(&#34;Arbitrary code (eval/exec) detected.&#34;)</code></pre>
-</details>
-</dd>
-<dt id="src.bigbrother.ministry.ofexec.block_system"><code class="name flex">
-<span>def <span class="ident">block_system</span></span>(<span>cmd)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Prevent os.system except for whitelisted commands+contexts.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def block_system(cmd):
-    &#34;&#34;&#34;Prevent os.system except for whitelisted commands+contexts.&#34;&#34;&#34;
-    allowed = &#39;taskkill /PID &#39;
-    is_ok = False
-    if platform.system() == &#39;Windows&#39;:
-        if cmd.startswith(allowed):
-            for c in cmd.split(allowed)[1]:
-                if not c.isalnum() or c not in (&#39;/&#39;, &#39;F&#39;, &#39; &#39;):
-                    break
-            else:
-                is_ok = True
-    if not is_ok:
-        logger.warn(&#39;POSSIBLE EXPLOIT DETECTED, SEE LOGS&#39;, terminal=True)
-        logger.warn(f&#39;POSSIBLE EXPLOIT: shell command not in whitelist: {cmd}&#39;)
-        raise ArbitraryCodeExec(&#39;os.system command not in whitelist&#39;)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.bigbrother.ministry" href="index.html">src.bigbrother.ministry</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.bigbrother.ministry.ofexec.block_exec" href="#src.bigbrother.ministry.ofexec.block_exec">block_exec</a></code></li>
-<li><code><a title="src.bigbrother.ministry.ofexec.block_system" href="#src.bigbrother.ministry.ofexec.block_system">block_system</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicator/bootstrappeers.html

@@ -1,119 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicator.bootstrappeers API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicator.bootstrappeers</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>add bootstrap peers to the communicator peer list</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-add bootstrap peers to the communicator peer list
-&#34;&#34;&#34;
-from utils import readstatic, gettransports
-from coredb import keydb
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-bootstrap_peers = readstatic.read_static(&#39;bootstrap-nodes.txt&#39;).split(&#39;,&#39;)
-
-
-def add_bootstrap_list_to_peer_list(comm_inst, peerList, db_only=False):
-    &#34;&#34;&#34;Add the bootstrap list to the peer list (no duplicates).&#34;&#34;&#34;
-    for i in bootstrap_peers:
-        if i not in peerList and i not in comm_inst.offlinePeers \
-                and i not in gettransports.get() and len(str(i).strip()) &gt; 0:
-            if not db_only:
-                peerList.append(i)
-            keydb.addkeys.add_address(i)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicator.bootstrappeers.add_bootstrap_list_to_peer_list"><code class="name flex">
-<span>def <span class="ident">add_bootstrap_list_to_peer_list</span></span>(<span>comm_inst, peerList, db_only=False)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Add the bootstrap list to the peer list (no duplicates).</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def add_bootstrap_list_to_peer_list(comm_inst, peerList, db_only=False):
-    &#34;&#34;&#34;Add the bootstrap list to the peer list (no duplicates).&#34;&#34;&#34;
-    for i in bootstrap_peers:
-        if i not in peerList and i not in comm_inst.offlinePeers \
-                and i not in gettransports.get() and len(str(i).strip()) &gt; 0:
-            if not db_only:
-                peerList.append(i)
-            keydb.addkeys.add_address(i)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicator" href="index.html">src.communicator</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicator.bootstrappeers.add_bootstrap_list_to_peer_list" href="#src.communicator.bootstrappeers.add_bootstrap_list_to_peer_list">add_bootstrap_list_to_peer_list</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicator/daemoneventhooks/index.html

@@ -1,210 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicator.daemoneventhooks API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicator.daemoneventhooks</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>Hooks to handle daemon events</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-Hooks to handle daemon events
-&#34;&#34;&#34;
-from threading import Thread
-
-from .removefrominsertqueue import remove_from_insert_queue
-
-from typing import TYPE_CHECKING
-
-from gevent import sleep
-
-from communicatorutils.uploadblocks import mixmate
-from communicatorutils import restarttor
-
-if TYPE_CHECKING:
-    from toomanyobjs import TooMany
-    from communicator import OnionrCommunicatorDaemon
-    from httpapi.daemoneventsapi import DaemonEventsBP
-    from onionrtypes import BlockHash
-    from apiservers import PublicAPI
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def daemon_event_handlers(shared_state: &#39;TooMany&#39;):
-    def _get_inst(class_name: str):
-        while True:
-            try:
-                return shared_state.get_by_string(class_name)
-            except KeyError:
-                sleep(0.2)
-    comm_inst = _get_inst(&#39;OnionrCommunicatorDaemon&#39;)
-    public_api: &#39;PublicAPI&#39; = _get_inst(&#39;PublicAPI&#39;)
-    events_api: &#39;DaemonEventsBP&#39; = _get_inst(&#39;DaemonEventsBP&#39;)
-
-    def remove_from_insert_queue_wrapper(block_hash: &#39;BlockHash&#39;):
-        remove_from_insert_queue(comm_inst, block_hash)
-        return &#34;removed&#34;
-
-    def print_test(text=&#39;&#39;):
-        print(&#34;It works!&#34;, text)
-        return f&#34;It works! {text}&#34;
-
-    def upload_event(block: &#39;BlockHash&#39; = &#39;&#39;):
-        if not block:
-            raise ValueError
-        public_api.hideBlocks.append(block)
-        try:
-            mixmate.block_mixer(comm_inst.blocksToUpload, block)
-        except ValueError:
-            pass
-        return &#34;removed&#34;
-
-    def restart_tor():
-        restarttor.restart(comm_inst)
-        comm_inst.offlinePeers = []
-
-    def test_runtime():
-        Thread(target=comm_inst.shared_state.get_by_string(
-            &#34;OnionrRunTestManager&#34;).run_tests).start()
-
-    events_api.register_listener(remove_from_insert_queue_wrapper)
-    events_api.register_listener(print_test)
-    events_api.register_listener(upload_event)
-    events_api.register_listener(test_runtime)</code></pre>
-</details>
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.communicator.daemoneventhooks.removefrominsertqueue" href="removefrominsertqueue.html">src.communicator.daemoneventhooks.removefrominsertqueue</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - P2P Anonymous Storage Network …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicator.daemoneventhooks.daemon_event_handlers"><code class="name flex">
-<span>def <span class="ident">daemon_event_handlers</span></span>(<span>shared_state)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def daemon_event_handlers(shared_state: &#39;TooMany&#39;):
-    def _get_inst(class_name: str):
-        while True:
-            try:
-                return shared_state.get_by_string(class_name)
-            except KeyError:
-                sleep(0.2)
-    comm_inst = _get_inst(&#39;OnionrCommunicatorDaemon&#39;)
-    public_api: &#39;PublicAPI&#39; = _get_inst(&#39;PublicAPI&#39;)
-    events_api: &#39;DaemonEventsBP&#39; = _get_inst(&#39;DaemonEventsBP&#39;)
-
-    def remove_from_insert_queue_wrapper(block_hash: &#39;BlockHash&#39;):
-        remove_from_insert_queue(comm_inst, block_hash)
-        return &#34;removed&#34;
-
-    def print_test(text=&#39;&#39;):
-        print(&#34;It works!&#34;, text)
-        return f&#34;It works! {text}&#34;
-
-    def upload_event(block: &#39;BlockHash&#39; = &#39;&#39;):
-        if not block:
-            raise ValueError
-        public_api.hideBlocks.append(block)
-        try:
-            mixmate.block_mixer(comm_inst.blocksToUpload, block)
-        except ValueError:
-            pass
-        return &#34;removed&#34;
-
-    def restart_tor():
-        restarttor.restart(comm_inst)
-        comm_inst.offlinePeers = []
-
-    def test_runtime():
-        Thread(target=comm_inst.shared_state.get_by_string(
-            &#34;OnionrRunTestManager&#34;).run_tests).start()
-
-    events_api.register_listener(remove_from_insert_queue_wrapper)
-    events_api.register_listener(print_test)
-    events_api.register_listener(upload_event)
-    events_api.register_listener(test_runtime)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicator" href="../index.html">src.communicator</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.communicator.daemoneventhooks.removefrominsertqueue" href="removefrominsertqueue.html">src.communicator.daemoneventhooks.removefrominsertqueue</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicator.daemoneventhooks.daemon_event_handlers" href="#src.communicator.daemoneventhooks.daemon_event_handlers">daemon_event_handlers</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicator/daemoneventhooks/removefrominsertqueue.html

@@ -1,117 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicator.daemoneventhooks.removefrominsertqueue API documentation</title>
-<meta name="description" content="Onionr - P2P Anonymous Storage Network …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicator.daemoneventhooks.removefrominsertqueue</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - P2P Anonymous Storage Network.</p>
-<p>Remove block hash from daemon's upload list.</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - P2P Anonymous Storage Network.
-
-Remove block hash from daemon&#39;s upload list.
-&#34;&#34;&#34;
-from typing import TYPE_CHECKING
-if TYPE_CHECKING:
-    from communicator import OnionrCommunicatorDaemon
-    from onionrtypes import BlockHash
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def remove_from_insert_queue(comm_inst: &#34;OnionrCommunicatorDaemon&#34;,
-                             b_hash: &#34;BlockHash&#34;):
-    &#34;&#34;&#34;Remove block hash from daemon&#39;s upload list.&#34;&#34;&#34;
-    try:
-        comm_inst.generating_blocks.remove(b_hash)
-    except ValueError:
-        pass</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicator.daemoneventhooks.removefrominsertqueue.remove_from_insert_queue"><code class="name flex">
-<span>def <span class="ident">remove_from_insert_queue</span></span>(<span>comm_inst, b_hash)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Remove block hash from daemon's upload list.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def remove_from_insert_queue(comm_inst: &#34;OnionrCommunicatorDaemon&#34;,
-                             b_hash: &#34;BlockHash&#34;):
-    &#34;&#34;&#34;Remove block hash from daemon&#39;s upload list.&#34;&#34;&#34;
-    try:
-        comm_inst.generating_blocks.remove(b_hash)
-    except ValueError:
-        pass</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicator.daemoneventhooks" href="index.html">src.communicator.daemoneventhooks</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicator.daemoneventhooks.removefrominsertqueue.remove_from_insert_queue" href="#src.communicator.daemoneventhooks.removefrominsertqueue.remove_from_insert_queue">remove_from_insert_queue</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicator/index.html

@@ -1,866 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicator API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicator</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>This file contains both the OnionrCommunicate class for
-communcating with peers and code to operate as a daemon,
-getting commands from the command queue database
-(see core.Core.daemonQueue)</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-This file contains both the OnionrCommunicate class for
-communcating with peers and code to operate as a daemon,
-getting commands from the command queue database
-(see core.Core.daemonQueue)
-&#34;&#34;&#34;
-import os
-import time
-
-import config
-import logger
-import onionrpeers
-import onionrplugins as plugins
-from . import onlinepeers, uploadqueue
-from communicatorutils import servicecreator
-from communicatorutils import onionrcommunicatortimers
-from communicatorutils import downloadblocks
-from communicatorutils import lookupblocks
-from communicatorutils import lookupadders
-from communicatorutils import connectnewpeers
-from communicatorutils import uploadblocks
-from communicatorutils import announcenode, deniableinserts
-from communicatorutils import cooldownpeer
-from communicatorutils import housekeeping
-from communicatorutils import netcheck
-from onionrutils import localcommand
-from onionrutils import epoch
-from etc import humanreadabletime
-import onionrservices
-import filepaths
-from onionrblocks import storagecounter
-from coredb import dbfiles
-from netcontroller import NetController
-from . import bootstrappeers
-from . import daemoneventhooks
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-OnionrCommunicatorTimers = onionrcommunicatortimers.OnionrCommunicatorTimers
-
-config.reload()
-
-
-class OnionrCommunicatorDaemon:
-    def __init__(self, shared_state, developmentMode=None):
-        if developmentMode is None:
-            developmentMode = config.get(&#39;general.dev_mode&#39;, False)
-
-        # configure logger and stuff
-        self.config = config
-        self.storage_counter = storagecounter.StorageCounter()
-        self.isOnline = True  # Assume we&#39;re connected to the internet
-        self.shared_state = shared_state  # TooManyObjects module
-
-        if config.get(&#39;general.offline_mode&#39;, False):
-            self.isOnline = False
-
-        # list of timer instances
-        self.timers = []
-
-        # initialize core with Tor socks port being 3rd argument
-        self.proxyPort = shared_state.get(NetController).socksPort
-
-        # Upload information, list of blocks to upload
-        self.blocksToUpload = []
-        self.upload_session_manager = self.shared_state.get(
-            uploadblocks.sessionmanager.BlockUploadSessionManager)
-        self.shared_state.share_object()
-
-        # loop time.sleep delay in seconds
-        self.delay = 1
-
-        # lists of connected peers and peers we know we can&#39;t reach currently
-        self.onlinePeers = []
-        self.offlinePeers = []
-        self.cooldownPeer = {}
-        self.connectTimes = {}
-        # list of peer&#39;s profiles (onionrpeers.PeerProfile instances)
-        self.peerProfiles = []
-        # Peers merged to us. Don&#39;t add to db until we know they&#39;re reachable
-        self.newPeers = []
-        self.announceProgress = {}
-        self.announceCache = {}
-
-        self.generating_blocks = []
-
-        # amount of threads running by name, used to prevent too many
-        self.threadCounts = {}
-
-        # set true when shutdown command received
-        self.shutdown = False
-
-        # list of new blocks to download
-        # added to when new block lists are fetched from peers
-        self.blockQueue = {}
-
-        # list of blocks currently downloading, avoid s
-        self.currentDownloading = []
-
-        # timestamp when the last online node was seen
-        self.lastNodeSeen = None
-
-        # Dict of time stamps for peer&#39;s block list lookup times,
-        # to avoid downloading full lists all the time
-        self.dbTimestamps = {}
-
-        # Loads in and starts the enabled plugins
-        plugins.reload()
-
-        # time app started running for info/statistics purposes
-        self.startTime = epoch.get_epoch()
-
-        # extends our upload list and saves our list when Onionr exits
-        uploadqueue.UploadQueue(self)
-
-        if developmentMode:
-            OnionrCommunicatorTimers(self, self.heartbeat, 30)
-
-        # Set timers, function reference, seconds
-        # requires_peer True means the timer function won&#39;t fire if we
-        # have no connected peers
-        peerPoolTimer = OnionrCommunicatorTimers(
-            self, onlinepeers.get_online_peers, 60, max_threads=1,
-            my_args=[self])
-
-        # Timers to periodically lookup new blocks and download them
-        lookup_blocks_timer = OnionrCommunicatorTimers(
-            self,
-            lookupblocks.lookup_blocks_from_communicator,
-            config.get(&#39;timers.lookupBlocks&#39;, 25),
-            my_args=[self], requires_peer=True, max_threads=1)
-
-        &#34;&#34;&#34;The block download timer is accessed by the block lookup function
-        to trigger faster download starts&#34;&#34;&#34;
-        self.download_blocks_timer = OnionrCommunicatorTimers(
-            self, self.getBlocks, config.get(&#39;timers.getBlocks&#39;, 10),
-            requires_peer=True, max_threads=5)
-
-        # Timer to reset the longest offline peer
-        # so contact can be attempted again
-        OnionrCommunicatorTimers(
-            self, onlinepeers.clear_offline_peer, 58, my_args=[self])
-
-        # Timer to cleanup old blocks
-        blockCleanupTimer = OnionrCommunicatorTimers(
-            self, housekeeping.clean_old_blocks, 20, my_args=[self])
-
-        # Timer to discover new peers
-        OnionrCommunicatorTimers(
-            self, lookupadders.lookup_new_peer_transports_with_communicator,
-            60, requires_peer=True, my_args=[self], max_threads=2)
-
-        # Timer for adjusting which peers
-        # we actively communicate to at any given time,
-        # to avoid over-using peers
-        OnionrCommunicatorTimers(
-            self, cooldownpeer.cooldown_peer, 30,
-            my_args=[self], requires_peer=True)
-
-        # Timer to read the upload queue and upload the entries to peers
-        OnionrCommunicatorTimers(
-            self, uploadblocks.upload_blocks_from_communicator,
-            5, my_args=[self], requires_peer=True, max_threads=1)
-
-        # Setup direct connections
-        if config.get(&#39;general.socket_servers&#39;, False):
-            self.services = onionrservices.OnionrServices()
-            self.active_services = []
-            self.service_greenlets = []
-            OnionrCommunicatorTimers(
-                self, servicecreator.service_creator, 5,
-                max_threads=50, my_args=[self])
-        else:
-            self.services = None
-
-        # {peer_pubkey: ephemeral_address}, the address to reach them
-        self.direct_connection_clients = {}
-
-        # This timer creates deniable blocks,
-        # in an attempt to further obfuscate block insertion metadata
-        if config.get(&#39;general.insert_deniable_blocks&#39;, True):
-            deniableBlockTimer = OnionrCommunicatorTimers(
-                self, deniableinserts.insert_deniable_block,
-                180, my_args=[self], requires_peer=True, max_threads=1)
-            deniableBlockTimer.count = (deniableBlockTimer.frequency - 175)
-
-        # Timer to check for connectivity,
-        # through Tor to various high-profile onion services
-        OnionrCommunicatorTimers(self, netcheck.net_check, 500,
-                                 my_args=[self], max_threads=1)
-
-        # Announce the public API server transport address
-        # to other nodes if security level allows
-        if config.get(&#39;general.security_level&#39;, 1) == 0 \
-                and config.get(&#39;general.announce_node&#39;, True):
-            # Default to high security level incase config breaks
-            announceTimer = OnionrCommunicatorTimers(
-                self,
-                announcenode.announce_node,
-                3600, my_args=[self], requires_peer=True, max_threads=1)
-            announceTimer.count = (announceTimer.frequency - 60)
-        else:
-            logger.debug(&#39;Will not announce node.&#39;)
-
-        # Timer to delete malfunctioning or long-dead peers
-        cleanupTimer = OnionrCommunicatorTimers(
-            self, self.peerCleanup, 300, requires_peer=True)
-
-        # Timer to cleanup dead ephemeral forward secrecy keys
-        OnionrCommunicatorTimers(
-            self, housekeeping.clean_keys, 15, my_args=[self], max_threads=1)
-
-        # Adjust initial timer triggers
-        peerPoolTimer.count = (peerPoolTimer.frequency - 1)
-        cleanupTimer.count = (cleanupTimer.frequency - 60)
-        blockCleanupTimer.count = (blockCleanupTimer.frequency - 2)
-        lookup_blocks_timer = (lookup_blocks_timer.frequency - 2)
-
-        shared_state.add(self)
-
-        if config.get(&#39;general.use_bootstrap_list&#39;, True):
-            bootstrappeers.add_bootstrap_list_to_peer_list(
-                self, [], db_only=True)
-
-        daemoneventhooks.daemon_event_handlers(shared_state)
-
-        if not config.get(&#39;onboarding.done&#39;, True):
-            logger.info(
-                &#39;First run detected. Run openhome to get setup.&#39;,
-                terminal=True)
-
-            while not config.get(&#39;onboarding.done&#39;, True):
-                time.sleep(5)
-
-        # Main daemon loop, mainly for calling timers,
-        # don&#39;t do any complex operations here to avoid locking
-        try:
-            while not self.shutdown:
-                for i in self.timers:
-                    if self.shutdown:
-                        break
-                    i.processTimer()
-                time.sleep(self.delay)
-        except KeyboardInterrupt:
-            self.shutdown = True
-
-        logger.info(
-            &#39;Goodbye. (Onionr is cleaning up, and will exit)&#39;, terminal=True)
-        try:
-            self.service_greenlets
-        except AttributeError:
-            pass
-        else:
-            # Stop onionr direct connection services
-            for server in self.service_greenlets:
-                server.stop()
-        try:
-            time.sleep(0.5)
-        except KeyboardInterrupt:
-            pass
-
-    def getBlocks(self):
-        &#34;&#34;&#34;Download new blocks in queue.&#34;&#34;&#34;
-        downloadblocks.download_blocks_from_communicator(self)
-
-    def decrementThreadCount(self, threadName):
-        &#34;&#34;&#34;Decrement amount of a thread name if more than zero.
-
-        called when a function meant to be run in a thread ends
-        &#34;&#34;&#34;
-        try:
-            if self.threadCounts[threadName] &gt; 0:
-                self.threadCounts[threadName] -= 1
-        except KeyError:
-            pass
-
-    def connectNewPeer(self, peer=&#39;&#39;, useBootstrap=False):
-        &#34;&#34;&#34;Adds a new random online peer to self.onlinePeers&#34;&#34;&#34;
-        connectnewpeers.connect_new_peer_to_communicator(
-            self, peer, useBootstrap)
-
-    def peerCleanup(self):
-        &#34;&#34;&#34;This just calls onionrpeers.cleanupPeers.
-
-        Remove dead or bad peers (offline too long, too slow)&#34;&#34;&#34;
-        onionrpeers.peer_cleanup()
-        self.decrementThreadCount(&#39;peerCleanup&#39;)
-
-    def getPeerProfileInstance(self, peer):
-        &#34;&#34;&#34;Gets a peer profile instance from the list of profiles&#34;&#34;&#34;
-        for i in self.peerProfiles:
-            # if the peer&#39;s profile is already loaded, return that
-            if i.address == peer:
-                retData = i
-                break
-        else:
-            # if the peer&#39;s profile is not loaded, return a new one.
-            # connectNewPeer also adds it to the list on connect
-            retData = onionrpeers.PeerProfiles(peer)
-            self.peerProfiles.append(retData)
-        return retData
-
-    def getUptime(self):
-        return epoch.get_epoch() - self.startTime
-
-    def heartbeat(self):
-        &#34;&#34;&#34;Show a heartbeat debug message.&#34;&#34;&#34;
-        logger.debug(&#39;Heartbeat. Node running for %s.&#39; %
-                     humanreadabletime.human_readable_time(self.getUptime()))
-        self.decrementThreadCount(&#39;heartbeat&#39;)
-
-
-def startCommunicator(shared_state):
-    OnionrCommunicatorDaemon(shared_state)</code></pre>
-</details>
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.communicator.bootstrappeers" href="bootstrappeers.html">src.communicator.bootstrappeers</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicator.daemoneventhooks" href="daemoneventhooks/index.html">src.communicator.daemoneventhooks</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicator.onlinepeers" href="onlinepeers/index.html">src.communicator.onlinepeers</a></code></dt>
-<dd>
-<section class="desc"></section>
-</dd>
-<dt><code class="name"><a title="src.communicator.peeraction" href="peeraction.html">src.communicator.peeraction</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicator.uploadqueue" href="uploadqueue/index.html">src.communicator.uploadqueue</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicator.startCommunicator"><code class="name flex">
-<span>def <span class="ident">startCommunicator</span></span>(<span>shared_state)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def startCommunicator(shared_state):
-    OnionrCommunicatorDaemon(shared_state)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="src.communicator.OnionrCommunicatorDaemon"><code class="flex name class">
-<span>class <span class="ident">OnionrCommunicatorDaemon</span></span>
-<span>(</span><span>shared_state, developmentMode=None)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class OnionrCommunicatorDaemon:
-    def __init__(self, shared_state, developmentMode=None):
-        if developmentMode is None:
-            developmentMode = config.get(&#39;general.dev_mode&#39;, False)
-
-        # configure logger and stuff
-        self.config = config
-        self.storage_counter = storagecounter.StorageCounter()
-        self.isOnline = True  # Assume we&#39;re connected to the internet
-        self.shared_state = shared_state  # TooManyObjects module
-
-        if config.get(&#39;general.offline_mode&#39;, False):
-            self.isOnline = False
-
-        # list of timer instances
-        self.timers = []
-
-        # initialize core with Tor socks port being 3rd argument
-        self.proxyPort = shared_state.get(NetController).socksPort
-
-        # Upload information, list of blocks to upload
-        self.blocksToUpload = []
-        self.upload_session_manager = self.shared_state.get(
-            uploadblocks.sessionmanager.BlockUploadSessionManager)
-        self.shared_state.share_object()
-
-        # loop time.sleep delay in seconds
-        self.delay = 1
-
-        # lists of connected peers and peers we know we can&#39;t reach currently
-        self.onlinePeers = []
-        self.offlinePeers = []
-        self.cooldownPeer = {}
-        self.connectTimes = {}
-        # list of peer&#39;s profiles (onionrpeers.PeerProfile instances)
-        self.peerProfiles = []
-        # Peers merged to us. Don&#39;t add to db until we know they&#39;re reachable
-        self.newPeers = []
-        self.announceProgress = {}
-        self.announceCache = {}
-
-        self.generating_blocks = []
-
-        # amount of threads running by name, used to prevent too many
-        self.threadCounts = {}
-
-        # set true when shutdown command received
-        self.shutdown = False
-
-        # list of new blocks to download
-        # added to when new block lists are fetched from peers
-        self.blockQueue = {}
-
-        # list of blocks currently downloading, avoid s
-        self.currentDownloading = []
-
-        # timestamp when the last online node was seen
-        self.lastNodeSeen = None
-
-        # Dict of time stamps for peer&#39;s block list lookup times,
-        # to avoid downloading full lists all the time
-        self.dbTimestamps = {}
-
-        # Loads in and starts the enabled plugins
-        plugins.reload()
-
-        # time app started running for info/statistics purposes
-        self.startTime = epoch.get_epoch()
-
-        # extends our upload list and saves our list when Onionr exits
-        uploadqueue.UploadQueue(self)
-
-        if developmentMode:
-            OnionrCommunicatorTimers(self, self.heartbeat, 30)
-
-        # Set timers, function reference, seconds
-        # requires_peer True means the timer function won&#39;t fire if we
-        # have no connected peers
-        peerPoolTimer = OnionrCommunicatorTimers(
-            self, onlinepeers.get_online_peers, 60, max_threads=1,
-            my_args=[self])
-
-        # Timers to periodically lookup new blocks and download them
-        lookup_blocks_timer = OnionrCommunicatorTimers(
-            self,
-            lookupblocks.lookup_blocks_from_communicator,
-            config.get(&#39;timers.lookupBlocks&#39;, 25),
-            my_args=[self], requires_peer=True, max_threads=1)
-
-        &#34;&#34;&#34;The block download timer is accessed by the block lookup function
-        to trigger faster download starts&#34;&#34;&#34;
-        self.download_blocks_timer = OnionrCommunicatorTimers(
-            self, self.getBlocks, config.get(&#39;timers.getBlocks&#39;, 10),
-            requires_peer=True, max_threads=5)
-
-        # Timer to reset the longest offline peer
-        # so contact can be attempted again
-        OnionrCommunicatorTimers(
-            self, onlinepeers.clear_offline_peer, 58, my_args=[self])
-
-        # Timer to cleanup old blocks
-        blockCleanupTimer = OnionrCommunicatorTimers(
-            self, housekeeping.clean_old_blocks, 20, my_args=[self])
-
-        # Timer to discover new peers
-        OnionrCommunicatorTimers(
-            self, lookupadders.lookup_new_peer_transports_with_communicator,
-            60, requires_peer=True, my_args=[self], max_threads=2)
-
-        # Timer for adjusting which peers
-        # we actively communicate to at any given time,
-        # to avoid over-using peers
-        OnionrCommunicatorTimers(
-            self, cooldownpeer.cooldown_peer, 30,
-            my_args=[self], requires_peer=True)
-
-        # Timer to read the upload queue and upload the entries to peers
-        OnionrCommunicatorTimers(
-            self, uploadblocks.upload_blocks_from_communicator,
-            5, my_args=[self], requires_peer=True, max_threads=1)
-
-        # Setup direct connections
-        if config.get(&#39;general.socket_servers&#39;, False):
-            self.services = onionrservices.OnionrServices()
-            self.active_services = []
-            self.service_greenlets = []
-            OnionrCommunicatorTimers(
-                self, servicecreator.service_creator, 5,
-                max_threads=50, my_args=[self])
-        else:
-            self.services = None
-
-        # {peer_pubkey: ephemeral_address}, the address to reach them
-        self.direct_connection_clients = {}
-
-        # This timer creates deniable blocks,
-        # in an attempt to further obfuscate block insertion metadata
-        if config.get(&#39;general.insert_deniable_blocks&#39;, True):
-            deniableBlockTimer = OnionrCommunicatorTimers(
-                self, deniableinserts.insert_deniable_block,
-                180, my_args=[self], requires_peer=True, max_threads=1)
-            deniableBlockTimer.count = (deniableBlockTimer.frequency - 175)
-
-        # Timer to check for connectivity,
-        # through Tor to various high-profile onion services
-        OnionrCommunicatorTimers(self, netcheck.net_check, 500,
-                                 my_args=[self], max_threads=1)
-
-        # Announce the public API server transport address
-        # to other nodes if security level allows
-        if config.get(&#39;general.security_level&#39;, 1) == 0 \
-                and config.get(&#39;general.announce_node&#39;, True):
-            # Default to high security level incase config breaks
-            announceTimer = OnionrCommunicatorTimers(
-                self,
-                announcenode.announce_node,
-                3600, my_args=[self], requires_peer=True, max_threads=1)
-            announceTimer.count = (announceTimer.frequency - 60)
-        else:
-            logger.debug(&#39;Will not announce node.&#39;)
-
-        # Timer to delete malfunctioning or long-dead peers
-        cleanupTimer = OnionrCommunicatorTimers(
-            self, self.peerCleanup, 300, requires_peer=True)
-
-        # Timer to cleanup dead ephemeral forward secrecy keys
-        OnionrCommunicatorTimers(
-            self, housekeeping.clean_keys, 15, my_args=[self], max_threads=1)
-
-        # Adjust initial timer triggers
-        peerPoolTimer.count = (peerPoolTimer.frequency - 1)
-        cleanupTimer.count = (cleanupTimer.frequency - 60)
-        blockCleanupTimer.count = (blockCleanupTimer.frequency - 2)
-        lookup_blocks_timer = (lookup_blocks_timer.frequency - 2)
-
-        shared_state.add(self)
-
-        if config.get(&#39;general.use_bootstrap_list&#39;, True):
-            bootstrappeers.add_bootstrap_list_to_peer_list(
-                self, [], db_only=True)
-
-        daemoneventhooks.daemon_event_handlers(shared_state)
-
-        if not config.get(&#39;onboarding.done&#39;, True):
-            logger.info(
-                &#39;First run detected. Run openhome to get setup.&#39;,
-                terminal=True)
-
-            while not config.get(&#39;onboarding.done&#39;, True):
-                time.sleep(5)
-
-        # Main daemon loop, mainly for calling timers,
-        # don&#39;t do any complex operations here to avoid locking
-        try:
-            while not self.shutdown:
-                for i in self.timers:
-                    if self.shutdown:
-                        break
-                    i.processTimer()
-                time.sleep(self.delay)
-        except KeyboardInterrupt:
-            self.shutdown = True
-
-        logger.info(
-            &#39;Goodbye. (Onionr is cleaning up, and will exit)&#39;, terminal=True)
-        try:
-            self.service_greenlets
-        except AttributeError:
-            pass
-        else:
-            # Stop onionr direct connection services
-            for server in self.service_greenlets:
-                server.stop()
-        try:
-            time.sleep(0.5)
-        except KeyboardInterrupt:
-            pass
-
-    def getBlocks(self):
-        &#34;&#34;&#34;Download new blocks in queue.&#34;&#34;&#34;
-        downloadblocks.download_blocks_from_communicator(self)
-
-    def decrementThreadCount(self, threadName):
-        &#34;&#34;&#34;Decrement amount of a thread name if more than zero.
-
-        called when a function meant to be run in a thread ends
-        &#34;&#34;&#34;
-        try:
-            if self.threadCounts[threadName] &gt; 0:
-                self.threadCounts[threadName] -= 1
-        except KeyError:
-            pass
-
-    def connectNewPeer(self, peer=&#39;&#39;, useBootstrap=False):
-        &#34;&#34;&#34;Adds a new random online peer to self.onlinePeers&#34;&#34;&#34;
-        connectnewpeers.connect_new_peer_to_communicator(
-            self, peer, useBootstrap)
-
-    def peerCleanup(self):
-        &#34;&#34;&#34;This just calls onionrpeers.cleanupPeers.
-
-        Remove dead or bad peers (offline too long, too slow)&#34;&#34;&#34;
-        onionrpeers.peer_cleanup()
-        self.decrementThreadCount(&#39;peerCleanup&#39;)
-
-    def getPeerProfileInstance(self, peer):
-        &#34;&#34;&#34;Gets a peer profile instance from the list of profiles&#34;&#34;&#34;
-        for i in self.peerProfiles:
-            # if the peer&#39;s profile is already loaded, return that
-            if i.address == peer:
-                retData = i
-                break
-        else:
-            # if the peer&#39;s profile is not loaded, return a new one.
-            # connectNewPeer also adds it to the list on connect
-            retData = onionrpeers.PeerProfiles(peer)
-            self.peerProfiles.append(retData)
-        return retData
-
-    def getUptime(self):
-        return epoch.get_epoch() - self.startTime
-
-    def heartbeat(self):
-        &#34;&#34;&#34;Show a heartbeat debug message.&#34;&#34;&#34;
-        logger.debug(&#39;Heartbeat. Node running for %s.&#39; %
-                     humanreadabletime.human_readable_time(self.getUptime()))
-        self.decrementThreadCount(&#39;heartbeat&#39;)</code></pre>
-</details>
-<h3>Methods</h3>
-<dl>
-<dt id="src.communicator.OnionrCommunicatorDaemon.connectNewPeer"><code class="name flex">
-<span>def <span class="ident">connectNewPeer</span></span>(<span>self, peer='', useBootstrap=False)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Adds a new random online peer to self.onlinePeers</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def connectNewPeer(self, peer=&#39;&#39;, useBootstrap=False):
-    &#34;&#34;&#34;Adds a new random online peer to self.onlinePeers&#34;&#34;&#34;
-    connectnewpeers.connect_new_peer_to_communicator(
-        self, peer, useBootstrap)</code></pre>
-</details>
-</dd>
-<dt id="src.communicator.OnionrCommunicatorDaemon.decrementThreadCount"><code class="name flex">
-<span>def <span class="ident">decrementThreadCount</span></span>(<span>self, threadName)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Decrement amount of a thread name if more than zero.</p>
-<p>called when a function meant to be run in a thread ends</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def decrementThreadCount(self, threadName):
-    &#34;&#34;&#34;Decrement amount of a thread name if more than zero.
-
-    called when a function meant to be run in a thread ends
-    &#34;&#34;&#34;
-    try:
-        if self.threadCounts[threadName] &gt; 0:
-            self.threadCounts[threadName] -= 1
-    except KeyError:
-        pass</code></pre>
-</details>
-</dd>
-<dt id="src.communicator.OnionrCommunicatorDaemon.getBlocks"><code class="name flex">
-<span>def <span class="ident">getBlocks</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Download new blocks in queue.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def getBlocks(self):
-    &#34;&#34;&#34;Download new blocks in queue.&#34;&#34;&#34;
-    downloadblocks.download_blocks_from_communicator(self)</code></pre>
-</details>
-</dd>
-<dt id="src.communicator.OnionrCommunicatorDaemon.getPeerProfileInstance"><code class="name flex">
-<span>def <span class="ident">getPeerProfileInstance</span></span>(<span>self, peer)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Gets a peer profile instance from the list of profiles</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def getPeerProfileInstance(self, peer):
-    &#34;&#34;&#34;Gets a peer profile instance from the list of profiles&#34;&#34;&#34;
-    for i in self.peerProfiles:
-        # if the peer&#39;s profile is already loaded, return that
-        if i.address == peer:
-            retData = i
-            break
-    else:
-        # if the peer&#39;s profile is not loaded, return a new one.
-        # connectNewPeer also adds it to the list on connect
-        retData = onionrpeers.PeerProfiles(peer)
-        self.peerProfiles.append(retData)
-    return retData</code></pre>
-</details>
-</dd>
-<dt id="src.communicator.OnionrCommunicatorDaemon.getUptime"><code class="name flex">
-<span>def <span class="ident">getUptime</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def getUptime(self):
-    return epoch.get_epoch() - self.startTime</code></pre>
-</details>
-</dd>
-<dt id="src.communicator.OnionrCommunicatorDaemon.heartbeat"><code class="name flex">
-<span>def <span class="ident">heartbeat</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Show a heartbeat debug message.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def heartbeat(self):
-    &#34;&#34;&#34;Show a heartbeat debug message.&#34;&#34;&#34;
-    logger.debug(&#39;Heartbeat. Node running for %s.&#39; %
-                 humanreadabletime.human_readable_time(self.getUptime()))
-    self.decrementThreadCount(&#39;heartbeat&#39;)</code></pre>
-</details>
-</dd>
-<dt id="src.communicator.OnionrCommunicatorDaemon.peerCleanup"><code class="name flex">
-<span>def <span class="ident">peerCleanup</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>This just calls onionrpeers.cleanupPeers.</p>
-<p>Remove dead or bad peers (offline too long, too slow)</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def peerCleanup(self):
-    &#34;&#34;&#34;This just calls onionrpeers.cleanupPeers.
-
-    Remove dead or bad peers (offline too long, too slow)&#34;&#34;&#34;
-    onionrpeers.peer_cleanup()
-    self.decrementThreadCount(&#39;peerCleanup&#39;)</code></pre>
-</details>
-</dd>
-</dl>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src" href="../index.html">src</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.communicator.bootstrappeers" href="bootstrappeers.html">src.communicator.bootstrappeers</a></code></li>
-<li><code><a title="src.communicator.daemoneventhooks" href="daemoneventhooks/index.html">src.communicator.daemoneventhooks</a></code></li>
-<li><code><a title="src.communicator.onlinepeers" href="onlinepeers/index.html">src.communicator.onlinepeers</a></code></li>
-<li><code><a title="src.communicator.peeraction" href="peeraction.html">src.communicator.peeraction</a></code></li>
-<li><code><a title="src.communicator.uploadqueue" href="uploadqueue/index.html">src.communicator.uploadqueue</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicator.startCommunicator" href="#src.communicator.startCommunicator">startCommunicator</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="src.communicator.OnionrCommunicatorDaemon" href="#src.communicator.OnionrCommunicatorDaemon">OnionrCommunicatorDaemon</a></code></h4>
-<ul class="">
-<li><code><a title="src.communicator.OnionrCommunicatorDaemon.connectNewPeer" href="#src.communicator.OnionrCommunicatorDaemon.connectNewPeer">connectNewPeer</a></code></li>
-<li><code><a title="src.communicator.OnionrCommunicatorDaemon.decrementThreadCount" href="#src.communicator.OnionrCommunicatorDaemon.decrementThreadCount">decrementThreadCount</a></code></li>
-<li><code><a title="src.communicator.OnionrCommunicatorDaemon.getBlocks" href="#src.communicator.OnionrCommunicatorDaemon.getBlocks">getBlocks</a></code></li>
-<li><code><a title="src.communicator.OnionrCommunicatorDaemon.getPeerProfileInstance" href="#src.communicator.OnionrCommunicatorDaemon.getPeerProfileInstance">getPeerProfileInstance</a></code></li>
-<li><code><a title="src.communicator.OnionrCommunicatorDaemon.getUptime" href="#src.communicator.OnionrCommunicatorDaemon.getUptime">getUptime</a></code></li>
-<li><code><a title="src.communicator.OnionrCommunicatorDaemon.heartbeat" href="#src.communicator.OnionrCommunicatorDaemon.heartbeat">heartbeat</a></code></li>
-<li><code><a title="src.communicator.OnionrCommunicatorDaemon.peerCleanup" href="#src.communicator.OnionrCommunicatorDaemon.peerCleanup">peerCleanup</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicator/onlinepeers/clearofflinepeer.html

@@ -1,124 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicator.onlinepeers.clearofflinepeer API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicator.onlinepeers.clearofflinepeer</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>clear offline peer in a communicator instance</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-clear offline peer in a communicator instance
-&#34;&#34;&#34;
-from typing import TYPE_CHECKING
-
-import logger
-if TYPE_CHECKING:
-    from communicator import OnionrCommunicatorDaemon
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def clear_offline_peer(comm_inst: &#39;OnionrCommunicatorDaemon&#39;):
-    &#34;&#34;&#34;Remove the longest offline peer to retry later.&#34;&#34;&#34;
-    try:
-        removed = comm_inst.offlinePeers.pop(0)
-    except IndexError:
-        pass
-    else:
-        logger.debug(&#39;Removed &#39; + removed +
-                     &#39; from offline list, will try them again.&#39;)
-    comm_inst.decrementThreadCount(&#39;clear_offline_peer&#39;)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicator.onlinepeers.clearofflinepeer.clear_offline_peer"><code class="name flex">
-<span>def <span class="ident">clear_offline_peer</span></span>(<span>comm_inst)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Remove the longest offline peer to retry later.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def clear_offline_peer(comm_inst: &#39;OnionrCommunicatorDaemon&#39;):
-    &#34;&#34;&#34;Remove the longest offline peer to retry later.&#34;&#34;&#34;
-    try:
-        removed = comm_inst.offlinePeers.pop(0)
-    except IndexError:
-        pass
-    else:
-        logger.debug(&#39;Removed &#39; + removed +
-                     &#39; from offline list, will try them again.&#39;)
-    comm_inst.decrementThreadCount(&#39;clear_offline_peer&#39;)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicator.onlinepeers" href="index.html">src.communicator.onlinepeers</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicator.onlinepeers.clearofflinepeer.clear_offline_peer" href="#src.communicator.onlinepeers.clearofflinepeer.clear_offline_peer">clear_offline_peer</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicator/onlinepeers/index.html

@@ -1,91 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicator.onlinepeers API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicator.onlinepeers</code></h1>
-</header>
-<section id="section-intro">
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">from . import clearofflinepeer, onlinepeers, pickonlinepeers, removeonlinepeer
-
-clear_offline_peer = clearofflinepeer.clear_offline_peer
-get_online_peers = onlinepeers.get_online_peers
-pick_online_peer = pickonlinepeers.pick_online_peer
-remove_online_peer = removeonlinepeer.remove_online_peer</code></pre>
-</details>
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.communicator.onlinepeers.clearofflinepeer" href="clearofflinepeer.html">src.communicator.onlinepeers.clearofflinepeer</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicator.onlinepeers.onlinepeers" href="onlinepeers.html">src.communicator.onlinepeers.onlinepeers</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicator.onlinepeers.pickonlinepeers" href="pickonlinepeers.html">src.communicator.onlinepeers.pickonlinepeers</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicator.onlinepeers.removeonlinepeer" href="removeonlinepeer.html">src.communicator.onlinepeers.removeonlinepeer</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicator" href="../index.html">src.communicator</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.communicator.onlinepeers.clearofflinepeer" href="clearofflinepeer.html">src.communicator.onlinepeers.clearofflinepeer</a></code></li>
-<li><code><a title="src.communicator.onlinepeers.onlinepeers" href="onlinepeers.html">src.communicator.onlinepeers.onlinepeers</a></code></li>
-<li><code><a title="src.communicator.onlinepeers.pickonlinepeers" href="pickonlinepeers.html">src.communicator.onlinepeers.pickonlinepeers</a></code></li>
-<li><code><a title="src.communicator.onlinepeers.removeonlinepeer" href="removeonlinepeer.html">src.communicator.onlinepeers.removeonlinepeer</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicator/onlinepeers/onlinepeers.html

@@ -1,173 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicator.onlinepeers.onlinepeers API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicator.onlinepeers.onlinepeers</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>get online peers in a communicator instance</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-get online peers in a communicator instance
-&#34;&#34;&#34;
-import time
-from typing import TYPE_CHECKING
-
-from etc import humanreadabletime
-import logger
-if TYPE_CHECKING:
-    from communicator import OnionrCommunicatorDaemon
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def get_online_peers(comm_inst: &#39;OnionrCommunicatorDaemon&#39;):
-    &#34;&#34;&#34;Manage the comm_inst.onlinePeers attribute list.
-
-    Connect to more peers if we have none connected
-    &#34;&#34;&#34;
-    config = comm_inst.config
-    if config.get(&#39;general.offline_mode&#39;, False):
-        comm_inst.decrementThreadCount(&#39;get_online_peers&#39;)
-        return
-    logger.debug(&#39;Refreshing peer pool...&#39;)
-    max_peers = int(config.get(&#39;peers.max_connect&#39;, 10))
-    needed = max_peers - len(comm_inst.onlinePeers)
-
-    last_seen = &#39;never&#39;
-    if not isinstance(comm_inst.lastNodeSeen, type(None)):
-        last_seen = humanreadabletime.human_readable_time(
-            comm_inst.lastNodeSeen)
-
-    for _ in range(needed):
-        if len(comm_inst.onlinePeers) == 0:
-            comm_inst.connectNewPeer(useBootstrap=True)
-        else:
-            comm_inst.connectNewPeer()
-
-        if comm_inst.shutdown:
-            break
-    else:
-        if len(comm_inst.onlinePeers) == 0:
-            logger.debug(&#39;Couldn\&#39;t connect to any peers.&#39; +
-                         f&#39; Last node seen {last_seen}  ago.&#39;)
-        else:
-            comm_inst.lastNodeSeen = time.time()
-    comm_inst.decrementThreadCount(&#39;get_online_peers&#39;)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicator.onlinepeers.onlinepeers.get_online_peers"><code class="name flex">
-<span>def <span class="ident">get_online_peers</span></span>(<span>comm_inst)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Manage the comm_inst.onlinePeers attribute list.</p>
-<p>Connect to more peers if we have none connected</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def get_online_peers(comm_inst: &#39;OnionrCommunicatorDaemon&#39;):
-    &#34;&#34;&#34;Manage the comm_inst.onlinePeers attribute list.
-
-    Connect to more peers if we have none connected
-    &#34;&#34;&#34;
-    config = comm_inst.config
-    if config.get(&#39;general.offline_mode&#39;, False):
-        comm_inst.decrementThreadCount(&#39;get_online_peers&#39;)
-        return
-    logger.debug(&#39;Refreshing peer pool...&#39;)
-    max_peers = int(config.get(&#39;peers.max_connect&#39;, 10))
-    needed = max_peers - len(comm_inst.onlinePeers)
-
-    last_seen = &#39;never&#39;
-    if not isinstance(comm_inst.lastNodeSeen, type(None)):
-        last_seen = humanreadabletime.human_readable_time(
-            comm_inst.lastNodeSeen)
-
-    for _ in range(needed):
-        if len(comm_inst.onlinePeers) == 0:
-            comm_inst.connectNewPeer(useBootstrap=True)
-        else:
-            comm_inst.connectNewPeer()
-
-        if comm_inst.shutdown:
-            break
-    else:
-        if len(comm_inst.onlinePeers) == 0:
-            logger.debug(&#39;Couldn\&#39;t connect to any peers.&#39; +
-                         f&#39; Last node seen {last_seen}  ago.&#39;)
-        else:
-            comm_inst.lastNodeSeen = time.time()
-    comm_inst.decrementThreadCount(&#39;get_online_peers&#39;)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicator.onlinepeers" href="index.html">src.communicator.onlinepeers</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicator.onlinepeers.onlinepeers.get_online_peers" href="#src.communicator.onlinepeers.onlinepeers.get_online_peers">get_online_peers</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicator/onlinepeers/pickonlinepeers.html

@@ -1,141 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicator.onlinepeers.pickonlinepeers API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicator.onlinepeers.pickonlinepeers</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>pick online peers in a communicator instance</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;
-Onionr - Private P2P Communication.
-
-pick online peers in a communicator instance
-&#34;&#34;&#34;
-import secrets
-
-import onionrexceptions
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def pick_online_peer(comm_inst):
-    &#34;&#34;&#34;Randomly picks peer from pool without bias (using secrets module).&#34;&#34;&#34;
-    ret_data = &#39;&#39;
-    peer_length = len(comm_inst.onlinePeers)
-    if peer_length &lt;= 0:
-        raise onionrexceptions.OnlinePeerNeeded
-
-    while True:
-        peer_length = len(comm_inst.onlinePeers)
-
-        try:
-            # Get a random online peer, securely.
-            # May get stuck in loop if network is lost
-            ret_data = comm_inst.onlinePeers[secrets.randbelow(peer_length)]
-        except IndexError:
-            pass
-        else:
-            break
-    return ret_data</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicator.onlinepeers.pickonlinepeers.pick_online_peer"><code class="name flex">
-<span>def <span class="ident">pick_online_peer</span></span>(<span>comm_inst)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Randomly picks peer from pool without bias (using secrets module).</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def pick_online_peer(comm_inst):
-    &#34;&#34;&#34;Randomly picks peer from pool without bias (using secrets module).&#34;&#34;&#34;
-    ret_data = &#39;&#39;
-    peer_length = len(comm_inst.onlinePeers)
-    if peer_length &lt;= 0:
-        raise onionrexceptions.OnlinePeerNeeded
-
-    while True:
-        peer_length = len(comm_inst.onlinePeers)
-
-        try:
-            # Get a random online peer, securely.
-            # May get stuck in loop if network is lost
-            ret_data = comm_inst.onlinePeers[secrets.randbelow(peer_length)]
-        except IndexError:
-            pass
-        else:
-            break
-    return ret_data</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicator.onlinepeers" href="index.html">src.communicator.onlinepeers</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicator.onlinepeers.pickonlinepeers.pick_online_peer" href="#src.communicator.onlinepeers.pickonlinepeers.pick_online_peer">pick_online_peer</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicator/onlinepeers/removeonlinepeer.html

@@ -1,127 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicator.onlinepeers.removeonlinepeer API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicator.onlinepeers.removeonlinepeer</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>remove an online peer from the pool in a communicator instance</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-remove an online peer from the pool in a communicator instance
-&#34;&#34;&#34;
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def remove_online_peer(comm_inst, peer):
-    &#34;&#34;&#34;Remove an online peer.&#34;&#34;&#34;
-    try:
-        del comm_inst.connectTimes[peer]
-    except KeyError:
-        pass
-    try:
-        del comm_inst.dbTimestamps[peer]
-    except KeyError:
-        pass
-    try:
-        comm_inst.onlinePeers.remove(peer)
-    except ValueError:
-        pass</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicator.onlinepeers.removeonlinepeer.remove_online_peer"><code class="name flex">
-<span>def <span class="ident">remove_online_peer</span></span>(<span>comm_inst, peer)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Remove an online peer.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def remove_online_peer(comm_inst, peer):
-    &#34;&#34;&#34;Remove an online peer.&#34;&#34;&#34;
-    try:
-        del comm_inst.connectTimes[peer]
-    except KeyError:
-        pass
-    try:
-        del comm_inst.dbTimestamps[peer]
-    except KeyError:
-        pass
-    try:
-        comm_inst.onlinePeers.remove(peer)
-    except ValueError:
-        pass</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicator.onlinepeers" href="index.html">src.communicator.onlinepeers</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicator.onlinepeers.removeonlinepeer.remove_online_peer" href="#src.communicator.onlinepeers.removeonlinepeer.remove_online_peer">remove_online_peer</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicator/peeraction.html

@@ -1,178 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicator.peeraction API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicator.peeraction</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>This file implements logic for performing requests to Onionr peers</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-This file implements logic for performing requests to Onionr peers
-&#34;&#34;&#34;
-import streamedrequests
-import logger
-from onionrutils import epoch, basicrequests
-from coredb import keydb
-from . import onlinepeers
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def peer_action(comm_inst, peer, action,
-                returnHeaders=False, max_resp_size=5242880):
-    &#34;&#34;&#34;Perform a get request to a peer.&#34;&#34;&#34;
-    penalty_score = -10
-    if len(peer) == 0:
-        return False
-    url = &#39;http://%s/%s&#39; % (peer, action)
-
-    try:
-        ret_data = basicrequests.do_get_request(url, port=comm_inst.proxyPort,
-                                                max_size=max_resp_size)
-    except streamedrequests.exceptions.ResponseLimitReached:
-        logger.warn(
-            &#39;Request failed due to max response size being overflowed&#39;,
-            terminal=True)
-        ret_data = False
-        penalty_score = -100
-    # if request failed, (error), mark peer offline
-    if ret_data is False:
-        try:
-            comm_inst.getPeerProfileInstance(peer).addScore(penalty_score)
-            onlinepeers.remove_online_peer(comm_inst, peer)
-            keydb.transportinfo.set_address_info(
-                peer, &#39;lastConnectAttempt&#39;, epoch.get_epoch())
-            if action != &#39;ping&#39; and not comm_inst.shutdown:
-                logger.warn(f&#39;Lost connection to {peer}&#39;, terminal=True)
-                # Will only add a new peer to pool if needed
-                onlinepeers.get_online_peers(comm_inst)
-        except ValueError:
-            pass
-    else:
-        peer_profile = comm_inst.getPeerProfileInstance(peer)
-        peer_profile.update_connect_time()
-        peer_profile.addScore(1)
-    # If returnHeaders, returns tuple of data, headers.
-    # If not, just data string
-    return ret_data</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicator.peeraction.peer_action"><code class="name flex">
-<span>def <span class="ident">peer_action</span></span>(<span>comm_inst, peer, action, returnHeaders=False, max_resp_size=5242880)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Perform a get request to a peer.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def peer_action(comm_inst, peer, action,
-                returnHeaders=False, max_resp_size=5242880):
-    &#34;&#34;&#34;Perform a get request to a peer.&#34;&#34;&#34;
-    penalty_score = -10
-    if len(peer) == 0:
-        return False
-    url = &#39;http://%s/%s&#39; % (peer, action)
-
-    try:
-        ret_data = basicrequests.do_get_request(url, port=comm_inst.proxyPort,
-                                                max_size=max_resp_size)
-    except streamedrequests.exceptions.ResponseLimitReached:
-        logger.warn(
-            &#39;Request failed due to max response size being overflowed&#39;,
-            terminal=True)
-        ret_data = False
-        penalty_score = -100
-    # if request failed, (error), mark peer offline
-    if ret_data is False:
-        try:
-            comm_inst.getPeerProfileInstance(peer).addScore(penalty_score)
-            onlinepeers.remove_online_peer(comm_inst, peer)
-            keydb.transportinfo.set_address_info(
-                peer, &#39;lastConnectAttempt&#39;, epoch.get_epoch())
-            if action != &#39;ping&#39; and not comm_inst.shutdown:
-                logger.warn(f&#39;Lost connection to {peer}&#39;, terminal=True)
-                # Will only add a new peer to pool if needed
-                onlinepeers.get_online_peers(comm_inst)
-        except ValueError:
-            pass
-    else:
-        peer_profile = comm_inst.getPeerProfileInstance(peer)
-        peer_profile.update_connect_time()
-        peer_profile.addScore(1)
-    # If returnHeaders, returns tuple of data, headers.
-    # If not, just data string
-    return ret_data</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicator" href="index.html">src.communicator</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicator.peeraction.peer_action" href="#src.communicator.peeraction.peer_action">peer_action</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicator/uploadqueue/index.html

@@ -1,215 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicator.uploadqueue API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicator.uploadqueue</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>Class to remember blocks that need to be uploaded
-and not shared on startup/shutdown</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-Class to remember blocks that need to be uploaded
-and not shared on startup/shutdown
-&#34;&#34;&#34;
-import atexit
-import os
-from typing import TYPE_CHECKING
-
-import deadsimplekv
-
-import filepaths
-from onionrutils import localcommand
-if TYPE_CHECKING:
-    from communicator import OnionrCommunicatorDaemon
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-UPLOAD_MEMORY_FILE = filepaths.upload_list
-
-
-def _add_to_hidden_blocks(cache):
-    for bl in cache:
-        localcommand.local_command(&#39;waitforshare/&#39; + bl, post=True)
-
-
-class UploadQueue:
-    &#34;&#34;&#34;Saves and loads block upload info from json file.&#34;&#34;&#34;
-
-    def __init__(self, communicator: &#39;OnionrCommunicatorDaemon&#39;):
-        &#34;&#34;&#34;Start the UploadQueue object, loading left over uploads into queue.
-
-        register save shutdown function
-        &#34;&#34;&#34;
-        self.communicator = communicator
-        cache: deadsimplekv.DeadSimpleKV = deadsimplekv.DeadSimpleKV(
-            UPLOAD_MEMORY_FILE)
-        self.store_obj = cache
-        cache = cache.get(&#39;uploads&#39;)
-        if cache is None:
-            cache = []
-
-        _add_to_hidden_blocks(cache)
-        self.communicator.blocksToUpload.extend(cache)
-
-        atexit.register(self.save)
-
-    def save(self):
-        &#34;&#34;&#34;Save to disk on shutdown or if called manually.&#34;&#34;&#34;
-        bl: deadsimplekv.DeadSimpleKV = self.communicator.blocksToUpload
-        if len(bl) == 0:
-            try:
-                os.remove(UPLOAD_MEMORY_FILE)
-            except FileNotFoundError:
-                pass
-        else:
-            self.store_obj.put(&#39;uploads&#39;, bl)
-            self.store_obj.flush()</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="src.communicator.uploadqueue.UploadQueue"><code class="flex name class">
-<span>class <span class="ident">UploadQueue</span></span>
-<span>(</span><span>communicator)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Saves and loads block upload info from json file.</p>
-<p>Start the UploadQueue object, loading left over uploads into queue.</p>
-<p>register save shutdown function</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class UploadQueue:
-    &#34;&#34;&#34;Saves and loads block upload info from json file.&#34;&#34;&#34;
-
-    def __init__(self, communicator: &#39;OnionrCommunicatorDaemon&#39;):
-        &#34;&#34;&#34;Start the UploadQueue object, loading left over uploads into queue.
-
-        register save shutdown function
-        &#34;&#34;&#34;
-        self.communicator = communicator
-        cache: deadsimplekv.DeadSimpleKV = deadsimplekv.DeadSimpleKV(
-            UPLOAD_MEMORY_FILE)
-        self.store_obj = cache
-        cache = cache.get(&#39;uploads&#39;)
-        if cache is None:
-            cache = []
-
-        _add_to_hidden_blocks(cache)
-        self.communicator.blocksToUpload.extend(cache)
-
-        atexit.register(self.save)
-
-    def save(self):
-        &#34;&#34;&#34;Save to disk on shutdown or if called manually.&#34;&#34;&#34;
-        bl: deadsimplekv.DeadSimpleKV = self.communicator.blocksToUpload
-        if len(bl) == 0:
-            try:
-                os.remove(UPLOAD_MEMORY_FILE)
-            except FileNotFoundError:
-                pass
-        else:
-            self.store_obj.put(&#39;uploads&#39;, bl)
-            self.store_obj.flush()</code></pre>
-</details>
-<h3>Methods</h3>
-<dl>
-<dt id="src.communicator.uploadqueue.UploadQueue.save"><code class="name flex">
-<span>def <span class="ident">save</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Save to disk on shutdown or if called manually.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def save(self):
-    &#34;&#34;&#34;Save to disk on shutdown or if called manually.&#34;&#34;&#34;
-    bl: deadsimplekv.DeadSimpleKV = self.communicator.blocksToUpload
-    if len(bl) == 0:
-        try:
-            os.remove(UPLOAD_MEMORY_FILE)
-        except FileNotFoundError:
-            pass
-    else:
-        self.store_obj.put(&#39;uploads&#39;, bl)
-        self.store_obj.flush()</code></pre>
-</details>
-</dd>
-</dl>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicator" href="../index.html">src.communicator</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="src.communicator.uploadqueue.UploadQueue" href="#src.communicator.uploadqueue.UploadQueue">UploadQueue</a></code></h4>
-<ul class="">
-<li><code><a title="src.communicator.uploadqueue.UploadQueue.save" href="#src.communicator.uploadqueue.UploadQueue.save">save</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/announcenode.html

@@ -1,202 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.announcenode API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.announcenode</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>Use a communicator instance to announce
-our transport address to connected nodes</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;
-    Onionr - Private P2P Communication.
-
-Use a communicator instance to announce
-our transport address to connected nodes
-&#34;&#34;&#34;
-import base64
-import onionrproofs
-import logger
-from etc import onionrvalues
-from onionrutils import basicrequests, bytesconverter
-from utils import gettransports
-from netcontroller import NetController
-from communicator import onlinepeers
-from coredb import keydb
-import onionrexceptions
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def announce_node(daemon):
-    &#34;&#34;&#34;Announce our node to our peers.&#34;&#34;&#34;
-    ret_data = False
-    announce_fail = False
-
-    # Do not let announceCache get too large
-    if len(daemon.announceCache) &gt;= 10000:
-        daemon.announceCache.popitem()
-
-    if daemon.config.get(&#39;general.security_level&#39;, 0) == 0:
-        # Announce to random online peers
-        for i in daemon.onlinePeers:
-            if i not in daemon.announceCache and\
-                    i not in daemon.announceProgress:
-                peer = i
-                break
-        else:
-            try:
-                peer = onlinepeers.pick_online_peer(daemon)
-            except onionrexceptions.OnlinePeerNeeded:
-                peer = &#34;&#34;
-
-        try:
-            ourID = gettransports.get()[0]
-            if not peer:
-                raise onionrexceptions.OnlinePeerNeeded
-        except (IndexError, onionrexceptions.OnlinePeerNeeded):
-            pass
-        else:
-            url = &#39;http://&#39; + peer + &#39;/announce&#39;
-            data = {&#39;node&#39;: ourID}
-
-            logger.info(&#39;Announcing node to &#39; + url)
-            if basicrequests.do_post_request(
-                    url,
-                    data,
-                    port=daemon.shared_state.get(NetController).socksPort)\
-                    == &#39;Success&#39;:
-                logger.info(&#39;Successfully introduced node to &#39; + peer,
-                            terminal=True)
-                ret_data = True
-                keydb.transportinfo.set_address_info(peer, &#39;introduced&#39;, 1)
-
-    daemon.decrementThreadCount(&#39;announce_node&#39;)
-    return ret_data</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicatorutils.announcenode.announce_node"><code class="name flex">
-<span>def <span class="ident">announce_node</span></span>(<span>daemon)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Announce our node to our peers.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def announce_node(daemon):
-    &#34;&#34;&#34;Announce our node to our peers.&#34;&#34;&#34;
-    ret_data = False
-    announce_fail = False
-
-    # Do not let announceCache get too large
-    if len(daemon.announceCache) &gt;= 10000:
-        daemon.announceCache.popitem()
-
-    if daemon.config.get(&#39;general.security_level&#39;, 0) == 0:
-        # Announce to random online peers
-        for i in daemon.onlinePeers:
-            if i not in daemon.announceCache and\
-                    i not in daemon.announceProgress:
-                peer = i
-                break
-        else:
-            try:
-                peer = onlinepeers.pick_online_peer(daemon)
-            except onionrexceptions.OnlinePeerNeeded:
-                peer = &#34;&#34;
-
-        try:
-            ourID = gettransports.get()[0]
-            if not peer:
-                raise onionrexceptions.OnlinePeerNeeded
-        except (IndexError, onionrexceptions.OnlinePeerNeeded):
-            pass
-        else:
-            url = &#39;http://&#39; + peer + &#39;/announce&#39;
-            data = {&#39;node&#39;: ourID}
-
-            logger.info(&#39;Announcing node to &#39; + url)
-            if basicrequests.do_post_request(
-                    url,
-                    data,
-                    port=daemon.shared_state.get(NetController).socksPort)\
-                    == &#39;Success&#39;:
-                logger.info(&#39;Successfully introduced node to &#39; + peer,
-                            terminal=True)
-                ret_data = True
-                keydb.transportinfo.set_address_info(peer, &#39;introduced&#39;, 1)
-
-    daemon.decrementThreadCount(&#39;announce_node&#39;)
-    return ret_data</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils" href="index.html">src.communicatorutils</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicatorutils.announcenode.announce_node" href="#src.communicatorutils.announcenode.announce_node">announce_node</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/connectnewpeers.html

@@ -1,242 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.connectnewpeers API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.connectnewpeers</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>Connect a new peer to our communicator instance. Does so randomly if no peer is specified</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    Connect a new peer to our communicator instance. Does so randomly if no peer is specified
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-import time, sys, secrets
-import onionrexceptions, logger, onionrpeers
-from utils import networkmerger, gettransports
-from onionrutils import stringvalidators, epoch
-from communicator import peeraction, bootstrappeers
-from coredb import keydb
-def connect_new_peer_to_communicator(comm_inst, peer=&#39;&#39;, useBootstrap=False):
-    config = comm_inst.config
-    retData = False
-    tried = comm_inst.offlinePeers
-    transports = gettransports.get()
-    if peer != &#39;&#39;:
-        if stringvalidators.validate_transport(peer):
-            peerList = [peer]
-        else:
-            raise onionrexceptions.InvalidAddress(&#39;Will not attempt connection test to invalid address&#39;)
-    else:
-        peerList = keydb.listkeys.list_adders()
-
-    mainPeerList = keydb.listkeys.list_adders()
-    peerList = onionrpeers.get_score_sorted_peer_list()
-
-    # If we don&#39;t have enough peers connected or random chance, select new peers to try
-    if len(peerList) &lt; 8 or secrets.randbelow(4) == 3:
-        tryingNew = []
-        for x in comm_inst.newPeers:
-            if x not in peerList:
-                peerList.append(x)
-                tryingNew.append(x)
-        for i in tryingNew:
-            comm_inst.newPeers.remove(i)
-    
-    if len(peerList) == 0 or useBootstrap:
-        # Avoid duplicating bootstrap addresses in peerList
-        if config.get(&#39;general.use_bootstrap_list&#39;, True):
-            bootstrappeers.add_bootstrap_list_to_peer_list(comm_inst, peerList)
-
-    for address in peerList:
-        address = address.strip()
-
-        if not config.get(&#39;tor.v3onions&#39;) and len(address) == 62:
-            continue
-        # Don&#39;t connect to our own address
-        if address in transports:
-            continue
-        # Don&#39;t connect to invalid address or if its already been tried/connected, or if its cooled down
-        if len(address) == 0 or address in tried or address in comm_inst.onlinePeers or address in comm_inst.cooldownPeer:
-            continue
-        if comm_inst.shutdown:
-            return
-        # Ping a peer,
-        ret = peeraction.peer_action(comm_inst, address, &#39;ping&#39;)
-        if ret == &#39;pong!&#39;:
-            time.sleep(0.1)
-            if address not in mainPeerList:
-                # Add a peer to our list if it isn&#39;t already since it successfully connected
-                networkmerger.mergeAdders(address)
-            if address not in comm_inst.onlinePeers:
-                logger.info(&#39;Connected to &#39; + address, terminal=True)
-                comm_inst.onlinePeers.append(address)
-                comm_inst.connectTimes[address] = epoch.get_epoch()
-            retData = address
-
-            # add peer to profile list if they&#39;re not in it
-            for profile in comm_inst.peerProfiles:
-                if profile.address == address:
-                    break
-            else:
-                comm_inst.peerProfiles.append(onionrpeers.PeerProfiles(address))
-            break
-        else:
-            # Mark a peer as tried if they failed to respond to ping
-            tried.append(address)
-            logger.debug(&#39;Failed to connect to %s: %s &#39; % (address, ret))
-    return retData</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicatorutils.connectnewpeers.connect_new_peer_to_communicator"><code class="name flex">
-<span>def <span class="ident">connect_new_peer_to_communicator</span></span>(<span>comm_inst, peer='', useBootstrap=False)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def connect_new_peer_to_communicator(comm_inst, peer=&#39;&#39;, useBootstrap=False):
-    config = comm_inst.config
-    retData = False
-    tried = comm_inst.offlinePeers
-    transports = gettransports.get()
-    if peer != &#39;&#39;:
-        if stringvalidators.validate_transport(peer):
-            peerList = [peer]
-        else:
-            raise onionrexceptions.InvalidAddress(&#39;Will not attempt connection test to invalid address&#39;)
-    else:
-        peerList = keydb.listkeys.list_adders()
-
-    mainPeerList = keydb.listkeys.list_adders()
-    peerList = onionrpeers.get_score_sorted_peer_list()
-
-    # If we don&#39;t have enough peers connected or random chance, select new peers to try
-    if len(peerList) &lt; 8 or secrets.randbelow(4) == 3:
-        tryingNew = []
-        for x in comm_inst.newPeers:
-            if x not in peerList:
-                peerList.append(x)
-                tryingNew.append(x)
-        for i in tryingNew:
-            comm_inst.newPeers.remove(i)
-    
-    if len(peerList) == 0 or useBootstrap:
-        # Avoid duplicating bootstrap addresses in peerList
-        if config.get(&#39;general.use_bootstrap_list&#39;, True):
-            bootstrappeers.add_bootstrap_list_to_peer_list(comm_inst, peerList)
-
-    for address in peerList:
-        address = address.strip()
-
-        if not config.get(&#39;tor.v3onions&#39;) and len(address) == 62:
-            continue
-        # Don&#39;t connect to our own address
-        if address in transports:
-            continue
-        # Don&#39;t connect to invalid address or if its already been tried/connected, or if its cooled down
-        if len(address) == 0 or address in tried or address in comm_inst.onlinePeers or address in comm_inst.cooldownPeer:
-            continue
-        if comm_inst.shutdown:
-            return
-        # Ping a peer,
-        ret = peeraction.peer_action(comm_inst, address, &#39;ping&#39;)
-        if ret == &#39;pong!&#39;:
-            time.sleep(0.1)
-            if address not in mainPeerList:
-                # Add a peer to our list if it isn&#39;t already since it successfully connected
-                networkmerger.mergeAdders(address)
-            if address not in comm_inst.onlinePeers:
-                logger.info(&#39;Connected to &#39; + address, terminal=True)
-                comm_inst.onlinePeers.append(address)
-                comm_inst.connectTimes[address] = epoch.get_epoch()
-            retData = address
-
-            # add peer to profile list if they&#39;re not in it
-            for profile in comm_inst.peerProfiles:
-                if profile.address == address:
-                    break
-            else:
-                comm_inst.peerProfiles.append(onionrpeers.PeerProfiles(address))
-            break
-        else:
-            # Mark a peer as tried if they failed to respond to ping
-            tried.append(address)
-            logger.debug(&#39;Failed to connect to %s: %s &#39; % (address, ret))
-    return retData</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils" href="index.html">src.communicatorutils</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicatorutils.connectnewpeers.connect_new_peer_to_communicator" href="#src.communicatorutils.connectnewpeers.connect_new_peer_to_communicator">connect_new_peer_to_communicator</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/cooldownpeer.html

@@ -1,166 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.cooldownpeer API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.cooldownpeer</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>Select a random online peer in a communicator instance and have them "cool down"</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    Select a random online peer in a communicator instance and have them &#34;cool down&#34;
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-from onionrutils import epoch
-from communicator import onlinepeers
-def cooldown_peer(comm_inst):
-    &#39;&#39;&#39;Randomly add an online peer to cooldown, so we can connect a new one&#39;&#39;&#39;
-    config = comm_inst.config
-    onlinePeerAmount = len(comm_inst.onlinePeers)
-    minTime = 300
-    cooldownTime = 600
-    toCool = &#39;&#39;
-    tempConnectTimes = dict(comm_inst.connectTimes)
-
-    # Remove peers from cooldown that have been there long enough
-    tempCooldown = dict(comm_inst.cooldownPeer)
-    for peer in tempCooldown:
-        if (epoch.get_epoch() - tempCooldown[peer]) &gt;= cooldownTime:
-            del comm_inst.cooldownPeer[peer]
-
-    # Cool down a peer, if we have max connections alive for long enough
-    if onlinePeerAmount &gt;= config.get(&#39;peers.max_connect&#39;, 10, save = True):
-        finding = True
-
-        while finding:
-            try:
-                toCool = min(tempConnectTimes, key=tempConnectTimes.get)
-                if (epoch.get_epoch() - tempConnectTimes[toCool]) &lt; minTime:
-                    del tempConnectTimes[toCool]
-                else:
-                    finding = False
-            except ValueError:
-                break
-        else:
-            onlinepeers.remove_online_peer(comm_inst, toCool)
-            comm_inst.cooldownPeer[toCool] = epoch.get_epoch()
-
-    comm_inst.decrementThreadCount(&#39;cooldown_peer&#39;)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicatorutils.cooldownpeer.cooldown_peer"><code class="name flex">
-<span>def <span class="ident">cooldown_peer</span></span>(<span>comm_inst)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Randomly add an online peer to cooldown, so we can connect a new one</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def cooldown_peer(comm_inst):
-    &#39;&#39;&#39;Randomly add an online peer to cooldown, so we can connect a new one&#39;&#39;&#39;
-    config = comm_inst.config
-    onlinePeerAmount = len(comm_inst.onlinePeers)
-    minTime = 300
-    cooldownTime = 600
-    toCool = &#39;&#39;
-    tempConnectTimes = dict(comm_inst.connectTimes)
-
-    # Remove peers from cooldown that have been there long enough
-    tempCooldown = dict(comm_inst.cooldownPeer)
-    for peer in tempCooldown:
-        if (epoch.get_epoch() - tempCooldown[peer]) &gt;= cooldownTime:
-            del comm_inst.cooldownPeer[peer]
-
-    # Cool down a peer, if we have max connections alive for long enough
-    if onlinePeerAmount &gt;= config.get(&#39;peers.max_connect&#39;, 10, save = True):
-        finding = True
-
-        while finding:
-            try:
-                toCool = min(tempConnectTimes, key=tempConnectTimes.get)
-                if (epoch.get_epoch() - tempConnectTimes[toCool]) &lt; minTime:
-                    del tempConnectTimes[toCool]
-                else:
-                    finding = False
-            except ValueError:
-                break
-        else:
-            onlinepeers.remove_online_peer(comm_inst, toCool)
-            comm_inst.cooldownPeer[toCool] = epoch.get_epoch()
-
-    comm_inst.decrementThreadCount(&#39;cooldown_peer&#39;)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils" href="index.html">src.communicatorutils</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicatorutils.cooldownpeer.cooldown_peer" href="#src.communicatorutils.cooldownpeer.cooldown_peer">cooldown_peer</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/deniableinserts.html

@@ -1,121 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.deniableinserts API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.deniableinserts</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>Use the communicator to insert fake mail messages</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    Use the communicator to insert fake mail messages
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-import secrets
-from etc import onionrvalues
-import onionrblocks
-def insert_deniable_block(comm_inst):
-    &#39;&#39;&#39;Insert a fake block in order to make it more difficult to track real blocks&#39;&#39;&#39;
-    fakePeer = &#39;&#39;
-    chance = 10
-    if secrets.randbelow(chance) == (chance - 1):
-        # This assumes on the libsodium primitives to have key-privacy
-        fakePeer = onionrvalues.DENIABLE_PEER_ADDRESS
-        data = secrets.token_hex(secrets.randbelow(5120) + 1)
-        onionrblocks.insert(data, header=&#39;pm&#39;, encryptType=&#39;asym&#39;, asymPeer=fakePeer, disableForward=True, meta={&#39;subject&#39;: &#39;foo&#39;})
-    comm_inst.decrementThreadCount(&#39;insert_deniable_block&#39;)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicatorutils.deniableinserts.insert_deniable_block"><code class="name flex">
-<span>def <span class="ident">insert_deniable_block</span></span>(<span>comm_inst)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Insert a fake block in order to make it more difficult to track real blocks</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def insert_deniable_block(comm_inst):
-    &#39;&#39;&#39;Insert a fake block in order to make it more difficult to track real blocks&#39;&#39;&#39;
-    fakePeer = &#39;&#39;
-    chance = 10
-    if secrets.randbelow(chance) == (chance - 1):
-        # This assumes on the libsodium primitives to have key-privacy
-        fakePeer = onionrvalues.DENIABLE_PEER_ADDRESS
-        data = secrets.token_hex(secrets.randbelow(5120) + 1)
-        onionrblocks.insert(data, header=&#39;pm&#39;, encryptType=&#39;asym&#39;, asymPeer=fakePeer, disableForward=True, meta={&#39;subject&#39;: &#39;foo&#39;})
-    comm_inst.decrementThreadCount(&#39;insert_deniable_block&#39;)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils" href="index.html">src.communicatorutils</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicatorutils.deniableinserts.insert_deniable_block" href="#src.communicatorutils.deniableinserts.insert_deniable_block">insert_deniable_block</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/downloadblocks/index.html

@@ -1,375 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.downloadblocks API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.downloadblocks</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>Download blocks using the communicator instance</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;
-    Onionr - Private P2P Communication
-
-    Download blocks using the communicator instance
-&#34;&#34;&#34;
-from typing import TYPE_CHECKING
-if TYPE_CHECKING:
-    from communicator import OnionrCommunicatorDaemon
-
-from gevent import spawn
-
-import onionrexceptions
-import logger
-import onionrpeers
-import communicator
-from communicator import peeraction
-from communicator import onlinepeers
-from onionrutils import blockmetadata
-from onionrutils import validatemetadata
-from coredb import blockmetadb
-from onionrutils.localcommand import local_command
-import onionrcrypto
-import onionrstorage
-from onionrblocks import onionrblacklist
-from onionrblocks import storagecounter
-from . import shoulddownload
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def download_blocks_from_communicator(comm_inst: &#34;OnionrCommunicatorDaemon&#34;):
-    &#34;&#34;&#34;Use communicator instance to download blocks in the comms&#39;s queue&#34;&#34;&#34;
-    blacklist = onionrblacklist.OnionrBlackList()
-    storage_counter = storagecounter.StorageCounter()
-    LOG_SKIP_COUNT = 50 # for how many iterations we skip logging the counter
-    count: int = 0
-    metadata_validation_result: bool = False
-    # Iterate the block queue in the communicator
-    for blockHash in list(comm_inst.blockQueue):
-        count += 1
-
-        triedQueuePeers = [] # List of peers we&#39;ve tried for a block
-        try:
-            blockPeers = list(comm_inst.blockQueue[blockHash])
-        except KeyError:
-            blockPeers = []
-        removeFromQueue = True
-
-        if not shoulddownload.should_download(comm_inst, blockHash):
-            continue
-
-        if comm_inst.shutdown or not comm_inst.isOnline or storage_counter.is_full():
-            # Exit loop if shutting down or offline, or disk allocation reached
-            break
-        # Do not download blocks being downloaded
-        if blockHash in comm_inst.currentDownloading:
-            continue
-
-        if len(comm_inst.onlinePeers) == 0:
-            break
-
-        comm_inst.currentDownloading.append(blockHash) # So we can avoid concurrent downloading in other threads of same block
-        if len(blockPeers) == 0:
-            try:
-                peerUsed = onlinepeers.pick_online_peer(comm_inst)
-            except onionrexceptions.OnlinePeerNeeded:
-                continue
-        else:
-            blockPeers = onionrcrypto.cryptoutils.random_shuffle(blockPeers)
-            peerUsed = blockPeers.pop(0)
-
-        if not comm_inst.shutdown and peerUsed.strip() != &#39;&#39;:
-            logger.info(&#34;Attempting to download %s from %s...&#34; % (blockHash[:12], peerUsed))
-        content = peeraction.peer_action(comm_inst, peerUsed, &#39;getdata/&#39; + blockHash, max_resp_size=3000000) # block content from random peer (includes metadata)
-
-        if content is not False and len(content) &gt; 0:
-            try:
-                content = content.encode()
-            except AttributeError:
-                pass
-
-            realHash = onionrcrypto.hashers.sha3_hash(content)
-            try:
-                realHash = realHash.decode() # bytes on some versions for some reason
-            except AttributeError:
-                pass
-            if realHash == blockHash:
-                #content = content.decode() # decode here because sha3Hash needs bytes above
-                metas = blockmetadata.get_block_metadata_from_data(content) # returns tuple(metadata, meta), meta is also in metadata
-                metadata = metas[0]
-                try:
-                    metadata_validation_result = \
-                        validatemetadata.validate_metadata(metadata, metas[2])
-                except onionrexceptions.DataExists:
-                    metadata_validation_result = False
-                if metadata_validation_result: # check if metadata is valid, and verify nonce
-                    if onionrcrypto.cryptoutils.verify_POW(content): # check if POW is enough/correct
-                        logger.info(&#39;Attempting to save block %s...&#39; % blockHash[:12])
-                        try:
-                            onionrstorage.set_data(content)
-                        except onionrexceptions.DataExists:
-                            logger.warn(&#39;Data is already set for %s &#39; % (blockHash,))
-                        except onionrexceptions.DiskAllocationReached:
-                            logger.error(&#39;Reached disk allocation allowance, cannot save block %s.&#39; % (blockHash,))
-                            removeFromQueue = False
-                        else:
-                            blockmetadb.add_to_block_DB(blockHash, dataSaved=True) # add block to meta db
-                            spawn(
-                                local_command,
-                                f&#39;/daemon-event/upload_event&#39;,
-                                post=True,
-                                is_json=True,
-                                postData={&#39;block&#39;: blockHash}
-                            )
-
-                            blockmetadata.process_block_metadata(blockHash) # caches block metadata values to block database
-                    else:
-                        logger.warn(&#39;POW failed for block %s.&#39; % (blockHash,))
-                else:
-                    if blacklist.inBlacklist(realHash):
-                        logger.warn(&#39;Block %s is blacklisted.&#39; % (realHash,))
-                    else:
-                        logger.warn(&#39;Metadata for block %s is invalid.&#39; % (blockHash,))
-                        blacklist.addToDB(blockHash)
-            else:
-                # if block didn&#39;t meet expected hash
-                tempHash = onionrcrypto.hashers.sha3_hash(content) # lazy hack, TODO use var
-                try:
-                    tempHash = tempHash.decode()
-                except AttributeError:
-                    pass
-                # Punish peer for sharing invalid block (not always malicious, but is bad regardless)
-                onionrpeers.PeerProfiles(peerUsed).addScore(-50)
-                if tempHash != &#39;ed55e34cb828232d6c14da0479709bfa10a0923dca2b380496e6b2ed4f7a0253&#39;:
-                    # Dumb hack for 404 response from peer. Don&#39;t log it if 404 since its likely not malicious or a critical error.
-                    logger.warn(
-                        &#39;Block hash validation failed for &#39; +
-                        blockHash + &#39; got &#39; + tempHash)
-                else:
-                    removeFromQueue = False # Don&#39;t remove from queue if 404
-            if removeFromQueue:
-                try:
-                    del comm_inst.blockQueue[blockHash] # remove from block queue both if success or false
-                    if count == LOG_SKIP_COUNT:
-                        logger.info(&#39;%s blocks remaining in queue&#39; %
-                        [len(comm_inst.blockQueue)], terminal=True)
-                        count = 0
-                except KeyError:
-                    pass
-        comm_inst.currentDownloading.remove(blockHash)
-    comm_inst.decrementThreadCount(&#39;getBlocks&#39;)</code></pre>
-</details>
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.communicatorutils.downloadblocks.shoulddownload" href="shoulddownload.html">src.communicatorutils.downloadblocks.shoulddownload</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicatorutils.downloadblocks.download_blocks_from_communicator"><code class="name flex">
-<span>def <span class="ident">download_blocks_from_communicator</span></span>(<span>comm_inst)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Use communicator instance to download blocks in the comms's queue</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def download_blocks_from_communicator(comm_inst: &#34;OnionrCommunicatorDaemon&#34;):
-    &#34;&#34;&#34;Use communicator instance to download blocks in the comms&#39;s queue&#34;&#34;&#34;
-    blacklist = onionrblacklist.OnionrBlackList()
-    storage_counter = storagecounter.StorageCounter()
-    LOG_SKIP_COUNT = 50 # for how many iterations we skip logging the counter
-    count: int = 0
-    metadata_validation_result: bool = False
-    # Iterate the block queue in the communicator
-    for blockHash in list(comm_inst.blockQueue):
-        count += 1
-
-        triedQueuePeers = [] # List of peers we&#39;ve tried for a block
-        try:
-            blockPeers = list(comm_inst.blockQueue[blockHash])
-        except KeyError:
-            blockPeers = []
-        removeFromQueue = True
-
-        if not shoulddownload.should_download(comm_inst, blockHash):
-            continue
-
-        if comm_inst.shutdown or not comm_inst.isOnline or storage_counter.is_full():
-            # Exit loop if shutting down or offline, or disk allocation reached
-            break
-        # Do not download blocks being downloaded
-        if blockHash in comm_inst.currentDownloading:
-            continue
-
-        if len(comm_inst.onlinePeers) == 0:
-            break
-
-        comm_inst.currentDownloading.append(blockHash) # So we can avoid concurrent downloading in other threads of same block
-        if len(blockPeers) == 0:
-            try:
-                peerUsed = onlinepeers.pick_online_peer(comm_inst)
-            except onionrexceptions.OnlinePeerNeeded:
-                continue
-        else:
-            blockPeers = onionrcrypto.cryptoutils.random_shuffle(blockPeers)
-            peerUsed = blockPeers.pop(0)
-
-        if not comm_inst.shutdown and peerUsed.strip() != &#39;&#39;:
-            logger.info(&#34;Attempting to download %s from %s...&#34; % (blockHash[:12], peerUsed))
-        content = peeraction.peer_action(comm_inst, peerUsed, &#39;getdata/&#39; + blockHash, max_resp_size=3000000) # block content from random peer (includes metadata)
-
-        if content is not False and len(content) &gt; 0:
-            try:
-                content = content.encode()
-            except AttributeError:
-                pass
-
-            realHash = onionrcrypto.hashers.sha3_hash(content)
-            try:
-                realHash = realHash.decode() # bytes on some versions for some reason
-            except AttributeError:
-                pass
-            if realHash == blockHash:
-                #content = content.decode() # decode here because sha3Hash needs bytes above
-                metas = blockmetadata.get_block_metadata_from_data(content) # returns tuple(metadata, meta), meta is also in metadata
-                metadata = metas[0]
-                try:
-                    metadata_validation_result = \
-                        validatemetadata.validate_metadata(metadata, metas[2])
-                except onionrexceptions.DataExists:
-                    metadata_validation_result = False
-                if metadata_validation_result: # check if metadata is valid, and verify nonce
-                    if onionrcrypto.cryptoutils.verify_POW(content): # check if POW is enough/correct
-                        logger.info(&#39;Attempting to save block %s...&#39; % blockHash[:12])
-                        try:
-                            onionrstorage.set_data(content)
-                        except onionrexceptions.DataExists:
-                            logger.warn(&#39;Data is already set for %s &#39; % (blockHash,))
-                        except onionrexceptions.DiskAllocationReached:
-                            logger.error(&#39;Reached disk allocation allowance, cannot save block %s.&#39; % (blockHash,))
-                            removeFromQueue = False
-                        else:
-                            blockmetadb.add_to_block_DB(blockHash, dataSaved=True) # add block to meta db
-                            spawn(
-                                local_command,
-                                f&#39;/daemon-event/upload_event&#39;,
-                                post=True,
-                                is_json=True,
-                                postData={&#39;block&#39;: blockHash}
-                            )
-
-                            blockmetadata.process_block_metadata(blockHash) # caches block metadata values to block database
-                    else:
-                        logger.warn(&#39;POW failed for block %s.&#39; % (blockHash,))
-                else:
-                    if blacklist.inBlacklist(realHash):
-                        logger.warn(&#39;Block %s is blacklisted.&#39; % (realHash,))
-                    else:
-                        logger.warn(&#39;Metadata for block %s is invalid.&#39; % (blockHash,))
-                        blacklist.addToDB(blockHash)
-            else:
-                # if block didn&#39;t meet expected hash
-                tempHash = onionrcrypto.hashers.sha3_hash(content) # lazy hack, TODO use var
-                try:
-                    tempHash = tempHash.decode()
-                except AttributeError:
-                    pass
-                # Punish peer for sharing invalid block (not always malicious, but is bad regardless)
-                onionrpeers.PeerProfiles(peerUsed).addScore(-50)
-                if tempHash != &#39;ed55e34cb828232d6c14da0479709bfa10a0923dca2b380496e6b2ed4f7a0253&#39;:
-                    # Dumb hack for 404 response from peer. Don&#39;t log it if 404 since its likely not malicious or a critical error.
-                    logger.warn(
-                        &#39;Block hash validation failed for &#39; +
-                        blockHash + &#39; got &#39; + tempHash)
-                else:
-                    removeFromQueue = False # Don&#39;t remove from queue if 404
-            if removeFromQueue:
-                try:
-                    del comm_inst.blockQueue[blockHash] # remove from block queue both if success or false
-                    if count == LOG_SKIP_COUNT:
-                        logger.info(&#39;%s blocks remaining in queue&#39; %
-                        [len(comm_inst.blockQueue)], terminal=True)
-                        count = 0
-                except KeyError:
-                    pass
-        comm_inst.currentDownloading.remove(blockHash)
-    comm_inst.decrementThreadCount(&#39;getBlocks&#39;)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils" href="../index.html">src.communicatorutils</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.communicatorutils.downloadblocks.shoulddownload" href="shoulddownload.html">src.communicatorutils.downloadblocks.shoulddownload</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicatorutils.downloadblocks.download_blocks_from_communicator" href="#src.communicatorutils.downloadblocks.download_blocks_from_communicator">download_blocks_from_communicator</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/downloadblocks/shoulddownload.html

@@ -1,139 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.downloadblocks.shoulddownload API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.downloadblocks.shoulddownload</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>Check if a block should be downloaded
-(if we already have it or its blacklisted or not)</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-Check if a block should be downloaded
-(if we already have it or its blacklisted or not)
-&#34;&#34;&#34;
-from coredb import blockmetadb
-from onionrblocks import onionrblacklist
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def should_download(comm_inst, block_hash) -&gt; bool:
-    &#34;&#34;&#34;Return bool for if a (assumed to exist) block should be downloaded.&#34;&#34;&#34;
-    blacklist = onionrblacklist.OnionrBlackList()
-    should = True
-    if block_hash in blockmetadb.get_block_list():
-        # Don&#39;t download block we have
-        should = False
-    else:
-        if blacklist.inBlacklist(block_hash):
-            # Don&#39;t download blacklisted block
-            should = False
-    if should is False:
-        # Remove block from communicator queue if it shouldn&#39;t be downloaded
-        try:
-            del comm_inst.blockQueue[block_hash]
-        except KeyError:
-            pass
-    return should</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicatorutils.downloadblocks.shoulddownload.should_download"><code class="name flex">
-<span>def <span class="ident">should_download</span></span>(<span>comm_inst, block_hash)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Return bool for if a (assumed to exist) block should be downloaded.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def should_download(comm_inst, block_hash) -&gt; bool:
-    &#34;&#34;&#34;Return bool for if a (assumed to exist) block should be downloaded.&#34;&#34;&#34;
-    blacklist = onionrblacklist.OnionrBlackList()
-    should = True
-    if block_hash in blockmetadb.get_block_list():
-        # Don&#39;t download block we have
-        should = False
-    else:
-        if blacklist.inBlacklist(block_hash):
-            # Don&#39;t download blacklisted block
-            should = False
-    if should is False:
-        # Remove block from communicator queue if it shouldn&#39;t be downloaded
-        try:
-            del comm_inst.blockQueue[block_hash]
-        except KeyError:
-            pass
-    return should</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils.downloadblocks" href="index.html">src.communicatorutils.downloadblocks</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicatorutils.downloadblocks.shoulddownload.should_download" href="#src.communicatorutils.downloadblocks.shoulddownload.should_download">should_download</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/housekeeping.html

@@ -1,206 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.housekeeping API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.housekeeping</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>Cleanup old Onionr blocks and forward secrecy keys using the communicator. Ran from a timer usually</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    Cleanup old Onionr blocks and forward secrecy keys using the communicator. Ran from a timer usually
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-import sqlite3
-import logger
-from onionrusers import onionrusers
-from onionrutils import epoch
-from coredb import blockmetadb, dbfiles
-import onionrstorage
-from onionrstorage import removeblock
-from onionrblocks import onionrblacklist
-
-def __remove_from_upload(comm_inst, block_hash: str):
-    try:
-        comm_inst.blocksToUpload.remove(block_hash)
-    except ValueError:
-        pass
-
-def clean_old_blocks(comm_inst):
-    &#39;&#39;&#39;Delete old blocks if our disk allocation is full/near full, and also expired blocks&#39;&#39;&#39;
-    blacklist = onionrblacklist.OnionrBlackList()
-    # Delete expired blocks
-    for bHash in blockmetadb.expiredblocks.get_expired_blocks():
-        blacklist.addToDB(bHash)
-        removeblock.remove_block(bHash)
-        onionrstorage.deleteBlock(bHash)
-        __remove_from_upload(comm_inst, bHash)
-        logger.info(&#39;Deleted block: %s&#39; % (bHash,))
-
-    while comm_inst.storage_counter.is_full():
-        oldest = blockmetadb.get_block_list()[0]
-        blacklist.addToDB(oldest)
-        removeblock.remove_block(oldest)
-        onionrstorage.deleteBlock(oldest)
-        __remove_from_upload.remove(comm_inst, oldest)
-        logger.info(&#39;Deleted block: %s&#39; % (oldest,))
-
-    comm_inst.decrementThreadCount(&#39;clean_old_blocks&#39;)
-
-def clean_keys(comm_inst):
-    &#39;&#39;&#39;Delete expired forward secrecy keys&#39;&#39;&#39;
-    conn = sqlite3.connect(dbfiles.user_id_info_db, timeout=10)
-    c = conn.cursor()
-    time = epoch.get_epoch()
-    deleteKeys = []
-
-    for entry in c.execute(&#34;SELECT * FROM forwardKeys WHERE expire &lt;= ?&#34;, (time,)):
-        logger.debug(&#39;Forward key: %s&#39; % entry[1])
-        deleteKeys.append(entry[1])
-
-    for key in deleteKeys:
-        logger.debug(&#39;Deleting forward key %s&#39; % key)
-        c.execute(&#34;DELETE from forwardKeys where forwardKey = ?&#34;, (key,))
-    conn.commit()
-    conn.close()
-
-    onionrusers.deleteExpiredKeys()
-
-    comm_inst.decrementThreadCount(&#39;clean_keys&#39;)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicatorutils.housekeeping.clean_keys"><code class="name flex">
-<span>def <span class="ident">clean_keys</span></span>(<span>comm_inst)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Delete expired forward secrecy keys</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def clean_keys(comm_inst):
-    &#39;&#39;&#39;Delete expired forward secrecy keys&#39;&#39;&#39;
-    conn = sqlite3.connect(dbfiles.user_id_info_db, timeout=10)
-    c = conn.cursor()
-    time = epoch.get_epoch()
-    deleteKeys = []
-
-    for entry in c.execute(&#34;SELECT * FROM forwardKeys WHERE expire &lt;= ?&#34;, (time,)):
-        logger.debug(&#39;Forward key: %s&#39; % entry[1])
-        deleteKeys.append(entry[1])
-
-    for key in deleteKeys:
-        logger.debug(&#39;Deleting forward key %s&#39; % key)
-        c.execute(&#34;DELETE from forwardKeys where forwardKey = ?&#34;, (key,))
-    conn.commit()
-    conn.close()
-
-    onionrusers.deleteExpiredKeys()
-
-    comm_inst.decrementThreadCount(&#39;clean_keys&#39;)</code></pre>
-</details>
-</dd>
-<dt id="src.communicatorutils.housekeeping.clean_old_blocks"><code class="name flex">
-<span>def <span class="ident">clean_old_blocks</span></span>(<span>comm_inst)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Delete old blocks if our disk allocation is full/near full, and also expired blocks</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def clean_old_blocks(comm_inst):
-    &#39;&#39;&#39;Delete old blocks if our disk allocation is full/near full, and also expired blocks&#39;&#39;&#39;
-    blacklist = onionrblacklist.OnionrBlackList()
-    # Delete expired blocks
-    for bHash in blockmetadb.expiredblocks.get_expired_blocks():
-        blacklist.addToDB(bHash)
-        removeblock.remove_block(bHash)
-        onionrstorage.deleteBlock(bHash)
-        __remove_from_upload(comm_inst, bHash)
-        logger.info(&#39;Deleted block: %s&#39; % (bHash,))
-
-    while comm_inst.storage_counter.is_full():
-        oldest = blockmetadb.get_block_list()[0]
-        blacklist.addToDB(oldest)
-        removeblock.remove_block(oldest)
-        onionrstorage.deleteBlock(oldest)
-        __remove_from_upload.remove(comm_inst, oldest)
-        logger.info(&#39;Deleted block: %s&#39; % (oldest,))
-
-    comm_inst.decrementThreadCount(&#39;clean_old_blocks&#39;)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils" href="index.html">src.communicatorutils</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicatorutils.housekeeping.clean_keys" href="#src.communicatorutils.housekeeping.clean_keys">clean_keys</a></code></li>
-<li><code><a title="src.communicatorutils.housekeeping.clean_old_blocks" href="#src.communicatorutils.housekeeping.clean_old_blocks">clean_old_blocks</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/index.html

@@ -1,130 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.communicatorutils.announcenode" href="announcenode.html">src.communicatorutils.announcenode</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicatorutils.connectnewpeers" href="connectnewpeers.html">src.communicatorutils.connectnewpeers</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicatorutils.cooldownpeer" href="cooldownpeer.html">src.communicatorutils.cooldownpeer</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicatorutils.deniableinserts" href="deniableinserts.html">src.communicatorutils.deniableinserts</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicatorutils.downloadblocks" href="downloadblocks/index.html">src.communicatorutils.downloadblocks</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicatorutils.housekeeping" href="housekeeping.html">src.communicatorutils.housekeeping</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicatorutils.lookupadders" href="lookupadders.html">src.communicatorutils.lookupadders</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicatorutils.lookupblocks" href="lookupblocks.html">src.communicatorutils.lookupblocks</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicatorutils.netcheck" href="netcheck.html">src.communicatorutils.netcheck</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicatorutils.onionrcommunicatortimers" href="onionrcommunicatortimers.html">src.communicatorutils.onionrcommunicatortimers</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicatorutils.proxypicker" href="proxypicker.html">src.communicatorutils.proxypicker</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicatorutils.restarttor" href="restarttor.html">src.communicatorutils.restarttor</a></code></dt>
-<dd>
-<section class="desc"></section>
-</dd>
-<dt><code class="name"><a title="src.communicatorutils.servicecreator" href="servicecreator.html">src.communicatorutils.servicecreator</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicatorutils.uploadblocks" href="uploadblocks/index.html">src.communicatorutils.uploadblocks</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src" href="../index.html">src</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.communicatorutils.announcenode" href="announcenode.html">src.communicatorutils.announcenode</a></code></li>
-<li><code><a title="src.communicatorutils.connectnewpeers" href="connectnewpeers.html">src.communicatorutils.connectnewpeers</a></code></li>
-<li><code><a title="src.communicatorutils.cooldownpeer" href="cooldownpeer.html">src.communicatorutils.cooldownpeer</a></code></li>
-<li><code><a title="src.communicatorutils.deniableinserts" href="deniableinserts.html">src.communicatorutils.deniableinserts</a></code></li>
-<li><code><a title="src.communicatorutils.downloadblocks" href="downloadblocks/index.html">src.communicatorutils.downloadblocks</a></code></li>
-<li><code><a title="src.communicatorutils.housekeeping" href="housekeeping.html">src.communicatorutils.housekeeping</a></code></li>
-<li><code><a title="src.communicatorutils.lookupadders" href="lookupadders.html">src.communicatorutils.lookupadders</a></code></li>
-<li><code><a title="src.communicatorutils.lookupblocks" href="lookupblocks.html">src.communicatorutils.lookupblocks</a></code></li>
-<li><code><a title="src.communicatorutils.netcheck" href="netcheck.html">src.communicatorutils.netcheck</a></code></li>
-<li><code><a title="src.communicatorutils.onionrcommunicatortimers" href="onionrcommunicatortimers.html">src.communicatorutils.onionrcommunicatortimers</a></code></li>
-<li><code><a title="src.communicatorutils.proxypicker" href="proxypicker.html">src.communicatorutils.proxypicker</a></code></li>
-<li><code><a title="src.communicatorutils.restarttor" href="restarttor.html">src.communicatorutils.restarttor</a></code></li>
-<li><code><a title="src.communicatorutils.servicecreator" href="servicecreator.html">src.communicatorutils.servicecreator</a></code></li>
-<li><code><a title="src.communicatorutils.uploadblocks" href="uploadblocks/index.html">src.communicatorutils.uploadblocks</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/lookupadders.html

@@ -1,173 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.lookupadders API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.lookupadders</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>Lookup new peer transport addresses using the communicator</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    Lookup new peer transport addresses using the communicator
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-import logger
-from onionrutils import stringvalidators
-from communicator import peeraction, onlinepeers
-from utils import gettransports
-import onionrexceptions
-def lookup_new_peer_transports_with_communicator(comm_inst):
-    logger.info(&#39;Looking up new addresses...&#39;)
-    tryAmount = 1
-    newPeers = []
-    transports = gettransports.get()
-
-    for i in range(tryAmount):
-        # Download new peer address list from random online peers
-        if len(newPeers) &gt; 10000:
-            # Don&#39;t get new peers if we have too many queued up
-            break
-        try:
-            peer = onlinepeers.pick_online_peer(comm_inst)
-            newAdders = peeraction.peer_action(comm_inst, peer, action=&#39;pex&#39;)
-        except onionrexceptions.OnlinePeerNeeded:
-            continue
-        try:
-            newPeers = newAdders.split(&#39;,&#39;)
-        except AttributeError:
-            pass
-    else:
-        # Validate new peers are good format and not already in queue
-        invalid = []
-        for x in newPeers:
-            x = x.strip()
-            if not stringvalidators.validate_transport(x) or x in comm_inst.newPeers or x in transports:
-                # avoid adding if its our address
-                invalid.append(x)
-        for x in invalid:
-            try:
-                newPeers.remove(x)
-            except ValueError:
-                pass
-        comm_inst.newPeers.extend(newPeers)
-    comm_inst.decrementThreadCount(&#39;lookup_new_peer_transports_with_communicator&#39;)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicatorutils.lookupadders.lookup_new_peer_transports_with_communicator"><code class="name flex">
-<span>def <span class="ident">lookup_new_peer_transports_with_communicator</span></span>(<span>comm_inst)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def lookup_new_peer_transports_with_communicator(comm_inst):
-    logger.info(&#39;Looking up new addresses...&#39;)
-    tryAmount = 1
-    newPeers = []
-    transports = gettransports.get()
-
-    for i in range(tryAmount):
-        # Download new peer address list from random online peers
-        if len(newPeers) &gt; 10000:
-            # Don&#39;t get new peers if we have too many queued up
-            break
-        try:
-            peer = onlinepeers.pick_online_peer(comm_inst)
-            newAdders = peeraction.peer_action(comm_inst, peer, action=&#39;pex&#39;)
-        except onionrexceptions.OnlinePeerNeeded:
-            continue
-        try:
-            newPeers = newAdders.split(&#39;,&#39;)
-        except AttributeError:
-            pass
-    else:
-        # Validate new peers are good format and not already in queue
-        invalid = []
-        for x in newPeers:
-            x = x.strip()
-            if not stringvalidators.validate_transport(x) or x in comm_inst.newPeers or x in transports:
-                # avoid adding if its our address
-                invalid.append(x)
-        for x in invalid:
-            try:
-                newPeers.remove(x)
-            except ValueError:
-                pass
-        comm_inst.newPeers.extend(newPeers)
-    comm_inst.decrementThreadCount(&#39;lookup_new_peer_transports_with_communicator&#39;)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils" href="index.html">src.communicatorutils</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicatorutils.lookupadders.lookup_new_peer_transports_with_communicator" href="#src.communicatorutils.lookupadders.lookup_new_peer_transports_with_communicator">lookup_new_peer_transports_with_communicator</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/lookupblocks.html

@@ -1,254 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.lookupblocks API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.lookupblocks</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>Lookup new blocks with the communicator using a random connected peer</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    Lookup new blocks with the communicator using a random connected peer
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-from gevent import time
-
-import logger, onionrproofs
-from onionrutils import stringvalidators, epoch
-from communicator import peeraction, onlinepeers
-from coredb import blockmetadb
-from utils import reconstructhash
-from onionrblocks import onionrblacklist
-import onionrexceptions
-blacklist = onionrblacklist.OnionrBlackList()
-def lookup_blocks_from_communicator(comm_inst):
-    logger.info(&#39;Looking up new blocks&#39;)
-    tryAmount = 2
-    newBlocks = &#39;&#39;
-    existingBlocks = blockmetadb.get_block_list() # List of existing saved blocks
-    triedPeers = [] # list of peers we&#39;ve tried this time around
-    maxBacklog = 1560 # Max amount of *new* block hashes to have already in queue, to avoid memory exhaustion
-    lastLookupTime = 0 # Last time we looked up a particular peer&#39;s list
-    new_block_count = 0
-    for i in range(tryAmount):
-        listLookupCommand = &#39;getblocklist&#39; # This is defined here to reset it each time
-        if len(comm_inst.blockQueue) &gt;= maxBacklog:
-            break
-        if not comm_inst.isOnline:
-            break
-        # check if disk allocation is used
-        if comm_inst.storage_counter.is_full():
-            logger.debug(&#39;Not looking up new blocks due to maximum amount of allowed disk space used&#39;)
-            break
-        try:
-            # select random online peer
-            peer = onlinepeers.pick_online_peer(comm_inst)
-        except onionrexceptions.OnlinePeerNeeded:
-            time.sleep(1)
-            continue
-        # if we&#39;ve already tried all the online peers this time around, stop
-        if peer in triedPeers:
-            if len(comm_inst.onlinePeers) == len(triedPeers):
-                break
-            else:
-                continue
-        triedPeers.append(peer)
-
-        # Get the last time we looked up a peer&#39;s stamp to only fetch blocks since then.
-        # Saved in memory only for privacy reasons
-        try:
-            lastLookupTime = comm_inst.dbTimestamps[peer]
-        except KeyError:
-            lastLookupTime = 0
-        else:
-            listLookupCommand += &#39;?date=%s&#39; % (lastLookupTime,)
-        try:
-            newBlocks = peeraction.peer_action(comm_inst, peer, listLookupCommand) # get list of new block hashes
-        except Exception as error:
-            logger.warn(&#39;Could not get new blocks from %s.&#39; % peer, error = error)
-            newBlocks = False
-        else:
-            comm_inst.dbTimestamps[peer] = epoch.get_rounded_epoch(roundS=60)
-        if newBlocks != False:
-            # if request was a success
-            for i in newBlocks.split(&#39;\n&#39;):
-                if stringvalidators.validate_hash(i):
-                    i = reconstructhash.reconstruct_hash(i)
-                    # if newline seperated string is valid hash
-                    if not i in existingBlocks:
-                        # if block does not exist on disk and is not already in block queue
-                        if i not in comm_inst.blockQueue:
-                            if onionrproofs.hashMeetsDifficulty(i) and not blacklist.inBlacklist(i):
-                                if len(comm_inst.blockQueue) &lt;= 1000000:
-                                    comm_inst.blockQueue[i] = [peer] # add blocks to download queue
-                                    new_block_count += 1
-                        else:
-                            if peer not in comm_inst.blockQueue[i]:
-                                if len(comm_inst.blockQueue[i]) &lt; 10:
-                                    comm_inst.blockQueue[i].append(peer)
-    if new_block_count &gt; 0:
-        block_string = &#34;&#34;
-        if new_block_count &gt; 1:
-            block_string = &#34;s&#34;
-        logger.info(&#39;Discovered %s new block%s&#39; % (new_block_count, block_string), terminal=True)
-        comm_inst.download_blocks_timer.count = int(comm_inst.download_blocks_timer.frequency * 0.99)
-    comm_inst.decrementThreadCount(&#39;lookup_blocks_from_communicator&#39;)
-    return</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicatorutils.lookupblocks.lookup_blocks_from_communicator"><code class="name flex">
-<span>def <span class="ident">lookup_blocks_from_communicator</span></span>(<span>comm_inst)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def lookup_blocks_from_communicator(comm_inst):
-    logger.info(&#39;Looking up new blocks&#39;)
-    tryAmount = 2
-    newBlocks = &#39;&#39;
-    existingBlocks = blockmetadb.get_block_list() # List of existing saved blocks
-    triedPeers = [] # list of peers we&#39;ve tried this time around
-    maxBacklog = 1560 # Max amount of *new* block hashes to have already in queue, to avoid memory exhaustion
-    lastLookupTime = 0 # Last time we looked up a particular peer&#39;s list
-    new_block_count = 0
-    for i in range(tryAmount):
-        listLookupCommand = &#39;getblocklist&#39; # This is defined here to reset it each time
-        if len(comm_inst.blockQueue) &gt;= maxBacklog:
-            break
-        if not comm_inst.isOnline:
-            break
-        # check if disk allocation is used
-        if comm_inst.storage_counter.is_full():
-            logger.debug(&#39;Not looking up new blocks due to maximum amount of allowed disk space used&#39;)
-            break
-        try:
-            # select random online peer
-            peer = onlinepeers.pick_online_peer(comm_inst)
-        except onionrexceptions.OnlinePeerNeeded:
-            time.sleep(1)
-            continue
-        # if we&#39;ve already tried all the online peers this time around, stop
-        if peer in triedPeers:
-            if len(comm_inst.onlinePeers) == len(triedPeers):
-                break
-            else:
-                continue
-        triedPeers.append(peer)
-
-        # Get the last time we looked up a peer&#39;s stamp to only fetch blocks since then.
-        # Saved in memory only for privacy reasons
-        try:
-            lastLookupTime = comm_inst.dbTimestamps[peer]
-        except KeyError:
-            lastLookupTime = 0
-        else:
-            listLookupCommand += &#39;?date=%s&#39; % (lastLookupTime,)
-        try:
-            newBlocks = peeraction.peer_action(comm_inst, peer, listLookupCommand) # get list of new block hashes
-        except Exception as error:
-            logger.warn(&#39;Could not get new blocks from %s.&#39; % peer, error = error)
-            newBlocks = False
-        else:
-            comm_inst.dbTimestamps[peer] = epoch.get_rounded_epoch(roundS=60)
-        if newBlocks != False:
-            # if request was a success
-            for i in newBlocks.split(&#39;\n&#39;):
-                if stringvalidators.validate_hash(i):
-                    i = reconstructhash.reconstruct_hash(i)
-                    # if newline seperated string is valid hash
-                    if not i in existingBlocks:
-                        # if block does not exist on disk and is not already in block queue
-                        if i not in comm_inst.blockQueue:
-                            if onionrproofs.hashMeetsDifficulty(i) and not blacklist.inBlacklist(i):
-                                if len(comm_inst.blockQueue) &lt;= 1000000:
-                                    comm_inst.blockQueue[i] = [peer] # add blocks to download queue
-                                    new_block_count += 1
-                        else:
-                            if peer not in comm_inst.blockQueue[i]:
-                                if len(comm_inst.blockQueue[i]) &lt; 10:
-                                    comm_inst.blockQueue[i].append(peer)
-    if new_block_count &gt; 0:
-        block_string = &#34;&#34;
-        if new_block_count &gt; 1:
-            block_string = &#34;s&#34;
-        logger.info(&#39;Discovered %s new block%s&#39; % (new_block_count, block_string), terminal=True)
-        comm_inst.download_blocks_timer.count = int(comm_inst.download_blocks_timer.frequency * 0.99)
-    comm_inst.decrementThreadCount(&#39;lookup_blocks_from_communicator&#39;)
-    return</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils" href="index.html">src.communicatorutils</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicatorutils.lookupblocks.lookup_blocks_from_communicator" href="#src.communicatorutils.lookupblocks.lookup_blocks_from_communicator">lookup_blocks_from_communicator</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/netcheck.html

@@ -1,159 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.netcheck API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.netcheck</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>Determine if our node is able to use Tor based
-on the status of a communicator instance
-and the result of pinging onion http servers</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;
-    Onionr - Private P2P Communication
-
-    Determine if our node is able to use Tor based
-    on the status of a communicator instance
-    and the result of pinging onion http servers
-&#34;&#34;&#34;
-import logger
-from utils import netutils
-from onionrutils import localcommand, epoch
-from . import restarttor
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def net_check(comm_inst):
-    &#34;&#34;&#34;Check if we are connected to the internet
-    or not when we can&#39;t connect to any peers&#34;&#34;&#34;
-    # for detecting if we have received incoming connections recently
-    rec = False
-    if len(comm_inst.onlinePeers) == 0:
-        try:
-            if (epoch.get_epoch() - int(localcommand.local_command
-                                        (&#39;/lastconnect&#39;))) &lt;= 60:
-                comm_inst.isOnline = True
-                rec = True
-        except ValueError:
-            pass
-        if not rec and not netutils.checkNetwork(torPort=comm_inst.proxyPort):
-            if not comm_inst.shutdown:
-                if not comm_inst.config.get(&#39;general.offline_mode&#39;, False):
-                    logger.warn(&#39;Network check failed, are you connected to &#39; +
-                                &#39;the Internet, and is Tor working?&#39;,
-                                terminal=True)
-                    restarttor.restart(comm_inst)
-                    comm_inst.offlinePeers = []
-            comm_inst.isOnline = False
-        else:
-            comm_inst.isOnline = True
-    comm_inst.decrementThreadCount(&#39;net_check&#39;)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicatorutils.netcheck.net_check"><code class="name flex">
-<span>def <span class="ident">net_check</span></span>(<span>comm_inst)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Check if we are connected to the internet
-or not when we can't connect to any peers</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def net_check(comm_inst):
-    &#34;&#34;&#34;Check if we are connected to the internet
-    or not when we can&#39;t connect to any peers&#34;&#34;&#34;
-    # for detecting if we have received incoming connections recently
-    rec = False
-    if len(comm_inst.onlinePeers) == 0:
-        try:
-            if (epoch.get_epoch() - int(localcommand.local_command
-                                        (&#39;/lastconnect&#39;))) &lt;= 60:
-                comm_inst.isOnline = True
-                rec = True
-        except ValueError:
-            pass
-        if not rec and not netutils.checkNetwork(torPort=comm_inst.proxyPort):
-            if not comm_inst.shutdown:
-                if not comm_inst.config.get(&#39;general.offline_mode&#39;, False):
-                    logger.warn(&#39;Network check failed, are you connected to &#39; +
-                                &#39;the Internet, and is Tor working?&#39;,
-                                terminal=True)
-                    restarttor.restart(comm_inst)
-                    comm_inst.offlinePeers = []
-            comm_inst.isOnline = False
-        else:
-            comm_inst.isOnline = True
-    comm_inst.decrementThreadCount(&#39;net_check&#39;)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils" href="index.html">src.communicatorutils</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicatorutils.netcheck.net_check" href="#src.communicatorutils.netcheck.net_check">net_check</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/onionrcommunicatortimers.html

@@ -1,253 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.onionrcommunicatortimers API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.onionrcommunicatortimers</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>This file contains timer control for the communicator</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    This file contains timer control for the communicator
-&#39;&#39;&#39;
-from __future__ import annotations  # thank you python, very cool
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-
-import uuid
-import threading
-
-import onionrexceptions, logger
-
-from typing import TYPE_CHECKING
-from typing import Callable, NewType, Iterable
-if TYPE_CHECKING:
-    from communicator import OnionrCommunicatorDaemon
-
-CallFreqSeconds = NewType(&#39;CallFreqSeconds&#39;, int)
-
-class OnionrCommunicatorTimers:
-    def __init__(self, daemon_inst: OnionrCommunicatorDaemon, 
-                timer_function: Callable, frequency: CallFreqSeconds, 
-                make_thread:bool=True, thread_amount:int=1, max_threads:int=5, 
-                requires_peer:bool=False, my_args:Iterable=[]):
-        self.timer_function = timer_function
-        self.frequency = frequency
-        self.thread_amount = thread_amount
-        self.make_thread = make_thread
-        self.requires_peer = requires_peer
-        self.daemon_inst = daemon_inst
-        self.max_threads = max_threads
-        self.args = my_args
-
-        self.daemon_inst.timers.append(self)
-        self.count = 0
-
-    def processTimer(self):
-
-        # mark how many instances of a thread we have (decremented at thread end)
-        try:
-            self.daemon_inst.threadCounts[self.timer_function.__name__]
-        except KeyError:
-            self.daemon_inst.threadCounts[self.timer_function.__name__] = 0
-
-        # execute thread if it is time, and we are not missing *required* online peer
-        if self.count == self.frequency and not self.daemon_inst.shutdown:
-            try:
-                if self.requires_peer and len(self.daemon_inst.onlinePeers) == 0:
-                    raise onionrexceptions.OnlinePeerNeeded
-            except onionrexceptions.OnlinePeerNeeded:
-                return
-            else:
-                if self.make_thread:
-                    for i in range(self.thread_amount):
-                        if self.daemon_inst.threadCounts[self.timer_function.__name__] &gt;= self.max_threads:
-                            logger.debug(&#39;%s is currently using the maximum number of threads, not starting another.&#39; % self.timer_function.__name__)
-                        else:
-                            self.daemon_inst.threadCounts[self.timer_function.__name__] += 1
-                            newThread = threading.Thread(target=self.timer_function, args=self.args, daemon=True, 
-                                                        name=self.timer_function.__name__ + &#39; - &#39; + str(uuid.uuid4()))
-                            newThread.start()
-                else:
-                    self.timer_function()
-            self.count = -1 # negative 1 because its incremented at bottom
-        self.count += 1</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="src.communicatorutils.onionrcommunicatortimers.OnionrCommunicatorTimers"><code class="flex name class">
-<span>class <span class="ident">OnionrCommunicatorTimers</span></span>
-<span>(</span><span>daemon_inst, timer_function, frequency, make_thread=True, thread_amount=1, max_threads=5, requires_peer=False, my_args=[])</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class OnionrCommunicatorTimers:
-    def __init__(self, daemon_inst: OnionrCommunicatorDaemon, 
-                timer_function: Callable, frequency: CallFreqSeconds, 
-                make_thread:bool=True, thread_amount:int=1, max_threads:int=5, 
-                requires_peer:bool=False, my_args:Iterable=[]):
-        self.timer_function = timer_function
-        self.frequency = frequency
-        self.thread_amount = thread_amount
-        self.make_thread = make_thread
-        self.requires_peer = requires_peer
-        self.daemon_inst = daemon_inst
-        self.max_threads = max_threads
-        self.args = my_args
-
-        self.daemon_inst.timers.append(self)
-        self.count = 0
-
-    def processTimer(self):
-
-        # mark how many instances of a thread we have (decremented at thread end)
-        try:
-            self.daemon_inst.threadCounts[self.timer_function.__name__]
-        except KeyError:
-            self.daemon_inst.threadCounts[self.timer_function.__name__] = 0
-
-        # execute thread if it is time, and we are not missing *required* online peer
-        if self.count == self.frequency and not self.daemon_inst.shutdown:
-            try:
-                if self.requires_peer and len(self.daemon_inst.onlinePeers) == 0:
-                    raise onionrexceptions.OnlinePeerNeeded
-            except onionrexceptions.OnlinePeerNeeded:
-                return
-            else:
-                if self.make_thread:
-                    for i in range(self.thread_amount):
-                        if self.daemon_inst.threadCounts[self.timer_function.__name__] &gt;= self.max_threads:
-                            logger.debug(&#39;%s is currently using the maximum number of threads, not starting another.&#39; % self.timer_function.__name__)
-                        else:
-                            self.daemon_inst.threadCounts[self.timer_function.__name__] += 1
-                            newThread = threading.Thread(target=self.timer_function, args=self.args, daemon=True, 
-                                                        name=self.timer_function.__name__ + &#39; - &#39; + str(uuid.uuid4()))
-                            newThread.start()
-                else:
-                    self.timer_function()
-            self.count = -1 # negative 1 because its incremented at bottom
-        self.count += 1</code></pre>
-</details>
-<h3>Methods</h3>
-<dl>
-<dt id="src.communicatorutils.onionrcommunicatortimers.OnionrCommunicatorTimers.processTimer"><code class="name flex">
-<span>def <span class="ident">processTimer</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def processTimer(self):
-
-    # mark how many instances of a thread we have (decremented at thread end)
-    try:
-        self.daemon_inst.threadCounts[self.timer_function.__name__]
-    except KeyError:
-        self.daemon_inst.threadCounts[self.timer_function.__name__] = 0
-
-    # execute thread if it is time, and we are not missing *required* online peer
-    if self.count == self.frequency and not self.daemon_inst.shutdown:
-        try:
-            if self.requires_peer and len(self.daemon_inst.onlinePeers) == 0:
-                raise onionrexceptions.OnlinePeerNeeded
-        except onionrexceptions.OnlinePeerNeeded:
-            return
-        else:
-            if self.make_thread:
-                for i in range(self.thread_amount):
-                    if self.daemon_inst.threadCounts[self.timer_function.__name__] &gt;= self.max_threads:
-                        logger.debug(&#39;%s is currently using the maximum number of threads, not starting another.&#39; % self.timer_function.__name__)
-                    else:
-                        self.daemon_inst.threadCounts[self.timer_function.__name__] += 1
-                        newThread = threading.Thread(target=self.timer_function, args=self.args, daemon=True, 
-                                                    name=self.timer_function.__name__ + &#39; - &#39; + str(uuid.uuid4()))
-                        newThread.start()
-            else:
-                self.timer_function()
-        self.count = -1 # negative 1 because its incremented at bottom
-    self.count += 1</code></pre>
-</details>
-</dd>
-</dl>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils" href="index.html">src.communicatorutils</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="src.communicatorutils.onionrcommunicatortimers.OnionrCommunicatorTimers" href="#src.communicatorutils.onionrcommunicatortimers.OnionrCommunicatorTimers">OnionrCommunicatorTimers</a></code></h4>
-<ul class="">
-<li><code><a title="src.communicatorutils.onionrcommunicatortimers.OnionrCommunicatorTimers.processTimer" href="#src.communicatorutils.onionrcommunicatortimers.OnionrCommunicatorTimers.processTimer">processTimer</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/proxypicker.html

@@ -1,111 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.proxypicker API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.proxypicker</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>Just picks a proxy to use based on a peer's address</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    Just picks a proxy to use based on a peer&#39;s address
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-
-def pick_proxy(peer_address):
-    if peer_address.endswith(&#39;.onion&#39;):
-        return &#39;tor&#39;
-    elif peer_address.endswith(&#39;.i2p&#39;):
-        return &#39;i2p&#39;
-    raise ValueError(f&#34;Peer address was not string ending with acceptable value: {peer_address}&#34;)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicatorutils.proxypicker.pick_proxy"><code class="name flex">
-<span>def <span class="ident">pick_proxy</span></span>(<span>peer_address)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def pick_proxy(peer_address):
-    if peer_address.endswith(&#39;.onion&#39;):
-        return &#39;tor&#39;
-    elif peer_address.endswith(&#39;.i2p&#39;):
-        return &#39;i2p&#39;
-    raise ValueError(f&#34;Peer address was not string ending with acceptable value: {peer_address}&#34;)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils" href="index.html">src.communicatorutils</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicatorutils.proxypicker.pick_proxy" href="#src.communicatorutils.proxypicker.pick_proxy">pick_proxy</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/restarttor.html

@@ -1,90 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.restarttor API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.restarttor</code></h1>
-</header>
-<section id="section-intro">
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">import netcontroller
-import config
-
-def restart(comm_inst):
-    if not config.get(&#39;tor.use_existing_tor&#39;, False):
-        net = comm_inst.shared_state.get(netcontroller.NetController)
-        net.killTor()
-        net.startTor()</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicatorutils.restarttor.restart"><code class="name flex">
-<span>def <span class="ident">restart</span></span>(<span>comm_inst)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def restart(comm_inst):
-    if not config.get(&#39;tor.use_existing_tor&#39;, False):
-        net = comm_inst.shared_state.get(netcontroller.NetController)
-        net.killTor()
-        net.startTor()</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils" href="index.html">src.communicatorutils</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicatorutils.restarttor.restart" href="#src.communicatorutils.restarttor.restart">restart</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/servicecreator.html

@@ -1,144 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.servicecreator API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.servicecreator</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>Creates an onionr direct connection service by scanning all connection blocks</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    Creates an onionr direct connection service by scanning all connection blocks
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-import communicator
-from onionrblocks import onionrblockapi
-import logger
-from onionrutils import stringvalidators, bytesconverter
-from coredb import blockmetadb
-from onionrservices import server_exists
-def service_creator(daemon):
-    assert isinstance(daemon, communicator.OnionrCommunicatorDaemon)
-    
-    # Find socket connection blocks
-    # TODO cache blocks and only look at recently received ones
-    con_blocks = blockmetadb.get_blocks_by_type(&#39;con&#39;)
-    for b in con_blocks:
-        if not b in daemon.active_services:
-            bl = onionrblockapi.Block(b, decrypt=True)
-            bs = bytesconverter.bytes_to_str(bl.bcontent) + &#39;.onion&#39;
-            if server_exists(bl.signer):
-                continue
-            if stringvalidators.validate_pub_key(bl.signer) and stringvalidators.validate_transport(bs):
-                signer = bytesconverter.bytes_to_str(bl.signer)
-                daemon.active_services.append(b)
-                daemon.active_services.append(signer)
-                if not daemon.services.create_server(signer, bs, daemon):
-                    daemon.active_services.remove(b)
-                    daemon.active_services.remove(signer)
-    daemon.decrementThreadCount(&#39;service_creator&#39;)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicatorutils.servicecreator.service_creator"><code class="name flex">
-<span>def <span class="ident">service_creator</span></span>(<span>daemon)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def service_creator(daemon):
-    assert isinstance(daemon, communicator.OnionrCommunicatorDaemon)
-    
-    # Find socket connection blocks
-    # TODO cache blocks and only look at recently received ones
-    con_blocks = blockmetadb.get_blocks_by_type(&#39;con&#39;)
-    for b in con_blocks:
-        if not b in daemon.active_services:
-            bl = onionrblockapi.Block(b, decrypt=True)
-            bs = bytesconverter.bytes_to_str(bl.bcontent) + &#39;.onion&#39;
-            if server_exists(bl.signer):
-                continue
-            if stringvalidators.validate_pub_key(bl.signer) and stringvalidators.validate_transport(bs):
-                signer = bytesconverter.bytes_to_str(bl.signer)
-                daemon.active_services.append(b)
-                daemon.active_services.append(signer)
-                if not daemon.services.create_server(signer, bs, daemon):
-                    daemon.active_services.remove(b)
-                    daemon.active_services.remove(signer)
-    daemon.decrementThreadCount(&#39;service_creator&#39;)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils" href="index.html">src.communicatorutils</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicatorutils.servicecreator.service_creator" href="#src.communicatorutils.servicecreator.service_creator">service_creator</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/uploadblocks/index.html

@@ -1,313 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.uploadblocks API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.uploadblocks</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>Upload blocks in the upload queue to peers from the communicator</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-Upload blocks in the upload queue to peers from the communicator
-&#34;&#34;&#34;
-from typing import TYPE_CHECKING
-from time import sleep
-from threading import Thread
-
-from . import sessionmanager
-
-from onionrtypes import UserID
-import logger
-from communicatorutils import proxypicker
-import onionrexceptions
-from onionrblocks import onionrblockapi as block
-from onionrutils import stringvalidators, basicrequests
-import onionrcrypto
-from communicator import onlinepeers
-if TYPE_CHECKING:
-    from communicator import OnionrCommunicatorDaemon
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def upload_blocks_from_communicator(comm_inst: &#39;OnionrCommunicatorDaemon&#39;):
-    &#34;&#34;&#34;Accept a communicator instance + upload blocks from its upload queue.&#34;&#34;&#34;
-    &#34;&#34;&#34;when inserting a block, we try to upload
-     it to a few peers to add some deniability &amp; increase functionality&#34;&#34;&#34;
-    TIMER_NAME = &#34;upload_blocks_from_communicator&#34;
-
-    session_manager: sessionmanager.BlockUploadSessionManager
-    session_manager = comm_inst.shared_state.get(
-        sessionmanager.BlockUploadSessionManager)
-    tried_peers: UserID = []
-    finishedUploads = []
-    comm_inst.blocksToUpload = onionrcrypto.cryptoutils.random_shuffle(
-        comm_inst.blocksToUpload)
-
-    def remove_from_hidden(bl):
-        sleep(60)
-        try:
-            comm_inst.shared_state.get_by_string(
-                &#39;PublicAPI&#39;).hideBlocks.remove(bl)
-        except ValueError:
-            pass
-
-    if len(comm_inst.blocksToUpload) != 0:
-        for bl in comm_inst.blocksToUpload:
-            if not stringvalidators.validate_hash(bl):
-                logger.warn(&#39;Requested to upload invalid block&#39;, terminal=True)
-                comm_inst.decrementThreadCount(TIMER_NAME)
-                return
-            session = session_manager.add_session(bl)
-            for _ in range(min(len(comm_inst.onlinePeers), 6)):
-                try:
-                    peer = onlinepeers.pick_online_peer(comm_inst)
-                except onionrexceptions.OnlinePeerNeeded:
-                    continue
-                try:
-                    session.peer_exists[peer]
-                    continue
-                except KeyError:
-                    pass
-                try:
-                    if session.peer_fails[peer] &gt; 3:
-                        continue
-                except KeyError:
-                    pass
-                if peer in tried_peers:
-                    continue
-                tried_peers.append(peer)
-                url = f&#39;http://{peer}/upload&#39;
-                try:
-                    data = block.Block(bl).getRaw()
-                except onionrexceptions.NoDataAvailable:
-                    finishedUploads.append(bl)
-                    break
-                proxy_type = proxypicker.pick_proxy(peer)
-                logger.info(
-                    f&#34;Uploading block {bl[:8]} to {peer}&#34;, terminal=True)
-                resp = basicrequests.do_post_request(
-                    url, data=data, proxyType=proxy_type,
-                    content_type=&#39;application/octet-stream&#39;)
-                if resp is not False:
-                    if resp == &#39;success&#39;:
-                        Thread(target=remove_from_hidden,
-                               args=[bl], daemon=True).start()
-                        session.success()
-                        session.peer_exists[peer] = True
-                    elif resp == &#39;exists&#39;:
-                        session.success()
-                        session.peer_exists[peer] = True
-                    else:
-                        session.fail()
-                        session.fail_peer(peer)
-                        comm_inst.getPeerProfileInstance(peer).addScore(-5)
-                        logger.warn(
-                           f&#39;Failed to upload {bl[:8]}, reason: {resp}&#39;,
-                           terminal=True)
-                else:
-                    session.fail()
-        session_manager.clean_session()
-    for x in finishedUploads:
-        try:
-            comm_inst.blocksToUpload.remove(x)
-
-            comm_inst.shared_state.get_by_string(
-                &#39;PublicAPI&#39;).hideBlocks.remove(x)
-
-        except ValueError:
-            pass
-    comm_inst.decrementThreadCount(TIMER_NAME)</code></pre>
-</details>
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.communicatorutils.uploadblocks.mixmate" href="mixmate/index.html">src.communicatorutils.uploadblocks.mixmate</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicatorutils.uploadblocks.session" href="session.html">src.communicatorutils.uploadblocks.session</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.communicatorutils.uploadblocks.sessionmanager" href="sessionmanager.html">src.communicatorutils.uploadblocks.sessionmanager</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicatorutils.uploadblocks.upload_blocks_from_communicator"><code class="name flex">
-<span>def <span class="ident">upload_blocks_from_communicator</span></span>(<span>comm_inst)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Accept a communicator instance + upload blocks from its upload queue.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def upload_blocks_from_communicator(comm_inst: &#39;OnionrCommunicatorDaemon&#39;):
-    &#34;&#34;&#34;Accept a communicator instance + upload blocks from its upload queue.&#34;&#34;&#34;
-    &#34;&#34;&#34;when inserting a block, we try to upload
-     it to a few peers to add some deniability &amp; increase functionality&#34;&#34;&#34;
-    TIMER_NAME = &#34;upload_blocks_from_communicator&#34;
-
-    session_manager: sessionmanager.BlockUploadSessionManager
-    session_manager = comm_inst.shared_state.get(
-        sessionmanager.BlockUploadSessionManager)
-    tried_peers: UserID = []
-    finishedUploads = []
-    comm_inst.blocksToUpload = onionrcrypto.cryptoutils.random_shuffle(
-        comm_inst.blocksToUpload)
-
-    def remove_from_hidden(bl):
-        sleep(60)
-        try:
-            comm_inst.shared_state.get_by_string(
-                &#39;PublicAPI&#39;).hideBlocks.remove(bl)
-        except ValueError:
-            pass
-
-    if len(comm_inst.blocksToUpload) != 0:
-        for bl in comm_inst.blocksToUpload:
-            if not stringvalidators.validate_hash(bl):
-                logger.warn(&#39;Requested to upload invalid block&#39;, terminal=True)
-                comm_inst.decrementThreadCount(TIMER_NAME)
-                return
-            session = session_manager.add_session(bl)
-            for _ in range(min(len(comm_inst.onlinePeers), 6)):
-                try:
-                    peer = onlinepeers.pick_online_peer(comm_inst)
-                except onionrexceptions.OnlinePeerNeeded:
-                    continue
-                try:
-                    session.peer_exists[peer]
-                    continue
-                except KeyError:
-                    pass
-                try:
-                    if session.peer_fails[peer] &gt; 3:
-                        continue
-                except KeyError:
-                    pass
-                if peer in tried_peers:
-                    continue
-                tried_peers.append(peer)
-                url = f&#39;http://{peer}/upload&#39;
-                try:
-                    data = block.Block(bl).getRaw()
-                except onionrexceptions.NoDataAvailable:
-                    finishedUploads.append(bl)
-                    break
-                proxy_type = proxypicker.pick_proxy(peer)
-                logger.info(
-                    f&#34;Uploading block {bl[:8]} to {peer}&#34;, terminal=True)
-                resp = basicrequests.do_post_request(
-                    url, data=data, proxyType=proxy_type,
-                    content_type=&#39;application/octet-stream&#39;)
-                if resp is not False:
-                    if resp == &#39;success&#39;:
-                        Thread(target=remove_from_hidden,
-                               args=[bl], daemon=True).start()
-                        session.success()
-                        session.peer_exists[peer] = True
-                    elif resp == &#39;exists&#39;:
-                        session.success()
-                        session.peer_exists[peer] = True
-                    else:
-                        session.fail()
-                        session.fail_peer(peer)
-                        comm_inst.getPeerProfileInstance(peer).addScore(-5)
-                        logger.warn(
-                           f&#39;Failed to upload {bl[:8]}, reason: {resp}&#39;,
-                           terminal=True)
-                else:
-                    session.fail()
-        session_manager.clean_session()
-    for x in finishedUploads:
-        try:
-            comm_inst.blocksToUpload.remove(x)
-
-            comm_inst.shared_state.get_by_string(
-                &#39;PublicAPI&#39;).hideBlocks.remove(x)
-
-        except ValueError:
-            pass
-    comm_inst.decrementThreadCount(TIMER_NAME)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils" href="../index.html">src.communicatorutils</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.communicatorutils.uploadblocks.mixmate" href="mixmate/index.html">src.communicatorutils.uploadblocks.mixmate</a></code></li>
-<li><code><a title="src.communicatorutils.uploadblocks.session" href="session.html">src.communicatorutils.uploadblocks.session</a></code></li>
-<li><code><a title="src.communicatorutils.uploadblocks.sessionmanager" href="sessionmanager.html">src.communicatorutils.uploadblocks.sessionmanager</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicatorutils.uploadblocks.upload_blocks_from_communicator" href="#src.communicatorutils.uploadblocks.upload_blocks_from_communicator">upload_blocks_from_communicator</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/uploadblocks/mixmate/index.html

@@ -1,151 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.uploadblocks.mixmate API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.uploadblocks.mixmate</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>Perform block mixing</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-Perform block mixing
-&#34;&#34;&#34;
-import time
-from typing import List
-
-import onionrtypes
-from onionrblocks import onionrblockapi
-
-from .pool import UploadPool
-from .pool import PoolFullException
-
-from etc import onionrvalues
-
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-upload_pool = UploadPool(4)
-
-
-def block_mixer(upload_list: List[onionrtypes.BlockHash],
-                block_to_mix: onionrtypes.BlockHash):
-    &#34;&#34;&#34;Delay and mix block inserts.
-
-    Take a block list and a received/created block and add it
-    to the said block list
-    &#34;&#34;&#34;
-    bl = onionrblockapi.Block(block_to_mix)
-
-    if time.time() - bl.claimedTime &gt; onionrvalues.BLOCK_POOL_MAX_AGE:
-        raise ValueError
-    if block_to_mix:
-        upload_list.append(block_to_mix)</code></pre>
-</details>
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.communicatorutils.uploadblocks.mixmate.pool" href="pool.html">src.communicatorutils.uploadblocks.mixmate.pool</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.communicatorutils.uploadblocks.mixmate.block_mixer"><code class="name flex">
-<span>def <span class="ident">block_mixer</span></span>(<span>upload_list, block_to_mix)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Delay and mix block inserts.</p>
-<p>Take a block list and a received/created block and add it
-to the said block list</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def block_mixer(upload_list: List[onionrtypes.BlockHash],
-                block_to_mix: onionrtypes.BlockHash):
-    &#34;&#34;&#34;Delay and mix block inserts.
-
-    Take a block list and a received/created block and add it
-    to the said block list
-    &#34;&#34;&#34;
-    bl = onionrblockapi.Block(block_to_mix)
-
-    if time.time() - bl.claimedTime &gt; onionrvalues.BLOCK_POOL_MAX_AGE:
-        raise ValueError
-    if block_to_mix:
-        upload_list.append(block_to_mix)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils.uploadblocks" href="../index.html">src.communicatorutils.uploadblocks</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.communicatorutils.uploadblocks.mixmate.pool" href="pool.html">src.communicatorutils.uploadblocks.mixmate.pool</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.communicatorutils.uploadblocks.mixmate.block_mixer" href="#src.communicatorutils.uploadblocks.mixmate.block_mixer">block_mixer</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/uploadblocks/mixmate/pool.html

@@ -1,300 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.uploadblocks.mixmate.pool API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.uploadblocks.mixmate.pool</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>Upload pool</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-Upload pool
-&#34;&#34;&#34;
-from typing import List
-
-import onionrutils
-import onionrtypes
-from onionrcrypto import cryptoutils
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-class PoolFullException(Exception):
-    &#34;&#34;&#34;For when the UploadPool is full.
-
-    Raise when a new hash is attempted to be added
-    &#34;&#34;&#34;
-
-
-class PoolNotReady(Exception):
-    &#34;&#34;&#34;Raise when UploadPool pool access is attempted without it being full.&#34;&#34;&#34;
-
-
-class AlreadyInPool(Exception):
-    &#34;&#34;&#34;Raise when a hash already in pool is attempted to be added again.&#34;&#34;&#34;
-
-
-class UploadPool:
-    &#34;&#34;&#34;Upload pool for mixing blocks together and delaying uploads.&#34;&#34;&#34;
-
-    def __init__(self, pool_size: int):
-        &#34;&#34;&#34;Create a new pool with a specified max size.
-
-        Uses private var and getter to avoid direct adding
-        &#34;&#34;&#34;
-        self._pool: List[onionrtypes.BlockHash] = []
-        self._pool_size = pool_size
-        self.birthday = onionrutils.epoch.get_epoch()
-
-    def add_to_pool(self, item: List[onionrtypes.BlockHash]):
-        &#34;&#34;&#34;Add a new hash to the pool. Raise PoolFullException if full.&#34;&#34;&#34;
-        if len(self._pool) &gt;= self._pool_size:
-            raise PoolFullException
-        if not onionrutils.stringvalidators.validate_hash(item):
-            raise ValueError
-        self._pool.append(item)
-
-    def get_pool(self) -&gt; List[onionrtypes.BlockHash]:
-        &#34;&#34;&#34;Get the hash pool in secure random order.&#34;&#34;&#34;
-        if len(self._pool) != self._pool_size:
-            raise PoolNotReady
-        final_pool: List[onionrtypes.BlockHash] = cryptoutils.random_shuffle(
-            list(self._pool))
-
-        self._pool.clear()
-        self.birthday = onionrutils.epoch.get_epoch()
-        return final_pool</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="src.communicatorutils.uploadblocks.mixmate.pool.AlreadyInPool"><code class="flex name class">
-<span>class <span class="ident">AlreadyInPool</span></span>
-<span>(</span><span>...)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Raise when a hash already in pool is attempted to be added again.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class AlreadyInPool(Exception):
-    &#34;&#34;&#34;Raise when a hash already in pool is attempted to be added again.&#34;&#34;&#34;</code></pre>
-</details>
-<h3>Ancestors</h3>
-<ul class="hlist">
-<li>builtins.Exception</li>
-<li>builtins.BaseException</li>
-</ul>
-</dd>
-<dt id="src.communicatorutils.uploadblocks.mixmate.pool.PoolFullException"><code class="flex name class">
-<span>class <span class="ident">PoolFullException</span></span>
-<span>(</span><span>...)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>For when the UploadPool is full.</p>
-<p>Raise when a new hash is attempted to be added</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class PoolFullException(Exception):
-    &#34;&#34;&#34;For when the UploadPool is full.
-
-    Raise when a new hash is attempted to be added
-    &#34;&#34;&#34;</code></pre>
-</details>
-<h3>Ancestors</h3>
-<ul class="hlist">
-<li>builtins.Exception</li>
-<li>builtins.BaseException</li>
-</ul>
-</dd>
-<dt id="src.communicatorutils.uploadblocks.mixmate.pool.PoolNotReady"><code class="flex name class">
-<span>class <span class="ident">PoolNotReady</span></span>
-<span>(</span><span>...)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Raise when UploadPool pool access is attempted without it being full.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class PoolNotReady(Exception):
-    &#34;&#34;&#34;Raise when UploadPool pool access is attempted without it being full.&#34;&#34;&#34;</code></pre>
-</details>
-<h3>Ancestors</h3>
-<ul class="hlist">
-<li>builtins.Exception</li>
-<li>builtins.BaseException</li>
-</ul>
-</dd>
-<dt id="src.communicatorutils.uploadblocks.mixmate.pool.UploadPool"><code class="flex name class">
-<span>class <span class="ident">UploadPool</span></span>
-<span>(</span><span>pool_size)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Upload pool for mixing blocks together and delaying uploads.</p>
-<p>Create a new pool with a specified max size.</p>
-<p>Uses private var and getter to avoid direct adding</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class UploadPool:
-    &#34;&#34;&#34;Upload pool for mixing blocks together and delaying uploads.&#34;&#34;&#34;
-
-    def __init__(self, pool_size: int):
-        &#34;&#34;&#34;Create a new pool with a specified max size.
-
-        Uses private var and getter to avoid direct adding
-        &#34;&#34;&#34;
-        self._pool: List[onionrtypes.BlockHash] = []
-        self._pool_size = pool_size
-        self.birthday = onionrutils.epoch.get_epoch()
-
-    def add_to_pool(self, item: List[onionrtypes.BlockHash]):
-        &#34;&#34;&#34;Add a new hash to the pool. Raise PoolFullException if full.&#34;&#34;&#34;
-        if len(self._pool) &gt;= self._pool_size:
-            raise PoolFullException
-        if not onionrutils.stringvalidators.validate_hash(item):
-            raise ValueError
-        self._pool.append(item)
-
-    def get_pool(self) -&gt; List[onionrtypes.BlockHash]:
-        &#34;&#34;&#34;Get the hash pool in secure random order.&#34;&#34;&#34;
-        if len(self._pool) != self._pool_size:
-            raise PoolNotReady
-        final_pool: List[onionrtypes.BlockHash] = cryptoutils.random_shuffle(
-            list(self._pool))
-
-        self._pool.clear()
-        self.birthday = onionrutils.epoch.get_epoch()
-        return final_pool</code></pre>
-</details>
-<h3>Methods</h3>
-<dl>
-<dt id="src.communicatorutils.uploadblocks.mixmate.pool.UploadPool.add_to_pool"><code class="name flex">
-<span>def <span class="ident">add_to_pool</span></span>(<span>self, item)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Add a new hash to the pool. Raise PoolFullException if full.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def add_to_pool(self, item: List[onionrtypes.BlockHash]):
-    &#34;&#34;&#34;Add a new hash to the pool. Raise PoolFullException if full.&#34;&#34;&#34;
-    if len(self._pool) &gt;= self._pool_size:
-        raise PoolFullException
-    if not onionrutils.stringvalidators.validate_hash(item):
-        raise ValueError
-    self._pool.append(item)</code></pre>
-</details>
-</dd>
-<dt id="src.communicatorutils.uploadblocks.mixmate.pool.UploadPool.get_pool"><code class="name flex">
-<span>def <span class="ident">get_pool</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Get the hash pool in secure random order.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def get_pool(self) -&gt; List[onionrtypes.BlockHash]:
-    &#34;&#34;&#34;Get the hash pool in secure random order.&#34;&#34;&#34;
-    if len(self._pool) != self._pool_size:
-        raise PoolNotReady
-    final_pool: List[onionrtypes.BlockHash] = cryptoutils.random_shuffle(
-        list(self._pool))
-
-    self._pool.clear()
-    self.birthday = onionrutils.epoch.get_epoch()
-    return final_pool</code></pre>
-</details>
-</dd>
-</dl>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils.uploadblocks.mixmate" href="index.html">src.communicatorutils.uploadblocks.mixmate</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="src.communicatorutils.uploadblocks.mixmate.pool.AlreadyInPool" href="#src.communicatorutils.uploadblocks.mixmate.pool.AlreadyInPool">AlreadyInPool</a></code></h4>
-</li>
-<li>
-<h4><code><a title="src.communicatorutils.uploadblocks.mixmate.pool.PoolFullException" href="#src.communicatorutils.uploadblocks.mixmate.pool.PoolFullException">PoolFullException</a></code></h4>
-</li>
-<li>
-<h4><code><a title="src.communicatorutils.uploadblocks.mixmate.pool.PoolNotReady" href="#src.communicatorutils.uploadblocks.mixmate.pool.PoolNotReady">PoolNotReady</a></code></h4>
-</li>
-<li>
-<h4><code><a title="src.communicatorutils.uploadblocks.mixmate.pool.UploadPool" href="#src.communicatorutils.uploadblocks.mixmate.pool.UploadPool">UploadPool</a></code></h4>
-<ul class="">
-<li><code><a title="src.communicatorutils.uploadblocks.mixmate.pool.UploadPool.add_to_pool" href="#src.communicatorutils.uploadblocks.mixmate.pool.UploadPool.add_to_pool">add_to_pool</a></code></li>
-<li><code><a title="src.communicatorutils.uploadblocks.mixmate.pool.UploadPool.get_pool" href="#src.communicatorutils.uploadblocks.mixmate.pool.UploadPool.get_pool">get_pool</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/uploadblocks/session.html

@@ -1,220 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.uploadblocks.session API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.uploadblocks.session</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>Virtual upload "sessions" for blocks</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-Virtual upload &#34;sessions&#34; for blocks
-&#34;&#34;&#34;
-from typing import Union, Dict
-
-from onionrtypes import UserID
-from onionrutils import stringvalidators
-from onionrutils import bytesconverter
-from onionrutils import epoch
-from utils import reconstructhash
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-class UploadSession:
-    &#34;&#34;&#34;Manage statistics for an Onionr block upload session.
-
-    accept a block hash (incl. unpadded) as an argument
-    &#34;&#34;&#34;
-
-    def __init__(self, block_hash: Union[str, bytes]):
-        block_hash = bytesconverter.bytes_to_str(block_hash)
-        block_hash = reconstructhash.reconstruct_hash(block_hash)
-        if not stringvalidators.validate_hash(block_hash):
-            raise ValueError
-
-        self.start_time = epoch.get_epoch()
-        self.block_hash = reconstructhash.deconstruct_hash(block_hash)
-        self.total_fail_count: int = 0
-        self.total_success_count: int = 0
-        self.peer_fails: Dict[UserID, int] = {}
-        self.peer_exists: Dict[UserID, bool] = {}
-
-    def fail_peer(self, peer):
-        try:
-            self.peer_fails[peer] += 1
-        except KeyError:
-            self.peer_fails[peer] = 0
-
-    def fail(self):
-        self.total_fail_count += 1
-
-    def success(self):
-        self.total_success_count += 1</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="src.communicatorutils.uploadblocks.session.UploadSession"><code class="flex name class">
-<span>class <span class="ident">UploadSession</span></span>
-<span>(</span><span>block_hash)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Manage statistics for an Onionr block upload session.</p>
-<p>accept a block hash (incl. unpadded) as an argument</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class UploadSession:
-    &#34;&#34;&#34;Manage statistics for an Onionr block upload session.
-
-    accept a block hash (incl. unpadded) as an argument
-    &#34;&#34;&#34;
-
-    def __init__(self, block_hash: Union[str, bytes]):
-        block_hash = bytesconverter.bytes_to_str(block_hash)
-        block_hash = reconstructhash.reconstruct_hash(block_hash)
-        if not stringvalidators.validate_hash(block_hash):
-            raise ValueError
-
-        self.start_time = epoch.get_epoch()
-        self.block_hash = reconstructhash.deconstruct_hash(block_hash)
-        self.total_fail_count: int = 0
-        self.total_success_count: int = 0
-        self.peer_fails: Dict[UserID, int] = {}
-        self.peer_exists: Dict[UserID, bool] = {}
-
-    def fail_peer(self, peer):
-        try:
-            self.peer_fails[peer] += 1
-        except KeyError:
-            self.peer_fails[peer] = 0
-
-    def fail(self):
-        self.total_fail_count += 1
-
-    def success(self):
-        self.total_success_count += 1</code></pre>
-</details>
-<h3>Methods</h3>
-<dl>
-<dt id="src.communicatorutils.uploadblocks.session.UploadSession.fail"><code class="name flex">
-<span>def <span class="ident">fail</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def fail(self):
-    self.total_fail_count += 1</code></pre>
-</details>
-</dd>
-<dt id="src.communicatorutils.uploadblocks.session.UploadSession.fail_peer"><code class="name flex">
-<span>def <span class="ident">fail_peer</span></span>(<span>self, peer)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def fail_peer(self, peer):
-    try:
-        self.peer_fails[peer] += 1
-    except KeyError:
-        self.peer_fails[peer] = 0</code></pre>
-</details>
-</dd>
-<dt id="src.communicatorutils.uploadblocks.session.UploadSession.success"><code class="name flex">
-<span>def <span class="ident">success</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def success(self):
-    self.total_success_count += 1</code></pre>
-</details>
-</dd>
-</dl>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils.uploadblocks" href="index.html">src.communicatorutils.uploadblocks</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="src.communicatorutils.uploadblocks.session.UploadSession" href="#src.communicatorutils.uploadblocks.session.UploadSession">UploadSession</a></code></h4>
-<ul class="">
-<li><code><a title="src.communicatorutils.uploadblocks.session.UploadSession.fail" href="#src.communicatorutils.uploadblocks.session.UploadSession.fail">fail</a></code></li>
-<li><code><a title="src.communicatorutils.uploadblocks.session.UploadSession.fail_peer" href="#src.communicatorutils.uploadblocks.session.UploadSession.fail_peer">fail_peer</a></code></li>
-<li><code><a title="src.communicatorutils.uploadblocks.session.UploadSession.success" href="#src.communicatorutils.uploadblocks.session.UploadSession.success">success</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/communicatorutils/uploadblocks/sessionmanager.html

@@ -1,422 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.communicatorutils.uploadblocks.sessionmanager API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.communicatorutils.uploadblocks.sessionmanager</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>Manager for upload 'sessions'</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-Manager for upload &#39;sessions&#39;
-&#34;&#34;&#34;
-from typing import List, Union, TYPE_CHECKING
-if TYPE_CHECKING:
-    from session import UploadSession
-
-from onionrutils import bytesconverter
-from etc import onionrvalues
-from utils import reconstructhash
-
-from . import session
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-class BlockUploadSessionManager:
-    &#34;&#34;&#34;Holds block UploadSession instances.
-
-    Optionally accepts iterable of sessions to added on init
-    Arguments: old_session: iterable of old UploadSession objects
-    &#34;&#34;&#34;
-
-    def __init__(self, old_sessions: List = None):
-        if old_sessions is None:
-            self.sessions = []
-        else:
-            self.sessions = old_sessions
-
-    def add_session(self,
-                    session_or_block: Union[str,
-                                            bytes,
-                                            session.UploadSession
-                                            ]
-                    ) -&gt; session.UploadSession:
-        &#34;&#34;&#34;Create (or add existing) block upload session.
-
-        from a str/bytes block hex hash, existing UploadSession
-        &#34;&#34;&#34;
-        if isinstance(session_or_block, session.UploadSession):
-            if session_or_block not in self.sessions:
-                self.sessions.append(session_or_block)
-            return session_or_block
-        try:
-            return self.get_session(session_or_block)
-        except KeyError:
-            pass
-        # convert bytes hash to str
-        if isinstance(session_or_block, bytes):
-            session_or_block = bytesconverter.bytes_to_str(session_or_block)
-        # intentionally not elif
-        if isinstance(session_or_block, str):
-            new_session = session.UploadSession(session_or_block)
-            self.sessions.append(new_session)
-            return new_session
-        raise ValueError
-
-    def get_session(self,
-                    block_hash: Union[str, bytes]
-                    ) -&gt; session.UploadSession:
-        block_hash = reconstructhash.deconstruct_hash(
-            bytesconverter.bytes_to_str(block_hash))
-        for sess in self.sessions:
-            if sess.block_hash == block_hash:
-                return sess
-        raise KeyError
-
-    def clean_session(self,
-                      specific_session: Union[str, &#39;UploadSession&#39;] = None):
-
-        comm_inst: &#39;OnionrCommunicatorDaemon&#39;  # type: ignore
-        comm_inst = self._too_many.get_by_string(  # pylint: disable=E1101 type: ignore
-        &#34;OnionrCommunicatorDaemon&#34;)
-        sessions_to_delete = []
-        if comm_inst.getUptime() &lt; 120:
-            return
-        onlinePeerCount = len(comm_inst.onlinePeers)
-
-        # If we have no online peers right now,
-        if onlinePeerCount == 0:
-            return
-
-        for sess in self.sessions:
-            # if over 50% of peers that were online for a session have
-            # become unavailable, don&#39;t kill sessions
-            if sess.total_success_count &gt; onlinePeerCount:
-                if onlinePeerCount / sess.total_success_count &gt;= 0.5:
-                    return
-            # Clean sessions if they have uploaded to enough online peers
-            if sess.total_success_count &lt;= 0:
-                continue
-            if (sess.total_success_count / onlinePeerCount) &gt;= onionrvalues.MIN_BLOCK_UPLOAD_PEER_PERCENT:
-                sessions_to_delete.append(sess)
-        for sess in sessions_to_delete:
-            try:
-                self.sessions.remove(session)
-            except ValueError:
-                pass
-            # TODO cleanup to one round of search
-            # Remove the blocks from the sessions, upload list,
-            # and waitforshare list
-            try:
-                comm_inst.blocksToUpload.remove(
-                    reconstructhash.reconstruct_hash(sess.block_hash))
-            except ValueError:
-                pass
-            try:
-                comm_inst.blocksToUpload.remove(sess.block_hash)
-            except ValueError:
-                pass</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="src.communicatorutils.uploadblocks.sessionmanager.BlockUploadSessionManager"><code class="flex name class">
-<span>class <span class="ident">BlockUploadSessionManager</span></span>
-<span>(</span><span>old_sessions=None)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Holds block UploadSession instances.</p>
-<p>Optionally accepts iterable of sessions to added on init
-Arguments: old_session: iterable of old UploadSession objects</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class BlockUploadSessionManager:
-    &#34;&#34;&#34;Holds block UploadSession instances.
-
-    Optionally accepts iterable of sessions to added on init
-    Arguments: old_session: iterable of old UploadSession objects
-    &#34;&#34;&#34;
-
-    def __init__(self, old_sessions: List = None):
-        if old_sessions is None:
-            self.sessions = []
-        else:
-            self.sessions = old_sessions
-
-    def add_session(self,
-                    session_or_block: Union[str,
-                                            bytes,
-                                            session.UploadSession
-                                            ]
-                    ) -&gt; session.UploadSession:
-        &#34;&#34;&#34;Create (or add existing) block upload session.
-
-        from a str/bytes block hex hash, existing UploadSession
-        &#34;&#34;&#34;
-        if isinstance(session_or_block, session.UploadSession):
-            if session_or_block not in self.sessions:
-                self.sessions.append(session_or_block)
-            return session_or_block
-        try:
-            return self.get_session(session_or_block)
-        except KeyError:
-            pass
-        # convert bytes hash to str
-        if isinstance(session_or_block, bytes):
-            session_or_block = bytesconverter.bytes_to_str(session_or_block)
-        # intentionally not elif
-        if isinstance(session_or_block, str):
-            new_session = session.UploadSession(session_or_block)
-            self.sessions.append(new_session)
-            return new_session
-        raise ValueError
-
-    def get_session(self,
-                    block_hash: Union[str, bytes]
-                    ) -&gt; session.UploadSession:
-        block_hash = reconstructhash.deconstruct_hash(
-            bytesconverter.bytes_to_str(block_hash))
-        for sess in self.sessions:
-            if sess.block_hash == block_hash:
-                return sess
-        raise KeyError
-
-    def clean_session(self,
-                      specific_session: Union[str, &#39;UploadSession&#39;] = None):
-
-        comm_inst: &#39;OnionrCommunicatorDaemon&#39;  # type: ignore
-        comm_inst = self._too_many.get_by_string(  # pylint: disable=E1101 type: ignore
-        &#34;OnionrCommunicatorDaemon&#34;)
-        sessions_to_delete = []
-        if comm_inst.getUptime() &lt; 120:
-            return
-        onlinePeerCount = len(comm_inst.onlinePeers)
-
-        # If we have no online peers right now,
-        if onlinePeerCount == 0:
-            return
-
-        for sess in self.sessions:
-            # if over 50% of peers that were online for a session have
-            # become unavailable, don&#39;t kill sessions
-            if sess.total_success_count &gt; onlinePeerCount:
-                if onlinePeerCount / sess.total_success_count &gt;= 0.5:
-                    return
-            # Clean sessions if they have uploaded to enough online peers
-            if sess.total_success_count &lt;= 0:
-                continue
-            if (sess.total_success_count / onlinePeerCount) &gt;= onionrvalues.MIN_BLOCK_UPLOAD_PEER_PERCENT:
-                sessions_to_delete.append(sess)
-        for sess in sessions_to_delete:
-            try:
-                self.sessions.remove(session)
-            except ValueError:
-                pass
-            # TODO cleanup to one round of search
-            # Remove the blocks from the sessions, upload list,
-            # and waitforshare list
-            try:
-                comm_inst.blocksToUpload.remove(
-                    reconstructhash.reconstruct_hash(sess.block_hash))
-            except ValueError:
-                pass
-            try:
-                comm_inst.blocksToUpload.remove(sess.block_hash)
-            except ValueError:
-                pass</code></pre>
-</details>
-<h3>Methods</h3>
-<dl>
-<dt id="src.communicatorutils.uploadblocks.sessionmanager.BlockUploadSessionManager.add_session"><code class="name flex">
-<span>def <span class="ident">add_session</span></span>(<span>self, session_or_block)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Create (or add existing) block upload session.</p>
-<p>from a str/bytes block hex hash, existing UploadSession</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def add_session(self,
-                session_or_block: Union[str,
-                                        bytes,
-                                        session.UploadSession
-                                        ]
-                ) -&gt; session.UploadSession:
-    &#34;&#34;&#34;Create (or add existing) block upload session.
-
-    from a str/bytes block hex hash, existing UploadSession
-    &#34;&#34;&#34;
-    if isinstance(session_or_block, session.UploadSession):
-        if session_or_block not in self.sessions:
-            self.sessions.append(session_or_block)
-        return session_or_block
-    try:
-        return self.get_session(session_or_block)
-    except KeyError:
-        pass
-    # convert bytes hash to str
-    if isinstance(session_or_block, bytes):
-        session_or_block = bytesconverter.bytes_to_str(session_or_block)
-    # intentionally not elif
-    if isinstance(session_or_block, str):
-        new_session = session.UploadSession(session_or_block)
-        self.sessions.append(new_session)
-        return new_session
-    raise ValueError</code></pre>
-</details>
-</dd>
-<dt id="src.communicatorutils.uploadblocks.sessionmanager.BlockUploadSessionManager.clean_session"><code class="name flex">
-<span>def <span class="ident">clean_session</span></span>(<span>self, specific_session=None)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def clean_session(self,
-                  specific_session: Union[str, &#39;UploadSession&#39;] = None):
-
-    comm_inst: &#39;OnionrCommunicatorDaemon&#39;  # type: ignore
-    comm_inst = self._too_many.get_by_string(  # pylint: disable=E1101 type: ignore
-    &#34;OnionrCommunicatorDaemon&#34;)
-    sessions_to_delete = []
-    if comm_inst.getUptime() &lt; 120:
-        return
-    onlinePeerCount = len(comm_inst.onlinePeers)
-
-    # If we have no online peers right now,
-    if onlinePeerCount == 0:
-        return
-
-    for sess in self.sessions:
-        # if over 50% of peers that were online for a session have
-        # become unavailable, don&#39;t kill sessions
-        if sess.total_success_count &gt; onlinePeerCount:
-            if onlinePeerCount / sess.total_success_count &gt;= 0.5:
-                return
-        # Clean sessions if they have uploaded to enough online peers
-        if sess.total_success_count &lt;= 0:
-            continue
-        if (sess.total_success_count / onlinePeerCount) &gt;= onionrvalues.MIN_BLOCK_UPLOAD_PEER_PERCENT:
-            sessions_to_delete.append(sess)
-    for sess in sessions_to_delete:
-        try:
-            self.sessions.remove(session)
-        except ValueError:
-            pass
-        # TODO cleanup to one round of search
-        # Remove the blocks from the sessions, upload list,
-        # and waitforshare list
-        try:
-            comm_inst.blocksToUpload.remove(
-                reconstructhash.reconstruct_hash(sess.block_hash))
-        except ValueError:
-            pass
-        try:
-            comm_inst.blocksToUpload.remove(sess.block_hash)
-        except ValueError:
-            pass</code></pre>
-</details>
-</dd>
-<dt id="src.communicatorutils.uploadblocks.sessionmanager.BlockUploadSessionManager.get_session"><code class="name flex">
-<span>def <span class="ident">get_session</span></span>(<span>self, block_hash)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def get_session(self,
-                block_hash: Union[str, bytes]
-                ) -&gt; session.UploadSession:
-    block_hash = reconstructhash.deconstruct_hash(
-        bytesconverter.bytes_to_str(block_hash))
-    for sess in self.sessions:
-        if sess.block_hash == block_hash:
-            return sess
-    raise KeyError</code></pre>
-</details>
-</dd>
-</dl>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.communicatorutils.uploadblocks" href="index.html">src.communicatorutils.uploadblocks</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="src.communicatorutils.uploadblocks.sessionmanager.BlockUploadSessionManager" href="#src.communicatorutils.uploadblocks.sessionmanager.BlockUploadSessionManager">BlockUploadSessionManager</a></code></h4>
-<ul class="">
-<li><code><a title="src.communicatorutils.uploadblocks.sessionmanager.BlockUploadSessionManager.add_session" href="#src.communicatorutils.uploadblocks.sessionmanager.BlockUploadSessionManager.add_session">add_session</a></code></li>
-<li><code><a title="src.communicatorutils.uploadblocks.sessionmanager.BlockUploadSessionManager.clean_session" href="#src.communicatorutils.uploadblocks.sessionmanager.BlockUploadSessionManager.clean_session">clean_session</a></code></li>
-<li><code><a title="src.communicatorutils.uploadblocks.sessionmanager.BlockUploadSessionManager.get_session" href="#src.communicatorutils.uploadblocks.sessionmanager.BlockUploadSessionManager.get_session">get_session</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/config/index.html

@@ -1,431 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.config API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.config</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>This file deals with configuration management.</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-This file deals with configuration management.
-&#34;&#34;&#34;
-import os, json, logger
-import filepaths
-
-from . import onboarding
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-_configfile = filepaths.config_file
-_config = {}
-
-
-def get(key, default = None, save = False):
-    &#34;&#34;&#34;Gets the key from configuration, or returns `default`&#34;&#34;&#34;
-
-    key = str(key).split(&#39;.&#39;)
-    data = _config
-
-    last = key.pop()
-
-    for item in key:
-        if (not item in data) or (not type(data[item]) == dict):
-            return default
-        data = data[item]
-
-    if last not in data:
-        if save:
-            set(key, default, savefile = True)
-        return default
-
-    return data[last]
-
-
-def set(key, value = None, savefile = False):
-    &#34;&#34;&#34;Sets the key in configuration to `value`&#34;&#34;&#34;
-
-    global _config
-
-    whole_key = key
-    key = str(key).split(&#39;.&#39;)
-    data = _config
-
-    last = key.pop()
-
-    for item in key:
-        if (not item in data) or (not type(data[item]) == dict):
-            data[item] = dict()
-        data = data[item]
-
-    if value is None:
-        del data[last]
-    else:
-        data[last] = value
-
-    if savefile:
-        save()
-
-
-def is_set(key):
-    key = str(key).split(&#39;.&#39;)
-    data = _config
-
-    last = key.pop()
-
-    for item in key:
-        if (not item in data) or (not type(data[item]) == dict):
-            return False
-        data = data[item]
-
-    if not last in data:
-        return False
-
-    return True
-
-
-def check():
-    &#34;&#34;&#34;Checks if the configuration file exists, creates it if not&#34;&#34;&#34;
-
-    if not os.path.exists(os.path.dirname(get_config_file())):
-        os.makedirs(os.path.dirname(get_config_file()))
-
-
-def save():
-    &#34;&#34;&#34;Saves the configuration data to the configuration file&#34;&#34;&#34;
-
-    check()
-    try:
-        with open(get_config_file(), &#39;w&#39;, encoding=&#34;utf8&#34;) as configfile:
-            json.dump(get_config(), configfile, indent=2)
-    except json.JSONDecodeError:
-        logger.warn(&#39;Failed to write to configuration file.&#39;)
-
-
-def reload():
-    &#34;&#34;&#34;Reloads the configuration data in memory from the file&#34;&#34;&#34;
-    check()
-    try:
-        with open(get_config_file(), &#39;r&#39;, encoding=&#34;utf8&#34;) as configfile:
-            set_config(json.loads(configfile.read()))
-    except (FileNotFoundError, json.JSONDecodeError) as e:
-        pass
-        #logger.debug(&#39;Failed to parse configuration file.&#39;)
-
-
-def get_config():
-    &#34;&#34;&#34;Gets the entire configuration as an array&#34;&#34;&#34;
-    return _config
-
-
-def set_config(config):
-    &#34;&#34;&#34;Sets the configuration to the array in arguments&#34;&#34;&#34;
-    global _config
-    _config = config
-
-
-def get_config_file():
-    &#34;&#34;&#34;Returns the absolute path to the configuration file&#34;&#34;&#34;
-    return _configfile
-
-
-def set_config_file(configfile):
-    &#34;&#34;&#34;Sets the path to the configuration file.&#34;&#34;&#34;
-    global _configfile
-    _configfile = os.abs.abspath(configfile)</code></pre>
-</details>
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.config.onboarding" href="onboarding.html">src.config.onboarding</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.config.check"><code class="name flex">
-<span>def <span class="ident">check</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Checks if the configuration file exists, creates it if not</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def check():
-    &#34;&#34;&#34;Checks if the configuration file exists, creates it if not&#34;&#34;&#34;
-
-    if not os.path.exists(os.path.dirname(get_config_file())):
-        os.makedirs(os.path.dirname(get_config_file()))</code></pre>
-</details>
-</dd>
-<dt id="src.config.get"><code class="name flex">
-<span>def <span class="ident">get</span></span>(<span>key, default=None, save=False)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Gets the key from configuration, or returns <code>default</code></p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def get(key, default = None, save = False):
-    &#34;&#34;&#34;Gets the key from configuration, or returns `default`&#34;&#34;&#34;
-
-    key = str(key).split(&#39;.&#39;)
-    data = _config
-
-    last = key.pop()
-
-    for item in key:
-        if (not item in data) or (not type(data[item]) == dict):
-            return default
-        data = data[item]
-
-    if last not in data:
-        if save:
-            set(key, default, savefile = True)
-        return default
-
-    return data[last]</code></pre>
-</details>
-</dd>
-<dt id="src.config.get_config"><code class="name flex">
-<span>def <span class="ident">get_config</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Gets the entire configuration as an array</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def get_config():
-    &#34;&#34;&#34;Gets the entire configuration as an array&#34;&#34;&#34;
-    return _config</code></pre>
-</details>
-</dd>
-<dt id="src.config.get_config_file"><code class="name flex">
-<span>def <span class="ident">get_config_file</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Returns the absolute path to the configuration file</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def get_config_file():
-    &#34;&#34;&#34;Returns the absolute path to the configuration file&#34;&#34;&#34;
-    return _configfile</code></pre>
-</details>
-</dd>
-<dt id="src.config.is_set"><code class="name flex">
-<span>def <span class="ident">is_set</span></span>(<span>key)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def is_set(key):
-    key = str(key).split(&#39;.&#39;)
-    data = _config
-
-    last = key.pop()
-
-    for item in key:
-        if (not item in data) or (not type(data[item]) == dict):
-            return False
-        data = data[item]
-
-    if not last in data:
-        return False
-
-    return True</code></pre>
-</details>
-</dd>
-<dt id="src.config.reload"><code class="name flex">
-<span>def <span class="ident">reload</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Reloads the configuration data in memory from the file</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def reload():
-    &#34;&#34;&#34;Reloads the configuration data in memory from the file&#34;&#34;&#34;
-    check()
-    try:
-        with open(get_config_file(), &#39;r&#39;, encoding=&#34;utf8&#34;) as configfile:
-            set_config(json.loads(configfile.read()))
-    except (FileNotFoundError, json.JSONDecodeError) as e:
-        pass</code></pre>
-</details>
-</dd>
-<dt id="src.config.save"><code class="name flex">
-<span>def <span class="ident">save</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Saves the configuration data to the configuration file</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def save():
-    &#34;&#34;&#34;Saves the configuration data to the configuration file&#34;&#34;&#34;
-
-    check()
-    try:
-        with open(get_config_file(), &#39;w&#39;, encoding=&#34;utf8&#34;) as configfile:
-            json.dump(get_config(), configfile, indent=2)
-    except json.JSONDecodeError:
-        logger.warn(&#39;Failed to write to configuration file.&#39;)</code></pre>
-</details>
-</dd>
-<dt id="src.config.set"><code class="name flex">
-<span>def <span class="ident">set</span></span>(<span>key, value=None, savefile=False)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Sets the key in configuration to <code>value</code></p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def set(key, value = None, savefile = False):
-    &#34;&#34;&#34;Sets the key in configuration to `value`&#34;&#34;&#34;
-
-    global _config
-
-    whole_key = key
-    key = str(key).split(&#39;.&#39;)
-    data = _config
-
-    last = key.pop()
-
-    for item in key:
-        if (not item in data) or (not type(data[item]) == dict):
-            data[item] = dict()
-        data = data[item]
-
-    if value is None:
-        del data[last]
-    else:
-        data[last] = value
-
-    if savefile:
-        save()</code></pre>
-</details>
-</dd>
-<dt id="src.config.set_config"><code class="name flex">
-<span>def <span class="ident">set_config</span></span>(<span>config)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Sets the configuration to the array in arguments</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def set_config(config):
-    &#34;&#34;&#34;Sets the configuration to the array in arguments&#34;&#34;&#34;
-    global _config
-    _config = config</code></pre>
-</details>
-</dd>
-<dt id="src.config.set_config_file"><code class="name flex">
-<span>def <span class="ident">set_config_file</span></span>(<span>configfile)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Sets the path to the configuration file.</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def set_config_file(configfile):
-    &#34;&#34;&#34;Sets the path to the configuration file.&#34;&#34;&#34;
-    global _configfile
-    _configfile = os.abs.abspath(configfile)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src" href="../index.html">src</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.config.onboarding" href="onboarding.html">src.config.onboarding</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="two-column">
-<li><code><a title="src.config.check" href="#src.config.check">check</a></code></li>
-<li><code><a title="src.config.get" href="#src.config.get">get</a></code></li>
-<li><code><a title="src.config.get_config" href="#src.config.get_config">get_config</a></code></li>
-<li><code><a title="src.config.get_config_file" href="#src.config.get_config_file">get_config_file</a></code></li>
-<li><code><a title="src.config.is_set" href="#src.config.is_set">is_set</a></code></li>
-<li><code><a title="src.config.reload" href="#src.config.reload">reload</a></code></li>
-<li><code><a title="src.config.save" href="#src.config.save">save</a></code></li>
-<li><code><a title="src.config.set" href="#src.config.set">set</a></code></li>
-<li><code><a title="src.config.set_config" href="#src.config.set_config">set_config</a></code></li>
-<li><code><a title="src.config.set_config_file" href="#src.config.set_config_file">set_config_file</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/config/onboarding.html

@@ -1,213 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.config.onboarding API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.config.onboarding</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>Setup config from onboarding choices</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-Setup config from onboarding choices
-&#34;&#34;&#34;
-from pathlib import Path
-from typing import Union
-
-from filepaths import onboarding_mark_file
-from onionrtypes import JSONSerializable
-from onionrtypes import OnboardingConfig
-import config
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-def _get_val_or_none(json: dict, key: str) -&gt; Union[None, JSONSerializable]:
-    try:
-        return json[&#39;configInfo&#39;][key]
-    except KeyError:
-        return None
-
-
-def set_config_from_onboarding(config_settings: OnboardingConfig):
-    get = _get_val_or_none
-
-    config.reload()
-
-    if get(config_settings, &#39;stateTarget&#39;) or not get(config_settings,
-                                                      &#39;networkContrib&#39;):
-        config.set(&#39;general.security_level&#39;, 1)
-
-    if get(config_settings, &#39;localThreat&#39;):
-        config.set(&#39;general.security_level&#39;, 3)
-
-    config.set(&#39;ui.theme&#39;, &#39;light&#39;)
-    if get(config_settings, &#39;useDark&#39;):
-        config.set(&#39;ui.theme&#39;, &#39;dark&#39;)
-
-    disabled = config.get(&#39;plugins.disabled&#39;, [])
-
-    if not get(config_settings, &#39;circles&#39;) or \
-            config.get(&#39;general.security_level&#39;) &gt; 0:
-        disabled.append(&#39;flow&#39;)
-
-    if not get(config_settings, &#39;mail&#39;):
-        disabled.append(&#39;pms&#39;)
-
-    config.set(&#39;plugins.disabled&#39;, disabled)
-
-    config.set(&#39;general.store_plaintext_blocks&#39;,
-               get(config_settings, &#39;plainContrib&#39;))
-
-    config.set(&#39;onboarding.done&#39;, True, savefile=True)
-
-
-def set_onboarding_finished():
-    &#34;&#34;&#34;Create the onboarding completed setting file&#34;&#34;&#34;
-    Path(onboarding_mark_file).touch()
-
-
-def is_onboarding_finished() -&gt; bool:
-    return True</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.config.onboarding.is_onboarding_finished"><code class="name flex">
-<span>def <span class="ident">is_onboarding_finished</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def is_onboarding_finished() -&gt; bool:
-    return True</code></pre>
-</details>
-</dd>
-<dt id="src.config.onboarding.set_config_from_onboarding"><code class="name flex">
-<span>def <span class="ident">set_config_from_onboarding</span></span>(<span>config_settings)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def set_config_from_onboarding(config_settings: OnboardingConfig):
-    get = _get_val_or_none
-
-    config.reload()
-
-    if get(config_settings, &#39;stateTarget&#39;) or not get(config_settings,
-                                                      &#39;networkContrib&#39;):
-        config.set(&#39;general.security_level&#39;, 1)
-
-    if get(config_settings, &#39;localThreat&#39;):
-        config.set(&#39;general.security_level&#39;, 3)
-
-    config.set(&#39;ui.theme&#39;, &#39;light&#39;)
-    if get(config_settings, &#39;useDark&#39;):
-        config.set(&#39;ui.theme&#39;, &#39;dark&#39;)
-
-    disabled = config.get(&#39;plugins.disabled&#39;, [])
-
-    if not get(config_settings, &#39;circles&#39;) or \
-            config.get(&#39;general.security_level&#39;) &gt; 0:
-        disabled.append(&#39;flow&#39;)
-
-    if not get(config_settings, &#39;mail&#39;):
-        disabled.append(&#39;pms&#39;)
-
-    config.set(&#39;plugins.disabled&#39;, disabled)
-
-    config.set(&#39;general.store_plaintext_blocks&#39;,
-               get(config_settings, &#39;plainContrib&#39;))
-
-    config.set(&#39;onboarding.done&#39;, True, savefile=True)</code></pre>
-</details>
-</dd>
-<dt id="src.config.onboarding.set_onboarding_finished"><code class="name flex">
-<span>def <span class="ident">set_onboarding_finished</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Create the onboarding completed setting file</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def set_onboarding_finished():
-    &#34;&#34;&#34;Create the onboarding completed setting file&#34;&#34;&#34;
-    Path(onboarding_mark_file).touch()</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.config" href="index.html">src.config</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.config.onboarding.is_onboarding_finished" href="#src.config.onboarding.is_onboarding_finished">is_onboarding_finished</a></code></li>
-<li><code><a title="src.config.onboarding.set_config_from_onboarding" href="#src.config.onboarding.set_config_from_onboarding">set_config_from_onboarding</a></code></li>
-<li><code><a title="src.config.onboarding.set_onboarding_finished" href="#src.config.onboarding.set_onboarding_finished">set_onboarding_finished</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/coredb/blockmetadb/add.html

@@ -1,143 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.coredb.blockmetadb.add API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.coredb.blockmetadb.add</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>Add an entry to the block metadata database</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    Add an entry to the block metadata database
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-import os, sqlite3, secrets
-from onionrutils import epoch, blockmetadata
-from etc import onionrvalues
-from .. import dbfiles
-def add_to_block_DB(newHash, selfInsert=False, dataSaved=False):
-    &#39;&#39;&#39;
-        Add a hash value to the block db
-
-        Should be in hex format!
-    &#39;&#39;&#39;
-
-    if blockmetadata.has_block(newHash):
-        return
-    conn = sqlite3.connect(dbfiles.block_meta_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-    currentTime = epoch.get_epoch() + secrets.randbelow(301)
-    if selfInsert or dataSaved:
-        selfInsert = 1
-    else:
-        selfInsert = 0
-    data = (newHash, currentTime, &#39;&#39;, selfInsert)
-    c.execute(&#39;INSERT INTO hashes (hash, dateReceived, dataType, dataSaved) VALUES(?, ?, ?, ?);&#39;, data)
-    conn.commit()
-    conn.close()</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.coredb.blockmetadb.add.add_to_block_DB"><code class="name flex">
-<span>def <span class="ident">add_to_block_DB</span></span>(<span>newHash, selfInsert=False, dataSaved=False)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Add a hash value to the block db</p>
-<p>Should be in hex format!</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def add_to_block_DB(newHash, selfInsert=False, dataSaved=False):
-    &#39;&#39;&#39;
-        Add a hash value to the block db
-
-        Should be in hex format!
-    &#39;&#39;&#39;
-
-    if blockmetadata.has_block(newHash):
-        return
-    conn = sqlite3.connect(dbfiles.block_meta_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-    currentTime = epoch.get_epoch() + secrets.randbelow(301)
-    if selfInsert or dataSaved:
-        selfInsert = 1
-    else:
-        selfInsert = 0
-    data = (newHash, currentTime, &#39;&#39;, selfInsert)
-    c.execute(&#39;INSERT INTO hashes (hash, dateReceived, dataType, dataSaved) VALUES(?, ?, ?, ?);&#39;, data)
-    conn.commit()
-    conn.close()</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.coredb.blockmetadb" href="index.html">src.coredb.blockmetadb</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.coredb.blockmetadb.add.add_to_block_DB" href="#src.coredb.blockmetadb.add.add_to_block_DB">add_to_block_DB</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/coredb/blockmetadb/expiredblocks.html

@@ -1,133 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.coredb.blockmetadb.expiredblocks API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.coredb.blockmetadb.expiredblocks</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>Get a list of expired blocks still stored</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    Get a list of expired blocks still stored
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-import sqlite3
-from onionrutils import epoch
-from .. import dbfiles
-from etc import onionrvalues
-
-def get_expired_blocks():
-    &#39;&#39;&#39;Returns a list of expired blocks&#39;&#39;&#39;
-    conn = sqlite3.connect(dbfiles.block_meta_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-    date = int(epoch.get_epoch())
-
-    compiled = (date,)
-    execute = &#39;SELECT hash FROM hashes WHERE expire &lt;= ? ORDER BY dateReceived;&#39;
-
-    rows = list()
-    for row in c.execute(execute, compiled):
-        for i in row:
-            rows.append(i)
-    conn.close()
-    return rows</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.coredb.blockmetadb.expiredblocks.get_expired_blocks"><code class="name flex">
-<span>def <span class="ident">get_expired_blocks</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Returns a list of expired blocks</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def get_expired_blocks():
-    &#39;&#39;&#39;Returns a list of expired blocks&#39;&#39;&#39;
-    conn = sqlite3.connect(dbfiles.block_meta_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-    date = int(epoch.get_epoch())
-
-    compiled = (date,)
-    execute = &#39;SELECT hash FROM hashes WHERE expire &lt;= ? ORDER BY dateReceived;&#39;
-
-    rows = list()
-    for row in c.execute(execute, compiled):
-        for i in row:
-            rows.append(i)
-    conn.close()
-    return rows</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.coredb.blockmetadb" href="index.html">src.coredb.blockmetadb</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.coredb.blockmetadb.expiredblocks.get_expired_blocks" href="#src.coredb.blockmetadb.expiredblocks.get_expired_blocks">get_expired_blocks</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/coredb/blockmetadb/index.html

@@ -1,266 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.coredb.blockmetadb API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.coredb.blockmetadb</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>This module works with information relating to blocks stored on the node</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;
-    Onionr - Private P2P Communication
-
-    This module works with information relating to blocks stored on the node
-&#34;&#34;&#34;
-import sqlite3
-
-from etc import onionrvalues
-from . import expiredblocks, updateblockinfo, add
-from .. import dbfiles
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-update_block_info = updateblockinfo.update_block_info
-add_to_block_DB = add.add_to_block_DB
-
-
-def get_block_list(dateRec = None, unsaved = False):
-    &#34;&#34;&#34;
-        Get list of our blocks
-    &#34;&#34;&#34;
-    if dateRec == None:
-        dateRec = 0
-
-    conn = sqlite3.connect(dbfiles.block_meta_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-
-    execute = &#39;SELECT hash FROM hashes WHERE dateReceived &gt;= ? ORDER BY dateReceived ASC;&#39;
-    args = (dateRec,)
-    rows = list()
-    for row in c.execute(execute, args):
-        for i in row:
-            rows.append(i)
-    conn.close()
-    return rows
-
-
-def get_block_date(blockHash):
-    &#34;&#34;&#34;
-        Returns the date a block was received
-    &#34;&#34;&#34;
-
-    conn = sqlite3.connect(dbfiles.block_meta_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-
-    execute = &#39;SELECT dateReceived FROM hashes WHERE hash=?;&#39;
-    args = (blockHash,)
-    for row in c.execute(execute, args):
-        for i in row:
-            return int(i)
-    conn.close()
-    return None
-
-
-def get_blocks_by_type(blockType, orderDate=True):
-    &#34;&#34;&#34;
-        Returns a list of blocks by the type
-    &#34;&#34;&#34;
-
-    conn = sqlite3.connect(dbfiles.block_meta_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-
-    if orderDate:
-        execute = &#39;SELECT hash FROM hashes WHERE dataType=? ORDER BY dateReceived;&#39;
-    else:
-        execute = &#39;SELECT hash FROM hashes WHERE dataType=?;&#39;
-
-    args = (blockType,)
-    rows = list()
-
-    for row in c.execute(execute, args):
-        for i in row:
-            rows.append(i)
-    conn.close()
-    return rows</code></pre>
-</details>
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.coredb.blockmetadb.add" href="add.html">src.coredb.blockmetadb.add</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.coredb.blockmetadb.expiredblocks" href="expiredblocks.html">src.coredb.blockmetadb.expiredblocks</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.coredb.blockmetadb.updateblockinfo" href="updateblockinfo.html">src.coredb.blockmetadb.updateblockinfo</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.coredb.blockmetadb.get_block_date"><code class="name flex">
-<span>def <span class="ident">get_block_date</span></span>(<span>blockHash)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Returns the date a block was received</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def get_block_date(blockHash):
-    &#34;&#34;&#34;
-        Returns the date a block was received
-    &#34;&#34;&#34;
-
-    conn = sqlite3.connect(dbfiles.block_meta_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-
-    execute = &#39;SELECT dateReceived FROM hashes WHERE hash=?;&#39;
-    args = (blockHash,)
-    for row in c.execute(execute, args):
-        for i in row:
-            return int(i)
-    conn.close()
-    return None</code></pre>
-</details>
-</dd>
-<dt id="src.coredb.blockmetadb.get_block_list"><code class="name flex">
-<span>def <span class="ident">get_block_list</span></span>(<span>dateRec=None, unsaved=False)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Get list of our blocks</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def get_block_list(dateRec = None, unsaved = False):
-    &#34;&#34;&#34;
-        Get list of our blocks
-    &#34;&#34;&#34;
-    if dateRec == None:
-        dateRec = 0
-
-    conn = sqlite3.connect(dbfiles.block_meta_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-
-    execute = &#39;SELECT hash FROM hashes WHERE dateReceived &gt;= ? ORDER BY dateReceived ASC;&#39;
-    args = (dateRec,)
-    rows = list()
-    for row in c.execute(execute, args):
-        for i in row:
-            rows.append(i)
-    conn.close()
-    return rows</code></pre>
-</details>
-</dd>
-<dt id="src.coredb.blockmetadb.get_blocks_by_type"><code class="name flex">
-<span>def <span class="ident">get_blocks_by_type</span></span>(<span>blockType, orderDate=True)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Returns a list of blocks by the type</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def get_blocks_by_type(blockType, orderDate=True):
-    &#34;&#34;&#34;
-        Returns a list of blocks by the type
-    &#34;&#34;&#34;
-
-    conn = sqlite3.connect(dbfiles.block_meta_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-
-    if orderDate:
-        execute = &#39;SELECT hash FROM hashes WHERE dataType=? ORDER BY dateReceived;&#39;
-    else:
-        execute = &#39;SELECT hash FROM hashes WHERE dataType=?;&#39;
-
-    args = (blockType,)
-    rows = list()
-
-    for row in c.execute(execute, args):
-        for i in row:
-            rows.append(i)
-    conn.close()
-    return rows</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.coredb" href="../index.html">src.coredb</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.coredb.blockmetadb.add" href="add.html">src.coredb.blockmetadb.add</a></code></li>
-<li><code><a title="src.coredb.blockmetadb.expiredblocks" href="expiredblocks.html">src.coredb.blockmetadb.expiredblocks</a></code></li>
-<li><code><a title="src.coredb.blockmetadb.updateblockinfo" href="updateblockinfo.html">src.coredb.blockmetadb.updateblockinfo</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.coredb.blockmetadb.get_block_date" href="#src.coredb.blockmetadb.get_block_date">get_block_date</a></code></li>
-<li><code><a title="src.coredb.blockmetadb.get_block_list" href="#src.coredb.blockmetadb.get_block_list">get_block_list</a></code></li>
-<li><code><a title="src.coredb.blockmetadb.get_blocks_by_type" href="#src.coredb.blockmetadb.get_blocks_by_type">get_blocks_by_type</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/coredb/blockmetadb/updateblockinfo.html

@@ -1,176 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.coredb.blockmetadb.updateblockinfo API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.coredb.blockmetadb.updateblockinfo</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>Update block information in the metadata database by a field name</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    Update block information in the metadata database by a field name
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-import sqlite3
-from .. import dbfiles
-from etc import onionrvalues
-def update_block_info(hash, key, data):
-    &#39;&#39;&#39;
-        sets info associated with a block
-
-        hash         - the hash of a block
-        dateReceived - the date the block was recieved, not necessarily when it was created
-        decrypted    - if we can successfully decrypt the block (does not describe its current state)
-        dataType     - data type of the block
-        dataFound    - if the data has been found for the block
-        dataSaved    - if the data has been saved for the block
-        sig    - optional signature by the author (not optional if author is specified)
-        author       - multi-round partial sha3-256 hash of authors public key
-        dateClaimed  - timestamp claimed inside the block, only as trustworthy as the block author is
-        expire       - expire date for a block
-    &#39;&#39;&#39;
-    if key not in (&#39;dateReceived&#39;, &#39;decrypted&#39;, &#39;dataType&#39;, &#39;dataFound&#39;, 
-                  &#39;dataSaved&#39;, &#39;sig&#39;, &#39;author&#39;, &#39;dateClaimed&#39;, &#39;expire&#39;):
-        raise ValueError(&#39;Key must be in the allowed list&#39;)
-
-    conn = sqlite3.connect(dbfiles.block_meta_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-    args = (data, hash)
-    # Unfortunately, not really possible
-    c.execute(&#34;UPDATE hashes SET &#34; + key + &#34; = ? where hash = ?;&#34;, args)
-    conn.commit()
-    conn.close()
-
-    return True</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.coredb.blockmetadb.updateblockinfo.update_block_info"><code class="name flex">
-<span>def <span class="ident">update_block_info</span></span>(<span>hash, key, data)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>sets info associated with a block</p>
-<p>hash
-- the hash of a block
-dateReceived - the date the block was recieved, not necessarily when it was created
-decrypted
-- if we can successfully decrypt the block (does not describe its current state)
-dataType
-- data type of the block
-dataFound
-- if the data has been found for the block
-dataSaved
-- if the data has been saved for the block
-sig
-- optional signature by the author (not optional if author is specified)
-author
-- multi-round partial sha3-256 hash of authors public key
-dateClaimed
-- timestamp claimed inside the block, only as trustworthy as the block author is
-expire
-- expire date for a block</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def update_block_info(hash, key, data):
-    &#39;&#39;&#39;
-        sets info associated with a block
-
-        hash         - the hash of a block
-        dateReceived - the date the block was recieved, not necessarily when it was created
-        decrypted    - if we can successfully decrypt the block (does not describe its current state)
-        dataType     - data type of the block
-        dataFound    - if the data has been found for the block
-        dataSaved    - if the data has been saved for the block
-        sig    - optional signature by the author (not optional if author is specified)
-        author       - multi-round partial sha3-256 hash of authors public key
-        dateClaimed  - timestamp claimed inside the block, only as trustworthy as the block author is
-        expire       - expire date for a block
-    &#39;&#39;&#39;
-    if key not in (&#39;dateReceived&#39;, &#39;decrypted&#39;, &#39;dataType&#39;, &#39;dataFound&#39;, 
-                  &#39;dataSaved&#39;, &#39;sig&#39;, &#39;author&#39;, &#39;dateClaimed&#39;, &#39;expire&#39;):
-        raise ValueError(&#39;Key must be in the allowed list&#39;)
-
-    conn = sqlite3.connect(dbfiles.block_meta_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-    args = (data, hash)
-    # Unfortunately, not really possible
-    c.execute(&#34;UPDATE hashes SET &#34; + key + &#34; = ? where hash = ?;&#34;, args)
-    conn.commit()
-    conn.close()
-
-    return True</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.coredb.blockmetadb" href="index.html">src.coredb.blockmetadb</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.coredb.blockmetadb.updateblockinfo.update_block_info" href="#src.coredb.blockmetadb.updateblockinfo.update_block_info">update_block_info</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/coredb/dbfiles.html

@@ -1,69 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.coredb.dbfiles API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.coredb.dbfiles</code></h1>
-</header>
-<section id="section-intro">
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">from utils import identifyhome
-import filepaths
-home = identifyhome.identify_home()
-if not home.endswith(&#39;/&#39;): home += &#39;/&#39;
-
-block_meta_db = &#39;%sblock-metadata.db&#39; % (home)
-block_data_db = &#39;%s/block-data.db&#39; % (filepaths.block_data_location,)
-address_info_db = &#39;%saddress.db&#39; % (home,)
-user_id_info_db = &#39;%susers.db&#39; % (home,)
-forward_keys_db = &#39;%sforward-keys.db&#39; % (home,)
-blacklist_db = &#39;%sblacklist.db&#39; % (home,)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.coredb" href="index.html">src.coredb</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/coredb/index.html

@@ -1,81 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.coredb API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.coredb</code></h1>
-</header>
-<section id="section-intro">
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">from . import keydb, blockmetadb</code></pre>
-</details>
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.coredb.blockmetadb" href="blockmetadb/index.html">src.coredb.blockmetadb</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.coredb.dbfiles" href="dbfiles.html">src.coredb.dbfiles</a></code></dt>
-<dd>
-<section class="desc"></section>
-</dd>
-<dt><code class="name"><a title="src.coredb.keydb" href="keydb/index.html">src.coredb.keydb</a></code></dt>
-<dd>
-<section class="desc"></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src" href="../index.html">src</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.coredb.blockmetadb" href="blockmetadb/index.html">src.coredb.blockmetadb</a></code></li>
-<li><code><a title="src.coredb.dbfiles" href="dbfiles.html">src.coredb.dbfiles</a></code></li>
-<li><code><a title="src.coredb.keydb" href="keydb/index.html">src.coredb.keydb</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/coredb/keydb/addkeys.html

@@ -1,254 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.coredb.keydb.addkeys API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.coredb.keydb.addkeys</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>add user keys or transport addresses</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    add user keys or transport addresses
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-import sqlite3
-from onionrplugins import onionrevents as events
-from onionrutils import stringvalidators
-from . import listkeys
-from utils import gettransports
-from .. import dbfiles
-import onionrcrypto
-from etc import onionrvalues
-
-def add_peer(peerID, name=&#39;&#39;):
-    &#39;&#39;&#39;
-        Adds a public key to the key database (misleading function name)
-    &#39;&#39;&#39;
-    if peerID in listkeys.list_peers() or peerID == onionrcrypto.pub_key:
-        raise ValueError(&#34;specified id is already known&#34;)
-
-    # This function simply adds a peer to the DB
-    if not stringvalidators.validate_pub_key(peerID):
-        return False
-
-    #events.event(&#39;pubkey_add&#39;, data = {&#39;key&#39;: peerID}, onionr = core_inst.onionrInst)
-
-    conn = sqlite3.connect(dbfiles.user_id_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    hashID = &#34;&#34;
-    c = conn.cursor()
-    t = (peerID, name, &#39;unknown&#39;, hashID, 0)
-
-    for i in c.execute(&#34;SELECT * FROM peers WHERE id = ?;&#34;, (peerID,)):
-        try:
-            if i[0] == peerID:
-                conn.close()
-                return False
-        except ValueError:
-            pass
-        except IndexError:
-            pass
-    c.execute(&#39;INSERT INTO peers (id, name, dateSeen, hashID, trust) VALUES(?, ?, ?, ?, ?);&#39;, t)
-    conn.commit()
-    conn.close()
-
-    return True
-
-def add_address(address):
-    &#39;&#39;&#39;
-        Add an address to the address database (only tor currently)
-    &#39;&#39;&#39;
-
-    if type(address) is None or len(address) == 0:
-        return False
-    if stringvalidators.validate_transport(address):
-        if address in gettransports.get():
-            return False
-        conn = sqlite3.connect(dbfiles.address_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-        c = conn.cursor()
-        # check if address is in database
-        # this is safe to do because the address is validated above, but we strip some chars here too just in case
-        address = address.replace(&#39;\&#39;&#39;, &#39;&#39;).replace(&#39;;&#39;, &#39;&#39;).replace(&#39;&#34;&#39;, &#39;&#39;).replace(&#39;\\&#39;, &#39;&#39;)
-        for i in c.execute(&#34;SELECT * FROM adders WHERE address = ?;&#34;, (address,)):
-            try:
-                if i[0] == address:
-                    conn.close()
-                    return False
-            except ValueError:
-                pass
-            except IndexError:
-                pass
-
-        t = (address, 1)
-        c.execute(&#39;INSERT INTO adders (address, type) VALUES(?, ?);&#39;, t)
-        conn.commit()
-        conn.close()
-
-        #events.event(&#39;address_add&#39;, data = {&#39;address&#39;: address}, onionr = core_inst.onionrInst)
-
-        return True
-    else:
-        return False</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.coredb.keydb.addkeys.add_address"><code class="name flex">
-<span>def <span class="ident">add_address</span></span>(<span>address)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Add an address to the address database (only tor currently)</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def add_address(address):
-    &#39;&#39;&#39;
-        Add an address to the address database (only tor currently)
-    &#39;&#39;&#39;
-
-    if type(address) is None or len(address) == 0:
-        return False
-    if stringvalidators.validate_transport(address):
-        if address in gettransports.get():
-            return False
-        conn = sqlite3.connect(dbfiles.address_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-        c = conn.cursor()
-        # check if address is in database
-        # this is safe to do because the address is validated above, but we strip some chars here too just in case
-        address = address.replace(&#39;\&#39;&#39;, &#39;&#39;).replace(&#39;;&#39;, &#39;&#39;).replace(&#39;&#34;&#39;, &#39;&#39;).replace(&#39;\\&#39;, &#39;&#39;)
-        for i in c.execute(&#34;SELECT * FROM adders WHERE address = ?;&#34;, (address,)):
-            try:
-                if i[0] == address:
-                    conn.close()
-                    return False
-            except ValueError:
-                pass
-            except IndexError:
-                pass
-
-        t = (address, 1)
-        c.execute(&#39;INSERT INTO adders (address, type) VALUES(?, ?);&#39;, t)
-        conn.commit()
-        conn.close()
-
-        #events.event(&#39;address_add&#39;, data = {&#39;address&#39;: address}, onionr = core_inst.onionrInst)
-
-        return True
-    else:
-        return False</code></pre>
-</details>
-</dd>
-<dt id="src.coredb.keydb.addkeys.add_peer"><code class="name flex">
-<span>def <span class="ident">add_peer</span></span>(<span>peerID, name='')</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Adds a public key to the key database (misleading function name)</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def add_peer(peerID, name=&#39;&#39;):
-    &#39;&#39;&#39;
-        Adds a public key to the key database (misleading function name)
-    &#39;&#39;&#39;
-    if peerID in listkeys.list_peers() or peerID == onionrcrypto.pub_key:
-        raise ValueError(&#34;specified id is already known&#34;)
-
-    # This function simply adds a peer to the DB
-    if not stringvalidators.validate_pub_key(peerID):
-        return False
-
-    #events.event(&#39;pubkey_add&#39;, data = {&#39;key&#39;: peerID}, onionr = core_inst.onionrInst)
-
-    conn = sqlite3.connect(dbfiles.user_id_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    hashID = &#34;&#34;
-    c = conn.cursor()
-    t = (peerID, name, &#39;unknown&#39;, hashID, 0)
-
-    for i in c.execute(&#34;SELECT * FROM peers WHERE id = ?;&#34;, (peerID,)):
-        try:
-            if i[0] == peerID:
-                conn.close()
-                return False
-        except ValueError:
-            pass
-        except IndexError:
-            pass
-    c.execute(&#39;INSERT INTO peers (id, name, dateSeen, hashID, trust) VALUES(?, ?, ?, ?, ?);&#39;, t)
-    conn.commit()
-    conn.close()
-
-    return True</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.coredb.keydb" href="index.html">src.coredb.keydb</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.coredb.keydb.addkeys.add_address" href="#src.coredb.keydb.addkeys.add_address">add_address</a></code></li>
-<li><code><a title="src.coredb.keydb.addkeys.add_peer" href="#src.coredb.keydb.addkeys.add_peer">add_peer</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/coredb/keydb/index.html

@@ -1,91 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.coredb.keydb API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.coredb.keydb</code></h1>
-</header>
-<section id="section-intro">
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">from . import addkeys, listkeys, removekeys, userinfo, transportinfo</code></pre>
-</details>
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.coredb.keydb.addkeys" href="addkeys.html">src.coredb.keydb.addkeys</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.coredb.keydb.listkeys" href="listkeys.html">src.coredb.keydb.listkeys</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.coredb.keydb.removekeys" href="removekeys.html">src.coredb.keydb.removekeys</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.coredb.keydb.transportinfo" href="transportinfo.html">src.coredb.keydb.transportinfo</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.coredb.keydb.userinfo" href="userinfo.html">src.coredb.keydb.userinfo</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.coredb" href="../index.html">src.coredb</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.coredb.keydb.addkeys" href="addkeys.html">src.coredb.keydb.addkeys</a></code></li>
-<li><code><a title="src.coredb.keydb.listkeys" href="listkeys.html">src.coredb.keydb.listkeys</a></code></li>
-<li><code><a title="src.coredb.keydb.removekeys" href="removekeys.html">src.coredb.keydb.removekeys</a></code></li>
-<li><code><a title="src.coredb.keydb.transportinfo" href="transportinfo.html">src.coredb.keydb.transportinfo</a></code></li>
-<li><code><a title="src.coredb.keydb.userinfo" href="userinfo.html">src.coredb.keydb.userinfo</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/coredb/keydb/listkeys.html

@@ -1,239 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.coredb.keydb.listkeys API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.coredb.keydb.listkeys</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>get lists for user keys or transport addresses</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    get lists for user keys or transport addresses
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-import sqlite3
-import logger
-from onionrutils import epoch
-from etc import onionrvalues
-from .. import dbfiles
-from . import userinfo, transportinfo
-def list_peers(randomOrder=True, getPow=False, trust=0):
-    &#39;&#39;&#39;
-        Return a list of public keys (misleading function name)
-
-        randomOrder determines if the list should be in a random order
-        trust sets the minimum trust to list
-    &#39;&#39;&#39;
-    conn = sqlite3.connect(dbfiles.user_id_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-
-    payload = &#39;&#39;
-
-    if trust not in (0, 1, 2):
-        logger.error(&#39;Tried to select invalid trust.&#39;)
-        return
-
-    if randomOrder:
-        payload = &#39;SELECT * FROM peers WHERE trust &gt;= ? ORDER BY RANDOM();&#39;
-    else:
-        payload = &#39;SELECT * FROM peers WHERE trust &gt;= ?;&#39;
-
-    peerList = []
-
-    for i in c.execute(payload, (trust,)):
-        try:
-            if len(i[0]) != 0:
-                if getPow:
-                    peerList.append(i[0] + &#39;-&#39; + i[1])
-                else:
-                    peerList.append(i[0])
-        except TypeError:
-            pass
-
-    conn.close()
-
-    return peerList
-
-def list_adders(randomOrder=True, i2p=True, recent=0):
-    &#39;&#39;&#39;
-        Return a list of transport addresses
-    &#39;&#39;&#39;
-    conn = sqlite3.connect(dbfiles.address_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-    if randomOrder:
-        addresses = c.execute(&#39;SELECT * FROM adders ORDER BY RANDOM();&#39;)
-    else:
-        addresses = c.execute(&#39;SELECT * FROM adders;&#39;)
-    addressList = []
-    for i in addresses:
-        if len(i[0].strip()) == 0:
-            continue
-        addressList.append(i[0])
-    conn.close()
-    testList = list(addressList) # create new list to iterate
-    for address in testList:
-        try:
-            if recent &gt; 0 and (epoch.get_epoch() - transportinfo.get_address_info(address, &#39;lastConnect&#39;)) &gt; recent:
-                raise TypeError # If there is no last-connected date or it was too long ago, don&#39;t add peer to list if recent is not 0
-        except TypeError:
-            addressList.remove(address)
-    return addressList</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.coredb.keydb.listkeys.list_adders"><code class="name flex">
-<span>def <span class="ident">list_adders</span></span>(<span>randomOrder=True, i2p=True, recent=0)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Return a list of transport addresses</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def list_adders(randomOrder=True, i2p=True, recent=0):
-    &#39;&#39;&#39;
-        Return a list of transport addresses
-    &#39;&#39;&#39;
-    conn = sqlite3.connect(dbfiles.address_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-    if randomOrder:
-        addresses = c.execute(&#39;SELECT * FROM adders ORDER BY RANDOM();&#39;)
-    else:
-        addresses = c.execute(&#39;SELECT * FROM adders;&#39;)
-    addressList = []
-    for i in addresses:
-        if len(i[0].strip()) == 0:
-            continue
-        addressList.append(i[0])
-    conn.close()
-    testList = list(addressList) # create new list to iterate
-    for address in testList:
-        try:
-            if recent &gt; 0 and (epoch.get_epoch() - transportinfo.get_address_info(address, &#39;lastConnect&#39;)) &gt; recent:
-                raise TypeError # If there is no last-connected date or it was too long ago, don&#39;t add peer to list if recent is not 0
-        except TypeError:
-            addressList.remove(address)
-    return addressList</code></pre>
-</details>
-</dd>
-<dt id="src.coredb.keydb.listkeys.list_peers"><code class="name flex">
-<span>def <span class="ident">list_peers</span></span>(<span>randomOrder=True, getPow=False, trust=0)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Return a list of public keys (misleading function name)</p>
-<p>randomOrder determines if the list should be in a random order
-trust sets the minimum trust to list</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def list_peers(randomOrder=True, getPow=False, trust=0):
-    &#39;&#39;&#39;
-        Return a list of public keys (misleading function name)
-
-        randomOrder determines if the list should be in a random order
-        trust sets the minimum trust to list
-    &#39;&#39;&#39;
-    conn = sqlite3.connect(dbfiles.user_id_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-
-    payload = &#39;&#39;
-
-    if trust not in (0, 1, 2):
-        logger.error(&#39;Tried to select invalid trust.&#39;)
-        return
-
-    if randomOrder:
-        payload = &#39;SELECT * FROM peers WHERE trust &gt;= ? ORDER BY RANDOM();&#39;
-    else:
-        payload = &#39;SELECT * FROM peers WHERE trust &gt;= ?;&#39;
-
-    peerList = []
-
-    for i in c.execute(payload, (trust,)):
-        try:
-            if len(i[0]) != 0:
-                if getPow:
-                    peerList.append(i[0] + &#39;-&#39; + i[1])
-                else:
-                    peerList.append(i[0])
-        except TypeError:
-            pass
-
-    conn.close()
-
-    return peerList</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.coredb.keydb" href="index.html">src.coredb.keydb</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.coredb.keydb.listkeys.list_adders" href="#src.coredb.keydb.listkeys.list_adders">list_adders</a></code></li>
-<li><code><a title="src.coredb.keydb.listkeys.list_peers" href="#src.coredb.keydb.listkeys.list_peers">list_peers</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/coredb/keydb/removekeys.html

@@ -1,184 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.coredb.keydb.removekeys API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.coredb.keydb.removekeys</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>Remove a transport address but don't ban them</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    Remove a transport address but don&#39;t ban them
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-import sqlite3
-from onionrplugins import onionrevents as events
-from onionrutils import stringvalidators
-from onionrutils import mnemonickeys
-from .. import dbfiles
-from etc import onionrvalues
-
-def remove_address(address):
-    &#39;&#39;&#39;
-        Remove an address from the address database
-    &#39;&#39;&#39;
-
-    if stringvalidators.validate_transport(address):
-        conn = sqlite3.connect(dbfiles.address_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-        c = conn.cursor()
-        t = (address,)
-        c.execute(&#39;Delete from adders where address=?;&#39;, t)
-        conn.commit()
-        conn.close()
-
-        #events.event(&#39;address_remove&#39;, data = {&#39;address&#39;: address}, onionr = core_inst.onionrInst)
-        return True
-    else:
-        return False
-
-def remove_user(pubkey: str)-&gt;bool:
-    &#39;&#39;&#39;
-        Remove a user from the user database
-    &#39;&#39;&#39;
-    pubkey = mnemonickeys.get_base32(pubkey)
-    if stringvalidators.validate_pub_key(pubkey):
-        conn = sqlite3.connect(dbfiles.user_id_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-        c = conn.cursor()
-        t = (pubkey,)
-        c.execute(&#39;Delete from peers where id=?;&#39;, t)
-        conn.commit()
-        conn.close()
-
-        return True
-    else:
-        return False</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.coredb.keydb.removekeys.remove_address"><code class="name flex">
-<span>def <span class="ident">remove_address</span></span>(<span>address)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Remove an address from the address database</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def remove_address(address):
-    &#39;&#39;&#39;
-        Remove an address from the address database
-    &#39;&#39;&#39;
-
-    if stringvalidators.validate_transport(address):
-        conn = sqlite3.connect(dbfiles.address_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-        c = conn.cursor()
-        t = (address,)
-        c.execute(&#39;Delete from adders where address=?;&#39;, t)
-        conn.commit()
-        conn.close()
-
-        #events.event(&#39;address_remove&#39;, data = {&#39;address&#39;: address}, onionr = core_inst.onionrInst)
-        return True
-    else:
-        return False</code></pre>
-</details>
-</dd>
-<dt id="src.coredb.keydb.removekeys.remove_user"><code class="name flex">
-<span>def <span class="ident">remove_user</span></span>(<span>pubkey)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Remove a user from the user database</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def remove_user(pubkey: str)-&gt;bool:
-    &#39;&#39;&#39;
-        Remove a user from the user database
-    &#39;&#39;&#39;
-    pubkey = mnemonickeys.get_base32(pubkey)
-    if stringvalidators.validate_pub_key(pubkey):
-        conn = sqlite3.connect(dbfiles.user_id_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-        c = conn.cursor()
-        t = (pubkey,)
-        c.execute(&#39;Delete from peers where id=?;&#39;, t)
-        conn.commit()
-        conn.close()
-
-        return True
-    else:
-        return False</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.coredb.keydb" href="index.html">src.coredb.keydb</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.coredb.keydb.removekeys.remove_address" href="#src.coredb.keydb.removekeys.remove_address">remove_address</a></code></li>
-<li><code><a title="src.coredb.keydb.removekeys.remove_user" href="#src.coredb.keydb.removekeys.remove_user">remove_user</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/coredb/keydb/transportinfo.html

@@ -1,230 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.coredb.keydb.transportinfo API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.coredb.keydb.transportinfo</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>get or set transport address meta information</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    get or set transport address meta information
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-import sqlite3
-from .. import dbfiles
-from etc import onionrvalues
-
-def get_address_info(address, info):
-    &#39;&#39;&#39;
-        Get info about an address from its database entry
-
-        address text, 0
-        type int, 1
-        knownPeer text, 2
-        speed int, 3
-        success int, 4
-        powValue    5
-        failure int 6
-        lastConnect 7
-        trust       8
-        introduced  9
-    &#39;&#39;&#39;
-
-    conn = sqlite3.connect(dbfiles.address_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-
-    command = (address,)
-    infoNumbers = {&#39;address&#39;: 0, &#39;type&#39;: 1, &#39;knownPeer&#39;: 2, &#39;speed&#39;: 3, &#39;success&#39;: 4, &#39;powValue&#39;: 5, &#39;failure&#39;: 6, &#39;lastConnect&#39;: 7, &#39;trust&#39;: 8, &#39;introduced&#39;: 9}
-    info = infoNumbers[info]
-    iterCount = 0
-    retVal = &#39;&#39;
-
-    for row in c.execute(&#39;SELECT * FROM adders WHERE address=?;&#39;, command):
-        for i in row:
-            if iterCount == info:
-                retVal = i
-                break
-            else:
-                iterCount += 1
-    conn.close()
-
-    return retVal
-
-def set_address_info(address, key, data):
-    &#39;&#39;&#39;
-        Update an address for a key
-    &#39;&#39;&#39;
-
-    conn = sqlite3.connect(dbfiles.address_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-
-    command = (data, address)
-
-    if key not in (&#39;address&#39;, &#39;type&#39;, &#39;knownPeer&#39;, &#39;speed&#39;, &#39;success&#39;, &#39;failure&#39;, &#39;powValue&#39;, &#39;lastConnect&#39;, &#39;lastConnectAttempt&#39;, &#39;trust&#39;, &#39;introduced&#39;):
-        raise ValueError(&#34;Got invalid database key when setting address info, must be in whitelist&#34;)
-    else:
-        c.execute(&#39;UPDATE adders SET &#39; + key + &#39; = ? WHERE address=?&#39;, command)
-        conn.commit()
-    conn.close()</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.coredb.keydb.transportinfo.get_address_info"><code class="name flex">
-<span>def <span class="ident">get_address_info</span></span>(<span>address, info)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Get info about an address from its database entry</p>
-<p>address text, 0
-type int, 1
-knownPeer text, 2
-speed int, 3
-success int, 4
-powValue
-5
-failure int 6
-lastConnect 7
-trust
-8
-introduced
-9</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def get_address_info(address, info):
-    &#39;&#39;&#39;
-        Get info about an address from its database entry
-
-        address text, 0
-        type int, 1
-        knownPeer text, 2
-        speed int, 3
-        success int, 4
-        powValue    5
-        failure int 6
-        lastConnect 7
-        trust       8
-        introduced  9
-    &#39;&#39;&#39;
-
-    conn = sqlite3.connect(dbfiles.address_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-
-    command = (address,)
-    infoNumbers = {&#39;address&#39;: 0, &#39;type&#39;: 1, &#39;knownPeer&#39;: 2, &#39;speed&#39;: 3, &#39;success&#39;: 4, &#39;powValue&#39;: 5, &#39;failure&#39;: 6, &#39;lastConnect&#39;: 7, &#39;trust&#39;: 8, &#39;introduced&#39;: 9}
-    info = infoNumbers[info]
-    iterCount = 0
-    retVal = &#39;&#39;
-
-    for row in c.execute(&#39;SELECT * FROM adders WHERE address=?;&#39;, command):
-        for i in row:
-            if iterCount == info:
-                retVal = i
-                break
-            else:
-                iterCount += 1
-    conn.close()
-
-    return retVal</code></pre>
-</details>
-</dd>
-<dt id="src.coredb.keydb.transportinfo.set_address_info"><code class="name flex">
-<span>def <span class="ident">set_address_info</span></span>(<span>address, key, data)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Update an address for a key</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def set_address_info(address, key, data):
-    &#39;&#39;&#39;
-        Update an address for a key
-    &#39;&#39;&#39;
-
-    conn = sqlite3.connect(dbfiles.address_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-
-    command = (data, address)
-
-    if key not in (&#39;address&#39;, &#39;type&#39;, &#39;knownPeer&#39;, &#39;speed&#39;, &#39;success&#39;, &#39;failure&#39;, &#39;powValue&#39;, &#39;lastConnect&#39;, &#39;lastConnectAttempt&#39;, &#39;trust&#39;, &#39;introduced&#39;):
-        raise ValueError(&#34;Got invalid database key when setting address info, must be in whitelist&#34;)
-    else:
-        c.execute(&#39;UPDATE adders SET &#39; + key + &#39; = ? WHERE address=?&#39;, command)
-        conn.commit()
-    conn.close()</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.coredb.keydb" href="index.html">src.coredb.keydb</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.coredb.keydb.transportinfo.get_address_info" href="#src.coredb.keydb.transportinfo.get_address_info">get_address_info</a></code></li>
-<li><code><a title="src.coredb.keydb.transportinfo.set_address_info" href="#src.coredb.keydb.transportinfo.set_address_info">set_address_info</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/coredb/keydb/userinfo.html

@@ -1,251 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.coredb.keydb.userinfo API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.coredb.keydb.userinfo</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>get or set information about a user id</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    get or set information about a user id
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-import sqlite3
-from .. import dbfiles
-from etc import onionrvalues
-
-def get_user_info(peer, info):
-    &#39;&#39;&#39;
-        Get info about a peer from their database entry
-
-        id text             0
-        name text,          1
-        adders text,        2
-        dateSeen not null,  3
-        trust int           4
-        hashID text         5
-    &#39;&#39;&#39;
-    conn = sqlite3.connect(dbfiles.user_id_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-
-    command = (peer,)
-    infoNumbers = {&#39;id&#39;: 0, &#39;name&#39;: 1, &#39;adders&#39;: 2, &#39;dateSeen&#39;: 3, &#39;trust&#39;: 4, &#39;hashID&#39;: 5}
-    info = infoNumbers[info]
-    iterCount = 0
-    retVal = &#39;&#39;
-
-    for row in c.execute(&#39;SELECT * FROM peers WHERE id=?;&#39;, command):
-        for i in row:
-            if iterCount == info:
-                retVal = i
-                break
-            else:
-                iterCount += 1
-
-    conn.close()
-
-    return retVal
-
-def set_peer_info(peer, key, data):
-    &#39;&#39;&#39;
-        Update a peer for a key
-    &#39;&#39;&#39;
-
-    conn = sqlite3.connect(dbfiles.user_id_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-
-    command = (data, peer)
-
-    if key not in (&#39;id&#39;, &#39;name&#39;, &#39;pubkey&#39;, &#39;forwardKey&#39;, &#39;dateSeen&#39;, &#39;trust&#39;):
-        raise ValueError(&#34;Got invalid database key when setting peer info&#34;)
-
-    c.execute(&#39;UPDATE peers SET &#39; + key + &#39; = ? WHERE id=?&#39;, command)
-    conn.commit()
-    conn.close()
-
-set_user_info = set_peer_info</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.coredb.keydb.userinfo.get_user_info"><code class="name flex">
-<span>def <span class="ident">get_user_info</span></span>(<span>peer, info)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Get info about a peer from their database entry</p>
-<p>id text
-0
-name text,
-1
-adders text,
-2
-dateSeen not null,
-3
-trust int
-4
-hashID text
-5</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def get_user_info(peer, info):
-    &#39;&#39;&#39;
-        Get info about a peer from their database entry
-
-        id text             0
-        name text,          1
-        adders text,        2
-        dateSeen not null,  3
-        trust int           4
-        hashID text         5
-    &#39;&#39;&#39;
-    conn = sqlite3.connect(dbfiles.user_id_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-
-    command = (peer,)
-    infoNumbers = {&#39;id&#39;: 0, &#39;name&#39;: 1, &#39;adders&#39;: 2, &#39;dateSeen&#39;: 3, &#39;trust&#39;: 4, &#39;hashID&#39;: 5}
-    info = infoNumbers[info]
-    iterCount = 0
-    retVal = &#39;&#39;
-
-    for row in c.execute(&#39;SELECT * FROM peers WHERE id=?;&#39;, command):
-        for i in row:
-            if iterCount == info:
-                retVal = i
-                break
-            else:
-                iterCount += 1
-
-    conn.close()
-
-    return retVal</code></pre>
-</details>
-</dd>
-<dt id="src.coredb.keydb.userinfo.set_peer_info"><code class="name flex">
-<span>def <span class="ident">set_peer_info</span></span>(<span>peer, key, data)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Update a peer for a key</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def set_peer_info(peer, key, data):
-    &#39;&#39;&#39;
-        Update a peer for a key
-    &#39;&#39;&#39;
-
-    conn = sqlite3.connect(dbfiles.user_id_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-
-    command = (data, peer)
-
-    if key not in (&#39;id&#39;, &#39;name&#39;, &#39;pubkey&#39;, &#39;forwardKey&#39;, &#39;dateSeen&#39;, &#39;trust&#39;):
-        raise ValueError(&#34;Got invalid database key when setting peer info&#34;)
-
-    c.execute(&#39;UPDATE peers SET &#39; + key + &#39; = ? WHERE id=?&#39;, command)
-    conn.commit()
-    conn.close()</code></pre>
-</details>
-</dd>
-<dt id="src.coredb.keydb.userinfo.set_user_info"><code class="name flex">
-<span>def <span class="ident">set_user_info</span></span>(<span>peer, key, data)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Update a peer for a key</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def set_peer_info(peer, key, data):
-    &#39;&#39;&#39;
-        Update a peer for a key
-    &#39;&#39;&#39;
-
-    conn = sqlite3.connect(dbfiles.user_id_info_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT)
-    c = conn.cursor()
-
-    command = (data, peer)
-
-    if key not in (&#39;id&#39;, &#39;name&#39;, &#39;pubkey&#39;, &#39;forwardKey&#39;, &#39;dateSeen&#39;, &#39;trust&#39;):
-        raise ValueError(&#34;Got invalid database key when setting peer info&#34;)
-
-    c.execute(&#39;UPDATE peers SET &#39; + key + &#39; = ? WHERE id=?&#39;, command)
-    conn.commit()
-    conn.close()</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.coredb.keydb" href="index.html">src.coredb.keydb</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.coredb.keydb.userinfo.get_user_info" href="#src.coredb.keydb.userinfo.get_user_info">get_user_info</a></code></li>
-<li><code><a title="src.coredb.keydb.userinfo.set_peer_info" href="#src.coredb.keydb.userinfo.set_peer_info">set_peer_info</a></code></li>
-<li><code><a title="src.coredb.keydb.userinfo.set_user_info" href="#src.coredb.keydb.userinfo.set_user_info">set_user_info</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/index.html

@@ -1,65 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835 API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Namespace <code>src.data2871027835</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.data2871027835.plugins" href="plugins/index.html">src.data2871027835.plugins</a></code></dt>
-<dd>
-<section class="desc"></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src" href="../index.html">src</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins" href="plugins/index.html">src.data2871027835.plugins</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/chat/controlapi.html

@@ -1,246 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.chat.controlapi API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.data2871027835.plugins.chat.controlapi</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>HTTP endpoints for controlling IMs</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    HTTP endpoints for controlling IMs
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-import json
-from flask import Response, request, redirect, Blueprint, send_from_directory
-import deadsimplekv as simplekv
-import filepaths
-flask_blueprint = Blueprint(&#39;chat_control&#39;, __name__)
-key_store = simplekv.DeadSimpleKV(filepaths.cached_storage, refresh_seconds=5)
-@flask_blueprint.route(&#39;/chatapi/ping&#39;)
-def ping():
-    return &#39;pong!&#39;
-
-@flask_blueprint.route(&#39;/chatapi/send/&lt;peer&gt;&#39;, methods=[&#39;POST&#39;])
-def send_message(peer):
-    &#34;&#34;&#34;Send a message to the peer&#34;&#34;&#34;
-    data = request.get_json(force=True)
-    key_store.refresh()
-    existing = key_store.get(&#39;s&#39; + peer)
-    if existing is None:
-        existing = []
-    existing.append(data)
-    key_store.put(&#39;s&#39; + peer, existing)
-    key_store.flush()
-    return Response(&#39;success&#39;)
-
-@flask_blueprint.route(&#39;/chatapi/gets/&lt;peer&gt;&#39;)
-def get_sent(peer):
-    &#34;&#34;&#34;Get messages sent to peer&#34;&#34;&#34;
-    sent = key_store.get(&#39;s&#39; + peer)
-    if sent is None:
-        sent = []
-    return Response(json.dumps(sent))
-
-@flask_blueprint.route(&#39;/chatapi/addrec/&lt;peer&gt;&#39;, methods=[&#39;POST&#39;])
-def add_rec(peer):
-    &#34;&#34;&#34;Add a received message from the peer&#34;&#34;&#34;
-    data = request.get_json(force=True)
-    key_store.refresh()
-    existing = key_store.get(&#39;r&#39; + peer)
-    if existing is None:
-        existing = []
-    existing.append(data)
-    key_store.put(&#39;r&#39; + peer, existing)
-    key_store.flush()
-    return Response(&#39;success&#39;)
-
-@flask_blueprint.route(&#39;/chatapi/getrec/&lt;peer&gt;&#39;)
-def get_messages(peer):
-    &#34;&#34;&#34;Get received messages for the peer&#34;&#34;&#34;
-    key_store.refresh()
-    existing = key_store.get(&#39;r&#39; + peer)
-    if existing is None:
-        existing = []
-    else:
-        existing = list(existing)
-        key_store.delete(&#39;r&#39; + peer)
-    return Response(json.dumps(existing))</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.data2871027835.plugins.chat.controlapi.add_rec"><code class="name flex">
-<span>def <span class="ident">add_rec</span></span>(<span>peer)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Add a received message from the peer</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@flask_blueprint.route(&#39;/chatapi/addrec/&lt;peer&gt;&#39;, methods=[&#39;POST&#39;])
-def add_rec(peer):
-    &#34;&#34;&#34;Add a received message from the peer&#34;&#34;&#34;
-    data = request.get_json(force=True)
-    key_store.refresh()
-    existing = key_store.get(&#39;r&#39; + peer)
-    if existing is None:
-        existing = []
-    existing.append(data)
-    key_store.put(&#39;r&#39; + peer, existing)
-    key_store.flush()
-    return Response(&#39;success&#39;)</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.chat.controlapi.get_messages"><code class="name flex">
-<span>def <span class="ident">get_messages</span></span>(<span>peer)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Get received messages for the peer</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@flask_blueprint.route(&#39;/chatapi/getrec/&lt;peer&gt;&#39;)
-def get_messages(peer):
-    &#34;&#34;&#34;Get received messages for the peer&#34;&#34;&#34;
-    key_store.refresh()
-    existing = key_store.get(&#39;r&#39; + peer)
-    if existing is None:
-        existing = []
-    else:
-        existing = list(existing)
-        key_store.delete(&#39;r&#39; + peer)
-    return Response(json.dumps(existing))</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.chat.controlapi.get_sent"><code class="name flex">
-<span>def <span class="ident">get_sent</span></span>(<span>peer)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Get messages sent to peer</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@flask_blueprint.route(&#39;/chatapi/gets/&lt;peer&gt;&#39;)
-def get_sent(peer):
-    &#34;&#34;&#34;Get messages sent to peer&#34;&#34;&#34;
-    sent = key_store.get(&#39;s&#39; + peer)
-    if sent is None:
-        sent = []
-    return Response(json.dumps(sent))</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.chat.controlapi.ping"><code class="name flex">
-<span>def <span class="ident">ping</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@flask_blueprint.route(&#39;/chatapi/ping&#39;)
-def ping():
-    return &#39;pong!&#39;</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.chat.controlapi.send_message"><code class="name flex">
-<span>def <span class="ident">send_message</span></span>(<span>peer)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Send a message to the peer</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@flask_blueprint.route(&#39;/chatapi/send/&lt;peer&gt;&#39;, methods=[&#39;POST&#39;])
-def send_message(peer):
-    &#34;&#34;&#34;Send a message to the peer&#34;&#34;&#34;
-    data = request.get_json(force=True)
-    key_store.refresh()
-    existing = key_store.get(&#39;s&#39; + peer)
-    if existing is None:
-        existing = []
-    existing.append(data)
-    key_store.put(&#39;s&#39; + peer, existing)
-    key_store.flush()
-    return Response(&#39;success&#39;)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.chat" href="index.html">src.data2871027835.plugins.chat</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.data2871027835.plugins.chat.controlapi.add_rec" href="#src.data2871027835.plugins.chat.controlapi.add_rec">add_rec</a></code></li>
-<li><code><a title="src.data2871027835.plugins.chat.controlapi.get_messages" href="#src.data2871027835.plugins.chat.controlapi.get_messages">get_messages</a></code></li>
-<li><code><a title="src.data2871027835.plugins.chat.controlapi.get_sent" href="#src.data2871027835.plugins.chat.controlapi.get_sent">get_sent</a></code></li>
-<li><code><a title="src.data2871027835.plugins.chat.controlapi.ping" href="#src.data2871027835.plugins.chat.controlapi.ping">ping</a></code></li>
-<li><code><a title="src.data2871027835.plugins.chat.controlapi.send_message" href="#src.data2871027835.plugins.chat.controlapi.send_message">send_message</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/chat/index.html

@@ -1,80 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.chat API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Namespace <code>src.data2871027835.plugins.chat</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.data2871027835.plugins.chat.controlapi" href="controlapi.html">src.data2871027835.plugins.chat.controlapi</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.data2871027835.plugins.chat.main" href="main.html">src.data2871027835.plugins.chat.main</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.data2871027835.plugins.chat.peerserver" href="peerserver.html">src.data2871027835.plugins.chat.peerserver</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.data2871027835.plugins.chat.settings" href="settings.html">src.data2871027835.plugins.chat.settings</a></code></dt>
-<dd>
-<section class="desc"></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins" href="../index.html">src.data2871027835.plugins</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.chat.controlapi" href="controlapi.html">src.data2871027835.plugins.chat.controlapi</a></code></li>
-<li><code><a title="src.data2871027835.plugins.chat.main" href="main.html">src.data2871027835.plugins.chat.main</a></code></li>
-<li><code><a title="src.data2871027835.plugins.chat.peerserver" href="peerserver.html">src.data2871027835.plugins.chat.peerserver</a></code></li>
-<li><code><a title="src.data2871027835.plugins.chat.settings" href="settings.html">src.data2871027835.plugins.chat.settings</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/chat/main.html

@@ -1,122 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.chat.main API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.data2871027835.plugins.chat.main</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>Instant message conversations with Onionr peers</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    Instant message conversations with Onionr peers
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-
-# Imports some useful libraries
-import locale, sys, os, threading, json
-locale.setlocale(locale.LC_ALL, &#39;&#39;)
-import onionrservices, logger, config
-from onionrservices import bootstrapservice
-from onionrutils import stringvalidators, epoch, basicrequests
-
-plugin_name = &#39;chat&#39;
-PLUGIN_VERSION = &#39;0.0.0&#39;
-sys.path.insert(0, os.path.dirname(os.path.realpath(__file__)))
-import controlapi, peerserver
-flask_blueprint = controlapi.flask_blueprint
-direct_blueprint = peerserver.direct_blueprint
-security_whitelist = [&#39;staticfiles.chat&#39;, &#39;staticfiles.chatIndex&#39;]
-
-def exit_with_error(text=&#39;&#39;):
-    if text != &#39;&#39;:
-        logger.error(text)
-    sys.exit(1)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.data2871027835.plugins.chat.main.exit_with_error"><code class="name flex">
-<span>def <span class="ident">exit_with_error</span></span>(<span>text='')</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def exit_with_error(text=&#39;&#39;):
-    if text != &#39;&#39;:
-        logger.error(text)
-    sys.exit(1)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.chat" href="index.html">src.data2871027835.plugins.chat</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.data2871027835.plugins.chat.main.exit_with_error" href="#src.data2871027835.plugins.chat.main.exit_with_error">exit_with_error</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/chat/peerserver.html

@@ -1,200 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.chat.peerserver API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.data2871027835.plugins.chat.peerserver</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>HTTP endpoints for communicating with peers</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    HTTP endpoints for communicating with peers
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-import sys, os, json
-from utils import identifyhome
-from onionrutils import localcommand
-import deadsimplekv as simplekv, filepaths
-from flask import Response, request, redirect, Blueprint, abort, g
-sys.path.insert(0, os.path.dirname(os.path.realpath(__file__)))
-direct_blueprint = Blueprint(&#39;chat&#39;, __name__)
-
-key_store = simplekv.DeadSimpleKV(filepaths.cached_storage, refresh_seconds=5)
-storage_dir = identifyhome.identify_home()
-
-@direct_blueprint.before_request
-def request_setup():
-    key_store.refresh()
-    host = request.host
-    host = host.strip(&#39;.b32.i2p&#39;)
-    host = host.strip(&#39;.onion&#39;)
-    g.host = host
-    g.peer = key_store.get(&#39;dc-&#39; + g.host)
-
-@direct_blueprint.route(&#39;/chat/ping&#39;)
-def pingdirect():
-    return &#39;pong!&#39;
-
-@direct_blueprint.route(&#39;/chat/sendto&#39;, methods=[&#39;POST&#39;, &#39;GET&#39;])
-def sendto():
-    &#34;&#34;&#34;Endpoint peers send chat messages to&#34;&#34;&#34;
-    try:
-        msg = request.get_json(force=True)
-    except json.JSONDecodeError:
-        msg = &#39;&#39;
-    else:
-        msg = json.dumps(msg)
-        localcommand.local_command(&#39;/chat/addrec/%s&#39; % (g.peer,), post=True, postData=msg)
-    return Response(&#39;success&#39;)
-
-@direct_blueprint.route(&#39;/chat/poll&#39;)
-def poll_chat():
-    &#34;&#34;&#34;Endpoints peers get new messages from&#34;&#34;&#34;
-    return Response(localcommand.local_command(&#39;/chat/gets/%s&#39; % (g.peer,)))</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.data2871027835.plugins.chat.peerserver.pingdirect"><code class="name flex">
-<span>def <span class="ident">pingdirect</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@direct_blueprint.route(&#39;/chat/ping&#39;)
-def pingdirect():
-    return &#39;pong!&#39;</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.chat.peerserver.poll_chat"><code class="name flex">
-<span>def <span class="ident">poll_chat</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Endpoints peers get new messages from</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@direct_blueprint.route(&#39;/chat/poll&#39;)
-def poll_chat():
-    &#34;&#34;&#34;Endpoints peers get new messages from&#34;&#34;&#34;
-    return Response(localcommand.local_command(&#39;/chat/gets/%s&#39; % (g.peer,)))</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.chat.peerserver.request_setup"><code class="name flex">
-<span>def <span class="ident">request_setup</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@direct_blueprint.before_request
-def request_setup():
-    key_store.refresh()
-    host = request.host
-    host = host.strip(&#39;.b32.i2p&#39;)
-    host = host.strip(&#39;.onion&#39;)
-    g.host = host
-    g.peer = key_store.get(&#39;dc-&#39; + g.host)</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.chat.peerserver.sendto"><code class="name flex">
-<span>def <span class="ident">sendto</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"><p>Endpoint peers send chat messages to</p></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@direct_blueprint.route(&#39;/chat/sendto&#39;, methods=[&#39;POST&#39;, &#39;GET&#39;])
-def sendto():
-    &#34;&#34;&#34;Endpoint peers send chat messages to&#34;&#34;&#34;
-    try:
-        msg = request.get_json(force=True)
-    except json.JSONDecodeError:
-        msg = &#39;&#39;
-    else:
-        msg = json.dumps(msg)
-        localcommand.local_command(&#39;/chat/addrec/%s&#39; % (g.peer,), post=True, postData=msg)
-    return Response(&#39;success&#39;)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.chat" href="index.html">src.data2871027835.plugins.chat</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.data2871027835.plugins.chat.peerserver.pingdirect" href="#src.data2871027835.plugins.chat.peerserver.pingdirect">pingdirect</a></code></li>
-<li><code><a title="src.data2871027835.plugins.chat.peerserver.poll_chat" href="#src.data2871027835.plugins.chat.peerserver.poll_chat">poll_chat</a></code></li>
-<li><code><a title="src.data2871027835.plugins.chat.peerserver.request_setup" href="#src.data2871027835.plugins.chat.peerserver.request_setup">request_setup</a></code></li>
-<li><code><a title="src.data2871027835.plugins.chat.peerserver.sendto" href="#src.data2871027835.plugins.chat.peerserver.sendto">sendto</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/chat/settings.html

@@ -1,53 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.chat.settings API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.data2871027835.plugins.chat.settings</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.chat" href="index.html">src.data2871027835.plugins.chat</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/encrypt/index.html

@@ -1,65 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.encrypt API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Namespace <code>src.data2871027835.plugins.encrypt</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.data2871027835.plugins.encrypt.main" href="main.html">src.data2871027835.plugins.encrypt.main</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins" href="../index.html">src.data2871027835.plugins</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.encrypt.main" href="main.html">src.data2871027835.plugins.encrypt.main</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/encrypt/main.html

@@ -1,414 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.encrypt.main API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.data2871027835.plugins.encrypt.main</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>This default plugin allows users to encrypt/decrypt messages without using blocks</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    This default plugin allows users to encrypt/decrypt messages without using blocks
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-
-# Imports some useful libraries
-import logger, config, threading, time, datetime, sys, json
-from onionrutils import stringvalidators, bytesconverter
-from onionrcrypto import encryption, keypair, signing, getourkeypair
-import onionrexceptions, onionrusers
-import locale
-locale.setlocale(locale.LC_ALL, &#39;&#39;)
-plugin_name = &#39;encrypt&#39;
-
-class PlainEncryption:
-    def __init__(self, api):
-        self.api = api
-        return
-    def encrypt(self):
-        # peer, data
-        plaintext = &#34;&#34;
-        encrypted = &#34;&#34;
-        # detect if signing is enabled
-        sign = True
-        try:
-            if sys.argv[3].lower() == &#39;false&#39;:
-                sign = False
-        except IndexError:
-            pass
-
-        try:
-            if not stringvalidators.validate_pub_key(sys.argv[2]):
-                raise onionrexceptions.InvalidPubkey
-        except (ValueError, IndexError) as e:
-            logger.error(&#34;Peer public key not specified&#34;, terminal=True)
-        except onionrexceptions.InvalidPubkey:
-            logger.error(&#34;Invalid public key&#34;, terminal=True)
-        else:
-            pubkey = sys.argv[2]
-            # Encrypt if public key is valid
-            logger.info(&#34;Please enter your message (ctrl-d or -q to stop):&#34;, terminal=True)
-            try:
-                for line in sys.stdin:
-                    if line == &#39;-q\n&#39;:
-                        break
-                    plaintext += line
-            except KeyboardInterrupt:
-                sys.exit(1)
-            # Build Message to encrypt
-            data = {}
-            myPub = keypair[0]
-            if sign:
-                data[&#39;sig&#39;] = signing.ed_sign(plaintext, key=keypair[1], encodeResult=True)
-                data[&#39;sig&#39;] = bytesconverter.bytes_to_str(data[&#39;sig&#39;])
-                data[&#39;signer&#39;] = myPub
-            data[&#39;data&#39;] = plaintext
-            data = json.dumps(data)
-            plaintext = data
-            encrypted = encryption.pub_key_encrypt(plaintext, pubkey, encodedData=True)
-            encrypted = bytesconverter.bytes_to_str(encrypted)
-            logger.info(&#39;Encrypted Message: \n\nONIONR ENCRYPTED DATA %s END ENCRYPTED DATA&#39; % (encrypted,), terminal=True)
-
-    def decrypt(self):
-        plaintext = &#34;&#34;
-        data = &#34;&#34;
-        logger.info(&#34;Please enter your message (ctrl-d or -q to stop):&#34;, terminal=True)
-        keypair = getourkeypair.get_keypair()
-        try:
-            for line in sys.stdin:
-                if line == &#39;-q\n&#39;:
-                        break
-                data += line
-        except KeyboardInterrupt:
-            sys.exit(1)
-        if len(data) &lt;= 1:
-            return
-        encrypted = data.replace(&#39;ONIONR ENCRYPTED DATA &#39;, &#39;&#39;).replace(&#39;END ENCRYPTED DATA&#39;, &#39;&#39;)
-        myPub = keypair[0]
-        decrypted = encryption.pub_key_decrypt(encrypted, privkey=keypair[1], encodedData=True)
-        if decrypted == False:
-            logger.error(&#34;Decryption failed&#34;, terminal=True)
-        else:
-            data = json.loads(decrypted)
-            logger.info(&#39;Decrypted Message: \n\n%s&#39; % data[&#39;data&#39;], terminal=True)
-            try:
-                logger.info(&#34;Signing public key: %s&#34; % (data[&#39;signer&#39;],), terminal=True)
-                if not signing.ed_verify(data[&#39;data&#39;], data[&#39;signer&#39;], data[&#39;sig&#39;]): raise ValueError
-            except (ValueError, KeyError) as e:
-                logger.warn(&#34;WARNING: THIS MESSAGE HAS A MISSING OR INVALID SIGNATURE&#34;, terminal=True)
-            else:
-                logger.info(&#34;Message has good signature.&#34;, terminal=True)
-        return
-
-def on_decrypt_cmd(api, data=None):
-    PlainEncryption(api).decrypt()
-
-def on_encrypt_cmd(api, data=None):
-    PlainEncryption(api).encrypt()
-
-on_encrypt_cmd.onionr_help = &#34;&#34;&#34;encrypt &lt;user_key&gt;\nEncrypt text data to an Onionr user key. Similar to PGP&#34;&#34;&#34;
-on_decrypt_cmd.onionr_help = &#34;&#34;&#34;decrypt\nDecrypt text data with your Onionr key. Similar to PGP&#34;&#34;&#34;
-ONIONR_COMMANDS = [&#39;encrypt&#39;, &#39;decrypt&#39;]</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.data2871027835.plugins.encrypt.main.on_decrypt_cmd"><code class="name flex">
-<span>def <span class="ident">on_decrypt_cmd</span></span>(<span>api, data=None)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def on_decrypt_cmd(api, data=None):
-    PlainEncryption(api).decrypt()</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.encrypt.main.on_encrypt_cmd"><code class="name flex">
-<span>def <span class="ident">on_encrypt_cmd</span></span>(<span>api, data=None)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def on_encrypt_cmd(api, data=None):
-    PlainEncryption(api).encrypt()</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="src.data2871027835.plugins.encrypt.main.PlainEncryption"><code class="flex name class">
-<span>class <span class="ident">PlainEncryption</span></span>
-<span>(</span><span>api)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class PlainEncryption:
-    def __init__(self, api):
-        self.api = api
-        return
-    def encrypt(self):
-        # peer, data
-        plaintext = &#34;&#34;
-        encrypted = &#34;&#34;
-        # detect if signing is enabled
-        sign = True
-        try:
-            if sys.argv[3].lower() == &#39;false&#39;:
-                sign = False
-        except IndexError:
-            pass
-
-        try:
-            if not stringvalidators.validate_pub_key(sys.argv[2]):
-                raise onionrexceptions.InvalidPubkey
-        except (ValueError, IndexError) as e:
-            logger.error(&#34;Peer public key not specified&#34;, terminal=True)
-        except onionrexceptions.InvalidPubkey:
-            logger.error(&#34;Invalid public key&#34;, terminal=True)
-        else:
-            pubkey = sys.argv[2]
-            # Encrypt if public key is valid
-            logger.info(&#34;Please enter your message (ctrl-d or -q to stop):&#34;, terminal=True)
-            try:
-                for line in sys.stdin:
-                    if line == &#39;-q\n&#39;:
-                        break
-                    plaintext += line
-            except KeyboardInterrupt:
-                sys.exit(1)
-            # Build Message to encrypt
-            data = {}
-            myPub = keypair[0]
-            if sign:
-                data[&#39;sig&#39;] = signing.ed_sign(plaintext, key=keypair[1], encodeResult=True)
-                data[&#39;sig&#39;] = bytesconverter.bytes_to_str(data[&#39;sig&#39;])
-                data[&#39;signer&#39;] = myPub
-            data[&#39;data&#39;] = plaintext
-            data = json.dumps(data)
-            plaintext = data
-            encrypted = encryption.pub_key_encrypt(plaintext, pubkey, encodedData=True)
-            encrypted = bytesconverter.bytes_to_str(encrypted)
-            logger.info(&#39;Encrypted Message: \n\nONIONR ENCRYPTED DATA %s END ENCRYPTED DATA&#39; % (encrypted,), terminal=True)
-
-    def decrypt(self):
-        plaintext = &#34;&#34;
-        data = &#34;&#34;
-        logger.info(&#34;Please enter your message (ctrl-d or -q to stop):&#34;, terminal=True)
-        keypair = getourkeypair.get_keypair()
-        try:
-            for line in sys.stdin:
-                if line == &#39;-q\n&#39;:
-                        break
-                data += line
-        except KeyboardInterrupt:
-            sys.exit(1)
-        if len(data) &lt;= 1:
-            return
-        encrypted = data.replace(&#39;ONIONR ENCRYPTED DATA &#39;, &#39;&#39;).replace(&#39;END ENCRYPTED DATA&#39;, &#39;&#39;)
-        myPub = keypair[0]
-        decrypted = encryption.pub_key_decrypt(encrypted, privkey=keypair[1], encodedData=True)
-        if decrypted == False:
-            logger.error(&#34;Decryption failed&#34;, terminal=True)
-        else:
-            data = json.loads(decrypted)
-            logger.info(&#39;Decrypted Message: \n\n%s&#39; % data[&#39;data&#39;], terminal=True)
-            try:
-                logger.info(&#34;Signing public key: %s&#34; % (data[&#39;signer&#39;],), terminal=True)
-                if not signing.ed_verify(data[&#39;data&#39;], data[&#39;signer&#39;], data[&#39;sig&#39;]): raise ValueError
-            except (ValueError, KeyError) as e:
-                logger.warn(&#34;WARNING: THIS MESSAGE HAS A MISSING OR INVALID SIGNATURE&#34;, terminal=True)
-            else:
-                logger.info(&#34;Message has good signature.&#34;, terminal=True)
-        return</code></pre>
-</details>
-<h3>Methods</h3>
-<dl>
-<dt id="src.data2871027835.plugins.encrypt.main.PlainEncryption.decrypt"><code class="name flex">
-<span>def <span class="ident">decrypt</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def decrypt(self):
-    plaintext = &#34;&#34;
-    data = &#34;&#34;
-    logger.info(&#34;Please enter your message (ctrl-d or -q to stop):&#34;, terminal=True)
-    keypair = getourkeypair.get_keypair()
-    try:
-        for line in sys.stdin:
-            if line == &#39;-q\n&#39;:
-                    break
-            data += line
-    except KeyboardInterrupt:
-        sys.exit(1)
-    if len(data) &lt;= 1:
-        return
-    encrypted = data.replace(&#39;ONIONR ENCRYPTED DATA &#39;, &#39;&#39;).replace(&#39;END ENCRYPTED DATA&#39;, &#39;&#39;)
-    myPub = keypair[0]
-    decrypted = encryption.pub_key_decrypt(encrypted, privkey=keypair[1], encodedData=True)
-    if decrypted == False:
-        logger.error(&#34;Decryption failed&#34;, terminal=True)
-    else:
-        data = json.loads(decrypted)
-        logger.info(&#39;Decrypted Message: \n\n%s&#39; % data[&#39;data&#39;], terminal=True)
-        try:
-            logger.info(&#34;Signing public key: %s&#34; % (data[&#39;signer&#39;],), terminal=True)
-            if not signing.ed_verify(data[&#39;data&#39;], data[&#39;signer&#39;], data[&#39;sig&#39;]): raise ValueError
-        except (ValueError, KeyError) as e:
-            logger.warn(&#34;WARNING: THIS MESSAGE HAS A MISSING OR INVALID SIGNATURE&#34;, terminal=True)
-        else:
-            logger.info(&#34;Message has good signature.&#34;, terminal=True)
-    return</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.encrypt.main.PlainEncryption.encrypt"><code class="name flex">
-<span>def <span class="ident">encrypt</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def encrypt(self):
-    # peer, data
-    plaintext = &#34;&#34;
-    encrypted = &#34;&#34;
-    # detect if signing is enabled
-    sign = True
-    try:
-        if sys.argv[3].lower() == &#39;false&#39;:
-            sign = False
-    except IndexError:
-        pass
-
-    try:
-        if not stringvalidators.validate_pub_key(sys.argv[2]):
-            raise onionrexceptions.InvalidPubkey
-    except (ValueError, IndexError) as e:
-        logger.error(&#34;Peer public key not specified&#34;, terminal=True)
-    except onionrexceptions.InvalidPubkey:
-        logger.error(&#34;Invalid public key&#34;, terminal=True)
-    else:
-        pubkey = sys.argv[2]
-        # Encrypt if public key is valid
-        logger.info(&#34;Please enter your message (ctrl-d or -q to stop):&#34;, terminal=True)
-        try:
-            for line in sys.stdin:
-                if line == &#39;-q\n&#39;:
-                    break
-                plaintext += line
-        except KeyboardInterrupt:
-            sys.exit(1)
-        # Build Message to encrypt
-        data = {}
-        myPub = keypair[0]
-        if sign:
-            data[&#39;sig&#39;] = signing.ed_sign(plaintext, key=keypair[1], encodeResult=True)
-            data[&#39;sig&#39;] = bytesconverter.bytes_to_str(data[&#39;sig&#39;])
-            data[&#39;signer&#39;] = myPub
-        data[&#39;data&#39;] = plaintext
-        data = json.dumps(data)
-        plaintext = data
-        encrypted = encryption.pub_key_encrypt(plaintext, pubkey, encodedData=True)
-        encrypted = bytesconverter.bytes_to_str(encrypted)
-        logger.info(&#39;Encrypted Message: \n\nONIONR ENCRYPTED DATA %s END ENCRYPTED DATA&#39; % (encrypted,), terminal=True)</code></pre>
-</details>
-</dd>
-</dl>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.encrypt" href="index.html">src.data2871027835.plugins.encrypt</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.data2871027835.plugins.encrypt.main.on_decrypt_cmd" href="#src.data2871027835.plugins.encrypt.main.on_decrypt_cmd">on_decrypt_cmd</a></code></li>
-<li><code><a title="src.data2871027835.plugins.encrypt.main.on_encrypt_cmd" href="#src.data2871027835.plugins.encrypt.main.on_encrypt_cmd">on_encrypt_cmd</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="src.data2871027835.plugins.encrypt.main.PlainEncryption" href="#src.data2871027835.plugins.encrypt.main.PlainEncryption">PlainEncryption</a></code></h4>
-<ul class="">
-<li><code><a title="src.data2871027835.plugins.encrypt.main.PlainEncryption.decrypt" href="#src.data2871027835.plugins.encrypt.main.PlainEncryption.decrypt">decrypt</a></code></li>
-<li><code><a title="src.data2871027835.plugins.encrypt.main.PlainEncryption.encrypt" href="#src.data2871027835.plugins.encrypt.main.PlainEncryption.encrypt">encrypt</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/flow/flowapi.html

@@ -1,236 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.flow.flowapi API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.data2871027835.plugins.flow.flowapi</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>This file primarily serves to allow specific fetching of flow board messages</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-This file primarily serves to allow specific fetching of flow board messages
-&#34;&#34;&#34;
-import json
-import os
-
-from flask import Response, Blueprint
-from deadsimplekv import DeadSimpleKV
-
-from utils import identifyhome
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-flask_blueprint = Blueprint(&#39;flow&#39;, __name__)
-
-with open(os.path.dirname(os.path.realpath(__file__)) + &#39;/info.json&#39;, &#39;r&#39;) as info_file:
-    data = info_file.read().strip()
-    version = json.loads(data, strict=False)[&#39;version&#39;]
-
-@flask_blueprint.route(&#39;/flow/getpostsbyboard/&lt;board&gt;&#39;)
-def get_post_by_board(board):
-    board_cache = DeadSimpleKV(
-        identifyhome.identify_home() + &#39;/board-index.cache.json&#39;,
-        flush_on_exit=False)
-    board_cache.refresh()
-    posts = board_cache.get(board)
-    if posts is None:
-        posts = &#39;&#39;
-    else:
-        posts = &#39;,&#39;.join(posts)
-    return Response(posts)
-
-@flask_blueprint.route(&#39;/flow/getpostsbyboard/&lt;board&gt;/&lt;offset&gt;&#39;)
-def get_post_by_board_with_offset(board, offset):
-    offset = int(offset)
-    OFFSET_COUNT = 10
-    board_cache = DeadSimpleKV(
-        identifyhome.identify_home() + &#39;/board-index.cache.json&#39;,
-        flush_on_exit=False)
-    board_cache.refresh()
-    posts = board_cache.get(board)
-    if posts is None:
-        posts = &#39;&#39;
-    else:
-        posts.reverse()
-        posts = &#39;,&#39;.join(posts[offset:offset + OFFSET_COUNT])
-    return Response(posts)
-
-@flask_blueprint.route(&#39;/flow/version&#39;)
-def get_version():
-    return Response(version)
-
-@flask_blueprint.route(&#39;/flow/removefromcache/&lt;board&gt;/&lt;name&gt;&#39;, methods=[&#39;POST&#39;])
-def remove_from_cache(board, name):
-    board_cache = DeadSimpleKV(identifyhome.identify_home() +
-                               &#39;/board-index.cache.json&#39;,
-                               flush_on_exit=False)
-    board_cache.refresh()
-    posts = board_cache.get(board)
-    try:
-        posts.remove(name)
-    except ValueError:
-        pass
-    board_cache.put(board, posts)
-    return Response(&#39;success&#39;)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.data2871027835.plugins.flow.flowapi.get_post_by_board"><code class="name flex">
-<span>def <span class="ident">get_post_by_board</span></span>(<span>board)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@flask_blueprint.route(&#39;/flow/getpostsbyboard/&lt;board&gt;&#39;)
-def get_post_by_board(board):
-    board_cache = DeadSimpleKV(
-        identifyhome.identify_home() + &#39;/board-index.cache.json&#39;,
-        flush_on_exit=False)
-    board_cache.refresh()
-    posts = board_cache.get(board)
-    if posts is None:
-        posts = &#39;&#39;
-    else:
-        posts = &#39;,&#39;.join(posts)
-    return Response(posts)</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.flow.flowapi.get_post_by_board_with_offset"><code class="name flex">
-<span>def <span class="ident">get_post_by_board_with_offset</span></span>(<span>board, offset)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@flask_blueprint.route(&#39;/flow/getpostsbyboard/&lt;board&gt;/&lt;offset&gt;&#39;)
-def get_post_by_board_with_offset(board, offset):
-    offset = int(offset)
-    OFFSET_COUNT = 10
-    board_cache = DeadSimpleKV(
-        identifyhome.identify_home() + &#39;/board-index.cache.json&#39;,
-        flush_on_exit=False)
-    board_cache.refresh()
-    posts = board_cache.get(board)
-    if posts is None:
-        posts = &#39;&#39;
-    else:
-        posts.reverse()
-        posts = &#39;,&#39;.join(posts[offset:offset + OFFSET_COUNT])
-    return Response(posts)</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.flow.flowapi.get_version"><code class="name flex">
-<span>def <span class="ident">get_version</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@flask_blueprint.route(&#39;/flow/version&#39;)
-def get_version():
-    return Response(version)</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.flow.flowapi.remove_from_cache"><code class="name flex">
-<span>def <span class="ident">remove_from_cache</span></span>(<span>board, name)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@flask_blueprint.route(&#39;/flow/removefromcache/&lt;board&gt;/&lt;name&gt;&#39;, methods=[&#39;POST&#39;])
-def remove_from_cache(board, name):
-    board_cache = DeadSimpleKV(identifyhome.identify_home() +
-                               &#39;/board-index.cache.json&#39;,
-                               flush_on_exit=False)
-    board_cache.refresh()
-    posts = board_cache.get(board)
-    try:
-        posts.remove(name)
-    except ValueError:
-        pass
-    board_cache.put(board, posts)
-    return Response(&#39;success&#39;)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.flow" href="index.html">src.data2871027835.plugins.flow</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.data2871027835.plugins.flow.flowapi.get_post_by_board" href="#src.data2871027835.plugins.flow.flowapi.get_post_by_board">get_post_by_board</a></code></li>
-<li><code><a title="src.data2871027835.plugins.flow.flowapi.get_post_by_board_with_offset" href="#src.data2871027835.plugins.flow.flowapi.get_post_by_board_with_offset">get_post_by_board_with_offset</a></code></li>
-<li><code><a title="src.data2871027835.plugins.flow.flowapi.get_version" href="#src.data2871027835.plugins.flow.flowapi.get_version">get_version</a></code></li>
-<li><code><a title="src.data2871027835.plugins.flow.flowapi.remove_from_cache" href="#src.data2871027835.plugins.flow.flowapi.remove_from_cache">remove_from_cache</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/flow/index.html

@@ -1,70 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.flow API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Namespace <code>src.data2871027835.plugins.flow</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.data2871027835.plugins.flow.flowapi" href="flowapi.html">src.data2871027835.plugins.flow.flowapi</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.data2871027835.plugins.flow.main" href="main.html">src.data2871027835.plugins.flow.main</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins" href="../index.html">src.data2871027835.plugins</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.flow.flowapi" href="flowapi.html">src.data2871027835.plugins.flow.flowapi</a></code></li>
-<li><code><a title="src.data2871027835.plugins.flow.main" href="main.html">src.data2871027835.plugins.flow.main</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/flow/main.html

@@ -1,476 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.flow.main API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.data2871027835.plugins.flow.main</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>This default plugin handles "flow" messages
-(global chatroom style communication)</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-This default plugin handles &#34;flow&#34; messages
-(global chatroom style communication)
-&#34;&#34;&#34;
-import sys
-import os
-import deadsimplekv as simplekv
-from utils import identifyhome, reconstructhash
-from coredb import blockmetadb
-import threading
-import time
-import locale
-from onionrblocks.onionrblockapi import Block
-import logger
-import onionrblocks
-from onionrutils import escapeansi, epoch, bytesconverter
-
-locale.setlocale(locale.LC_ALL, &#39;&#39;)
-sys.path.insert(0, os.path.dirname(os.path.realpath(__file__)))
-# import after path insert
-import flowapi  # noqa
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-flask_blueprint = flowapi.flask_blueprint
-security_whitelist = [&#39;staticfiles.boardContent&#39;, &#39;staticfiles.board&#39;]
-
-plugin_name = &#39;flow&#39;
-PLUGIN_VERSION = &#39;0.0.1&#39;
-
-
-class OnionrFlow:
-    def __init__(self):
-        self.alreadyOutputed = []
-        self.flowRunning = False
-        self.channel = &#34;&#34;
-        return
-
-    def start(self):
-        logger.warn(
-            &#34;Please note: everything said here is public, &#34; +
-            &#34;even if a random channel name is used.&#34;, terminal=True)
-        message = &#34;&#34;
-        self.flowRunning = True
-        try:
-            self.channel = logger.readline(
-                &#34;Enter a channel name or none for default:&#34;).strip()
-        except (KeyboardInterrupt, EOFError):
-            self.flowRunning = False
-        newThread = threading.Thread(target=self.showOutput, daemon=True)
-        newThread.start()
-        while self.flowRunning:
-            if self.channel == &#34;&#34;:
-                self.channel = &#34;global&#34;
-            try:
-                message = logger.readline(&#39;\nInsert message into flow:&#39;).strip().replace(
-                    &#39;\n&#39;, &#39;\\n&#39;).replace(&#39;\r&#39;, &#39;\\r&#39;)
-            except EOFError:
-                pass
-            except KeyboardInterrupt:
-                self.flowRunning = False
-            else:
-                if message == &#34;q&#34;:
-                    self.flowRunning = False
-                expireTime = epoch.get_epoch() + 43200
-                if len(message) &gt; 0:
-                    logger.info(&#39;Inserting message as block...&#39;, terminal=True)
-                    onionrblocks.insert(message, header=&#39;brd&#39;,
-                                        expire=expireTime,
-                                        meta = {
-                                        &#39;ch&#39;: self.channel})
-
-        logger.info(&#34;Flow is exiting, goodbye&#34;, terminal=True)
-        return
-
-    def showOutput(self):
-        while type(self.channel) is type(None) and self.flowRunning:
-            time.sleep(1)
-        try:
-            while self.flowRunning:
-                for block in blockmetadb.get_blocks_by_type(&#39;brd&#39;):
-                    if block in self.alreadyOutputed:
-                        continue
-                    block = Block(block)
-                    b_hash = bytesconverter.bytes_to_str(block.getHash())
-                    if block.getMetadata(&#39;ch&#39;) != self.channel:
-                        continue
-                    if not self.flowRunning:
-                        break
-                    logger.info(&#39;\n------------------------&#39;,
-                                prompt=False, terminal=True)
-                    content = block.getContent()
-                    # Escape new lines, remove trailing whitespace, and escape ansi sequences
-                    content = escapeansi.escape_ANSI(content.replace(
-                        &#39;\n&#39;, &#39;\\n&#39;).replace(&#39;\r&#39;, &#39;\\r&#39;).strip())
-                    logger.info(block.getDate().strftime(
-                        &#34;%m/%d %H:%M&#34;) + &#39; - &#39; + logger.colors.reset + content, prompt=False, terminal=True)
-                    self.alreadyOutputed.append(b_hash)
-                time.sleep(5)
-        except KeyboardInterrupt:
-            self.flowRunning = False
-
-
-def on_flow_cmd(api, data=None):
-    OnionrFlow().start()
-
-
-def on_softreset(api, data=None):
-    try:
-        os.remove(identifyhome.identify_home() + &#39;/board-index.cache.json&#39;)
-        logger.info(&#39;Cleared Circles board cache&#39;)
-    except FileNotFoundError:
-        pass
-
-
-def on_processblocks(api, data=None):
-    metadata = data[&#39;block&#39;].bmetadata  # Get the block metadata
-    if data[&#39;type&#39;] != &#39;brd&#39;:
-        return
-
-    b_hash = reconstructhash.deconstruct_hash(
-        data[&#39;block&#39;].hash)  # Get the 0-truncated block hash
-    board_cache = simplekv.DeadSimpleKV(identifyhome.identify_home(
-    ) + &#39;/board-index.cache.json&#39;, flush_on_exit=False)  # get the board index cache
-    board_cache.refresh()
-    # Validate the channel name is sane for caching
-    try:
-        ch = metadata[&#39;ch&#39;]
-    except KeyError:
-        ch = &#39;global&#39;
-    ch_len = len(ch)
-    if ch_len == 0:
-        ch = &#39;global&#39;
-    elif ch_len &gt; 12:
-        return
-
-    existing_posts = board_cache.get(ch)
-    if existing_posts is None:
-        existing_posts = []
-    existing_posts.append(data[&#39;block&#39;].hash)
-    board_cache.put(ch, existing_posts)
-    board_cache.flush()</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.data2871027835.plugins.flow.main.on_flow_cmd"><code class="name flex">
-<span>def <span class="ident">on_flow_cmd</span></span>(<span>api, data=None)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def on_flow_cmd(api, data=None):
-    OnionrFlow().start()</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.flow.main.on_processblocks"><code class="name flex">
-<span>def <span class="ident">on_processblocks</span></span>(<span>api, data=None)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def on_processblocks(api, data=None):
-    metadata = data[&#39;block&#39;].bmetadata  # Get the block metadata
-    if data[&#39;type&#39;] != &#39;brd&#39;:
-        return
-
-    b_hash = reconstructhash.deconstruct_hash(
-        data[&#39;block&#39;].hash)  # Get the 0-truncated block hash
-    board_cache = simplekv.DeadSimpleKV(identifyhome.identify_home(
-    ) + &#39;/board-index.cache.json&#39;, flush_on_exit=False)  # get the board index cache
-    board_cache.refresh()
-    # Validate the channel name is sane for caching
-    try:
-        ch = metadata[&#39;ch&#39;]
-    except KeyError:
-        ch = &#39;global&#39;
-    ch_len = len(ch)
-    if ch_len == 0:
-        ch = &#39;global&#39;
-    elif ch_len &gt; 12:
-        return
-
-    existing_posts = board_cache.get(ch)
-    if existing_posts is None:
-        existing_posts = []
-    existing_posts.append(data[&#39;block&#39;].hash)
-    board_cache.put(ch, existing_posts)
-    board_cache.flush()</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.flow.main.on_softreset"><code class="name flex">
-<span>def <span class="ident">on_softreset</span></span>(<span>api, data=None)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def on_softreset(api, data=None):
-    try:
-        os.remove(identifyhome.identify_home() + &#39;/board-index.cache.json&#39;)
-        logger.info(&#39;Cleared Circles board cache&#39;)
-    except FileNotFoundError:
-        pass</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="src.data2871027835.plugins.flow.main.OnionrFlow"><code class="flex name class">
-<span>class <span class="ident">OnionrFlow</span></span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class OnionrFlow:
-    def __init__(self):
-        self.alreadyOutputed = []
-        self.flowRunning = False
-        self.channel = &#34;&#34;
-        return
-
-    def start(self):
-        logger.warn(
-            &#34;Please note: everything said here is public, &#34; +
-            &#34;even if a random channel name is used.&#34;, terminal=True)
-        message = &#34;&#34;
-        self.flowRunning = True
-        try:
-            self.channel = logger.readline(
-                &#34;Enter a channel name or none for default:&#34;).strip()
-        except (KeyboardInterrupt, EOFError):
-            self.flowRunning = False
-        newThread = threading.Thread(target=self.showOutput, daemon=True)
-        newThread.start()
-        while self.flowRunning:
-            if self.channel == &#34;&#34;:
-                self.channel = &#34;global&#34;
-            try:
-                message = logger.readline(&#39;\nInsert message into flow:&#39;).strip().replace(
-                    &#39;\n&#39;, &#39;\\n&#39;).replace(&#39;\r&#39;, &#39;\\r&#39;)
-            except EOFError:
-                pass
-            except KeyboardInterrupt:
-                self.flowRunning = False
-            else:
-                if message == &#34;q&#34;:
-                    self.flowRunning = False
-                expireTime = epoch.get_epoch() + 43200
-                if len(message) &gt; 0:
-                    logger.info(&#39;Inserting message as block...&#39;, terminal=True)
-                    onionrblocks.insert(message, header=&#39;brd&#39;,
-                                        expire=expireTime,
-                                        meta = {
-                                        &#39;ch&#39;: self.channel})
-
-        logger.info(&#34;Flow is exiting, goodbye&#34;, terminal=True)
-        return
-
-    def showOutput(self):
-        while type(self.channel) is type(None) and self.flowRunning:
-            time.sleep(1)
-        try:
-            while self.flowRunning:
-                for block in blockmetadb.get_blocks_by_type(&#39;brd&#39;):
-                    if block in self.alreadyOutputed:
-                        continue
-                    block = Block(block)
-                    b_hash = bytesconverter.bytes_to_str(block.getHash())
-                    if block.getMetadata(&#39;ch&#39;) != self.channel:
-                        continue
-                    if not self.flowRunning:
-                        break
-                    logger.info(&#39;\n------------------------&#39;,
-                                prompt=False, terminal=True)
-                    content = block.getContent()
-                    # Escape new lines, remove trailing whitespace, and escape ansi sequences
-                    content = escapeansi.escape_ANSI(content.replace(
-                        &#39;\n&#39;, &#39;\\n&#39;).replace(&#39;\r&#39;, &#39;\\r&#39;).strip())
-                    logger.info(block.getDate().strftime(
-                        &#34;%m/%d %H:%M&#34;) + &#39; - &#39; + logger.colors.reset + content, prompt=False, terminal=True)
-                    self.alreadyOutputed.append(b_hash)
-                time.sleep(5)
-        except KeyboardInterrupt:
-            self.flowRunning = False</code></pre>
-</details>
-<h3>Methods</h3>
-<dl>
-<dt id="src.data2871027835.plugins.flow.main.OnionrFlow.showOutput"><code class="name flex">
-<span>def <span class="ident">showOutput</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def showOutput(self):
-    while type(self.channel) is type(None) and self.flowRunning:
-        time.sleep(1)
-    try:
-        while self.flowRunning:
-            for block in blockmetadb.get_blocks_by_type(&#39;brd&#39;):
-                if block in self.alreadyOutputed:
-                    continue
-                block = Block(block)
-                b_hash = bytesconverter.bytes_to_str(block.getHash())
-                if block.getMetadata(&#39;ch&#39;) != self.channel:
-                    continue
-                if not self.flowRunning:
-                    break
-                logger.info(&#39;\n------------------------&#39;,
-                            prompt=False, terminal=True)
-                content = block.getContent()
-                # Escape new lines, remove trailing whitespace, and escape ansi sequences
-                content = escapeansi.escape_ANSI(content.replace(
-                    &#39;\n&#39;, &#39;\\n&#39;).replace(&#39;\r&#39;, &#39;\\r&#39;).strip())
-                logger.info(block.getDate().strftime(
-                    &#34;%m/%d %H:%M&#34;) + &#39; - &#39; + logger.colors.reset + content, prompt=False, terminal=True)
-                self.alreadyOutputed.append(b_hash)
-            time.sleep(5)
-    except KeyboardInterrupt:
-        self.flowRunning = False</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.flow.main.OnionrFlow.start"><code class="name flex">
-<span>def <span class="ident">start</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def start(self):
-    logger.warn(
-        &#34;Please note: everything said here is public, &#34; +
-        &#34;even if a random channel name is used.&#34;, terminal=True)
-    message = &#34;&#34;
-    self.flowRunning = True
-    try:
-        self.channel = logger.readline(
-            &#34;Enter a channel name or none for default:&#34;).strip()
-    except (KeyboardInterrupt, EOFError):
-        self.flowRunning = False
-    newThread = threading.Thread(target=self.showOutput, daemon=True)
-    newThread.start()
-    while self.flowRunning:
-        if self.channel == &#34;&#34;:
-            self.channel = &#34;global&#34;
-        try:
-            message = logger.readline(&#39;\nInsert message into flow:&#39;).strip().replace(
-                &#39;\n&#39;, &#39;\\n&#39;).replace(&#39;\r&#39;, &#39;\\r&#39;)
-        except EOFError:
-            pass
-        except KeyboardInterrupt:
-            self.flowRunning = False
-        else:
-            if message == &#34;q&#34;:
-                self.flowRunning = False
-            expireTime = epoch.get_epoch() + 43200
-            if len(message) &gt; 0:
-                logger.info(&#39;Inserting message as block...&#39;, terminal=True)
-                onionrblocks.insert(message, header=&#39;brd&#39;,
-                                    expire=expireTime,
-                                    meta = {
-                                    &#39;ch&#39;: self.channel})
-
-    logger.info(&#34;Flow is exiting, goodbye&#34;, terminal=True)
-    return</code></pre>
-</details>
-</dd>
-</dl>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.flow" href="index.html">src.data2871027835.plugins.flow</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.data2871027835.plugins.flow.main.on_flow_cmd" href="#src.data2871027835.plugins.flow.main.on_flow_cmd">on_flow_cmd</a></code></li>
-<li><code><a title="src.data2871027835.plugins.flow.main.on_processblocks" href="#src.data2871027835.plugins.flow.main.on_processblocks">on_processblocks</a></code></li>
-<li><code><a title="src.data2871027835.plugins.flow.main.on_softreset" href="#src.data2871027835.plugins.flow.main.on_softreset">on_softreset</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="src.data2871027835.plugins.flow.main.OnionrFlow" href="#src.data2871027835.plugins.flow.main.OnionrFlow">OnionrFlow</a></code></h4>
-<ul class="">
-<li><code><a title="src.data2871027835.plugins.flow.main.OnionrFlow.showOutput" href="#src.data2871027835.plugins.flow.main.OnionrFlow.showOutput">showOutput</a></code></li>
-<li><code><a title="src.data2871027835.plugins.flow.main.OnionrFlow.start" href="#src.data2871027835.plugins.flow.main.OnionrFlow.start">start</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/index.html

@@ -1,90 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Namespace <code>src.data2871027835.plugins</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.data2871027835.plugins.chat" href="chat/index.html">src.data2871027835.plugins.chat</a></code></dt>
-<dd>
-<section class="desc"></section>
-</dd>
-<dt><code class="name"><a title="src.data2871027835.plugins.encrypt" href="encrypt/index.html">src.data2871027835.plugins.encrypt</a></code></dt>
-<dd>
-<section class="desc"></section>
-</dd>
-<dt><code class="name"><a title="src.data2871027835.plugins.flow" href="flow/index.html">src.data2871027835.plugins.flow</a></code></dt>
-<dd>
-<section class="desc"></section>
-</dd>
-<dt><code class="name"><a title="src.data2871027835.plugins.metadataprocessor" href="metadataprocessor/index.html">src.data2871027835.plugins.metadataprocessor</a></code></dt>
-<dd>
-<section class="desc"></section>
-</dd>
-<dt><code class="name"><a title="src.data2871027835.plugins.pms" href="pms/index.html">src.data2871027835.plugins.pms</a></code></dt>
-<dd>
-<section class="desc"></section>
-</dd>
-<dt><code class="name"><a title="src.data2871027835.plugins.searchengine" href="searchengine/index.html">src.data2871027835.plugins.searchengine</a></code></dt>
-<dd>
-<section class="desc"></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835" href="../index.html">src.data2871027835</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.chat" href="chat/index.html">src.data2871027835.plugins.chat</a></code></li>
-<li><code><a title="src.data2871027835.plugins.encrypt" href="encrypt/index.html">src.data2871027835.plugins.encrypt</a></code></li>
-<li><code><a title="src.data2871027835.plugins.flow" href="flow/index.html">src.data2871027835.plugins.flow</a></code></li>
-<li><code><a title="src.data2871027835.plugins.metadataprocessor" href="metadataprocessor/index.html">src.data2871027835.plugins.metadataprocessor</a></code></li>
-<li><code><a title="src.data2871027835.plugins.pms" href="pms/index.html">src.data2871027835.plugins.pms</a></code></li>
-<li><code><a title="src.data2871027835.plugins.searchengine" href="searchengine/index.html">src.data2871027835.plugins.searchengine</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/metadataprocessor/index.html

@@ -1,65 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.metadataprocessor API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Namespace <code>src.data2871027835.plugins.metadataprocessor</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.data2871027835.plugins.metadataprocessor.main" href="main.html">src.data2871027835.plugins.metadataprocessor.main</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins" href="../index.html">src.data2871027835.plugins</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.metadataprocessor.main" href="main.html">src.data2871027835.plugins.metadataprocessor.main</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/metadataprocessor/main.html

@@ -1,165 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.metadataprocessor.main API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.data2871027835.plugins.metadataprocessor.main</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>This processes metadata for Onionr blocks</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    This processes metadata for Onionr blocks
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-
-# useful libraries
-import logger, config
-import os, sys, json, time, random, shutil, base64, getpass, datetime, re
-import onionrusers, onionrexceptions
-from onionrutils import stringvalidators
-
-plugin_name = &#39;metadataprocessor&#39;
-
-# event listeners
-
-def _processForwardKey(api, myBlock):
-    &#39;&#39;&#39;
-        Get the forward secrecy key specified by the user for us to use
-    &#39;&#39;&#39;
-    peer = onionrusers.OnionrUser(myBlock.signer)
-    key = myBlock.getMetadata(&#39;newFSKey&#39;)
-
-    # We don&#39;t need to validate here probably, but it helps
-    if stringvalidators.validate_pub_key(key):
-        peer.addForwardKey(key)
-    else:
-        raise onionrexceptions.InvalidPubkey(&#34;%s is not a valid pubkey key&#34; % (key,))
-
-def on_processblocks(api, data=None):
-    # Generally fired by utils.
-    myBlock = api.data[&#39;block&#39;]
-    blockType = api.data[&#39;type&#39;]
-    # Process specific block types
-
-    # forwardKey blocks, add a new forward secrecy key for a peer
-    if blockType == &#39;forwardKey&#39;:
-        if api.data[&#39;validSig&#39;] == True:
-            _processForwardKey(api, myBlock)
-    
-def on_init(api, data = None):
-
-    pluginapi = api
-
-    return</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.data2871027835.plugins.metadataprocessor.main.on_init"><code class="name flex">
-<span>def <span class="ident">on_init</span></span>(<span>api, data=None)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def on_init(api, data = None):
-
-    pluginapi = api
-
-    return</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.metadataprocessor.main.on_processblocks"><code class="name flex">
-<span>def <span class="ident">on_processblocks</span></span>(<span>api, data=None)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def on_processblocks(api, data=None):
-    # Generally fired by utils.
-    myBlock = api.data[&#39;block&#39;]
-    blockType = api.data[&#39;type&#39;]
-    # Process specific block types
-
-    # forwardKey blocks, add a new forward secrecy key for a peer
-    if blockType == &#39;forwardKey&#39;:
-        if api.data[&#39;validSig&#39;] == True:
-            _processForwardKey(api, myBlock)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.metadataprocessor" href="index.html">src.data2871027835.plugins.metadataprocessor</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.data2871027835.plugins.metadataprocessor.main.on_init" href="#src.data2871027835.plugins.metadataprocessor.main.on_init">on_init</a></code></li>
-<li><code><a title="src.data2871027835.plugins.metadataprocessor.main.on_processblocks" href="#src.data2871027835.plugins.metadataprocessor.main.on_processblocks">on_processblocks</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/pms/index.html

@@ -1,85 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.pms API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Namespace <code>src.data2871027835.plugins.pms</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.data2871027835.plugins.pms.loadinbox" href="loadinbox.html">src.data2871027835.plugins.pms.loadinbox</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.data2871027835.plugins.pms.mailapi" href="mailapi.html">src.data2871027835.plugins.pms.mailapi</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.data2871027835.plugins.pms.main" href="main.html">src.data2871027835.plugins.pms.main</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.data2871027835.plugins.pms.onblacklist" href="onblacklist.html">src.data2871027835.plugins.pms.onblacklist</a></code></dt>
-<dd>
-<section class="desc"></section>
-</dd>
-<dt><code class="name"><a title="src.data2871027835.plugins.pms.sentboxdb" href="sentboxdb.html">src.data2871027835.plugins.pms.sentboxdb</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins" href="../index.html">src.data2871027835.plugins</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.pms.loadinbox" href="loadinbox.html">src.data2871027835.plugins.pms.loadinbox</a></code></li>
-<li><code><a title="src.data2871027835.plugins.pms.mailapi" href="mailapi.html">src.data2871027835.plugins.pms.mailapi</a></code></li>
-<li><code><a title="src.data2871027835.plugins.pms.main" href="main.html">src.data2871027835.plugins.pms.main</a></code></li>
-<li><code><a title="src.data2871027835.plugins.pms.onblacklist" href="onblacklist.html">src.data2871027835.plugins.pms.onblacklist</a></code></li>
-<li><code><a title="src.data2871027835.plugins.pms.sentboxdb" href="sentboxdb.html">src.data2871027835.plugins.pms.sentboxdb</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/pms/loadinbox.html

@@ -1,127 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.pms.loadinbox API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.data2871027835.plugins.pms.loadinbox</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>Load the user's inbox and return it as a list</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    Load the user&#39;s inbox and return it as a list
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-from onionrblocks import onionrblockapi
-from coredb import blockmetadb
-import filepaths
-from utils import reconstructhash, identifyhome
-import deadsimplekv as simplekv
-def load_inbox():
-    inbox_list = []
-    deleted = simplekv.DeadSimpleKV(identifyhome.identify_home() + &#39;/mailcache.dat&#39;).get(&#39;deleted_mail&#39;)
-    if deleted is None:
-        deleted = []
-
-    for blockHash in blockmetadb.get_blocks_by_type(&#39;pm&#39;):
-        block = onionrblockapi.Block(blockHash)
-        block.decrypt()
-        if block.decrypted and reconstructhash.deconstruct_hash(blockHash) not in deleted:
-            inbox_list.append(blockHash)
-    return inbox_list</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.data2871027835.plugins.pms.loadinbox.load_inbox"><code class="name flex">
-<span>def <span class="ident">load_inbox</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def load_inbox():
-    inbox_list = []
-    deleted = simplekv.DeadSimpleKV(identifyhome.identify_home() + &#39;/mailcache.dat&#39;).get(&#39;deleted_mail&#39;)
-    if deleted is None:
-        deleted = []
-
-    for blockHash in blockmetadb.get_blocks_by_type(&#39;pm&#39;):
-        block = onionrblockapi.Block(blockHash)
-        block.decrypt()
-        if block.decrypted and reconstructhash.deconstruct_hash(blockHash) not in deleted:
-            inbox_list.append(blockHash)
-    return inbox_list</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.pms" href="index.html">src.data2871027835.plugins.pms</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.data2871027835.plugins.pms.loadinbox.load_inbox" href="#src.data2871027835.plugins.pms.loadinbox.load_inbox">load_inbox</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/pms/mailapi.html

@@ -1,216 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.pms.mailapi API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.data2871027835.plugins.pms.mailapi</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>HTTP endpoints for mail plugin.</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    HTTP endpoints for mail plugin.
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-import sys, os, json
-from flask import Response, request, redirect, Blueprint, abort
-from onionrusers import contactmanager
-from onionrutils import stringvalidators
-from utils import reconstructhash, identifyhome
-import filepaths
-import deadsimplekv as simplekv
-sys.path.insert(0, os.path.dirname(os.path.realpath(__file__)))
-import loadinbox, sentboxdb
-
-flask_blueprint = Blueprint(&#39;mail&#39;, __name__)
-kv = simplekv.DeadSimpleKV(identifyhome.identify_home() + &#39;/mailcache.dat&#39;)
-
-@flask_blueprint.route(&#39;/mail/ping&#39;)
-def mail_ping():
-    return &#39;pong!&#39;
-
-@flask_blueprint.route(&#39;/mail/deletemsg/&lt;block&gt;&#39;, methods=[&#39;POST&#39;])
-def mail_delete(block):
-    if not stringvalidators.validate_hash(block):
-        abort(504)
-    block = reconstructhash.deconstruct_hash(block)
-    existing = kv.get(&#39;deleted_mail&#39;)
-    if existing is None:
-        existing = []
-    if block not in existing:
-        existing.append(block)
-    kv.put(&#39;deleted_mail&#39;, existing)
-    kv.flush()
-    return &#39;success&#39;
-
-@flask_blueprint.route(&#39;/mail/getinbox&#39;)
-def list_inbox():
-    return &#39;,&#39;.join(loadinbox.load_inbox())
-
-@flask_blueprint.route(&#39;/mail/getsentbox&#39;)
-def list_sentbox():
-    kv.refresh()
-    sentbox_list = sentboxdb.SentBox().listSent()
-    list_copy = list(sentbox_list)
-    deleted = kv.get(&#39;deleted_mail&#39;)
-    if deleted is None:
-        deleted = []
-    for sent in list_copy:
-        if sent[&#39;hash&#39;] in deleted:
-            sentbox_list.remove(sent)
-            continue
-        sent[&#39;name&#39;] = contactmanager.ContactManager(sent[&#39;peer&#39;], saveUser=False).get_info(&#39;name&#39;)
-    return json.dumps(sentbox_list)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.data2871027835.plugins.pms.mailapi.list_inbox"><code class="name flex">
-<span>def <span class="ident">list_inbox</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@flask_blueprint.route(&#39;/mail/getinbox&#39;)
-def list_inbox():
-    return &#39;,&#39;.join(loadinbox.load_inbox())</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.pms.mailapi.list_sentbox"><code class="name flex">
-<span>def <span class="ident">list_sentbox</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@flask_blueprint.route(&#39;/mail/getsentbox&#39;)
-def list_sentbox():
-    kv.refresh()
-    sentbox_list = sentboxdb.SentBox().listSent()
-    list_copy = list(sentbox_list)
-    deleted = kv.get(&#39;deleted_mail&#39;)
-    if deleted is None:
-        deleted = []
-    for sent in list_copy:
-        if sent[&#39;hash&#39;] in deleted:
-            sentbox_list.remove(sent)
-            continue
-        sent[&#39;name&#39;] = contactmanager.ContactManager(sent[&#39;peer&#39;], saveUser=False).get_info(&#39;name&#39;)
-    return json.dumps(sentbox_list)</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.pms.mailapi.mail_delete"><code class="name flex">
-<span>def <span class="ident">mail_delete</span></span>(<span>block)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@flask_blueprint.route(&#39;/mail/deletemsg/&lt;block&gt;&#39;, methods=[&#39;POST&#39;])
-def mail_delete(block):
-    if not stringvalidators.validate_hash(block):
-        abort(504)
-    block = reconstructhash.deconstruct_hash(block)
-    existing = kv.get(&#39;deleted_mail&#39;)
-    if existing is None:
-        existing = []
-    if block not in existing:
-        existing.append(block)
-    kv.put(&#39;deleted_mail&#39;, existing)
-    kv.flush()
-    return &#39;success&#39;</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.pms.mailapi.mail_ping"><code class="name flex">
-<span>def <span class="ident">mail_ping</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">@flask_blueprint.route(&#39;/mail/ping&#39;)
-def mail_ping():
-    return &#39;pong!&#39;</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.pms" href="index.html">src.data2871027835.plugins.pms</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.data2871027835.plugins.pms.mailapi.list_inbox" href="#src.data2871027835.plugins.pms.mailapi.list_inbox">list_inbox</a></code></li>
-<li><code><a title="src.data2871027835.plugins.pms.mailapi.list_sentbox" href="#src.data2871027835.plugins.pms.mailapi.list_sentbox">list_sentbox</a></code></li>
-<li><code><a title="src.data2871027835.plugins.pms.mailapi.mail_delete" href="#src.data2871027835.plugins.pms.mailapi.mail_delete">mail_delete</a></code></li>
-<li><code><a title="src.data2871027835.plugins.pms.mailapi.mail_ping" href="#src.data2871027835.plugins.pms.mailapi.mail_ping">mail_ping</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/pms/main.html

@@ -1,206 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.pms.main API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.data2871027835.plugins.pms.main</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>This default plugin handles private messages in an email like fashion</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    This default plugin handles private messages in an email like fashion
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-
-# Imports some useful libraries
-import logger, config, threading, time, datetime
-import onionrexceptions
-from onionrusers import onionrusers, contactmanager
-from utils import reconstructhash
-from onionrutils import stringvalidators, escapeansi, bytesconverter
-import notifier
-import locale, sys, os, json
-
-locale.setlocale(locale.LC_ALL, &#39;&#39;)
-
-plugin_name = &#39;pms&#39;
-PLUGIN_VERSION = &#39;0.0.1&#39;
-
-sys.path.insert(0, os.path.dirname(os.path.realpath(__file__)))
-import sentboxdb, mailapi, loadinbox # import after path insert
-from onblacklist import on_blacklist_add
-
-flask_blueprint = mailapi.flask_blueprint
-security_whitelist = [&#39;staticfiles.mail&#39;, &#39;staticfiles.mailindex&#39;]
-
-def add_deleted(keyStore, b_hash):
-    existing = keyStore.get(&#39;deleted_mail&#39;)
-    bHash = reconstructhash.reconstruct_hash(b_hash)
-    if existing is None:
-        existing = []
-    else:
-        if bHash in existing:
-            return
-    keyStore.put(&#39;deleted_mail&#39;, existing.append(b_hash))
-
-def on_insertblock(api, data={}):
-    meta = json.loads(data[&#39;meta&#39;])
-    if meta[&#39;type&#39;] == &#39;pm&#39;:
-        sentboxTools = sentboxdb.SentBox()
-        sentboxTools.addToSent(data[&#39;hash&#39;], data[&#39;peer&#39;], data[&#39;content&#39;], meta[&#39;subject&#39;])
-
-def on_processblocks(api, data=None):
-    if data[&#39;type&#39;] != &#39;pm&#39;:
-        return
-    data[&#39;block&#39;].decrypt()
-    metadata = data[&#39;block&#39;].bmetadata
-
-    signer = bytesconverter.bytes_to_str(data[&#39;block&#39;].signer)
-    user = contactmanager.ContactManager(signer, saveUser=False)
-    name = user.get_info(&#34;name&#34;)
-    if name != &#39;anonymous&#39; and name != None:
-        signer = name.title()
-    else:
-        signer = signer[:5]
-
-    if data[&#39;block&#39;].decrypted:
-        notifier.notify(title=&#34;Onionr Mail - New Message&#34;, message=&#34;From: %s\n\nSubject: %s&#34; % (signer, metadata[&#39;subject&#39;]))</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.data2871027835.plugins.pms.main.add_deleted"><code class="name flex">
-<span>def <span class="ident">add_deleted</span></span>(<span>keyStore, b_hash)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def add_deleted(keyStore, b_hash):
-    existing = keyStore.get(&#39;deleted_mail&#39;)
-    bHash = reconstructhash.reconstruct_hash(b_hash)
-    if existing is None:
-        existing = []
-    else:
-        if bHash in existing:
-            return
-    keyStore.put(&#39;deleted_mail&#39;, existing.append(b_hash))</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.pms.main.on_insertblock"><code class="name flex">
-<span>def <span class="ident">on_insertblock</span></span>(<span>api, data={})</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def on_insertblock(api, data={}):
-    meta = json.loads(data[&#39;meta&#39;])
-    if meta[&#39;type&#39;] == &#39;pm&#39;:
-        sentboxTools = sentboxdb.SentBox()
-        sentboxTools.addToSent(data[&#39;hash&#39;], data[&#39;peer&#39;], data[&#39;content&#39;], meta[&#39;subject&#39;])</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.pms.main.on_processblocks"><code class="name flex">
-<span>def <span class="ident">on_processblocks</span></span>(<span>api, data=None)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def on_processblocks(api, data=None):
-    if data[&#39;type&#39;] != &#39;pm&#39;:
-        return
-    data[&#39;block&#39;].decrypt()
-    metadata = data[&#39;block&#39;].bmetadata
-
-    signer = bytesconverter.bytes_to_str(data[&#39;block&#39;].signer)
-    user = contactmanager.ContactManager(signer, saveUser=False)
-    name = user.get_info(&#34;name&#34;)
-    if name != &#39;anonymous&#39; and name != None:
-        signer = name.title()
-    else:
-        signer = signer[:5]
-
-    if data[&#39;block&#39;].decrypted:
-        notifier.notify(title=&#34;Onionr Mail - New Message&#34;, message=&#34;From: %s\n\nSubject: %s&#34; % (signer, metadata[&#39;subject&#39;]))</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.pms" href="index.html">src.data2871027835.plugins.pms</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.data2871027835.plugins.pms.main.add_deleted" href="#src.data2871027835.plugins.pms.main.add_deleted">add_deleted</a></code></li>
-<li><code><a title="src.data2871027835.plugins.pms.main.on_insertblock" href="#src.data2871027835.plugins.pms.main.on_insertblock">on_insertblock</a></code></li>
-<li><code><a title="src.data2871027835.plugins.pms.main.on_processblocks" href="#src.data2871027835.plugins.pms.main.on_processblocks">on_processblocks</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/pms/onblacklist.html

@@ -1,96 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.pms.onblacklist API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.data2871027835.plugins.pms.onblacklist</code></h1>
-</header>
-<section id="section-intro">
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">from threading import Thread
-
-from onionrutils import localcommand
-
-
-def on_blacklist_add(api, data=None):
-    blacklisted_data = data[&#39;data&#39;]
-
-    def remove():
-        localcommand.local_command(f&#39;/mail/deletemsg/{blacklisted_data}&#39;, post=True)
-
-    Thread(target=remove).start()</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.data2871027835.plugins.pms.onblacklist.on_blacklist_add"><code class="name flex">
-<span>def <span class="ident">on_blacklist_add</span></span>(<span>api, data=None)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def on_blacklist_add(api, data=None):
-    blacklisted_data = data[&#39;data&#39;]
-
-    def remove():
-        localcommand.local_command(f&#39;/mail/deletemsg/{blacklisted_data}&#39;, post=True)
-
-    Thread(target=remove).start()</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.pms" href="index.html">src.data2871027835.plugins.pms</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.data2871027835.plugins.pms.onblacklist.on_blacklist_add" href="#src.data2871027835.plugins.pms.onblacklist.on_blacklist_add">on_blacklist_add</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/pms/sentboxdb.html

@@ -1,333 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.pms.sentboxdb API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.data2871027835.plugins.pms.sentboxdb</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>This file handles the sentbox for the mail plugin</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;
-    Onionr - Private P2P Communication
-
-    This file handles the sentbox for the mail plugin
-&#34;&#34;&#34;
-import sqlite3
-import os
-from onionrutils import epoch
-from utils import identifyhome, reconstructhash
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-
-
-class SentBox:
-    def __init__(self):
-        self.dbLocation = identifyhome.identify_home() + &#39;/sentbox.db&#39;
-        if not os.path.exists(self.dbLocation):
-            self.createDB()
-        return
-
-    def connect(self):
-        self.conn = sqlite3.connect(self.dbLocation)
-        self.cursor = self.conn.cursor()
-
-    def close(self):
-        self.conn.close()
-
-    def createDB(self):
-        conn = sqlite3.connect(self.dbLocation)
-        cursor = conn.cursor()
-        cursor.execute(&#34;&#34;&#34;CREATE TABLE sent(
-            hash id not null,
-            peer text not null,
-            message text not null,
-            subject text not null,
-            date int not null
-            );
-        &#34;&#34;&#34;)
-        conn.commit()
-        conn.close()
-        return
-
-    def listSent(self):
-        self.connect()
-        retData = []
-        for entry in self.cursor.execute(&#39;SELECT * FROM sent;&#39;):
-            retData.append({&#39;hash&#39;: entry[0], &#39;peer&#39;: entry[1], &#39;message&#39;: entry[2], &#39;subject&#39;: entry[3], &#39;date&#39;: entry[4]})
-        self.close()
-        return retData
-
-    def addToSent(self, blockID, peer, message, subject=&#39;&#39;):
-        blockID = reconstructhash.deconstruct_hash(blockID)
-        self.connect()
-        args = (blockID, peer, message, subject, epoch.get_epoch())
-        self.cursor.execute(&#39;INSERT INTO sent VALUES(?, ?, ?, ?, ?)&#39;, args)
-        self.conn.commit()
-        self.close()
-        return
-
-    def removeSent(self, blockID):
-        blockID = reconstructhash.deconstruct_hash(blockID)
-        self.connect()
-        args = (blockID,)
-        self.cursor.execute(&#39;DELETE FROM sent where hash=?&#39;, args)
-        self.conn.commit()
-        self.close()
-        return</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-classes">Classes</h2>
-<dl>
-<dt id="src.data2871027835.plugins.pms.sentboxdb.SentBox"><code class="flex name class">
-<span>class <span class="ident">SentBox</span></span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">class SentBox:
-    def __init__(self):
-        self.dbLocation = identifyhome.identify_home() + &#39;/sentbox.db&#39;
-        if not os.path.exists(self.dbLocation):
-            self.createDB()
-        return
-
-    def connect(self):
-        self.conn = sqlite3.connect(self.dbLocation)
-        self.cursor = self.conn.cursor()
-
-    def close(self):
-        self.conn.close()
-
-    def createDB(self):
-        conn = sqlite3.connect(self.dbLocation)
-        cursor = conn.cursor()
-        cursor.execute(&#34;&#34;&#34;CREATE TABLE sent(
-            hash id not null,
-            peer text not null,
-            message text not null,
-            subject text not null,
-            date int not null
-            );
-        &#34;&#34;&#34;)
-        conn.commit()
-        conn.close()
-        return
-
-    def listSent(self):
-        self.connect()
-        retData = []
-        for entry in self.cursor.execute(&#39;SELECT * FROM sent;&#39;):
-            retData.append({&#39;hash&#39;: entry[0], &#39;peer&#39;: entry[1], &#39;message&#39;: entry[2], &#39;subject&#39;: entry[3], &#39;date&#39;: entry[4]})
-        self.close()
-        return retData
-
-    def addToSent(self, blockID, peer, message, subject=&#39;&#39;):
-        blockID = reconstructhash.deconstruct_hash(blockID)
-        self.connect()
-        args = (blockID, peer, message, subject, epoch.get_epoch())
-        self.cursor.execute(&#39;INSERT INTO sent VALUES(?, ?, ?, ?, ?)&#39;, args)
-        self.conn.commit()
-        self.close()
-        return
-
-    def removeSent(self, blockID):
-        blockID = reconstructhash.deconstruct_hash(blockID)
-        self.connect()
-        args = (blockID,)
-        self.cursor.execute(&#39;DELETE FROM sent where hash=?&#39;, args)
-        self.conn.commit()
-        self.close()
-        return</code></pre>
-</details>
-<h3>Methods</h3>
-<dl>
-<dt id="src.data2871027835.plugins.pms.sentboxdb.SentBox.addToSent"><code class="name flex">
-<span>def <span class="ident">addToSent</span></span>(<span>self, blockID, peer, message, subject='')</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def addToSent(self, blockID, peer, message, subject=&#39;&#39;):
-    blockID = reconstructhash.deconstruct_hash(blockID)
-    self.connect()
-    args = (blockID, peer, message, subject, epoch.get_epoch())
-    self.cursor.execute(&#39;INSERT INTO sent VALUES(?, ?, ?, ?, ?)&#39;, args)
-    self.conn.commit()
-    self.close()
-    return</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.pms.sentboxdb.SentBox.close"><code class="name flex">
-<span>def <span class="ident">close</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def close(self):
-    self.conn.close()</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.pms.sentboxdb.SentBox.connect"><code class="name flex">
-<span>def <span class="ident">connect</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def connect(self):
-    self.conn = sqlite3.connect(self.dbLocation)
-    self.cursor = self.conn.cursor()</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.pms.sentboxdb.SentBox.createDB"><code class="name flex">
-<span>def <span class="ident">createDB</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def createDB(self):
-    conn = sqlite3.connect(self.dbLocation)
-    cursor = conn.cursor()
-    cursor.execute(&#34;&#34;&#34;CREATE TABLE sent(
-        hash id not null,
-        peer text not null,
-        message text not null,
-        subject text not null,
-        date int not null
-        );
-    &#34;&#34;&#34;)
-    conn.commit()
-    conn.close()
-    return</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.pms.sentboxdb.SentBox.listSent"><code class="name flex">
-<span>def <span class="ident">listSent</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def listSent(self):
-    self.connect()
-    retData = []
-    for entry in self.cursor.execute(&#39;SELECT * FROM sent;&#39;):
-        retData.append({&#39;hash&#39;: entry[0], &#39;peer&#39;: entry[1], &#39;message&#39;: entry[2], &#39;subject&#39;: entry[3], &#39;date&#39;: entry[4]})
-    self.close()
-    return retData</code></pre>
-</details>
-</dd>
-<dt id="src.data2871027835.plugins.pms.sentboxdb.SentBox.removeSent"><code class="name flex">
-<span>def <span class="ident">removeSent</span></span>(<span>self, blockID)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def removeSent(self, blockID):
-    blockID = reconstructhash.deconstruct_hash(blockID)
-    self.connect()
-    args = (blockID,)
-    self.cursor.execute(&#39;DELETE FROM sent where hash=?&#39;, args)
-    self.conn.commit()
-    self.close()
-    return</code></pre>
-</details>
-</dd>
-</dl>
-</dd>
-</dl>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.pms" href="index.html">src.data2871027835.plugins.pms</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-classes">Classes</a></h3>
-<ul>
-<li>
-<h4><code><a title="src.data2871027835.plugins.pms.sentboxdb.SentBox" href="#src.data2871027835.plugins.pms.sentboxdb.SentBox">SentBox</a></code></h4>
-<ul class="two-column">
-<li><code><a title="src.data2871027835.plugins.pms.sentboxdb.SentBox.addToSent" href="#src.data2871027835.plugins.pms.sentboxdb.SentBox.addToSent">addToSent</a></code></li>
-<li><code><a title="src.data2871027835.plugins.pms.sentboxdb.SentBox.close" href="#src.data2871027835.plugins.pms.sentboxdb.SentBox.close">close</a></code></li>
-<li><code><a title="src.data2871027835.plugins.pms.sentboxdb.SentBox.connect" href="#src.data2871027835.plugins.pms.sentboxdb.SentBox.connect">connect</a></code></li>
-<li><code><a title="src.data2871027835.plugins.pms.sentboxdb.SentBox.createDB" href="#src.data2871027835.plugins.pms.sentboxdb.SentBox.createDB">createDB</a></code></li>
-<li><code><a title="src.data2871027835.plugins.pms.sentboxdb.SentBox.listSent" href="#src.data2871027835.plugins.pms.sentboxdb.SentBox.listSent">listSent</a></code></li>
-<li><code><a title="src.data2871027835.plugins.pms.sentboxdb.SentBox.removeSent" href="#src.data2871027835.plugins.pms.sentboxdb.SentBox.removeSent">removeSent</a></code></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/searchengine/index.html

@@ -1,65 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.searchengine API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Namespace <code>src.data2871027835.plugins.searchengine</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.data2871027835.plugins.searchengine.main" href="main.html">src.data2871027835.plugins.searchengine.main</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins" href="../index.html">src.data2871027835.plugins</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.searchengine.main" href="main.html">src.data2871027835.plugins.searchengine.main</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/data2871027835/plugins/searchengine/main.html

@@ -1,82 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.data2871027835.plugins.searchengine.main API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.data2871027835.plugins.searchengine.main</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>Search engine plugin for Onionr, to search for</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    Search engine plugin for Onionr, to search for 
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-
-
-plugin_name = &#39;searchengine&#39;</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.data2871027835.plugins.searchengine" href="index.html">src.data2871027835.plugins.searchengine</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/etc/cleanup/index.html

@@ -1,116 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.etc.cleanup API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.etc.cleanup</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>cleanup files</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;
-    Onionr - Private P2P Communication
-
-    cleanup files
-&#34;&#34;&#34;
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-import os, filepaths
-
-def _safe_remove(path):
-    try:
-        os.remove(path)
-    except FileNotFoundError:
-        pass
-
-def delete_run_files():
-     _safe_remove(filepaths.public_API_host_file)
-     _safe_remove(filepaths.private_API_host_file)
-     _safe_remove(filepaths.daemon_mark_file)
-     _safe_remove(filepaths.lock_file)</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.etc.cleanup.delete_run_files"><code class="name flex">
-<span>def <span class="ident">delete_run_files</span></span>(<span>)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def delete_run_files():
-     _safe_remove(filepaths.public_API_host_file)
-     _safe_remove(filepaths.private_API_host_file)
-     _safe_remove(filepaths.daemon_mark_file)
-     _safe_remove(filepaths.lock_file)</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.etc" href="../index.html">src.etc</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.etc.cleanup.delete_run_files" href="#src.etc.cleanup.delete_run_files">delete_run_files</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/etc/dependencycheck.html

@@ -1,59 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.etc.dependencycheck API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.etc.dependencycheck</code></h1>
-</header>
-<section id="section-intro">
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">from urllib3.contrib.socks import SOCKSProxyManager # noqa</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.etc" href="index.html">src.etc</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/etc/humanreadabletime.html

@@ -1,136 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.etc.humanreadabletime API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.etc.humanreadabletime</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication</p>
-<p>human_readable_time takes integer seconds and returns a human readable string</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#39;&#39;&#39;
-    Onionr - Private P2P Communication
-
-    human_readable_time takes integer seconds and returns a human readable string
-&#39;&#39;&#39;
-&#39;&#39;&#39;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#39;&#39;&#39;
-def human_readable_time(seconds):
-    build = &#39;&#39;
-
-    units = {
-        &#39;year&#39; : 31557600,
-        &#39;month&#39; : (31557600 / 12),
-        &#39;day&#39; : 86400,
-        &#39;hour&#39; : 3600,
-        &#39;minute&#39; : 60,
-        &#39;second&#39; : 1
-    }
-
-    for unit in units:
-        amnt_unit = int(seconds / units[unit])
-        if amnt_unit &gt;= 1:
-            seconds -= amnt_unit * units[unit]
-            build += &#39;%s %s&#39; % (amnt_unit, unit) + (&#39;s&#39; if amnt_unit != 1 else &#39;&#39;) + &#39; &#39;
-
-    return build.strip()</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-functions">Functions</h2>
-<dl>
-<dt id="src.etc.humanreadabletime.human_readable_time"><code class="name flex">
-<span>def <span class="ident">human_readable_time</span></span>(<span>seconds)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def human_readable_time(seconds):
-    build = &#39;&#39;
-
-    units = {
-        &#39;year&#39; : 31557600,
-        &#39;month&#39; : (31557600 / 12),
-        &#39;day&#39; : 86400,
-        &#39;hour&#39; : 3600,
-        &#39;minute&#39; : 60,
-        &#39;second&#39; : 1
-    }
-
-    for unit in units:
-        amnt_unit = int(seconds / units[unit])
-        if amnt_unit &gt;= 1:
-            seconds -= amnt_unit * units[unit]
-            build += &#39;%s %s&#39; % (amnt_unit, unit) + (&#39;s&#39; if amnt_unit != 1 else &#39;&#39;) + &#39; &#39;
-
-    return build.strip()</code></pre>
-</details>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.etc" href="index.html">src.etc</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-functions">Functions</a></h3>
-<ul class="">
-<li><code><a title="src.etc.humanreadabletime.human_readable_time" href="#src.etc.humanreadabletime.human_readable_time">human_readable_time</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/etc/index.html

@@ -1,90 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.etc API documentation</title>
-<meta name="description" content="" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.etc</code></h1>
-</header>
-<section id="section-intro">
-</section>
-<section>
-<h2 class="section-title" id="header-submodules">Sub-modules</h2>
-<dl>
-<dt><code class="name"><a title="src.etc.cleanup" href="cleanup/index.html">src.etc.cleanup</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.etc.dependencycheck" href="dependencycheck.html">src.etc.dependencycheck</a></code></dt>
-<dd>
-<section class="desc"></section>
-</dd>
-<dt><code class="name"><a title="src.etc.humanreadabletime" href="humanreadabletime.html">src.etc.humanreadabletime</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.etc.onionrvalues" href="onionrvalues.html">src.etc.onionrvalues</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.etc.powchoice" href="powchoice.html">src.etc.powchoice</a></code></dt>
-<dd>
-<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
-</dd>
-<dt><code class="name"><a title="src.etc.waitforsetvar" href="waitforsetvar.html">src.etc.waitforsetvar</a></code></dt>
-<dd>
-<section class="desc"></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src" href="../index.html">src</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-submodules">Sub-modules</a></h3>
-<ul>
-<li><code><a title="src.etc.cleanup" href="cleanup/index.html">src.etc.cleanup</a></code></li>
-<li><code><a title="src.etc.dependencycheck" href="dependencycheck.html">src.etc.dependencycheck</a></code></li>
-<li><code><a title="src.etc.humanreadabletime" href="humanreadabletime.html">src.etc.humanreadabletime</a></code></li>
-<li><code><a title="src.etc.onionrvalues" href="onionrvalues.html">src.etc.onionrvalues</a></code></li>
-<li><code><a title="src.etc.powchoice" href="powchoice.html">src.etc.powchoice</a></code></li>
-<li><code><a title="src.etc.waitforsetvar" href="waitforsetvar.html">src.etc.waitforsetvar</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>

docs/html/src/etc/onionrvalues.html

@@ -1,171 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.7.4" />
-<title>src.etc.onionrvalues API documentation</title>
-<meta name="description" content="Onionr - Private P2P Communication …" />
-<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
-<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
-<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
-<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
-<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
-<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
-</head>
-<body>
-<main>
-<article id="content">
-<header>
-<h1 class="title">Module <code>src.etc.onionrvalues</code></h1>
-</header>
-<section id="section-intro">
-<p>Onionr - Private P2P Communication.</p>
-<p>This file defines values and requirements used by Onionr</p>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">&#34;&#34;&#34;Onionr - Private P2P Communication.
-
-This file defines values and requirements used by Onionr
-&#34;&#34;&#34;
-import platform
-import os
-
-import filepaths
-&#34;&#34;&#34;
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.
-&#34;&#34;&#34;
-DENIABLE_PEER_ADDRESS = &#34;OVPCZLOXD6DC5JHX4EQ3PSOGAZ3T24F75HQLIUZSDSMYPEOXCPFA&#34;
-PASSWORD_LENGTH = 25
-ONIONR_TAGLINE = &#39;Private P2P Communication - GPLv3 - https://Onionr.net&#39;
-ONIONR_VERSION = &#39;0.1.0&#39; # for debugging and stuff
-ONIONR_VERSION_TUPLE = tuple(ONIONR_VERSION.split(&#39;.&#39;)) # (MAJOR, MINOR, VERSION)
-API_VERSION = &#39;0&#39; # increments of 1; only change when something fundamental about how the API works changes. This way other nodes know how to communicate without learning too much information about you.
-MIN_PY_VERSION = 7 # min version of 7 so we can take advantage of non-cyclic type hints
-DEVELOPMENT_MODE = False
-&#34;&#34;&#34;limit type length for a block (soft enforced, ignored if invalid but block still stored).&#34;&#34;&#34;
-MAX_BLOCK_TYPE_LENGTH = 15
-&#34;&#34;&#34;limit clock timestamp for new blocks to be skewed in the future in seconds,
-2 minutes to allow plenty of time for slow block insertion and slight clock inaccuracies&#34;&#34;&#34;
-MAX_BLOCK_CLOCK_SKEW = 120
-&#34;&#34;&#34;Onionr user IDs are ed25519 keys, which are always 32 bytes in length&#34;&#34;&#34;
-MAIN_PUBLIC_KEY_SIZE = 32
-ORIG_RUN_DIR_ENV_VAR = &#39;ORIG_ONIONR_RUN_DIR&#39;
-
-DATABASE_LOCK_TIMEOUT = 60
-
-# Block creation anonymization requirements
-MIN_BLOCK_UPLOAD_PEER_PERCENT = 0.1
-MIN_SHARE_WAIT_DELAY_SECS = 5
-
-WSGI_SERVER_REQUEST_TIMEOUT_SECS = 120
-
-MAX_NEW_PEER_QUEUE = 1000
-
-# Begin OnionrValues migrated values
-
-&#34;&#34;&#34;30 days is plenty of time for someone to decide to renew a block&#34;&#34;&#34;
-DEFAULT_EXPIRE = 2592000
-# Metadata header section length limits, in bytes
-BLOCK_METADATA_LENGTHS = {&#39;meta&#39;: 1000, &#39;sig&#39;: 200, &#39;signer&#39;: 200, &#39;time&#39;: 10, &#39;pow&#39;: 1000, &#39;encryptType&#39;: 4, &#39;expire&#39;: 14}
-
-# Pool Eligibility Max Age
-BLOCK_POOL_MAX_AGE = 300
-
-&#34;&#34;&#34;Public key that signs MOTD messages shown in the web UI&#34;&#34;&#34;
-MOTD_SIGN_KEY = &#34;TRH763JURNY47QPBTTQ4LLPYCYQK6Q5YA33R6GANKZK5C5DKCIGQ&#34;
-
-&#34;&#34;&#34;Public key that signs update notifications.&#34;&#34;&#34;
-UPDATE_SIGN_KEY = &#34;TRH763JURNY47QPBTTQ4LLPYCYQK6Q5YA33R6GANKZK5C5DKCIGQ&#34;
-
-platform = platform.system()
-if platform == &#39;Windows&#39;:
-    SCRIPT_NAME = &#39;run-windows.bat&#39;
-else:
-    if os.path.exists(filepaths.daemon_mark_file):
-        SCRIPT_NAME = &#39;start-daemon.sh&#39;
-    else:
-        SCRIPT_NAME = &#39;onionr.sh&#39;</code></pre>
-</details>
-</section>
-<section>
-</section>
-<section>
-<h2 class="section-title" id="header-variables">Global variables</h2>
-<dl>
-<dt id="src.etc.onionrvalues.BLOCK_POOL_MAX_AGE"><code class="name">var <span class="ident">BLOCK_POOL_MAX_AGE</span></code></dt>
-<dd>
-<section class="desc"><p>Public key that signs MOTD messages shown in the web UI</p></section>
-</dd>
-<dt id="src.etc.onionrvalues.DEVELOPMENT_MODE"><code class="name">var <span class="ident">DEVELOPMENT_MODE</span></code></dt>
-<dd>
-<section class="desc"><p>limit type length for a block (soft enforced, ignored if invalid but block still stored).</p></section>
-</dd>
-<dt id="src.etc.onionrvalues.MAX_BLOCK_CLOCK_SKEW"><code class="name">var <span class="ident">MAX_BLOCK_CLOCK_SKEW</span></code></dt>
-<dd>
-<section class="desc"><p>Onionr user IDs are ed25519 keys, which are always 32 bytes in length</p></section>
-</dd>
-<dt id="src.etc.onionrvalues.MAX_BLOCK_TYPE_LENGTH"><code class="name">var <span class="ident">MAX_BLOCK_TYPE_LENGTH</span></code></dt>
-<dd>
-<section class="desc"><p>limit clock timestamp for new blocks to be skewed in the future in seconds,
-2 minutes to allow plenty of time for slow block insertion and slight clock inaccuracies</p></section>
-</dd>
-<dt id="src.etc.onionrvalues.MAX_NEW_PEER_QUEUE"><code class="name">var <span class="ident">MAX_NEW_PEER_QUEUE</span></code></dt>
-<dd>
-<section class="desc"><p>30 days is plenty of time for someone to decide to renew a block</p></section>
-</dd>
-<dt id="src.etc.onionrvalues.MOTD_SIGN_KEY"><code class="name">var <span class="ident">MOTD_SIGN_KEY</span></code></dt>
-<dd>
-<section class="desc"><p>Public key that signs update notifications.</p></section>
-</dd>
-</dl>
-</section>
-<section>
-</section>
-<section>
-</section>
-</article>
-<nav id="sidebar">
-<h1>Index</h1>
-<div class="toc">
-<ul></ul>
-</div>
-<ul id="index">
-<li><h3>Super-module</h3>
-<ul>
-<li><code><a title="src.etc" href="index.html">src.etc</a></code></li>
-</ul>
-</li>
-<li><h3><a href="#header-variables">Global variables</a></h3>
-<ul class="">
-<li><code><a title="src.etc.onionrvalues.BLOCK_POOL_MAX_AGE" href="#src.etc.onionrvalues.BLOCK_POOL_MAX_AGE">BLOCK_POOL_MAX_AGE</a></code></li>
-<li><code><a title="src.etc.onionrvalues.DEVELOPMENT_MODE" href="#src.etc.onionrvalues.DEVELOPMENT_MODE">DEVELOPMENT_MODE</a></code></li>
-<li><code><a title="src.etc.onionrvalues.MAX_BLOCK_CLOCK_SKEW" href="#src.etc.onionrvalues.MAX_BLOCK_CLOCK_SKEW">MAX_BLOCK_CLOCK_SKEW</a></code></li>
-<li><code><a title="src.etc.onionrvalues.MAX_BLOCK_TYPE_LENGTH" href="#src.etc.onionrvalues.MAX_BLOCK_TYPE_LENGTH">MAX_BLOCK_TYPE_LENGTH</a></code></li>
-<li><code><a title="src.etc.onionrvalues.MAX_NEW_PEER_QUEUE" href="#src.etc.onionrvalues.MAX_NEW_PEER_QUEUE">MAX_NEW_PEER_QUEUE</a></code></li>
-<li><code><a title="src.etc.onionrvalues.MOTD_SIGN_KEY" href="#src.etc.onionrvalues.MOTD_SIGN_KEY">MOTD_SIGN_KEY</a></code></li>
-</ul>
-</li>
-</ul>
-</nav>
-</main>
-<footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
-</footer>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
-<script>hljs.initHighlightingOnLoad()</script>
-</body>
-</html>