p3lib 1.1.81__tar.gz → 1.1.83__tar.gz

{p3lib-1.1.81 → p3lib-1.1.83}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p3lib
-Version: 1.1.81
+Version: 1.1.83
 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.81 → p3lib-1.1.83}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = p3lib
-version = 1.1.81
+version = 1.1.83
 author = Paul Austen
 author_email = pausten.os@gmail.com
 description = A group of python modules for networking, plotting data, config storage, automating boot scripts, ssh access and user input output.

{p3lib-1.1.81 → p3lib-1.1.83}/src/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-1.1.81 → p3lib-1.1.83}/src/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-1.1.81 → p3lib-1.1.83}/src/p3lib/pconfig.py

@@ -339,11 +339,54 @@ class ConfigManager(object):
 
         return join( configPath, cfgFilename )
 
+    @staticmethod
+    def GetDefaultConfigFilename():
+        """@brief Get the default name of the config file for this app. This will be the program name
+                  (file that started up initially) without the .py extension. On Linux systems this 
+                  will reside in the ~/.config folder. If the ~/.config does not exist an attempt to 
+                  create it is made. If the ~/.config folder cannot be created then the config file 
+                  will be as detailed above but will be prefixed by a . character and will reside
+                  in the users home folder."""
+        progName = sys.argv[0]
+        if progName.endswith('.py'):
+            progName = progName[0:-3]
+
+        folder = '.config'
+        homePath = os.path.expanduser("~")
+        configFolder = os.path.join(homePath, folder)
+
+        if not os.path.isdir(homePath):
+            raise Exception(f"{homePath} HOME path does not exist.")
+        
+        # Create the ~/.config folder if it does not exist
+        if not os.path.isdir(configFolder):
+            # Create the ~/.config folder
+            os.makedir(configFolder)
+
+        # Note that we assume that addDotToFilename in the ConfigManager constructor is set True
+        # as this will prefix the filename with the . character.
+        if os.path.isdir(configFolder):
+            extraFolders = os.path.dirname(progName)
+            configFolder = os.path.join(configFolder, extraFolders)
+            if not os.path.isdir(configFolder):
+                os.makedirs(configFolder)
+            if not os.path.isdir(configFolder):
+                raise Exception(f"Failed to create the {configFolder} folder.")
+            
+            configFolder = "config"
+            configFolder = os.path.join(configFolder, extraFolders)
+            configFilename = os.path.join(configFolder, os.path.basename(progName) + '.cfg')
+
+        else:
+            configFilename = progName
+
+        return configFilename
+    
     def __init__(self, uio, cfgFilename, defaultConfig, addDotToFilename=True, encrypt=False, cfgPath=None):
         """@brief Constructor
            @param uio A UIO (User Input Output) instance. May be set to None if no user messages are required.
-           @param cfgFilename   The name of the config file.
-           @param defaultConfig A default config instance containg all the default key-value pairs.
+           @param cfgFilename   The name of the config file. If this is None then the default config filename is used.
+           @param defaultConfig A default config instance containing all the default key-value pairs.
            @param addDotToFilename If True (default) then a . is added to the start of the filename. This hides the file in normal cases.
            @param encrypt If True then data will be encrypted in the saved files.
                           The encryption uses part of the the local SSH RSA private key.
@@ -360,6 +403,10 @@ class ConfigManager(object):
         self._cfgPath           = cfgPath
         self._configDict        = {}
 
+        # If the user passed None in as the cfg filename then generate the default config file.
+        if self._cfgFilename is None:
+            self._cfgFilename =  ConfigManager.GetDefaultConfigFilename()
+
         self._cfgFile = self._getConfigFile()
         self._modifiedTime = self._getModifiedTime()
 

{p3lib-1.1.81 → p3lib-1.1.83}/src/p3lib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p3lib
-Version: 1.1.81
+Version: 1.1.83
 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