feat: config.Provider has new poperty: type; allow future support with other uri's beginning with http/https.

Author: rexzhang

Dockerfile

@@ -19,18 +19,23 @@ COPY docker /app
 COPY requirements.d /app/requirements.d
 
 RUN \
-    # install build's depends ---
-    apk add --no-cache --virtual .build-deps build-base libffi-dev openldap-dev \
+    # install python depends ---
+    apk add --no-cache --virtual .build-deps build-base libffi-dev \
+    # --- LDAP
+    openldap-dev \
+    # --- WebHDFS
+    krb5-dev \
+    # --- build & install
     && pip install --no-cache-dir -r /app/requirements.d/docker.txt \
-    # cleanup ---
+    # --- cleanup
     && apk del .build-deps \
     && rm -rf /root/.cache \
     && find /usr/local/lib/python*/ -type f -name '*.py[cod]' -delete \
     && find /usr/local/lib/python*/ -type d -name "__pycache__" -delete \
     # LDAP client's depends ---
     && apk add --no-cache libsasl libldap \
     # create non-root user ---
-    && apk add --no-cache shadow su-exec\
+    && apk add --no-cache shadow su-exec \
     && addgroup -S -g $GID runner \
     && adduser -S -D -G runner -u $UID -s /bin/sh runner \
     # support timezone ---

asgi_webdav/config.py

@@ -75,6 +75,8 @@ class Provider:
 
     prefix: str
     uri: str
+    type: str = ""
+
     home_dir: bool = False
     read_only: bool = False
     ignore_property_extra: bool = True

asgi_webdav/exception.py

@@ -11,8 +11,6 @@ class DAVExceptionRequestParserFailed(DAVException):
 
 
 class DAVExceptionProviderInitFailed(DAVException):
-    """will be trigger sys.exit(?)"""
-
     pass
 
 

asgi_webdav/provider/dev_provider.py

@@ -20,6 +20,8 @@
 
 
 class DAVProvider:
+    type: str
+
     def __init__(
         self,
         config: Config,

asgi_webdav/provider/file_system.py

@@ -140,6 +140,8 @@ async def _dav_response_data_generator(
 
 
 class FileSystemProvider(DAVProvider):
+    type = "fs"
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.support_content_range = True

asgi_webdav/provider/memory.py

@@ -205,6 +205,8 @@ def copy_member(
 
 
 class MemoryProvider(DAVProvider):
+    type = "memory"
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.support_content_range = True

asgi_webdav/provider/webhdfs.py

@@ -34,8 +34,10 @@ class FileStatus(TypedDict):
 
 
 class WebHDFSProvider(DAVProvider):
+    type = "webhdfs"
+
     def __init__(self, *args, **kwargs):
-        if not httpx or not HTTPKerberosAuth:
+        if httpx is None or HTTPKerberosAuth is None:
             raise DAVExceptionProviderInitFailed(
                 "httpx and httpx_kerberos are required for WebHDFSProvider, please check your installation"
             )

asgi_webdav/web_dav.py

@@ -4,7 +4,7 @@
 from os import getenv
 
 from asgi_webdav import __version__
-from asgi_webdav.config import Config
+from asgi_webdav.config import Config, Provider
 from asgi_webdav.constants import DAVDepth, DAVMethod, DAVPath, DAVTime
 from asgi_webdav.exception import DAVException, DAVExceptionProviderInitFailed
 from asgi_webdav.helpers import (
@@ -71,6 +71,8 @@
 _CONTENT_TBODY_FILE_TEMPLATE = """<tr><td><a href="{}">{}</a></td><td>{}</td>
 <td class="align-right">{}</td><td class="align-right">{}</td></tr>"""
 
+_HTTP_PROVIDERS = {p.type: p for p in [WebHDFSProvider]}
+
 
 @dataclass
 class PrefixProviderInfo:
@@ -102,39 +104,33 @@ class WebDAV:
 
     def __init__(self, config: Config):
         # init prefix => provider
-        for pm in config.provider_mapping:
-            if pm.uri.startswith("file://"):
-                provider_factory = FileSystemProvider
-
-            elif pm.uri.startswith("http://") or pm.uri.startswith("https://"):
-                provider_factory = WebHDFSProvider
-
-            elif pm.uri.startswith("memory://"):
-                provider_factory = MemoryProvider
-
-            else:
-                raise
+        for p_config in config.provider_mapping:
+            try:
+                provider_class = self.match_provider_class(p_config)
+            except DAVExceptionProviderInitFailed as e:
+                logger.error(f"{e}, please check your config, skip!")
+                continue
 
             try:
-                provider = provider_factory(
+                provider = provider_class(
                     config=config,
-                    prefix=DAVPath(pm.prefix),
-                    uri=pm.uri,
-                    home_dir=pm.home_dir,
-                    read_only=pm.read_only,
-                    ignore_property_extra=pm.ignore_property_extra,
+                    prefix=DAVPath(p_config.prefix),
+                    uri=p_config.uri,
+                    home_dir=p_config.home_dir,
+                    read_only=p_config.read_only,
+                    ignore_property_extra=p_config.ignore_property_extra,
                 )
             except DAVExceptionProviderInitFailed as e:
-                logger.error(f"Provider init failed: {pm}, {e}, skip!")
+                logger.error(f"Provider init failed: {p_config}, {e}, skip!")
                 continue
 
             ppi = PrefixProviderInfo(
-                prefix=DAVPath(pm.prefix),
-                prefix_weight=len(pm.prefix),
+                prefix=DAVPath(p_config.prefix),
+                prefix_weight=len(p_config.prefix),
                 provider=provider,
-                home_dir=pm.home_dir,
-                read_only=pm.read_only,
-                ignore_property_extra=pm.ignore_property_extra,
+                home_dir=p_config.home_dir,
+                read_only=p_config.read_only,
+                ignore_property_extra=p_config.ignore_property_extra,
             )
             self.prefix_provider_mapping.append(ppi)
             logger.info(f"Mapping Prefix: {ppi}")
@@ -149,12 +145,33 @@ def __init__(self, config: Config):
         # init hide file in dir
         self._hide_file_in_dir = DAVHideFileInDir(config)
 
-        # Please check environment variable
+        # check environment variable
         try:
             self.timezone = paser_timezone_key(getenv("TZ", "UTC"))
         except DAVException as e:
             DAVException(f"Please check environment variable: TZ, {e}")
 
+    @staticmethod
+    def match_provider_class(
+        p_config: Provider,
+    ) -> type[DAVProvider]:
+        if p_config.uri.startswith("file://"):
+            return FileSystemProvider
+
+        elif p_config.uri.startswith("memory://"):
+            return MemoryProvider
+
+        elif p_config.uri.startswith("http://") or p_config.uri.startswith("https://"):
+            provider_class = _HTTP_PROVIDERS.get(p_config.type)
+            if provider_class is None:
+                raise DAVExceptionProviderInitFailed(
+                    f"Provider not found: {p_config}",
+                )
+
+            return provider_class
+
+        raise DAVExceptionProviderInitFailed(f"Provider uri not supported: {p_config}")
+
     def match_provider(self, request: DAVRequest) -> DAVProvider | None:
         weight = None
         provider = None

docs/changelog.en.md

@@ -7,7 +7,7 @@
 - feat: new config, Compression.enable
 - feat: both support .toml and .json config file
 - feat: support optional anonymous user, thanks [PIC](https://www.pic.es)
-- Implement a WebHDFS provider, contributed by [PIC](https://www.pic.es)
+- feat: Implement a WebHDFS provider, contributed by [PIC](https://www.pic.es)
 
 ## 1.5.0 - 20250628
 

docs/index.zh.md

@@ -16,7 +16,7 @@
 
 - 符合 [ASGI](https://asgi.readthedocs.io) 标准
 - 符合 WebDAV 标准: [RFC4918](https://www.ietf.org/rfc/rfc4918.txt)
-- 支持多来源: FileProvider, MemoryProvider
+- 支持多来源: FileSystemProvider, MemoryProvider, WebHDFSProvider
 - 支持多账号以及权限控制
 - 支持可选的匿名用户
 - 支持可选的家目录