Compare commits
10 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| e7abe7924f | |||
| 8f7e4c8a91 | |||
| ab6879d54f | |||
| 8c93b9a015 | |||
| f77e826490 | |||
| fec5857995 | |||
| b1ef00b437 | |||
| 09ea29d6af | |||
| 8855fd0b01 | |||
| 8854cb393c |
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
[project]
|
[project]
|
||||||
name = "stapler"
|
name = "stapler"
|
||||||
version = "1.2.4"
|
version = "1.2.7"
|
||||||
description = "Static pages as simple as a gzip file"
|
description = "Static pages as simple as a gzip file"
|
||||||
requires-python = ">=3.14"
|
requires-python = ">=3.14"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
|
|||||||
+31
-16
@@ -25,6 +25,10 @@ if typing.TYPE_CHECKING:
|
|||||||
|
|
||||||
|
|
||||||
class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
|
class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
|
||||||
|
SANITIZE_REGEX = re.compile(r"[^\x20-\x7F]+")
|
||||||
|
timeout = 10
|
||||||
|
REQUEST_COUNT = 0
|
||||||
|
|
||||||
@typing.override
|
@typing.override
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
@@ -38,7 +42,10 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
|
|||||||
self.__host: str | None = None
|
self.__host: str | None = None
|
||||||
self.__in_size: int | None = None
|
self.__in_size: int | None = None
|
||||||
self.https: bool = params.https
|
self.https: bool = params.https
|
||||||
|
self.__class__.REQUEST_COUNT += 1
|
||||||
super().__init__(*args, **kwargs)
|
super().__init__(*args, **kwargs)
|
||||||
|
with contextlib.suppress(Exception):
|
||||||
|
self.connection.close()
|
||||||
|
|
||||||
@typing.override
|
@typing.override
|
||||||
def send_error(
|
def send_error(
|
||||||
@@ -75,7 +82,7 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
|
|||||||
|
|
||||||
@typing.override
|
@typing.override
|
||||||
def address_string(self) -> str: # pragma: no cover
|
def address_string(self) -> str: # pragma: no cover
|
||||||
return re.sub(r"[^\x00-\x7F]+", "", super().address_string())
|
return self.SANITIZE_REGEX.sub("?", super().address_string())
|
||||||
|
|
||||||
@typing.override
|
@typing.override
|
||||||
def log_message(self, format: str, *args: typing.Any) -> None: # pragma: no cover
|
def log_message(self, format: str, *args: typing.Any) -> None: # pragma: no cover
|
||||||
@@ -87,6 +94,20 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
|
|||||||
fmt = "%s - " + format
|
fmt = "%s - " + format
|
||||||
self.logger.error(fmt, self.address_string(), *args)
|
self.logger.error(fmt, self.address_string(), *args)
|
||||||
|
|
||||||
|
def _pre_log_request(self) -> None: # pragma: no cover
|
||||||
|
args = (
|
||||||
|
"...",
|
||||||
|
self.address_string(),
|
||||||
|
self.host,
|
||||||
|
format(self.__class__.REQUEST_COUNT, "07_d"),
|
||||||
|
self.SANITIZE_REGEX.sub("?", self.requestline),
|
||||||
|
)
|
||||||
|
fmt = "← %s - %s - %s - %s - %s"
|
||||||
|
if self.in_size > 0:
|
||||||
|
args = (*args, self.in_size)
|
||||||
|
fmt += " - %s"
|
||||||
|
self.logger.debug(fmt, *args)
|
||||||
|
|
||||||
@typing.override
|
@typing.override
|
||||||
def log_request(self, code: str = "?", size: str = "-") -> None: # ty:ignore[invalid-method-override] # pragma: no cover
|
def log_request(self, code: str = "?", size: str = "-") -> None: # ty:ignore[invalid-method-override] # pragma: no cover
|
||||||
if isinstance(code, http.HTTPStatus):
|
if isinstance(code, http.HTTPStatus):
|
||||||
@@ -106,9 +127,10 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
|
|||||||
code,
|
code,
|
||||||
self.address_string(),
|
self.address_string(),
|
||||||
self.host,
|
self.host,
|
||||||
re.sub(r"[^\x00-\x7F]+", "?", self.requestline),
|
format(self.__class__.REQUEST_COUNT, "07_d"),
|
||||||
|
self.SANITIZE_REGEX.sub("?", self.requestline),
|
||||||
)
|
)
|
||||||
fmt = "→ %s - %s - %s - %s"
|
fmt = "→ %s - %s - %s - %s - %s"
|
||||||
if size != "":
|
if size != "":
|
||||||
args = (*args, size)
|
args = (*args, size)
|
||||||
fmt += " - %s"
|
fmt += " - %s"
|
||||||
@@ -126,6 +148,7 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
|
|||||||
self.send_response(code, message)
|
self.send_response(code, message)
|
||||||
self.send_header("Content-Type", f"{content_type}; charset=UTF-8")
|
self.send_header("Content-Type", f"{content_type}; charset=UTF-8")
|
||||||
self.send_header("Content-Length", str(len(encoded)))
|
self.send_header("Content-Length", str(len(encoded)))
|
||||||
|
self.send_header("Connection", "close")
|
||||||
self.end_headers()
|
self.end_headers()
|
||||||
self.wfile.write(encoded)
|
self.wfile.write(encoded)
|
||||||
self.close_connection = True
|
self.close_connection = True
|
||||||
@@ -140,6 +163,7 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
|
|||||||
headers = {}
|
headers = {}
|
||||||
self.send_response(code, message)
|
self.send_response(code, message)
|
||||||
self.send_header("Content-Length", "0")
|
self.send_header("Content-Length", "0")
|
||||||
|
self.send_header("Connection", "close")
|
||||||
for header, value in headers.items():
|
for header, value in headers.items():
|
||||||
self.send_header(header, value)
|
self.send_header(header, value)
|
||||||
self.end_headers()
|
self.end_headers()
|
||||||
@@ -188,9 +212,11 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
|
|||||||
"transfer-encoding",
|
"transfer-encoding",
|
||||||
"server",
|
"server",
|
||||||
"date",
|
"date",
|
||||||
|
"connection",
|
||||||
]:
|
]:
|
||||||
self.send_header(header, value.replace(target_host, self.host))
|
self.send_header(header, value.replace(target_host, self.host))
|
||||||
self.send_header("Content-Length", str(out_size := len(response.content)))
|
self.send_header("Content-Length", str(out_size := len(response.content)))
|
||||||
|
self.send_header("Connection", "close")
|
||||||
self.end_headers()
|
self.end_headers()
|
||||||
if out_size > 0:
|
if out_size > 0:
|
||||||
self.wfile.write(response.content)
|
self.wfile.write(response.content)
|
||||||
@@ -227,19 +253,6 @@ class BaseHandler(abc.ABC, http.server.BaseHTTPRequestHandler):
|
|||||||
and len(self.headers[key]) > 0
|
and len(self.headers[key]) > 0
|
||||||
)
|
)
|
||||||
|
|
||||||
def _pre_log_request(self) -> None: # pragma: no cover
|
|
||||||
args = (
|
|
||||||
"...",
|
|
||||||
self.address_string(),
|
|
||||||
self.host,
|
|
||||||
re.sub(r"[^\x00-\x7F]+", "?", self.requestline),
|
|
||||||
)
|
|
||||||
fmt = "← %s - %s - %s - %s"
|
|
||||||
if self.in_size > 0:
|
|
||||||
args = (*args, self.in_size)
|
|
||||||
fmt += " - %s"
|
|
||||||
self.logger.debug(fmt, *args)
|
|
||||||
|
|
||||||
def server_signature(self) -> str:
|
def server_signature(self) -> str:
|
||||||
return self.server_version + "\n\n" + STAPLER_ASCII + "\n"
|
return self.server_version + "\n\n" + STAPLER_ASCII + "\n"
|
||||||
|
|
||||||
@@ -291,6 +304,8 @@ class RequestHandler(http.server.SimpleHTTPRequestHandler, BaseHandler):
|
|||||||
self.__target_spa: str | None = None
|
self.__target_spa: str | None = None
|
||||||
try:
|
try:
|
||||||
super().__init__(*args, directory=params.data_dir, **kwargs, params=params) # ty:ignore[unknown-argument]
|
super().__init__(*args, directory=params.data_dir, **kwargs, params=params) # ty:ignore[unknown-argument]
|
||||||
|
except (BrokenPipeError, ConnectionResetError) as e:
|
||||||
|
self.logger.error("Connection lost: %s", str(e)) # noqa: TRY400
|
||||||
except:
|
except:
|
||||||
self.logger.exception("Could not handle request")
|
self.logger.exception("Could not handle request")
|
||||||
|
|
||||||
|
|||||||
@@ -59,10 +59,6 @@ class TestDataDir(BaseTestCase):
|
|||||||
self.__create_path("test_1")
|
self.__create_path("test_1")
|
||||||
self.assertIsNone(self.data_dir.get_file("test_1", ".value"))
|
self.assertIsNone(self.data_dir.get_file("test_1", ".value"))
|
||||||
|
|
||||||
def test_get_file_cannot_read(self) -> None:
|
|
||||||
self.__create_path("test_1", {".value/.value": "value"})
|
|
||||||
self.assertIsNone(self.data_dir.get_file("test_1", ".value"))
|
|
||||||
|
|
||||||
def test_get_file_invalid_path(self) -> None:
|
def test_get_file_invalid_path(self) -> None:
|
||||||
self.assertIsNone(self.data_dir.get_file("test_1", ".value"))
|
self.assertIsNone(self.data_dir.get_file("test_1", ".value"))
|
||||||
|
|
||||||
|
|||||||
@@ -177,6 +177,21 @@ class TestRequestHandler(BaseHandlerTestCase):
|
|||||||
token_manager=self.token_manager,
|
token_manager=self.token_manager,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def test_handle_disconnect_silently(self) -> None:
|
||||||
|
with self.patch("http.server.BaseHTTPRequestHandler.__init__") as mock:
|
||||||
|
mock.side_effect = BrokenPipeError
|
||||||
|
logging.basicConfig(level=logging.CRITICAL)
|
||||||
|
RequestHandler(
|
||||||
|
unittest.mock.MagicMock(),
|
||||||
|
"127.0.0.1",
|
||||||
|
unittest.mock.MagicMock(),
|
||||||
|
params=Parameters(
|
||||||
|
data_dir=self.get_tmp_dir(), certbot_www=str(self.certbot_www)
|
||||||
|
),
|
||||||
|
registry=self.registry,
|
||||||
|
token_manager=self.token_manager,
|
||||||
|
)
|
||||||
|
|
||||||
def test_do_head_forward(self) -> None:
|
def test_do_head_forward(self) -> None:
|
||||||
handler = self._get_handler()
|
handler = self._get_handler()
|
||||||
with (
|
with (
|
||||||
|
|||||||
Reference in New Issue
Block a user