From 70b66ddfe2a39a6249046bc9cb37bcaec4bb5965 Mon Sep 17 00:00:00 2001 From: Peter Bieringer Date: Thu, 27 Mar 2025 07:57:13 +0100 Subject: [PATCH 1/7] extend copyright --- radicale/storage/multifilesystem/lock.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/radicale/storage/multifilesystem/lock.py b/radicale/storage/multifilesystem/lock.py index 68a92792..8947cfa9 100644 --- a/radicale/storage/multifilesystem/lock.py +++ b/radicale/storage/multifilesystem/lock.py @@ -1,7 +1,8 @@ # This file is part of Radicale - CalDAV and CardDAV server # Copyright © 2014 Jean-Marc Martins # Copyright © 2012-2017 Guillaume Ayoub -# Copyright © 2017-2019 Unrud +# Copyright © 2017-2022 Unrud +# Copyright © 2023-2025 Peter Bieringer # # This library is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by From af09d532c36a6ebb8e79d3a1e8befb61fcb7de35 Mon Sep 17 00:00:00 2001 From: Peter Bieringer Date: Thu, 27 Mar 2025 07:57:28 +0100 Subject: [PATCH 2/7] catch unsupported placeholder --- radicale/storage/multifilesystem/lock.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/radicale/storage/multifilesystem/lock.py b/radicale/storage/multifilesystem/lock.py index 8947cfa9..d21e4a7f 100644 --- a/radicale/storage/multifilesystem/lock.py +++ b/radicale/storage/multifilesystem/lock.py @@ -74,8 +74,13 @@ class StoragePartLock(StorageBase): else: # Process group is also used to identify child processes preexec_fn = os.setpgrp - command = self._hook % { - "user": shlex.quote(user or "Anonymous")} + try: + command = self._hook % { + "user": shlex.quote(user or "Anonymous")} + except KeyError as e: + logger.error("Storage hook contains not supported placeholder %s (skip execution of: %r)" % (e, self._hook)) + return + logger.debug("Executing storage hook: '%s'" % command) try: p = subprocess.Popen( From fb986ea02e27a9b142b5c45674396731592e6e5a Mon Sep 17 00:00:00 2001 From: Peter Bieringer Date: Thu, 27 Mar 2025 08:30:22 +0100 Subject: [PATCH 3/7] fix for flake8 --- radicale/app/put.py | 2 +- radicale/storage/multifilesystem/lock.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/radicale/app/put.py b/radicale/app/put.py index 962bf756..fda6140b 100644 --- a/radicale/app/put.py +++ b/radicale/app/put.py @@ -165,7 +165,7 @@ class ApplicationPartPut(ApplicationBase): bool(rights.intersect(access.permissions, "Ww")), bool(rights.intersect(access.parent_permissions, "w"))) - with self._storage.acquire_lock("w", user): + with self._storage.acquire_lock("w", user, path=path): item = next(iter(self._storage.discover(path)), None) parent_item = next(iter( self._storage.discover(access.parent_path)), None) diff --git a/radicale/storage/multifilesystem/lock.py b/radicale/storage/multifilesystem/lock.py index d21e4a7f..aa29049d 100644 --- a/radicale/storage/multifilesystem/lock.py +++ b/radicale/storage/multifilesystem/lock.py @@ -59,7 +59,7 @@ class StoragePartLock(StorageBase): self._hook = configuration.get("storage", "hook") @types.contextmanager - def acquire_lock(self, mode: str, user: str = "") -> Iterator[None]: + def acquire_lock(self, mode: str, user: str = "", *args, **kwargs) -> Iterator[None]: with self._lock.acquire(mode): yield # execute hook From 3eb61a82a64960150820be1015b16dc057e51e11 Mon Sep 17 00:00:00 2001 From: Peter Bieringer Date: Thu, 27 Mar 2025 08:30:48 +0100 Subject: [PATCH 4/7] add support for cwd+path --- radicale/storage/multifilesystem/lock.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/radicale/storage/multifilesystem/lock.py b/radicale/storage/multifilesystem/lock.py index aa29049d..1e25daee 100644 --- a/radicale/storage/multifilesystem/lock.py +++ b/radicale/storage/multifilesystem/lock.py @@ -74,8 +74,12 @@ class StoragePartLock(StorageBase): else: # Process group is also used to identify child processes preexec_fn = os.setpgrp + # optional argument + path = kwargs.get('path', "") try: command = self._hook % { + "path": shlex.quote(self._get_collection_root_folder() + path), + "cwd": shlex.quote(self._filesystem_folder), "user": shlex.quote(user or "Anonymous")} except KeyError as e: logger.error("Storage hook contains not supported placeholder %s (skip execution of: %r)" % (e, self._hook)) From 3bdc4382839fdf7c2881354d82bcfd0c27665325 Mon Sep 17 00:00:00 2001 From: Peter Bieringer Date: Thu, 27 Mar 2025 08:32:23 +0100 Subject: [PATCH 5/7] storage hook extend doc --- DOCUMENTATION.md | 4 +++- config | 7 +++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 838625c2..e80068b8 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -1334,7 +1334,9 @@ Command that is run after changes to storage. Take a look at the Default: Supported placeholders: - - `%(user)`: logged-in user + - `%(user)s`: logged-in user + - `%(cwd)s`: current working directory _(>= 3.5.1)_ + - `%(path)s`: full path of item _(>= 3.5.1)_ Command will be executed with base directory defined in `filesystem_folder` (see above) diff --git a/config b/config index 6b409c72..a4c51932 100644 --- a/config +++ b/config @@ -223,10 +223,13 @@ # Command that is run after changes to storage, default is emtpy # Supported placeholders: -# %(user): logged-in user +# %(user)s: logged-in user +# %(cwd)s : current working directory +# %(path)s: full path of item # Command will be executed with base directory defined in filesystem_folder # For "git" check DOCUMENTATION.md for bootstrap instructions -# Example: git add -A && (git diff --cached --quiet || git commit -m "Changes by \"%(user)s\"") +# Example(test): echo \"user=%(user)s path=%(path)s cwd=%(cwd)s\" +# Example(git): git add -A && (git diff --cached --quiet || git commit -m "Changes by \"%(user)s\"") #hook = # Create predefined user collections From 312e26977be9b074f778da1b3ea23ddefcc84134 Mon Sep 17 00:00:00 2001 From: Peter Bieringer Date: Thu, 27 Mar 2025 08:32:35 +0100 Subject: [PATCH 6/7] storage hook extend changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 03557c50..409204b0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ * Fix: auth/htpasswd related to detection and use of bcrypt * Add: option [auth] ldap_ignore_attribute_create_modify_timestamp for support of Authentik LDAP server +* Extend: [storage] hook supports now placeholder for "cwd" and "path" ## 3.5.0 From 14fb50954c96c2f9dec4f28dbeb3e8ca7e9f78de Mon Sep 17 00:00:00 2001 From: Peter Bieringer Date: Thu, 27 Mar 2025 08:36:27 +0100 Subject: [PATCH 7/7] extend changelog --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 409204b0..8bbf8ce0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ * Fix: auth/htpasswd related to detection and use of bcrypt * Add: option [auth] ldap_ignore_attribute_create_modify_timestamp for support of Authentik LDAP server -* Extend: [storage] hook supports now placeholder for "cwd" and "path" +* Extend: [storage] hook supports now placeholder for "cwd" and "path" (and catches unsupported placeholders) ## 3.5.0