p3lib 1.1.80__py3-none-any.whl → 1.1.82__py3-none-any.whl

p3lib/bokeh_auth.py

@@ -149,10 +149,16 @@ class LoginHandler(RequestHandler):
         self._recordLoginAttempt(username, password)
         valid = False
         credentialsJsonFile = GetCredentialsFile()
+        LoginHandler.SaveInfoAccessLogMessage(f"credentialsJsonFile = {credentialsJsonFile}")
+        fileExists = os.path.isfile(credentialsJsonFile)
+        LoginHandler.SaveInfoAccessLogMessage(f"fileExists = {fileExists}")
         ch = CredentialsHasher(credentialsJsonFile)
-        if ch.verify(username, password):
+        verified = ch.verify(username, password)
+        LoginHandler.SaveInfoAccessLogMessage(f"verified = {verified}")
+        if verified:
             valid = True
             self._recordLoginSuccess(username, password)
+        LoginHandler.SaveInfoAccessLogMessage(f"check_permission(): valid = {valid}")
         return valid
 
     def post(self):

p3lib/boot_manager.py

@@ -13,8 +13,65 @@ class BootManager(object):
        Currently supports the following platforms
        Linux"""
 
-    LINUX_OS_NAME = "Linux"
+    LINUX_OS_NAME       = "Linux"
+    ENABLE_CMD_OPT      = "--enable_auto_start"
+    DISABLE_CMD_OPT     = "--disable_auto_start"
+    CHECK_CMD_OPT       = "--check_auto_start"
 
+    @staticmethod
+    def AddCmdArgs(parser):
+        """@brief Add cmd line arguments to enable, disable and show the systemd boot state.
+           @param parser An instance of argparse.ArgumentParser."""
+        parser.add_argument(BootManager.ENABLE_CMD_OPT,  help="Auto start when this computer starts.", action="store_true", default=False)
+        parser.add_argument(BootManager.DISABLE_CMD_OPT, help="Disable auto starting when this computer starts.", action="store_true", default=False)
+        parser.add_argument(BootManager.CHECK_CMD_OPT,   help="Check the status of an auto started icons_gw instance.", action="store_true", default=False)
+
+    @staticmethod
+    def HandleOptions(uio, options, enable_syslog):
+        """@brief Handle one of the bot manager command line options if the 
+                  user passed it on the cmd line.
+           @param uio A UIO instance.
+           @param options As returned from parser.parse_args() where parser 
+                          is an instance of argparse.ArgumentParser.
+           @param enable_syslog True to enable systemd syslog output.
+           @return True if handled , False if not."""
+        handled = False
+        if options.check_auto_start:
+            BootManager.CheckAutoStartStatus(uio)
+            handled = True
+            
+        elif options.enable_auto_start:
+            BootManager.EnableAutoStart(uio, enable_syslog)
+            handled = True
+            
+        elif options.disable_auto_start:
+            BootManager.DisableAutoStart(uio)
+            handled = True
+
+        return handled
+
+    @staticmethod
+    def EnableAutoStart(uio, enable_syslog):
+        """@brief Enable this program to auto start when the computer on which it is installed starts."""
+        bootManager = BootManager(uio=uio, ensureRootUser=True)
+        arsString = " ".join(sys.argv)
+        bootManager.add(argString=arsString, enableSyslog=enable_syslog)
+
+    @staticmethod
+    def DisableAutoStart(uio):
+        """@brief Enable this program to auto start when the computer on which it is installed starts."""
+        bootManager = BootManager(uio=uio, ensureRootUser=True)
+        bootManager.remove()
+        
+    @staticmethod
+    def CheckAutoStartStatus(uio):
+        """@brief Check the status of a process previously set to auto start."""
+        bootManager = BootManager(uio=uio)
+        lines = bootManager.getStatus()
+        if lines and len(lines) > 0:
+            for line in lines:
+                uio.info(line)
+        
     def __init__(self, uio=None, allowRootUser=True, ensureRootUser=False):
         """@brief Constructor
            @param uio A UIO instance to display user output. If unset then no output
@@ -130,41 +187,14 @@ class LinuxBootManager(object):
                   named the same as the python file executed without the .py suffix.
            @return The startup script file (absolute path)."""""
         startupScript=None
-        pythonFile = sys.argv[0] # The python file executed at program startup
-        if pythonFile.startswith("./"):
-            pythonFile=pythonFile[2:]
-            
-        envPaths = self._getPaths()
-
-        # Search first for a file that does not have the .py suffix as 
-        # this may be installed via a deb/rpm installation.
-        exeFile=os.path.basename( pythonFile.replace(".py", "") )
-        if envPaths and len(envPaths) > 0:
-            for envPath in envPaths:
-                _exeStartupScript = os.path.join(envPath, exeFile)
-                if os.path.isfile(_exeStartupScript):
-                    startupScript=_exeStartupScript
-                    break 
-
-        # If the script file has not been found then search for a file with 
-        # the .py suffix.       
-        if not startupScript:
-            if envPaths and len(envPaths) > 0:
-                for envPath in envPaths:
-                    _startupScript = os.path.join(envPath, pythonFile)
-                    if os.path.isfile(_startupScript):
-                        startupScript=_startupScript
-                        break     
-                      
-        if not startupScript:
-            paths = self._getPaths()
-            if len(paths):
-                for _path in paths:
-                    self._info(_path)
-                self._fatalError("{} startup script not found using the PATH env var".format(pythonFile) )
-            else:
-                self._fatalError("No PATH env var found.")
-
+        argList = sys.argv
+        # If the first argument in the arg is a file.
+        if len(argList) > 0:
+            firstArg = argList[0]
+            if os.path.isfile(firstArg) or os.path.islink(firstArg):
+                startupScript = firstArg
+        if startupScript is None:
+            raise Exception("Failed to find the startup script.")
         return startupScript
 
     def _getPaths(self):
@@ -287,6 +317,13 @@ class LinuxBootManager(object):
         if user and len(user) > 0:
             lines.append('Environment="HOME=/home/{}"'.format(user))
         if argString:
+            argString = argString.strip()
+            if argString.startswith(absApp):
+                argString=argString.replace(absApp, "")
+            # We don't want the enable cmd opt in the cmd we add to the systemd file.
+            if argString.find(BootManager.ENABLE_CMD_OPT):
+                argString = argString.replace(BootManager.ENABLE_CMD_OPT, "")
+            argString = argString.strip()
             lines.append("ExecStart={} {}".format(absApp, argString))
         else:
             lines.append("ExecStart={}".format(absApp))
@@ -299,6 +336,7 @@ class LinuxBootManager(object):
             fd = open(serviceFile, 'w')
             fd.write( "\n".join(lines) )
             fd.close()
+            self._info(f"Created {serviceFile}")
         except IOError:
             self._fatalError("Failed to create {}".format(serviceFile) )
 

p3lib/pconfig.py

@@ -1,4 +1,4 @@
-#!/bin/sh/env python3d
+#!/bin/sh/env python3
 
 import  os
 import  base64
@@ -6,6 +6,7 @@ import  datetime
 import  sys
 import  json
 import  copy
+import  platform
 
 from    shutil import copyfile
 
@@ -313,31 +314,28 @@ class ConfigManager(object):
         if not cfgFilename:
             raise Exception("No config filename defined.")
 
-        cfgFilename = cfgFilename
         if addDotToFilename:
             if not cfgFilename.startswith("."):
 
                 cfgFilename=".%s" % (cfgFilename)
 
-            else:
-
-                cfgFilename=cfgFilename
-
         #The the config path has been set then use it
         if cfgPath:
             configPath = cfgPath
 
         else:
-            configPath=""
-            #If an absolute path is set for the config file then don't try to
-            #put the file in the users home dir
-            if not cfgFilename.startswith("/"):
-                configPath = expanduser("~")
-                configPath = configPath.strip()
-                #If no user is known then default to root user.
-                #This occurs on Omega2 startup apps.
-                if len(configPath) == 0 or configPath == '/' or configPath == '/root':
-                    configPath="/root"
+            # If the root user on a Linux system
+            if platform.system() == 'Linux' and os.geteuid() == 0:
+                # This should be the root users config folder.
+                configPath="/root"
+
+            else:
+                configPath=""
+                #If an absolute path is set for the config file then don't try to
+                #put the file in the users home dir
+                if not cfgFilename.startswith("/"):
+                    configPath = expanduser("~")
+                    configPath = configPath.strip()
 
         return join( configPath, cfgFilename )
 

p3lib/uio.py

@@ -113,7 +113,7 @@ class UIO(object):
                 self._print('{}INFO{}:  {}'.format(UIO.GetInfoEscapeSeq(), UIO.DISPLAY_RESET_ESCAPE_SEQ, text))
         else:
             self._print('INFO:  {}'.format(text))
-        self._update_syslog(PRIORITY.INFO, text)
+        self._update_syslog(PRIORITY.INFO, "INFO:  "+text)
 
     def debug(self, text):
         """@brief Present a debug level message to the user if debuging is enabled.
@@ -128,7 +128,7 @@ class UIO(object):
                 self.storeToDebugLog('{}DEBUG{}: {}'.format(UIO.GetDebugEscapeSeq(), UIO.DISPLAY_RESET_ESCAPE_SEQ, text))
             else:
                 self.storeToDebugLog('DEBUG: {}'.format(text))
-        self._update_syslog(PRIORITY.DEBUG, text)
+        self._update_syslog(PRIORITY.DEBUG, "DEBUG: "+text)
 
     def warn(self, text):
         """@brief Present a warning level message to the user.
@@ -137,7 +137,7 @@ class UIO(object):
             self._print('{}WARN{}:  {}'.format(UIO.GetWarnEscapeSeq(), UIO.DISPLAY_RESET_ESCAPE_SEQ, text))
         else:
             self._print('WARN:  {}'.format(text))
-        self._update_syslog(PRIORITY.WARNING, text)
+        self._update_syslog(PRIORITY.WARNING, "WARN:  "+text)
 
     def error(self, text):
         """@brief Present an error level message to the user.
@@ -146,7 +146,7 @@ class UIO(object):
             self._print('{}ERROR{}: {}'.format(UIO.GetErrorEscapeSeq(), UIO.DISPLAY_RESET_ESCAPE_SEQ, text))
         else:
             self._print('ERROR: {}'.format(text))
-        self._update_syslog(PRIORITY.ERROR, text)
+        self._update_syslog(PRIORITY.ERROR, "ERROR: "+text)
 
     def _print(self, text):
         """@brief Print text to stdout"""
@@ -382,7 +382,10 @@ class UIO(object):
            @param syslogProgramName The name of the program that is being logged. If defined this appears after the username in the syslog output."""
         self._sysLogEnabled = enabled
         self._sysLogHost = host
-        self._syslogProgramName = programName
+        if programName:
+            self._syslogProgramName = programName
+        else:
+            self._syslogProgramName = sys.argv[0]
 
     def _update_syslog(self, pri, msg):
         """Send a message to syslog is syslog is enabled
@@ -398,7 +401,7 @@ class UIO(object):
         """
         if self._sysLogEnabled:
             aMsg=msg
-            #Ensure we have no zero characters in the message.
+            #Ensure we have no 0x00 characters in the message.
             # syslog will throw an error if it finds any
             if "\x00" in aMsg:
                 aMsg=aMsg.replace("\x00", "")

{p3lib-1.1.80.dist-info → p3lib-1.1.82.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p3lib
-Version: 1.1.80
+Version: 1.1.82
 Summary: A group of python modules for networking, plotting data, config storage, automating boot scripts, ssh access and user input output.
 Home-page: https://github.com/pjaos/p3lib
 Author: Paul Austen

{p3lib-1.1.80.dist-info → p3lib-1.1.82.dist-info}/RECORD

@@ -1,8 +1,8 @@
 p3lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 p3lib/ate.py,sha256=_BiqMUYNAlp4O8MkP_PAUe62Bzd8dzV4Ipv62OFS6Ok,4759
-p3lib/bokeh_auth.py,sha256=wQKSiF_gYvCs5aWUptiDkloC2tmEO-5XiAQ0mO8KFYk,14767
+p3lib/bokeh_auth.py,sha256=zi_Hty2WkCJVNQ4sINNRo5FBXujuJky9phyoF6M55ms,15180
 p3lib/bokeh_gui.py,sha256=55sajP_x9O1lE0uP3w3-T5f2oMzk7jSolLqxlEdLeLg,40245
-p3lib/boot_manager.py,sha256=IrIJg9LOsxWBP1-1wNR_mO_jzR1FAWVOBVtw7mHHLgw,14968
+p3lib/boot_manager.py,sha256=h5In_QoRDH8oHivcu4gyTzGXWg3joKBiVCz2B8Ttn8E,16941
 p3lib/conduit.py,sha256=jPkjdtyCx2I6SFqcEo8y2g7rgnZ-jNY7oCuYIETzT5Q,6046
 p3lib/database_if.py,sha256=XKu1w3zftGbj4Rh54wrWJnoCtqHkhCzJUPN2S70XIKg,11915
 p3lib/helper.py,sha256=-B63_ncfchMwXrvyVcnj9sxwGnMJ3ASmLmpoYa4tBmM,11862
@@ -11,12 +11,12 @@ p3lib/mqtt_rpc.py,sha256=6LmFA1kR4HSJs9eWbOJORRHNY01L_lHWjvtE2fmY8P8,10511
 p3lib/netif.py,sha256=3QV5OGdHhELIf4MBj6mx5MNCtVeZ7JXoNEkeu4KzCaE,9796
 p3lib/netplotly.py,sha256=PMDx-w1jtRVW6Od5u_kuKbBxNpTS_Y88mMF60puMxLM,9363
 p3lib/ngt.py,sha256=rXA-6zQkfeOupZ-3Q-k3-1DvbKYIi2TCtLKgUb0waWY,37726
-p3lib/pconfig.py,sha256=_ri9w3aauHXZp8u2YLYHBVroFR_iCqaTCwj_MRa3rHo,30153
+p3lib/pconfig.py,sha256=IWNEE1DKGwLo78CsUoJLtwGNEMuVLfL4zTKPy_SxygY,30089
 p3lib/ssh.py,sha256=klqQ9YuqU8GwPVPHrAJeEs5PI5hgoYiXflq2kIGG3as,39509
 p3lib/table_plot.py,sha256=RPncwVlGUkkx5Fw0dHQedXo0TSPlTi__VrJBDzaMsuI,32116
-p3lib/uio.py,sha256=hMarPnYXnqVF23HUIeDfzREo7TMdBjrupXMY_ffuCbI,23133
-p3lib-1.1.80.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
-p3lib-1.1.80.dist-info/METADATA,sha256=mWNK7BKcx26J9B9-OGr8zyc3fr0qZ2Pe7TFNyDb7LQw,918
-p3lib-1.1.80.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-p3lib-1.1.80.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
-p3lib-1.1.80.dist-info/RECORD,,
+p3lib/uio.py,sha256=Aaxc99XiE3d2f9vLjaN-bZsckoNxay5t0ujdK6PXGrw,23265
+p3lib-1.1.82.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
+p3lib-1.1.82.dist-info/METADATA,sha256=Ug7Hh8J-1kXHvVGX5zCVGQItaWSbRDz6LsgsJ5XmXtI,918
+p3lib-1.1.82.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+p3lib-1.1.82.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
+p3lib-1.1.82.dist-info/RECORD,,