feat: get timezone from TZ [FR]Time zone support/时区如何实现自定义呀 #37

Author: rexzhang

asgi_webdav/constants.py

@@ -216,8 +216,8 @@ def http_date(self) -> str:
         #   <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT
         return self.arrow.format("ddd, DD MMM YYYY HH:mm:ss ZZZ")
 
-    def ui_display(self) -> str:
-        return self.arrow.format(arrow.FORMAT_W3C)
+    def ui_display(self, timezone: str) -> str:
+        return self.arrow.replace(tzinfo=timezone).format(arrow.FORMAT_W3C)
 
     def dav_creation_date(self) -> str:
         # format borrowed from Apache mod_webdav

asgi_webdav/helpers.py

@@ -5,13 +5,15 @@
 from logging import getLogger
 from mimetypes import guess_type as orig_guess_type
 from pathlib import Path
+from zoneinfo import ZoneInfo, ZoneInfoNotFoundError
 
 import aiofiles
 import xmltodict
 from chardet import UniversalDetector
 
 from asgi_webdav.config import Config
 from asgi_webdav.constants import RESPONSE_DATA_BLOCK_SIZE
+from asgi_webdav.exception import DAVException
 
 logger = getLogger(__name__)
 
@@ -154,3 +156,14 @@ def dav_xml2dict(data: bytes) -> dict | None:
         return None
 
     return data
+
+
+def paser_timezone_key(tz_key: str) -> str:
+    try:
+        zone_info = ZoneInfo(tz_key)
+
+    except ZoneInfoNotFoundError:
+        # TODO: rewrite, move into config
+        raise DAVException(f"Invalid timezone: {tz_key}")
+
+    return zone_info.key

asgi_webdav/web_dav.py

@@ -1,12 +1,17 @@
 from copy import copy
 from dataclasses import dataclass
 from logging import getLogger
+from os import getenv
 
 from asgi_webdav import __version__
 from asgi_webdav.config import Config
 from asgi_webdav.constants import DAVDepth, DAVMethod, DAVPath, DAVTime
-from asgi_webdav.exception import DAVExceptionProviderInitFailed
-from asgi_webdav.helpers import empty_data_generator, is_browser_user_agent
+from asgi_webdav.exception import DAVException, DAVExceptionProviderInitFailed
+from asgi_webdav.helpers import (
+    empty_data_generator,
+    is_browser_user_agent,
+    paser_timezone_key,
+)
 from asgi_webdav.property import DAVProperty
 from asgi_webdav.provider.dev_provider import DAVProvider
 from asgi_webdav.provider.file_system import FileSystemProvider
@@ -131,6 +136,12 @@ def __init__(self, config: Config):
         # init hide file in dir
         self._hide_file_in_dir = DAVHideFileInDir(config)
 
+        # Please check environment variable
+        try:
+            self.timezone = paser_timezone_key(getenv("TZ", "UTC"))
+        except DAVException as e:
+            DAVException(f"Please check environment variable: TZ, {e}")
+
     def match_provider(self, request: DAVRequest) -> DAVProvider | None:
         weight = None
         provider = None
@@ -385,22 +396,22 @@ async def _create_dir_browser_content(
                     basic_data.display_name,
                     basic_data.content_type,
                     "-",
-                    basic_data.last_modified.ui_display(),
+                    basic_data.last_modified.ui_display(self.timezone),
                 )
             else:
                 tbody_file += _CONTENT_TBODY_FILE_TEMPLATE.format(
                     dav_path.raw,
                     basic_data.display_name,
                     basic_data.content_type,
                     f"{basic_data.content_length:,}",
-                    basic_data.last_modified.ui_display(),
+                    basic_data.last_modified.ui_display(self.timezone),
                 )
 
         content = _CONTENT_TEMPLATE.format(
             root_path.raw,
             root_path.raw,
             tbody_parent + tbody_dir + tbody_file,
             __version__,
-            DAVTime().ui_display(),
+            DAVTime().ui_display(self.timezone),
         )
         return content.encode("utf-8")

tests/test_helpers.py

@@ -4,11 +4,13 @@
 
 from asgi_webdav.config import get_config
 from asgi_webdav.constants import AppEntryParameters
+from asgi_webdav.exception import DAVException
 from asgi_webdav.helpers import (
     detect_charset,
     get_data_generator_from_content,
     guess_type,
     is_browser_user_agent,
+    paser_timezone_key,
 )
 
 
@@ -126,3 +128,10 @@ async def test_func_get_data_generator_from_content():
     ):
         data_new += data_block
     assert len(data_new) == 100
+
+
+def test_get_timezone_from_env():
+    assert paser_timezone_key("Asia/Shanghai") == "Asia/Shanghai"
+
+    with pytest.raises(DAVException):
+        paser_timezone_key("Invalid/TimeZone")