split const and logger from main

pialert/__init__.py

@@ -0,0 +1 @@
+""" __init__ for Pi.Alert """

pialert/const.py

@@ -0,0 +1,21 @@
+""" CONSTANTS for Pi.Alert """
+
+#===============================================================================
+# PATHS
+#===============================================================================
+# pialertPath = '/home/pi/pialert'
+pialertPath ='/home/roland/repos/Pi.Alert'
+
+confPath = "/config/pialert.conf"
+dbPath = '/db/pialert.db'
+
+
+pluginsPath  = pialertPath + '/front/plugins'
+logPath      = pialertPath + '/front/log'
+fullConfPath = pialertPath + confPath
+fullDbPath   = pialertPath + dbPath
+fullPholusPath = pialertPath+'/pholus/pholus3.py'
+
+vendorsDB              = '/usr/share/arp-scan/ieee-oui.txt'
+piholeDB               = '/etc/pihole/pihole-FTL.db'
+piholeDhcpleases       = '/etc/pihole/dhcp.leases'

pialert/helper.py

@@ -0,0 +1,67 @@
+""" Colection of generic functions to support Pi.Alert """
+import datetime
+import os
+import subprocess
+
+from const import *
+from logger import mylog
+
+#-------------------------------------------------------------------------------
+def timeNow():
+    return datetime.datetime.now().replace(microsecond=0)
+
+#-------------------------------------------------------------------------------
+def updateSubnets(SCAN_SUBNETS):
+
+    #  remove old list
+    userSubnets = []  
+
+    # multiple interfaces
+    if type(SCAN_SUBNETS) is list:        
+        for interface in SCAN_SUBNETS :            
+            userSubnets.append(interface)
+    # one interface only
+    else:        
+        userSubnets.append(SCAN_SUBNETS)    
+
+
+
+#-------------------------------------------------------------------------------
+# check RW access of DB and config file
+def checkPermissionsOK():
+    global confR_access, confW_access, dbR_access, dbW_access
+    
+    confR_access = (os.access(fullConfPath, os.R_OK))
+    confW_access = (os.access(fullConfPath, os.W_OK))
+    dbR_access = (os.access(fullDbPath, os.R_OK))
+    dbW_access = (os.access(fullDbPath, os.W_OK))
+
+
+    mylog('none', ['\n Permissions check (All should be True)'])
+    mylog('none', ['------------------------------------------------'])
+    mylog('none', [ "  " , confPath ,     " | " , " READ  | " , confR_access])
+    mylog('none', [ "  " , confPath ,     " | " , " WRITE | " , confW_access])
+    mylog('none', [ "  " , dbPath , "       | " , " READ  | " , dbR_access])
+    mylog('none', [ "  " , dbPath , "       | " , " WRITE | " , dbW_access])
+    mylog('none', ['------------------------------------------------'])
+
+    #return dbR_access and dbW_access and confR_access and confW_access 
+    return (confR_access, dbR_access) 
+#-------------------------------------------------------------------------------
+def fixPermissions():
+    # Try fixing access rights if needed
+    chmodCommands = []
+    
+    chmodCommands.append(['sudo', 'chmod', 'a+rw', '-R', fullDbPath])    
+    chmodCommands.append(['sudo', 'chmod', 'a+rw', '-R', fullConfPath])
+
+    for com in chmodCommands:
+        # Execute command
+        mylog('none', ["[Setup] Attempting to fix permissions."])
+        try:
+            # try runnning a subprocess
+            result = subprocess.check_output (com, universal_newlines=True)
+        except subprocess.CalledProcessError as e:
+            # An error occured, handle it
+            mylog('none', ["[Setup] Fix Failed. Execute this command manually inside of the container: ", ' '.join(com)]) 
+            mylog('none', [e.output])

pialert/logger.py

@@ -0,0 +1,78 @@
+""" Colection of functions to support all logging for Pi.Alert """
+
+import datetime
+from const import *
+
+#-------------------------------------------------------------------------------
+debugLevels =   [
+                    ('none', 0), ('minimal', 1), ('verbose', 2), ('debug', 3)
+                ]
+LOG_LEVEL = 'debug'
+
+def mylog(requestedDebugLevel, n):
+
+    setLvl = 0  
+    reqLvl = 0  
+
+    #  Get debug urgency/relative weight
+    for lvl in debugLevels:
+        if LOG_LEVEL == lvl[0]:
+            setLvl = lvl[1]
+        if requestedDebugLevel == lvl[0]:
+            reqLvl = lvl[1]
+
+    if reqLvl <= setLvl:
+        file_print (*n)
+
+#-------------------------------------------------------------------------------
+def file_print (*args):
+
+    result = ''    
+       
+    for arg in args:                
+        result += str(arg)
+    print(result)
+
+    file = open(logPath + "/pialert.log", "a") 
+    file.write(result + '\n')
+    file.close()
+
+#-------------------------------------------------------------------------------
+def print_log (pText):
+    global log_timestamp
+
+    # Check LOG actived
+    if not LOG_LEVEL == 'debug' :
+        return
+
+    # Current Time    
+    log_timestamp2 = datetime.datetime.now().replace(microsecond=0)
+
+    # Print line + time + elapsed time + text
+    file_print ('[LOG_LEVEL=debug] ',
+        # log_timestamp2, ' ',
+        log_timestamp2.strftime ('%H:%M:%S'), ' ',
+        pText)
+    
+
+    # Save current time to calculate elapsed time until next log
+    log_timestamp = log_timestamp2 
+
+    return pText
+
+
+
+#-------------------------------------------------------------------------------
+def append_file_binary (pPath, input):    
+    file = open (pPath, 'ab') 
+    file.write (input) 
+    file.close() 
+
+
+#-------------------------------------------------------------------------------
+def logResult (stdout, stderr):
+    if stderr != None:
+        append_file_binary (logPath + '/stderr.log', stderr)
+    if stdout != None:
+        append_file_binary (logPath + '/stdout.log', stdout)  
+