smdb-web-server 2.0.4__tar.gz → 2.1.0__tar.gz

{smdb_web_server-2.0.4/smdb_web_server.egg-info → smdb_web_server-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smdb_web_server
-Version: 2.0.4
+Version: 2.1.0
 Summary: A really basic, not so safe web server.
 Home-page: https://github.com/NightKey/smdb-server
 Author: Janthó Dávid
@@ -36,6 +36,8 @@ from smdb_web_server import HTMLServer, UrlData
 server = HTMLServer("127.0.0.1", 8080, title="Example server")
 ```
 
+There is a possibility to send the exception messages (other than [KnownError](#knownerror)) by setting the `forward_exception_message` to true.
+
 If the plaintext or JSON responses will use any specific encodings you can set the `response_charset` property when creating the HTMLServer. The default value is 'UTF-8'.
 
 IP restrictions can be enforced by a function passed in to `address_filter`. For example, a local IP restriction could look like the following:

{smdb_web_server-2.0.4 → smdb_web_server-2.1.0}/README.md

@@ -19,6 +19,8 @@ from smdb_web_server import HTMLServer, UrlData
 server = HTMLServer("127.0.0.1", 8080, title="Example server")
 ```
 
+There is a possibility to send the exception messages (other than [KnownError](#knownerror)) by setting the `forward_exception_message` to true.
+
 If the plaintext or JSON responses will use any specific encodings you can set the `response_charset` property when creating the HTMLServer. The default value is 'UTF-8'.
 
 IP restrictions can be enforced by a function passed in to `address_filter`. For example, a local IP restriction could look like the following:

{smdb_web_server-2.0.4 → smdb_web_server-2.1.0}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = smdb_web_server
-version = 2.0.4
+version = 2.1.0
 author = Janthó Dávid
 author_email = davidjantho@gmail.com
 description = A really basic, not so safe web server.

{smdb_web_server-2.0.4 → smdb_web_server-2.1.0}/smdb_web_server/HTMLServer.py

@@ -21,7 +21,8 @@ class HTMLServer(Base):
             title: str = "HTML Server",
             disable_cache: bool = False,
             response_charset: str = "UTF-8",
-            address_filter: Callable[[str], bool] = lambda _: True
+            address_filter: Callable[[str], bool] = lambda _: True,
+            forward_exception_message: bool = False,
     ):
         super().__init__(
             logger=logger,
@@ -36,6 +37,7 @@ class HTMLServer(Base):
         self.disable_cache = disable_cache
         self.address_filter = address_filter
         self.server_task: Union[asyncio.Task, None] = None
+        self.forward_exception_message = forward_exception_message
 
     @wrapped
     def render_template_file(self, name: str, **kwargs) -> str:
@@ -103,7 +105,7 @@ class HTMLServer(Base):
             writer.close()
             return
         self.try_log(message=f'Accepted connection from {addr[0]}:{addr[1]}')
-        handler = HTTPRequestHandler(reader=reader, writer=writer, page_title=self.pageTitle, cwd=self.cwd, charset=self.charset, logger=self.logger, disable_cache=self.disable_cache)
+        handler = HTTPRequestHandler(reader=reader, writer=writer, page_title=self.pageTitle, cwd=self.cwd, charset=self.charset, logger=self.logger, disable_cache=self.disable_cache, forward_exception_message=self.forward_exception_message)
         await handler.handle_request()
 
     @async_wrapped

{smdb_web_server-2.0.4 → smdb_web_server-2.1.0}/smdb_web_server/HTTPRequestHandler.py

@@ -25,7 +25,8 @@ class HTTPRequestHandler(Base):
             logger: Union[Logger, None] = None,
             disable_cache: bool = False,
             source_address: str = "",
-            source_filter: Callable[[str], bool] = lambda _: True
+            source_filter: Callable[[str], bool] = lambda _: True,
+            forward_exception_message: bool = False,
     ) -> None:
         super().__init__(
             logger=logger,
@@ -42,6 +43,7 @@ class HTTPRequestHandler(Base):
         self.disable_cache = disable_cache
         self.source_address = source_address
         self.source_filter = source_filter
+        self.forward_exception_message = forward_exception_message
 
     @async_wrapped
     async def handle_request(self):
@@ -78,7 +80,7 @@ class HTTPRequestHandler(Base):
             await self.cleanup()
         except Exception as ex:
             self.try_log(message=f"Exception during handling request a request", exception=ex, level=LEVEL.ERROR)
-            html_file = HTTPRequestHandler.html_template.format(title=self.page_title, content=ex)
+            html_file = HTTPRequestHandler.html_template.format(title=self.page_title, content=ex) if self.forward_exception_message else ""
             response_code = Constants.InternalServerError
             self.send_message(response_code, html_file)
         finally:
@@ -174,17 +176,18 @@ class HTTPRequestHandler(Base):
                 response_code = Constants.Ok
                 self.disable_cache = get_rules[self.path][1] or self.disable_cache
             except KnownError as ke:
-                html_file = self.html_template.format(title=self.page_title, content=ke.response.name)
                 response_code = ke.response
                 self.try_log(message=f"Known Exception: {ke}", level=LEVEL.WARNING)
             except CloseException:
                 await self.cleanup()
             except RequestException as rex:
-                html_file = self.html_template.format(title=self.page_title, content=rex)
+                if self.forward_exception_message:
+                    html_file = self.html_template.format(title=self.page_title, content=rex)
                 response_code = Constants.BadRequest
                 self.try_log(message=f"Request Exception: {rex}", level=LEVEL.WARNING)
             except Exception as ex:
-                html_file = self.html_template.format(title=self.page_title, content=ex)
+                if self.forward_exception_message:
+                    html_file = self.html_template.format(title=self.page_title, content=ex)
                 self.try_log(message=f"Exception during handling a GET request for {self.path}", exception=ex, level=LEVEL.ERROR)
             finally:
                 if not self.close_event.is_set():
@@ -234,11 +237,14 @@ class HTTPRequestHandler(Base):
         except CloseException:
             await self.cleanup()
         except RequestException as rex:
-            result = self.html_template.format(title=self.page_title, content=rex)
+            if self.forward_exception_message:
+                result = self.html_template.format(title=self.page_title, content=rex)
             message_return = Constants.BadRequest
             self.try_log(message=f"Request Exception: {rex}", level=LEVEL.WARNING)
         except Exception as ex:
             message_return = Constants.InternalServerError
+            if self.forward_exception_message:
+                result = self.html_template.format(title=self.page_title, content=ex)
             self.try_log(message=f"Exception during handling a PUT request for {self.path}", exception=ex, level=LEVEL.ERROR)
         finally:
             if not self.close_event.is_set():
@@ -273,11 +279,14 @@ class HTTPRequestHandler(Base):
         except CloseException:
             await self.cleanup()
         except RequestException as rex:
-            result = self.html_template.format(title=self.page_title, content=rex)
             message_return = Constants.BadRequest
+            if self.forward_exception_message:
+                result = self.html_template.format(title=self.page_title, content=rex)
             self.try_log(message=f"Request Exception: {rex}", level=LEVEL.WARNING)
         except Exception as ex:
             message_return = Constants.InternalServerError
+            if self.forward_exception_message:
+                result = self.html_template.format(title=self.page_title, content=ex)
             self.try_log(message=f"Exception during handling a POST request for {self.path}", exception=ex, level=LEVEL.ERROR)
         finally:
             if not self.close_event.is_set():

{smdb_web_server-2.0.4 → smdb_web_server-2.1.0/smdb_web_server.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smdb_web_server
-Version: 2.0.4
+Version: 2.1.0
 Summary: A really basic, not so safe web server.
 Home-page: https://github.com/NightKey/smdb-server
 Author: Janthó Dávid
@@ -36,6 +36,8 @@ from smdb_web_server import HTMLServer, UrlData
 server = HTMLServer("127.0.0.1", 8080, title="Example server")
 ```
 
+There is a possibility to send the exception messages (other than [KnownError](#knownerror)) by setting the `forward_exception_message` to true.
+
 If the plaintext or JSON responses will use any specific encodings you can set the `response_charset` property when creating the HTMLServer. The default value is 'UTF-8'.
 
 IP restrictions can be enforced by a function passed in to `address_filter`. For example, a local IP restriction could look like the following: