master <- easy-releases

onionr/config.py

@@ -20,6 +20,7 @@
 
 import os, json, logger
 from utils import identifyhome
+
 # set data dir
 dataDir = identifyhome.identify_home()
 

onionr/core.py

@@ -458,4 +458,4 @@ class Core:
             self.daemonQueueAdd('announceNode')
             logger.info('Introduction command will be processed.', terminal=True)
         else:
-            logger.warn('No running node detected. Cannot introduce.', terminal=True)
+            logger.warn('No running node detected. Cannot introduce.', terminal=True)

onionr/logger.py

@@ -0,0 +1,250 @@
+'''
+    Onionr - P2P Microblogging Platform & Social network
+
+    This file handles all operations involving logging
+'''
+'''
+    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 <https://www.gnu.org/licenses/>.
+'''
+
+import re, sys, time, traceback, os
+
+class colors:
+    '''
+        This class allows you to set the color if ANSI codes are supported
+    '''
+    reset='\033[0m'
+    bold='\033[01m'
+    disable='\033[02m'
+    underline='\033[04m'
+    reverse='\033[07m'
+    strikethrough='\033[09m'
+    invisible='\033[08m'
+    italics='\033[3m'
+    class fg:
+        black='\033[30m'
+        red='\033[31m'
+        green='\033[32m'
+        orange='\033[33m'
+        blue='\033[34m'
+        purple='\033[35m'
+        cyan='\033[36m'
+        lightgrey='\033[37m'
+        darkgrey='\033[90m'
+        lightred='\033[91m'
+        lightgreen='\033[92m'
+        yellow='\033[93m'
+        lightblue='\033[94m'
+        pink='\033[95m'
+        lightcyan='\033[96m'
+    class bg:
+        black='\033[40m'
+        red='\033[41m'
+        green='\033[42m'
+        orange='\033[43m'
+        blue='\033[44m'
+        purple='\033[45m'
+        cyan='\033[46m'
+        lightgrey='\033[47m'
+    @staticmethod
+    def filter(data):
+        return re.compile(r'\x1B\[[0-?]*[ -/]*[@-~]').sub('', str(data))
+
+'''
+    Use the bitwise operators to merge these settings
+'''
+USE_ANSI = 0b100
+if os.name == 'nt':
+    USE_ANSI = 0b000
+OUTPUT_TO_CONSOLE = 0b010
+OUTPUT_TO_FILE = 0b001
+
+LEVEL_DEBUG = 1
+LEVEL_INFO = 2
+LEVEL_WARN = 3
+LEVEL_ERROR = 4
+LEVEL_FATAL = 5
+LEVEL_IMPORTANT = 6
+
+_type = OUTPUT_TO_CONSOLE | USE_ANSI # the default settings for logging
+_level = LEVEL_DEBUG # the lowest level to log
+_outputfile = 'data/onionr.log' # the file to log to
+
+def set_settings(type):
+    '''
+        Set the settings for the logger using bitwise operators
+    '''
+
+    global _type
+    _type = type
+
+def get_settings():
+    '''
+        Get settings from the logger
+    '''
+
+    return _type
+
+def set_level(level):
+    '''
+        Set the lowest log level to output
+    '''
+
+    global _level
+    _level = level
+
+def get_level():
+    '''
+        Get the lowest log level currently being outputted
+    '''
+
+    return _level
+
+def set_file(outputfile):
+    '''
+        Set the file to output to, if enabled
+    '''
+
+    global _outputfile
+    _outputfile = outputfile
+
+def get_file():
+    '''
+        Get the file to output to
+    '''
+
+    return _outputfile
+
+def raw(data, fd = sys.stdout, sensitive = False):
+    '''
+        Outputs raw data to console without formatting
+    '''
+
+    if get_settings() & OUTPUT_TO_CONSOLE:
+        ts = fd.write('%s\n' % data)
+    if get_settings() & OUTPUT_TO_FILE and not sensitive:
+        try:
+            with open(_outputfile, "a+") as f:
+                f.write(colors.filter(data) + '\n')
+        except OSError:
+            pass
+
+def log(prefix, data, color = '', timestamp=True, fd = sys.stdout, prompt = True, sensitive = False):
+    '''
+        Logs the data
+        prefix : The prefix to the output
+        data   : The actual data to output
+        color  : The color to output before the data
+    '''
+    curTime = ''
+    if timestamp:
+        curTime = time.strftime("%m-%d %H:%M:%S") + ' '
+
+    output = colors.reset + str(color) + ('[' + colors.bold + str(prefix) + colors.reset + str(color) + '] ' if prompt is True else '') + curTime + str(data) + colors.reset
+    if not get_settings() & USE_ANSI:
+        output = colors.filter(output)
+
+    raw(output, fd = fd, sensitive = sensitive)
+
+def readline(message = ''):
+    '''
+        Takes in input from the console, not stored in logs
+        message: The message to display before taking input
+    '''
+
+    color = colors.fg.green + colors.bold
+    output = colors.reset + str(color) + '... ' + colors.reset + str(message) + colors.reset
+
+    if not get_settings() & USE_ANSI:
+        output = colors.filter(output)
+
+    sys.stdout.write(output)
+
+    return input()
+
+def confirm(default = 'y', message = 'Are you sure %s? '):
+    '''
+        Displays an "Are you sure" message, returns True for Y and False for N
+        message: The confirmation message, use %s for (y/n)
+        default: which to prefer-- y or n
+    '''
+
+    color = colors.fg.green + colors.bold
+
+    default = default.lower()
+    confirm = colors.bold
+    if default.startswith('y'):
+        confirm += '(Y/n)'
+    else:
+        confirm += '(y/N)'
+    confirm += colors.reset + color
+
+    output = colors.reset + str(color) + '... ' + colors.reset + str(message) + colors.reset
+
+    if not get_settings() & USE_ANSI:
+        output = colors.filter(output)
+
+    sys.stdout.write(output.replace('%s', confirm))
+
+    inp = input().lower()
+
+    if 'y' in inp:
+        return True
+    if 'n' in inp:
+        return False
+    else:
+        return default == 'y'
+
+# debug: when there is info that could be useful for debugging purposes only
+def debug(data, error = None, timestamp = True, prompt = True, sensitive = False, level = LEVEL_DEBUG):
+    if get_level() <= level:
+        log('/', data, timestamp = timestamp, prompt = prompt, sensitive = sensitive)
+    if not error is None:
+        debug('Error: ' + str(error) + parse_error())
+
+# info: when there is something to notify the user of, such as the success of a process
+def info(data, timestamp = False, prompt = True, sensitive = False, level = LEVEL_INFO):
+    if get_level() <= level:
+        log('+', data, colors.fg.green, timestamp = timestamp, prompt = prompt, sensitive = sensitive)
+
+# warn: when there is a potential for something bad to happen
+def warn(data, error = None, timestamp = True, prompt = True, sensitive = False, level = LEVEL_WARN):
+    if not error is None:
+        debug('Error: ' + str(error) + parse_error())
+    if get_level() <= level:
+        log('!', data, colors.fg.orange, timestamp = timestamp, prompt = prompt, sensitive = sensitive)
+
+# error: when only one function, module, or process of the program encountered a problem and must stop
+def error(data, error = None, timestamp = True, prompt = True, sensitive = False, level = LEVEL_ERROR):
+    if get_level() <= level:
+        log('-', data, colors.fg.red, timestamp = timestamp, fd = sys.stderr, prompt = prompt, sensitive = sensitive)
+    if not error is None:
+        debug('Error: ' + str(error) + parse_error())
+
+# fatal: when the something so bad has happened that the program must stop
+def fatal(data, error = None, timestamp=True, prompt = True, sensitive = False, level = LEVEL_FATAL):
+    if not error is None:
+        debug('Error: ' + str(error) + parse_error(), sensitive = sensitive)
+    if get_level() <= level:
+        log('#', data, colors.bg.red + colors.fg.green + colors.bold, timestamp = timestamp, fd = sys.stderr, prompt = prompt, sensitive = sensitive)
+
+# returns a formatted error message
+def parse_error():
+    details = traceback.extract_tb(sys.exc_info()[2])
+    output = ''
+
+    for line in details:
+        output += '\n    ... module %s in  %s:%i' % (line[2], line[0], line[1])
+
+    return output

onionr/netcontroller/netcontrol.py

@@ -133,6 +133,7 @@ HiddenServicePort 80 ''' + self.apiServerIP + ''':''' + str(self.hsPort)
             return False
 
         logger.info('Finished starting Tor.', terminal=True)
+
         self.readyState = True
 
         try:

onionr/onionr.py

@@ -157,6 +157,12 @@ class Onionr:
         else:
             self.header(None)
 
+    def cmdHeader(self):
+        if len(sys.argv) >= 3:
+            self.header(logger.colors.fg.pink + sys.argv[2].replace('Onionr', logger.colors.bold + 'Onionr' + logger.colors.reset + logger.colors.fg.pink))
+        else:
+            self.header(None)
+
     def header(self, message = logger.colors.fg.pink + logger.colors.bold + 'Onionr' + logger.colors.reset + logger.colors.fg.pink + ' has started.'):
         if os.path.exists('static-data/header.txt') and logger.get_level() <= logger.LEVEL_INFO:
             with open('static-data/header.txt', 'rb') as file:
@@ -166,6 +172,17 @@ class Onionr:
                 if not message is None:
                     logger.info(logger.colors.fg.lightgreen + '-> ' + str(message) + logger.colors.reset + logger.colors.fg.lightgreen + ' <-\n', terminal=True)
 
+    def doExport(self, bHash):
+        exportDir = self.dataDir + 'block-export/'
+        if not os.path.exists(exportDir):
+            if os.path.exists(self.dataDir):
+                os.mkdir(exportDir)
+            else:
+                logger.error('Onionr Not initialized')
+        data = onionrstorage.getData(self.onionrCore, bHash)
+        with open('%s/%s.dat' % (exportDir, bHash), 'wb') as exportFile:
+            exportFile.write(data)
+
     def deleteRunFiles(self):
         try:
             os.remove(self.onionrCore.publicApiHostFile)
@@ -299,6 +316,7 @@ class Onionr:
             function(ONIONR_TAGLINE, terminal=True)
         if verbosity >= 2:
             function('Running on %s %s' % (platform.platform(), platform.release()), terminal=True)
+            function('Onionr data dir: %s' % self.dataDir)
 
     def doPEX(self):
         '''make communicator do pex'''

onionr/onionrcommands/__init__.py

@@ -164,4 +164,4 @@ cmd_help = {
     'change-id': 'Change active ID',
     'open-home': 'Open your node\'s home/info screen',
     'reset-tor': 'Delete the Tor data directory. Only do this if Tor never starts.'
-        }
+}

onionr/onionrcommands/onionrstatistics.py

@@ -109,7 +109,7 @@ def show_peers(o_inst):
                     if peers == 'none':
                         print('No current outgoing connections.')
                     else:
-                        print(peers)
+                        logger.info('Peers: %s' % peers)
                 else:
-                    print('Daemon probably not running. Unable to list connected peers.')
-                break
+                    logger.warn('Daemon probably not running. Unable to list connected peers.')
+                break

onionr/onionrplugins.py

@@ -20,6 +20,7 @@
 import os, re, importlib
 import onionrevents as events, config, logger
 from utils import identifyhome
+
 # set data dir
 dataDir = identifyhome.identify_home()
 
@@ -67,9 +68,10 @@ def enable(name, onionr = None, start_event = True):
         if not name in enabled_plugins:
             try:
                 events.call(get_plugin(name), 'enable', onionr)
-            except ImportError: # Was getting import error on Gitlab CI test "data"
+            except ImportError as e: # Was getting import error on Gitlab CI test "data"
                 # NOTE: If you are experiencing issues with plugins not being enabled, it might be this resulting from an error in the module
                 # can happen inconsistently (especially between versions)
+                logger.debug('Failed to enable module; Import error: %s' % e)
                 return False
             else:
                 enabled_plugins.append(name)
@@ -82,6 +84,7 @@ def enable(name, onionr = None, start_event = True):
             return False
     else:
         logger.error('Failed to enable plugin \"%s\", disabling plugin.' % name, terminal=True)
+        logger.debug('Plugins folder not found: %s' % get_plugins_folder(str(name).lower()))
         disable(name)
 
         return False
@@ -169,6 +172,7 @@ def import_module_from_file(full_path_to_module):
     module_name, module_ext = os.path.splitext(module_file)
 
     module_name = module_dir # Module name must be unique otherwise it will get written in other imports
+    
     # Get module "spec" from filename
     spec = importlib.util.spec_from_file_location(module_name,full_path_to_module)
 

onionr/static-data/default-plugins/cliui/main.py

@@ -81,12 +81,12 @@ class OnionrCLIUI:
                 if self.flow_enabled:
                     self.subCommand("flow")
                 else:
-                    print('Plugin not enabled')
+                    logger.warn('flow plugin is not enabled')
             elif choice in ("2", "mail"):
                 if self.mail_enabled:
                     self.subCommand("mail")
                 else:
-                    print('Plugin not enabled')
+                    logger.warn('mail plugin not enabled')
             elif choice in ("3", "file sharing", "file"):
                 try:
                     filename = input("Enter full path to file: ").strip()