From 34b919d3244f575126e11101a67436f8bc9e1e23 Mon Sep 17 00:00:00 2001 From: Aaron <20esaua@ttsdstudents.org> Date: Tue, 31 Jul 2018 00:14:42 +0000 Subject: [PATCH 1/4] Add stuff to readme --- onionr/static-data/ui/README.md | 45 ++++++++++++++++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) diff --git a/onionr/static-data/ui/README.md b/onionr/static-data/ui/README.md index 40dea268..451b08ed 100644 --- a/onionr/static-data/ui/README.md +++ b/onionr/static-data/ui/README.md @@ -1 +1,44 @@ -Static files for Onionr's web ui, change at your own risk. +# Onionr UI + +## About + +The default GUI for Onionr + +## Setup + +To compile the application, simply execute the following: + +``` +python3 compile.py +``` + +If you are wanting to compile Onionr UI for another language, execute the following, replacing `[lang]` with the target language (supported languages include `eng` for English, `spa` para español, and `zho`为中国人): + +``` +python3 compile.py [lang] +``` + +## FAQ +### Why "compile" anyway? +This web application is compiled for a few reasons: +1. To make it easier to update; this way, we do not have to update the header in every file if we want to change something about it. +2. To make the application smaller in size; there is less duplicated code when the code like the header and footer can be stored in an individual file rather than every file. +3. For multi-language support; with the Python "tags" feature, we can reference strings by variable name, and based on a language file, they can be dynamically inserted into the page on compilation. +4. For compile-time customizations. + +### What exactly happens when you compile? +Upon compilation, files from the `src/` directory will be copied to `dist/` directory, header and footers will be injected in the proper places, and Python "tags" will be interpreted. + + +### How do Python "tags" work? +There are two types of Python "tags": +1. Logic tags (`<$ logic $>`): These tags allow you to perform logic at compile time. Example: `<$ import datetime; lastUpdate = datetime.datetime.now() $>`: This gets the current time while compiling, then stores it in `lastUpdate`. +2. Data tags (`<$= data $>`): These tags take whatever the return value of the statement in the tags is, and write it directly to the page. Example: `<$= 'This application was compiled at %s.' % lastUpdate $>`: This will write the message in the string in the tags to the page. + +**Note:** Logic tags take a higher priority and will always be interpreted first. + +### How does the language feature work? +When you use a data tag to write a string to the page (e.g. `<$= LANG.HELLO_WORLD $>`), the language feature simply takes dictionary of the language that is currently being used from the language map file (`lang.json`), then searches for the key (being the variable name after the characters `LANG.` in the data tag, like `HELLO_WORLD` from the example before). It then writes that string to the page. Language variables are always prefixed with `LANG.` and should always be uppercase (as they are a constant). + +### I changed a few things in the application and tried to view the updates in my browser, but nothing changed! +You most likely forgot to compile. Try running `python3 compile.py` and check again. If you are still having issues, [open up an issue](https://gitlab.com/beardog/Onionr/issues/new?issue[title]=Onionr UI not updating after compiling). \ No newline at end of file From ddb3ce1e35272a3cb5bff89103b2e783ee1a210a Mon Sep 17 00:00:00 2001 From: Arinerron Date: Mon, 30 Jul 2018 21:41:32 -0700 Subject: [PATCH 2/4] Various bug fixes --- onionr/api.py | 44 ++++++++++++++++++-------- onionr/communicator2.py | 8 +++-- onionr/netcontroller.py | 2 +- onionr/onionr.py | 4 +-- onionr/onionrevents.py | 4 +-- onionr/onionrexceptions.py | 1 + onionr/onionrutils.py | 16 +++++----- onionr/static-data/default_config.json | 12 +++++-- 8 files changed, 60 insertions(+), 31 deletions(-) diff --git a/onionr/api.py b/onionr/api.py index 705a4781..e9ecd475 100755 --- a/onionr/api.py +++ b/onionr/api.py @@ -24,7 +24,7 @@ from gevent.wsgi import WSGIServer import sys, random, threading, hmac, hashlib, base64, time, math, os, logger, config from core import Core from onionrblockapi import Block -import onionrutils, onionrcrypto, blockimporter +import onionrutils, onionrcrypto, blockimporter, onionrevents as events class API: ''' @@ -94,6 +94,7 @@ class API: ''' Simply define the request as not having yet failed, before every request. ''' + self.requestFailed = False return @@ -119,16 +120,24 @@ class API: @app.route('/client/ui/') def webUI(path): startTime = math.floor(time.time()) + if request.args.get('timingToken') is None: timingToken = '' else: timingToken = request.args.get('timingToken') - self.validateHost('private') + + if not config.get("onionr_ui.run", True): + abort(403) + if config.get("onionr_ui.private_only", True): + self.validateHost('private') + endTime = math.floor(time.time()) elapsed = endTime - startTime + if not hmac.compare_digest(timingToken, self.timeBypassToken): if elapsed < self._privateDelayTime: time.sleep(self._privateDelayTime - elapsed) + return send_from_directory('static-data/ui/dist/', path) @app.route('/client/') @@ -150,6 +159,9 @@ class API: if not self.validateToken(token): abort(403) + + events.event('webapi_private', onionr = None, data = {'action' : action, 'data' : data, 'timingToken' : timingToken, 'token' : token}) + self.validateHost('private') if action == 'hello': resp = Response('Hello, World! ' + request.host) @@ -198,12 +210,12 @@ class API: response['hash'] = hash response['reason'] = 'Successfully wrote block to file' else: - response['reason'] = 'Faield to save the block' + response['reason'] = 'Failed to save the block' except Exception as e: logger.debug('insertBlock api request failed', error = e) resp = Response(json.dumps(response)) - elif action in callbacks['private']: + elif action in API.callbacks['private']: resp = Response(str(getCallback(action, scope = 'private')(request))) else: resp = Response('(O_o) Dude what? (invalid command)') @@ -257,6 +269,10 @@ class API: data = data except: data = '' + + + events.event('webapi_public', onionr = None, data = {'action' : action, 'data' : data, 'requestingPeer' : requestingPeer, 'request' : request}) + if action == 'firstConnect': pass elif action == 'ping': @@ -299,7 +315,7 @@ class API: peers = self._core.listPeers(getPow=True) response = ','.join(peers) resp = Response(response) - elif action in callbacks['public']: + elif action in API.callbacks['public']: resp = Response(str(getCallback(action, scope = 'public')(request))) else: resp = Response("") @@ -373,29 +389,29 @@ class API: sys.exit(1) def setCallback(action, callback, scope = 'public'): - if not scope in callbacks: + if not scope in API.callbacks: return False - callbacks[scope][action] = callback + API.callbacks[scope][action] = callback return True def removeCallback(action, scope = 'public'): - if (not scope in callbacks) or (not action in callbacks[scope]): + if (not scope in API.callbacks) or (not action in API.callbacks[scope]): return False - del callbacks[scope][action] + del API.callbacks[scope][action] return True def getCallback(action, scope = 'public'): - if (not scope in callbacks) or (not action in callbacks[scope]): + if (not scope in API.callbacks) or (not action in API.callbacks[scope]): return None - return callbacks[scope][action] + return API.callbacks[scope][action] def getCallbacks(scope = None): - if (not scope is None) and (scope in callbacks): - return callbacks[scope] + if (not scope is None) and (scope in API.callbacks): + return API.callbacks[scope] - return callbacks + return API.callbacks diff --git a/onionr/communicator2.py b/onionr/communicator2.py index b420fcba..894ea094 100755 --- a/onionr/communicator2.py +++ b/onionr/communicator2.py @@ -19,8 +19,8 @@ You should have received a copy of the GNU General Public License along with this program. If not, see . ''' -import sys, os, core, config, json, onionrblockapi as block, requests, time, logger, threading, onionrplugins as plugins, base64, onionr -import onionrexceptions, onionrpeers +import sys, os, core, config, json, requests, time, logger, threading, base64, onionr +import onionrexceptions, onionrpeers, onionrevents as events, onionrplugins as plugins, onionrblockapi as block from defusedxml import minidom class OnionrCommunicatorDaemon: @@ -337,6 +337,8 @@ class OnionrCommunicatorDaemon: cmd = self._core.daemonQueue() if cmd is not False: + events.event('daemon_command', onionr = None, data = {'cmd' : cmd}) + if cmd[0] == 'shutdown': self.shutdown = True elif cmd[0] == 'announceNode': @@ -355,6 +357,7 @@ class OnionrCommunicatorDaemon: threading.Thread(target=self.uploadBlock).start() else: logger.info('Recieved daemonQueue command:' + cmd[0]) + self.decrementThreadCount('daemonCommands') def uploadBlock(self): @@ -401,6 +404,7 @@ class OnionrCommunicatorDaemon: time.sleep(1) else: # This executes if the api is NOT detected to be running + events.event('daemon_crash', onionr = None, data = {}) logger.error('Daemon detected API crash (or otherwise unable to reach API after long time), stopping...') self.shutdown = True self.decrementThreadCount('detectAPICrash') diff --git a/onionr/netcontroller.py b/onionr/netcontroller.py index 7ad74cc0..386c334b 100644 --- a/onionr/netcontroller.py +++ b/onionr/netcontroller.py @@ -100,7 +100,7 @@ DataDirectory data/tordata/ logger.fatal('Failed to start Tor. Try killing any other Tor processes owned by this user.') return False except KeyboardInterrupt: - logger.fatal("Got keyboard interrupt") + logger.fatal("Got keyboard interrupt.") return False logger.debug('Finished starting Tor.', timestamp=True) diff --git a/onionr/onionr.py b/onionr/onionr.py index ec3ec468..acf14374 100755 --- a/onionr/onionr.py +++ b/onionr/onionr.py @@ -40,9 +40,9 @@ except ImportError: raise Exception("You need the PySocks module (for use with socks5 proxy to use Tor)") ONIONR_TAGLINE = 'Anonymous P2P Platform - GPLv3 - https://Onionr.VoidNet.Tech' -ONIONR_VERSION = '0.1.0' # for debugging and stuff +ONIONR_VERSION = '0.1.1' # for debugging and stuff ONIONR_VERSION_TUPLE = tuple(ONIONR_VERSION.split('.')) # (MAJOR, MINOR, VERSION) -API_VERSION = '4' # increments of 1; only change when something fundemental about how the API works changes. This way other nodes knows how to communicate without learning too much information about you. +API_VERSION = '4' # increments of 1; only change when something fundemental about how the API works changes. This way other nodes know how to communicate without learning too much information about you. class Onionr: def __init__(self): diff --git a/onionr/onionrevents.py b/onionr/onionrevents.py index 9ecc552f..26fdc093 100644 --- a/onionr/onionrevents.py +++ b/onionr/onionrevents.py @@ -33,10 +33,10 @@ def __event_caller(event_name, data = {}, onionr = None): try: call(plugins.get_plugin(plugin), event_name, data, get_pluginapi(onionr, data)) except ModuleNotFoundError as e: - logger.warn('Disabling nonexistant plugin \"' + plugin + '\"...') + logger.warn('Disabling nonexistant plugin "%s"...' % plugin) plugins.disable(plugin, onionr, stop_event = False) except Exception as e: - logger.warn('Event \"' + event_name + '\" failed for plugin \"' + plugin + '\".') + logger.warn('Event "%s" failed for plugin "%s".' % (event_name, plugin)) logger.debug(str(e)) diff --git a/onionr/onionrexceptions.py b/onionr/onionrexceptions.py index d0a6d248..2817d419 100644 --- a/onionr/onionrexceptions.py +++ b/onionr/onionrexceptions.py @@ -49,5 +49,6 @@ class InvalidProof(Exception): # network level exceptions class MissingPort(Exception): pass + class InvalidAddress(Exception): pass diff --git a/onionr/onionrutils.py b/onionr/onionrutils.py index 2b6c6e5a..105519e9 100644 --- a/onionr/onionrutils.py +++ b/onionr/onionrutils.py @@ -199,7 +199,7 @@ class OnionrUtils: def getBlockMetadataFromData(self, blockData): ''' accepts block contents as string, returns a tuple of metadata, meta (meta being internal metadata, which will be returned as an encrypted base64 string if it is encrypted, dict if not). - + ''' meta = {} metadata = {} @@ -208,7 +208,7 @@ class OnionrUtils: blockData = blockData.encode() except AttributeError: pass - + try: metadata = json.loads(blockData[:blockData.find(b'\n')].decode()) except json.decoder.JSONDecodeError: @@ -221,7 +221,7 @@ class OnionrUtils: meta = json.loads(metadata['meta']) except KeyError: pass - meta = metadata['meta'] + meta = metadata['meta'] return (metadata, meta, data) def checkPort(self, port, host=''): @@ -251,7 +251,7 @@ class OnionrUtils: return False else: return True - + def processBlockMetadata(self, blockHash): ''' Read metadata from a block and cache it to the block database @@ -269,7 +269,7 @@ class OnionrUtils: def escapeAnsi(self, line): ''' Remove ANSI escape codes from a string with regex - + taken or adapted from: https://stackoverflow.com/a/38662876 ''' ansi_escape = re.compile(r'(\x9B|\x1B\[)[0-?]*[ -/]*[@-~]') @@ -331,12 +331,12 @@ class OnionrUtils: retVal = False return retVal - + def validateMetadata(self, metadata): '''Validate metadata meets onionr spec (does not validate proof value computation), take in either dictionary or json string''' # TODO, make this check sane sizes retData = False - + # convert to dict if it is json string if type(metadata) is str: try: @@ -382,7 +382,7 @@ class OnionrUtils: else: retVal = True return retVal - + def isIntegerString(self, data): '''Check if a string is a valid base10 integer''' try: diff --git a/onionr/static-data/default_config.json b/onionr/static-data/default_config.json index 3a08f7db..663bd732 100644 --- a/onionr/static-data/default_config.json +++ b/onionr/static-data/default_config.json @@ -2,8 +2,16 @@ "general" : { "dev_mode": true, "display_header" : true, - "dc_response": true, - "dc_execcallbacks" : true + + "direct_connect" : { + "respond" : true, + "execute_callbacks" : true + } + }, + + "onionr_ui" : { + "run" : true, + "private_only" : true }, "client" : { From 8e01063f94146ff1e1c93b297692109156099cdf Mon Sep 17 00:00:00 2001 From: Arinerron Date: Mon, 30 Jul 2018 21:52:48 -0700 Subject: [PATCH 3/4] Move to www --- onionr/api.py | 48 +++++++++++++++--- onionr/static-data/default_config.json | 16 ++++-- onionr/static-data/{ => www}/ui/README.md | 0 .../{ => www}/ui/common/footer.html | 0 .../{ => www}/ui/common/header.html | 0 .../ui/common/onionr-timeline-post.html | 0 onionr/static-data/{ => www}/ui/compile.py | 0 onionr/static-data/{ => www}/ui/config.json | 0 .../{ => www}/ui/dist/css/main.css | 0 .../{ => www}/ui/dist/css/themes/dark.css | 0 .../{ => www}/ui/dist/img/default.png | Bin .../static-data/{ => www}/ui/dist/index.html | 0 .../static-data/{ => www}/ui/dist/js/main.js | 0 .../{ => www}/ui/dist/js/timeline.js | 0 onionr/static-data/{ => www}/ui/lang.json | 0 .../static-data/{ => www}/ui/src/css/main.css | 0 .../{ => www}/ui/src/css/themes/dark.css | 0 .../{ => www}/ui/src/img/default.png | Bin .../static-data/{ => www}/ui/src/index.html | 0 .../static-data/{ => www}/ui/src/js/main.js | 0 .../{ => www}/ui/src/js/timeline.js | 0 21 files changed, 54 insertions(+), 10 deletions(-) rename onionr/static-data/{ => www}/ui/README.md (100%) rename onionr/static-data/{ => www}/ui/common/footer.html (100%) rename onionr/static-data/{ => www}/ui/common/header.html (100%) rename onionr/static-data/{ => www}/ui/common/onionr-timeline-post.html (100%) rename onionr/static-data/{ => www}/ui/compile.py (100%) rename onionr/static-data/{ => www}/ui/config.json (100%) rename onionr/static-data/{ => www}/ui/dist/css/main.css (100%) rename onionr/static-data/{ => www}/ui/dist/css/themes/dark.css (100%) rename onionr/static-data/{ => www}/ui/dist/img/default.png (100%) rename onionr/static-data/{ => www}/ui/dist/index.html (100%) rename onionr/static-data/{ => www}/ui/dist/js/main.js (100%) rename onionr/static-data/{ => www}/ui/dist/js/timeline.js (100%) rename onionr/static-data/{ => www}/ui/lang.json (100%) rename onionr/static-data/{ => www}/ui/src/css/main.css (100%) rename onionr/static-data/{ => www}/ui/src/css/themes/dark.css (100%) rename onionr/static-data/{ => www}/ui/src/img/default.png (100%) rename onionr/static-data/{ => www}/ui/src/index.html (100%) rename onionr/static-data/{ => www}/ui/src/js/main.js (100%) rename onionr/static-data/{ => www}/ui/src/js/timeline.js (100%) diff --git a/onionr/api.py b/onionr/api.py index e9ecd475..4da9364c 100755 --- a/onionr/api.py +++ b/onionr/api.py @@ -117,8 +117,8 @@ class API: return resp - @app.route('/client/ui/') - def webUI(path): + @app.route('/www/private/') + def www_private(path): startTime = math.floor(time.time()) if request.args.get('timingToken') is None: @@ -126,10 +126,10 @@ class API: else: timingToken = request.args.get('timingToken') - if not config.get("onionr_ui.run", True): + if not config.get("www.private.run", True): abort(403) - if config.get("onionr_ui.private_only", True): - self.validateHost('private') + + self.validateHost('private') endTime = math.floor(time.time()) elapsed = endTime - startTime @@ -138,7 +138,42 @@ class API: if elapsed < self._privateDelayTime: time.sleep(self._privateDelayTime - elapsed) - return send_from_directory('static-data/ui/dist/', path) + return send_from_directory('static-data/www/private/', path) + + @app.route('/www/public/') + def www_public(path): + if not config.get("www.public.run", True): + abort(403) + + self.validateHost('public') + + return send_from_directory('static-data/www/public/', path) + + @app.route('/www/ui/') + def ui_private(path): + startTime = math.floor(time.time()) + + if request.args.get('timingToken') is None: + timingToken = '' + else: + timingToken = request.args.get('timingToken') + + if not config.get("www.ui.run", True): + abort(403) + + if config.get("www.ui.private", True): + self.validateHost('private') + else: + self.validateHost('public') + + endTime = math.floor(time.time()) + elapsed = endTime - startTime + + if not hmac.compare_digest(timingToken, self.timeBypassToken): + if elapsed < self._privateDelayTime: + time.sleep(self._privateDelayTime - elapsed) + + return send_from_directory('static-data/www/ui/dist/', path) @app.route('/client/') def private_handler(): @@ -270,7 +305,6 @@ class API: except: data = '' - events.event('webapi_public', onionr = None, data = {'action' : action, 'data' : data, 'requestingPeer' : requestingPeer, 'request' : request}) if action == 'firstConnect': diff --git a/onionr/static-data/default_config.json b/onionr/static-data/default_config.json index 663bd732..04c00835 100644 --- a/onionr/static-data/default_config.json +++ b/onionr/static-data/default_config.json @@ -9,9 +9,19 @@ } }, - "onionr_ui" : { - "run" : true, - "private_only" : true + "www" : { + "public" : { + "run" : true + }, + + "private" : { + "run" : true + }, + + "ui" : { + "run" : true, + "private" : true + } }, "client" : { diff --git a/onionr/static-data/ui/README.md b/onionr/static-data/www/ui/README.md similarity index 100% rename from onionr/static-data/ui/README.md rename to onionr/static-data/www/ui/README.md diff --git a/onionr/static-data/ui/common/footer.html b/onionr/static-data/www/ui/common/footer.html similarity index 100% rename from onionr/static-data/ui/common/footer.html rename to onionr/static-data/www/ui/common/footer.html diff --git a/onionr/static-data/ui/common/header.html b/onionr/static-data/www/ui/common/header.html similarity index 100% rename from onionr/static-data/ui/common/header.html rename to onionr/static-data/www/ui/common/header.html diff --git a/onionr/static-data/ui/common/onionr-timeline-post.html b/onionr/static-data/www/ui/common/onionr-timeline-post.html similarity index 100% rename from onionr/static-data/ui/common/onionr-timeline-post.html rename to onionr/static-data/www/ui/common/onionr-timeline-post.html diff --git a/onionr/static-data/ui/compile.py b/onionr/static-data/www/ui/compile.py similarity index 100% rename from onionr/static-data/ui/compile.py rename to onionr/static-data/www/ui/compile.py diff --git a/onionr/static-data/ui/config.json b/onionr/static-data/www/ui/config.json similarity index 100% rename from onionr/static-data/ui/config.json rename to onionr/static-data/www/ui/config.json diff --git a/onionr/static-data/ui/dist/css/main.css b/onionr/static-data/www/ui/dist/css/main.css similarity index 100% rename from onionr/static-data/ui/dist/css/main.css rename to onionr/static-data/www/ui/dist/css/main.css diff --git a/onionr/static-data/ui/dist/css/themes/dark.css b/onionr/static-data/www/ui/dist/css/themes/dark.css similarity index 100% rename from onionr/static-data/ui/dist/css/themes/dark.css rename to onionr/static-data/www/ui/dist/css/themes/dark.css diff --git a/onionr/static-data/ui/dist/img/default.png b/onionr/static-data/www/ui/dist/img/default.png similarity index 100% rename from onionr/static-data/ui/dist/img/default.png rename to onionr/static-data/www/ui/dist/img/default.png diff --git a/onionr/static-data/ui/dist/index.html b/onionr/static-data/www/ui/dist/index.html similarity index 100% rename from onionr/static-data/ui/dist/index.html rename to onionr/static-data/www/ui/dist/index.html diff --git a/onionr/static-data/ui/dist/js/main.js b/onionr/static-data/www/ui/dist/js/main.js similarity index 100% rename from onionr/static-data/ui/dist/js/main.js rename to onionr/static-data/www/ui/dist/js/main.js diff --git a/onionr/static-data/ui/dist/js/timeline.js b/onionr/static-data/www/ui/dist/js/timeline.js similarity index 100% rename from onionr/static-data/ui/dist/js/timeline.js rename to onionr/static-data/www/ui/dist/js/timeline.js diff --git a/onionr/static-data/ui/lang.json b/onionr/static-data/www/ui/lang.json similarity index 100% rename from onionr/static-data/ui/lang.json rename to onionr/static-data/www/ui/lang.json diff --git a/onionr/static-data/ui/src/css/main.css b/onionr/static-data/www/ui/src/css/main.css similarity index 100% rename from onionr/static-data/ui/src/css/main.css rename to onionr/static-data/www/ui/src/css/main.css diff --git a/onionr/static-data/ui/src/css/themes/dark.css b/onionr/static-data/www/ui/src/css/themes/dark.css similarity index 100% rename from onionr/static-data/ui/src/css/themes/dark.css rename to onionr/static-data/www/ui/src/css/themes/dark.css diff --git a/onionr/static-data/ui/src/img/default.png b/onionr/static-data/www/ui/src/img/default.png similarity index 100% rename from onionr/static-data/ui/src/img/default.png rename to onionr/static-data/www/ui/src/img/default.png diff --git a/onionr/static-data/ui/src/index.html b/onionr/static-data/www/ui/src/index.html similarity index 100% rename from onionr/static-data/ui/src/index.html rename to onionr/static-data/www/ui/src/index.html diff --git a/onionr/static-data/ui/src/js/main.js b/onionr/static-data/www/ui/src/js/main.js similarity index 100% rename from onionr/static-data/ui/src/js/main.js rename to onionr/static-data/www/ui/src/js/main.js diff --git a/onionr/static-data/ui/src/js/timeline.js b/onionr/static-data/www/ui/src/js/timeline.js similarity index 100% rename from onionr/static-data/ui/src/js/timeline.js rename to onionr/static-data/www/ui/src/js/timeline.js From ce8800652de90f35f6eef3758ece4c46479e7aec Mon Sep 17 00:00:00 2001 From: Arinerron Date: Mon, 30 Jul 2018 22:02:01 -0700 Subject: [PATCH 4/4] www/ui/ -> ui/ --- onionr/api.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/onionr/api.py b/onionr/api.py index 4da9364c..ccfc39db 100755 --- a/onionr/api.py +++ b/onionr/api.py @@ -149,7 +149,7 @@ class API: return send_from_directory('static-data/www/public/', path) - @app.route('/www/ui/') + @app.route('/ui/') def ui_private(path): startTime = math.floor(time.time())