Add: display mtime_ns precision of storage folder with condition warning if too less

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 3.3.3.dev
+* Add: display mtime_ns precision of storage folder with condition warning if too less
+
 ## 3.3.2
 * Fix: debug logging in rights/from_file
 * Add: option [storage] use_cache_subfolder_for_item for storing 'item' cache outside collection-root

pyproject.toml

@@ -3,7 +3,7 @@ name = "Radicale"
 # When the version is updated, a new section in the CHANGELOG.md file must be
 # added too.
 readme = "README.md"
-version = "3.3.2"
+version = "3.3.3.dev"
 authors = [{name = "Guillaume Ayoub", email = "guillaume.ayoub@kozea.fr"}, {name = "Unrud", email = "unrud@outlook.com"}, {name = "Peter Bieringer", email = "pb@bieringer.de"}]
 license = {text = "GNU GPL v3"}
 description = "CalDAV and CardDAV Server"

radicale/storage/multifilesystem/__init__.py

@@ -47,6 +47,8 @@ from radicale.storage.multifilesystem.sync import CollectionPartSync
 from radicale.storage.multifilesystem.upload import CollectionPartUpload
 from radicale.storage.multifilesystem.verify import StoragePartVerify
 
+# 999 second, 999 ms, 999 us, 999 ns
+MTIME_NS_TEST: int = 999999999999
 
 class Collection(
         CollectionPartDelete, CollectionPartMeta, CollectionPartSync,
@@ -91,22 +93,76 @@ class Storage(
 
     def __init__(self, configuration: config.Configuration) -> None:
         super().__init__(configuration)
-        logger.info("storage location: %r", self._filesystem_folder)
+        logger.info("Storage location: %r", self._filesystem_folder)
         self._makedirs_synced(self._filesystem_folder)
-        logger.info("storage location subfolder: %r", self._get_collection_root_folder())
+        logger.info("Storage location subfolder: %r", self._get_collection_root_folder())
-        logger.info("storage cache subfolder usage for 'item': %s", self._use_cache_subfolder_for_item)
+        logger.info("Storage cache subfolder usage for 'item': %s", self._use_cache_subfolder_for_item)
-        logger.info("storage cache subfolder usage for 'history': %s", self._use_cache_subfolder_for_history)
+        logger.info("Storage cache subfolder usage for 'history': %s", self._use_cache_subfolder_for_history)
-        logger.info("storage cache subfolder usage for 'sync-token': %s", self._use_cache_subfolder_for_synctoken)
+        logger.info("Storage cache subfolder usage for 'sync-token': %s", self._use_cache_subfolder_for_synctoken)
-        logger.info("storage cache use mtime and size for 'item': %s", self._use_mtime_and_size_for_item_cache)
+        logger.info("Storage cache use mtime and size for 'item': %s", self._use_mtime_and_size_for_item_cache)
-        logger.debug("storage cache action logging: %s", self._debug_cache_actions)
+        if self._use_mtime_and_size_for_item_cache is True:
+            # calculate and display mtime resolution
+            path = os.path.join(self._get_collection_root_folder(), ".Radicale.mtime_test")
+            try:
+                with open(path, "w") as f:
+                    f.write("mtime_test")
+                    f.close
+            except Exception:
+                logger.error("Storage item mtime resolution test not possible")
+                raise
+            # set mtime_ns for tests
+            os.utime(path, times=None, ns=(MTIME_NS_TEST, MTIME_NS_TEST))
+            logger.debug("Storage item mtime resoultion test set: %d" % MTIME_NS_TEST)
+            mtime_ns = os.stat(path).st_mtime_ns
+            mtime_ns = int(MTIME_NS_TEST / 100000000) * 100000000
+            logger.debug("Storage item mtime resoultion test get: %d" % mtime_ns)
+            # start analysis
+            precision = 1
+            mtime_ns_test = MTIME_NS_TEST
+            while mtime_ns > 0:
+                if mtime_ns == mtime_ns_test:
+                    break
+                factor = 2
+                if int(mtime_ns / factor) == int(mtime_ns_test / factor):
+                    precision = precision * factor
+                    break
+                factor = 5
+                if int(mtime_ns / factor) == int(mtime_ns_test / factor):
+                    precision = precision * factor
+                    break
+                precision = precision * 10
+                mtime_ns = int(mtime_ns / 10)
+                mtime_ns_test = int(mtime_ns_test / 10)
+            unit = "ns"
+            precision_log = precision
+            if precision >= 1000000000:
+                precision_log = precision / 1000000000
+                unit = "s"
+            elif precision >= 1000000:
+                precision_log = precision / 1000000
+                unit = "ms"
+            elif precision >= 1000:
+                precision_log = precision / 1000
+                unit = "us"
+            os.remove(path)
+            if precision >= 100000000:
+                # >= 100 ms
+                logger.warning("Storage item mtime resolution test result: %d %s (VERY RISKY ON PRODUCTION SYSTEMS)" % (precision_log, unit))
+            elif precision >= 10000000:
+                # >= 10 ms
+                logger.warning("Storage item mtime resolution test result: %d %s (RISKY ON PRODUCTION SYSTEMS)" % (precision_log, unit))
+            else:
+                logger.info("Storage item mtime resolution test result: %d %s" % (precision_log, unit))
+        raise
+        logger.debug("Storage cache action logging: %s", self._debug_cache_actions)
         if self._use_cache_subfolder_for_item is True or self._use_cache_subfolder_for_history is True or self._use_cache_subfolder_for_synctoken is True:
-            logger.info("storage cache subfolder: %r", self._get_collection_cache_folder())
+            logger.info("Storage cache subfolder: %r", self._get_collection_cache_folder())
             self._makedirs_synced(self._get_collection_cache_folder())
         if sys.platform != "win32":
             if not self._folder_umask:
                 # retrieve current umask by setting a dummy umask
                 current_umask = os.umask(0o0022)
-                logger.info("storage folder umask (from system): '%04o'", current_umask)
+                logger.info("Storage folder umask (from system): '%04o'", current_umask)
                 # reset to original
                 os.umask(current_umask)
             else:

setup.py.legacy

@@ -20,7 +20,7 @@ from setuptools import find_packages, setup
 
 # When the version is updated, a new section in the CHANGELOG.md file must be
 # added too.
-VERSION = "3.3.2"
+VERSION = "3.3.3.dev"
 
 with open("README.md", encoding="utf-8") as f:
     long_description = f.read()