From 2d8903dc440fc954f9541aa153bbae22414ced3c Mon Sep 17 00:00:00 2001
From: Peter Bieringer <pb@bieringer.de>
Date: Tue, 10 Dec 2024 08:23:32 +0100
Subject: [PATCH] add new options

---
 DOCUMENTATION.md   | 38 +++++++++++++++++++++++++++++++++++++-
 config             | 20 +++++++++++++++++++-
 radicale/config.py | 18 +++++++++++++++++-
 3 files changed, 73 insertions(+), 3 deletions(-)

diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
index 6bcac293..ac5f7c5d 100644
--- a/DOCUMENTATION.md
+++ b/DOCUMENTATION.md
@@ -1005,12 +1005,48 @@ Folder for storing local collections, created if not present.
 
 Default: `/var/lib/radicale/collections`
 
+##### filesystem_cache_folder
+
+Folder for storing cache of local collections, created if not present
+
+Default_ `/var/lib/radicale/collections`
+
+Note: only used in case of use_cache_subfolder_* options are active
+
+Note: can be used on multi-instance setup to cache files on local node (see below)
+
 ##### use_cache_subfolder_for_item
 
-Use subfolder `collection-cache` for cache file structure of item instead of inside collection folders, created if not present
+Use subfolder `collection-cache` for cache file structure of 'item' instead of inside collection folders, created if not present
 
 Default: `False`
 
+Note: can be used on multi-instance setup to cache 'item' on local node
+
+##### use_cache_subfolder_for_history
+
+Use subfolder `collection-cache` for cache file structure of 'history' instead of inside collection folders, created if not present
+
+Default: `False`
+
+Note: use only on single-instance setup, will break consistency with client in multi-instance setup
+
+##### use_cache_subfolder_for_synctoken
+
+Use subfolder `collection-cache` for cache file structure of 'sync-token' instead of inside collection folders, created if not present
+
+Default: `False`
+
+Note: use only on single-instance setup, will break consistency with client in multi-instance setup
+
+##### folder_umask
+
+Use configured umask for folder creation (not applicable for OS Windows)
+
+Default: (system-default, usual `0022`)
+
+Useful value: `0077` (user:rw group:- other:-) or `0027` (user:rw group:r other:-) or `0007` (user:rw group:rw other:-) or `0022` (user:rw group:r other:r)
+
 ##### max_sync_token_age
 
 Delete sync-token that are older than the specified time. (seconds)
diff --git a/config b/config
index dbe8c68e..0d62912d 100644
--- a/config
+++ b/config
@@ -138,9 +138,27 @@
 # Folder for storing local collections, created if not present
 #filesystem_folder = /var/lib/radicale/collections
 
-# Use subfolder 'collection-cache' for item cache file structure instead of inside collection folder
+# Folder for storing cache of local collections, created if not present
+# Note: only used in case of use_cache_subfolder_* options are active
+# Note: can be used on multi-instance setup to cache files on local node (see below)
+#filesystem_cache_folder = /var/lib/radicale/collections
+
+# Use subfolder 'collection-cache' for 'item' cache file structure instead of inside collection folder
+# Note: can be used on multi-instance setup to cache 'item' on local node
 #use_cache_subfolder_for_item = False
 
+# Use subfolder 'collection-cache' for 'history' cache file structure instead of inside collection folder
+# Note: use only on single-instance setup, will break consistency with client in multi-instance setup
+#use_cache_subfolder_for_history = False
+
+# Use subfolder 'collection-cache' for 'sync-token' cache file structure instead of inside collection folder
+# Note: use only on single-instance setup, will break consistency with client in multi-instance setup
+#use_cache_subfolder_for_synctoken = False
+
+# Use configured umask for folder creation (not applicable for OS Windows)
+# Useful value: 0077 | 0027 | 0007 | 0022
+#folder_umask = (system default, usual 0022)
+
 # Delete sync token that are older (seconds)
 #max_sync_token_age = 2592000
 
diff --git a/radicale/config.py b/radicale/config.py
index 44a4381b..af4eec74 100644
--- a/radicale/config.py
+++ b/radicale/config.py
@@ -279,10 +279,26 @@ DEFAULT_CONFIG_SCHEMA: types.CONFIG_SCHEMA = OrderedDict([
             "value": "/var/lib/radicale/collections",
             "help": "path where collections are stored",
             "type": filepath}),
+        ("filesystem_cache_folder", {
+            "value": "/var/lib/radicale/collections",
+            "help": "path where cache of collections is stored in case of use_cache_subfolder_* options are active",
+            "type": filepath}),
         ("use_cache_subfolder_for_item", {
             "value": "False",
-            "help": "use subfolder 'collection-cache' for item cache file structure instead of inside collection folder",
+            "help": "use subfolder 'collection-cache' for 'item' cache file structure instead of inside collection folder",
             "type": bool}),
+        ("use_cache_subfolder_for_history", {
+            "value": "False",
+            "help": "use subfolder 'collection-cache' for 'history' cache file structure instead of inside collection folder",
+            "type": bool}),
+        ("use_cache_subfolder_for_synctoken", {
+            "value": "False",
+            "help": "use subfolder 'collection-cache' for 'sync-token' cache file structure instead of inside collection folder",
+            "type": bool}),
+        ("folder_umask", {
+            "value": "",
+            "help": "umask for folder creation (empty: system default)",
+            "type": str}),
         ("max_sync_token_age", {
             "value": "2592000",  # 30 days
             "help": "delete sync token that are older",