p3lib 1.1.66__py3-none-any.whl → 1.1.67__py3-none-any.whl

p3lib/bokeh_auth.py

@@ -15,18 +15,22 @@ from   argon2 import PasswordHasher
 from   argon2.exceptions import VerificationError
 from   datetime import datetime
 
+# could also define get_login_url function (but must give up LoginHandler)
+login_url = "/login"
+
 CRED_FILE_KEY = "CRED_FILE"
 LOGIN_HTML_FILE_KEY = "LOGIN_HTML_FILE"
 ACCESS_LOG_FILE = "ACCESS_LOG_FILE"
 
 # could define get_user_async instead
 def get_user(request_handler):
+    # Record the get request
+    LoginHandler.RecordGet(request_handler.request.remote_ip)
     user = request_handler.get_cookie("user")
+    # Record the user making the request
+    LoginHandler.SaveInfoAccessLogMessage(f"USER={user}")
     return user
 
-# could also define get_login_url function (but must give up LoginHandler)
-login_url = "/login"
-
 def GetAuthAttrFile():
     """@brief Get the file that is used to pass parameters (credentials file and login.html file) to the tornado server.
               There must be a better way of passing the credentials file to the tornado login handler than this..."""
@@ -73,19 +77,22 @@ def GetAccessLogFile():
 # optional login page for login_url
 class LoginHandler(RequestHandler):
 
-    def _recordGet(self):
-        """@brief Record an HHTP get on the login page."""
-        self._saveInfoAccessLogMessage(f"HTTP GET from {self.request.remote_ip}")
+    @staticmethod
+    def RecordGet(remoteIP):
+        """@brief Record an HHTP get on the login page.
+           @param remoteIP The IP address of the client."""
+        msg = f"HTTP GET from {remoteIP}"
+        LoginHandler.SaveInfoAccessLogMessage(msg)
         try:
             # We import here so that the p3lib module will import even if ip2geotools
-            # is not available as pip install ip2geotools adds in 73 python modules !!!
+            # is not available as pip install ip2geotools adds in ~ 70 python modules !!!
             from   ip2geotools.databases.noncommercial import DbIpCity
-            response = DbIpCity.get(self.request.remote_ip, api_key='free')
-            self._saveInfoAccessLogMessage(f"HTTP GET country   = {response.country}")
-            self._saveInfoAccessLogMessage(f"HTTP GET region    = {response.region}")
-            self._saveInfoAccessLogMessage(f"HTTP GET city      = {response.city}")
-            self._saveInfoAccessLogMessage(f"HTTP GET latitude  = {response.latitude}")
-            self._saveInfoAccessLogMessage(f"HTTP GET longitude = {response.longitude}")
+            response = DbIpCity.get(remoteIP, api_key='free')
+            LoginHandler.SaveInfoAccessLogMessage(f"HTTP GET country   = {response.country}")
+            LoginHandler.SaveInfoAccessLogMessage(f"HTTP GET region    = {response.region}")
+            LoginHandler.SaveInfoAccessLogMessage(f"HTTP GET city      = {response.city}")
+            LoginHandler.SaveInfoAccessLogMessage(f"HTTP GET latitude  = {response.latitude}")
+            LoginHandler.SaveInfoAccessLogMessage(f"HTTP GET longitude = {response.longitude}")
         except:
             pass
 
@@ -94,26 +101,23 @@ class LoginHandler(RequestHandler):
            @param username The username entered.
            @param password The password entered."""
         pw = "*"*len(password)
-        self._saveInfoAccessLogMessage(f"Login attempt from {self.request.remote_ip}: username = {username}, password={pw}")
+        LoginHandler.SaveInfoAccessLogMessage(f"Login attempt from {self.request.remote_ip}: username = {username}, password={pw}")
 
     def _recordLoginSuccess(self, username, password):
         """@brief Record a successful login to the server.
            @param username The username entered.
            @param password The password entered."""
         pw = "*"*len(password)
-        self._saveInfoAccessLogMessage(f"Login success from {self.request.remote_ip}: username = {username}, password={pw}")
-
-    def _saveInfoAccessLogMessage(self, msg):
-        """@brief Save an info level access log message.
-           @param msg The message to save to the access log."""
-        self._saveAccessLogMessage("INFO:  "+str(msg))
+        LoginHandler.SaveInfoAccessLogMessage(f"Login success from {self.request.remote_ip}: username = {username}, password={pw}")
 
-    def _saveErrorAccessLogMessage(self, msg):
+    @staticmethod
+    def SaveInfoAccessLogMessage(msg):
         """@brief Save an info level access log message.
            @param msg The message to save to the access log."""
-        self._saveAccessLogMessage("ERROR: "+str(msg))
+        LoginHandler.SaveAccessLogMessage("INFO:  "+str(msg))
 
-    def _saveAccessLogMessage(self, msg):
+    @staticmethod
+    def SaveAccessLogMessage(msg):
         """@brief Save an access log message.
            @param msg The message to save to the access log."""
         now = datetime.now()
@@ -132,7 +136,6 @@ class LoginHandler(RequestHandler):
                 pass
 
     def get(self):
-        self._recordGet()
         try:
             errormessage = self.get_argument("error")
         except Exception:
@@ -166,10 +169,10 @@ class LoginHandler(RequestHandler):
     def set_current_user(self, user):
         if user:
             self.set_cookie("user", tornado.escape.json_encode(user))
-            self._saveInfoAccessLogMessage(f"Set user cookie: user={user}")
+            LoginHandler.SaveInfoAccessLogMessage(f"Set user cookie: user={user}")
         else:
             self.clear_cookie("user")
-            self._saveInfoAccessLogMessage("Cleared user cookie")
+            LoginHandler.SaveInfoAccessLogMessage("Cleared user cookie")
 
 # optional logout_url, available as curdoc().session_context.logout_url
 logout_url = "/logout"

{p3lib-1.1.66.dist-info → p3lib-1.1.67.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p3lib
-Version: 1.1.66
+Version: 1.1.67
 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.66.dist-info → p3lib-1.1.67.dist-info}/RECORD

@@ -1,6 +1,6 @@
 p3lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 p3lib/ate.py,sha256=_BiqMUYNAlp4O8MkP_PAUe62Bzd8dzV4Ipv62OFS6Ok,4759
-p3lib/bokeh_auth.py,sha256=oyDGoJ4h1D2aMpzB36es-p5YjMLWuy8-yDCcts3-oOU,14660
+p3lib/bokeh_auth.py,sha256=XqdCLOalHL3dkyrMPqQoVQBSziVnqlfjB9YAWhZUd_U,14769
 p3lib/bokeh_gui.py,sha256=MNapLctSncZ9YyKGzNcUICMwpI5_h7a7bH3QdMd2UxI,40393
 p3lib/boot_manager.py,sha256=-kbfYbFpO-ktKv_heUgYdvvIQrntfCQ7pBcPWqS3C0s,12551
 p3lib/conduit.py,sha256=jPkjdtyCx2I6SFqcEo8y2g7rgnZ-jNY7oCuYIETzT5Q,6046
@@ -13,8 +13,8 @@ p3lib/netplotly.py,sha256=PMDx-w1jtRVW6Od5u_kuKbBxNpTS_Y88mMF60puMxLM,9363
 p3lib/pconfig.py,sha256=_ri9w3aauHXZp8u2YLYHBVroFR_iCqaTCwj_MRa3rHo,30153
 p3lib/ssh.py,sha256=YE1ddgiEt9EeBM8evuxCV8Gnj4jz1Sv52vEKidvjrJA,38369
 p3lib/uio.py,sha256=hMarPnYXnqVF23HUIeDfzREo7TMdBjrupXMY_ffuCbI,23133
-p3lib-1.1.66.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
-p3lib-1.1.66.dist-info/METADATA,sha256=OrQlH17mOVpX1q-9EBGq0__yRQfbFG8h__wDe4rBup4,920
-p3lib-1.1.66.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-p3lib-1.1.66.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
-p3lib-1.1.66.dist-info/RECORD,,
+p3lib-1.1.67.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
+p3lib-1.1.67.dist-info/METADATA,sha256=3SZVksgoZrtT2NwfrYK0Q2VOq6Yh_j31A9pYB7042y8,920
+p3lib-1.1.67.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+p3lib-1.1.67.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
+p3lib-1.1.67.dist-info/RECORD,,