feat: config.Provider has new ignore_property_extra poperty, default is True

Author: rexzhang

asgi_webdav/config.py

@@ -53,6 +53,7 @@ class Provider(BaseModel):
     uri: str
     home_dir: bool = False
     read_only: bool = False
+    ignore_property_extra: bool = True
 
 
 class GuessTypeExtension(BaseModel):

asgi_webdav/dev/dev.py

@@ -51,10 +51,12 @@
         {
             "prefix": "/tmp",
             "uri": "file:///tmp",
+            "ignore_property_extra": False,
         },
         {
             "prefix": "/memory",
             "uri": "memory:///",
+            "ignore_property_extra": False,
         },
         {
             "prefix": "/~",

asgi_webdav/dev/litmus.py

@@ -15,19 +15,23 @@
             "prefix": "/",
             "uri": "memory:///",
             "read_only": True,
+            "ignore_property_extra": False,
         },
         {
             "prefix": "/provider",
             "uri": "memory:///",
             "read_only": True,
+            "ignore_property_extra": False,
         },
         {
             "prefix": "/provider/fs",
             "uri": "file:///tmp",
+            "ignore_property_extra": False,
         },
         {
             "prefix": "/provider/memory",
             "uri": "memory:///",
+            "ignore_property_extra": False,
         },
     ],
 }

asgi_webdav/provider/dev_provider.py

@@ -25,8 +25,9 @@ def __init__(
         config: Config,
         prefix: DAVPath,
         uri: str,
-        home_dir: bool = False,
-        read_only: bool = False,
+        home_dir: bool,
+        read_only: bool,
+        ignore_property_extra: bool,
     ):
         self.config = config
 
@@ -46,6 +47,8 @@ def __init__(
         else:
             self.header_allow_methods = ",".join(DAV_METHODS).encode("utf-8")
 
+        self.ignore_property_extra = ignore_property_extra
+
         self.dav_lock = DAVLock()
 
         # https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Headers/Accept-Ranges

asgi_webdav/provider/file_system.py

@@ -208,7 +208,7 @@ async def _create_dav_property_obj(
         )
 
         # extra
-        if request.propfind_only_fetch_basic:
+        if self.ignore_property_extra or request.propfind_only_fetch_basic:
             return dav_property
 
         properties_path = self._get_fs_properties_path(fs_path)
@@ -299,6 +299,9 @@ async def _do_propfind(self, request: DAVRequest) -> dict[DAVPath, DAVProperty]:
         return dav_properties
 
     async def _do_proppatch(self, request: DAVRequest) -> int:
+        if self.ignore_property_extra:
+            return 207
+
         fs_path = self._get_fs_path(request.dist_src_path, request.user.username)
         properties_path = self._get_fs_properties_path(fs_path)
         if not await aiofiles.ospath.exists(fs_path):

asgi_webdav/provider/memory.py

@@ -278,6 +278,9 @@ async def _do_propfind(self, request: DAVRequest) -> dict[DAVPath, DAVProperty]:
             return dav_properties
 
     async def _do_proppatch(self, request: DAVRequest) -> int:
+        if self.ignore_property_extra:
+            return 207
+
         async with self.fs_lock:
             fs_member = self.fs_root.get_member(request.dist_src_path)
             if fs_member is None:

asgi_webdav/web_dav.py

@@ -78,20 +78,22 @@ class PrefixProviderInfo:
     provider: DAVProvider
     home_dir: bool
     read_only: bool
+    ignore_property_extra: bool
 
     def __str__(self):
         flag_list = list()
         if self.home_dir:
-            flag_list.append("Home")
+            flag_list.append("home_dir")
         if self.read_only:
-            flag_list.append("ReadOnly")
+            flag_list.append("read_only")
+        if self.ignore_property_extra:
+            flag_list.append("ignore_property_extra")
 
-        if flag_list:
-            flag_str = f"--[{'/'.join(flag_list)}]-->"
-        else:
-            flag_str = "-->"
+        flag_str = ",".join(flag_list)
+        if flag_str:
+            flag_str = f" ,[{flag_str}]"
 
-        return f"{self.prefix} {flag_str} {self.provider}"
+        return f"{self.prefix} ==> {self.provider}{flag_str}"
 
 
 class WebDAV:
@@ -115,13 +117,15 @@ def __init__(self, config: Config):
                 uri=pm.uri,
                 home_dir=pm.home_dir,
                 read_only=pm.read_only,
+                ignore_property_extra=pm.ignore_property_extra,
             )
             ppi = PrefixProviderInfo(
                 prefix=DAVPath(pm.prefix),
                 prefix_weight=len(pm.prefix),
                 provider=provider,
                 home_dir=pm.home_dir,
                 read_only=pm.read_only,
+                ignore_property_extra=pm.ignore_property_extra,
             )
             self.prefix_provider_mapping.append(ppi)
             logger.info(f"Mapping Prefix: {ppi}")

docs/changelog.en.md

@@ -2,6 +2,8 @@
 
 ## 1.5.0 - ?
 
+- Breaking Change
+  - feat: `config.Provider` has new `ignore_property_extra` poperty, default is `True`
 - Allow authenticating any user from LDAP server, thanks [PIC](https://www.pic.es)
 - feat: better timezone support, get timezone from env `TZ`
 - feat: `HTTPBasicAuth`'s cache is now configurable

docs/reference/config-file.en.md

@@ -62,7 +62,8 @@ When the file exists, the mapping relationship is defined by the file content.
     },
     {
       "prefix": "/provider/memory",
-      "uri": "memory:///"
+      "uri": "memory:///",
+      "ignore_property_extra": false
     },
     {
       "prefix": "/~",
@@ -187,23 +188,23 @@ Example
 ### `Provider` Object
 
 - Introduced in 0.1
-- Last updated in 1.4.0
+- Last updated in 1.5.0
 
-| Key       | Value Type | Default Value |
-| --------- | ---------- | ------------- |
-| prefix    | str        | -             |
-| uri       | str        | -             |
-| home_dir  | bool       | `false`       |
-| read_only | bool       | `false`       |
+| Key                   | Value Type | Default Value |
+| --------------------- | ---------- | ------------- |
+| prefix                | str        | -             |
+| uri                   | str        | -             |
+| home_dir              | bool       | `false`       |
+| read_only             | bool       | `false`       |
+| ignore_property_extra | bool       | `true`        |
 
 ### Home Directory
 
 - When `home_dir` is `true`, it is the home directory. The `prefix` recommends using `/~` or `/home`.
-
 - When `home_dir` is `true` and `prefix` is `/~` and `uri` is `file:///data/homes` and `username` is `user_x`
   ; `http://webdav.host/~/path` will map to `file:///data/homes/user_x/path`.
-
 - When `read_only` is `true`; it is a read only directory, include subdirectories.
+- When `ignore_property_extra` is `true`; The Provider ignores the extra property, based on the Provider's implementation.
 
 ## for Rules Process