Split BaseCollection into BaseStorage and BaseCollection
This commit is contained in:
Unrud
@@ -32,49 +32,40 @@ from tempfile import NamedTemporaryFile
|
||||
from radicale import pathutils, storage
|
||||
from radicale.storage.multifilesystem.cache import CollectionCacheMixin
|
||||
from radicale.storage.multifilesystem.create_collection import \
|
||||
CollectionCreateCollectionMixin
|
||||
StorageCreateCollectionMixin
|
||||
from radicale.storage.multifilesystem.delete import CollectionDeleteMixin
|
||||
from radicale.storage.multifilesystem.discover import CollectionDiscoverMixin
|
||||
from radicale.storage.multifilesystem.discover import StorageDiscoverMixin
|
||||
from radicale.storage.multifilesystem.get import CollectionGetMixin
|
||||
from radicale.storage.multifilesystem.history import CollectionHistoryMixin
|
||||
from radicale.storage.multifilesystem.lock import CollectionLockMixin
|
||||
from radicale.storage.multifilesystem.lock import (CollectionLockMixin,
|
||||
StorageLockMixin)
|
||||
from radicale.storage.multifilesystem.meta import CollectionMetaMixin
|
||||
from radicale.storage.multifilesystem.move import CollectionMoveMixin
|
||||
from radicale.storage.multifilesystem.move import StorageMoveMixin
|
||||
from radicale.storage.multifilesystem.sync import CollectionSyncMixin
|
||||
from radicale.storage.multifilesystem.upload import CollectionUploadMixin
|
||||
from radicale.storage.multifilesystem.verify import CollectionVerifyMixin
|
||||
from radicale.storage.multifilesystem.verify import StorageVerifyMixin
|
||||
|
||||
|
||||
class Collection(
|
||||
CollectionCacheMixin, CollectionCreateCollectionMixin,
|
||||
CollectionDeleteMixin, CollectionDiscoverMixin, CollectionGetMixin,
|
||||
CollectionCacheMixin, CollectionDeleteMixin, CollectionGetMixin,
|
||||
CollectionHistoryMixin, CollectionLockMixin, CollectionMetaMixin,
|
||||
CollectionMoveMixin, CollectionSyncMixin, CollectionUploadMixin,
|
||||
CollectionVerifyMixin, storage.BaseCollection):
|
||||
"""Collection stored in several files per calendar."""
|
||||
CollectionSyncMixin, CollectionUploadMixin, storage.BaseCollection):
|
||||
|
||||
@classmethod
|
||||
def static_init(cls):
|
||||
folder = cls.configuration.get("storage", "filesystem_folder")
|
||||
cls._makedirs_synced(folder)
|
||||
super().static_init()
|
||||
|
||||
def __init__(self, path, filesystem_path=None):
|
||||
folder = self._get_collection_root_folder()
|
||||
def __init__(self, storage, path, filesystem_path=None):
|
||||
self._storage = storage
|
||||
folder = storage._get_collection_root_folder()
|
||||
# Path should already be sanitized
|
||||
self.path = pathutils.strip_path(path)
|
||||
self._encoding = self.configuration.get("encoding", "stock")
|
||||
self._path = pathutils.strip_path(path)
|
||||
self._encoding = self._storage.configuration.get("encoding", "stock")
|
||||
if filesystem_path is None:
|
||||
filesystem_path = pathutils.path_to_filesystem(folder, self.path)
|
||||
self._filesystem_path = filesystem_path
|
||||
self._etag_cache = None
|
||||
super().__init__()
|
||||
|
||||
@classmethod
|
||||
def _get_collection_root_folder(cls):
|
||||
filesystem_folder = cls.configuration.get(
|
||||
"storage", "filesystem_folder")
|
||||
return os.path.join(filesystem_folder, "collection-root")
|
||||
@property
|
||||
def path(self):
|
||||
return self._path
|
||||
|
||||
@contextlib.contextmanager
|
||||
def _atomic_write(self, path, mode="w", newline=None, sync_directory=True,
|
||||
@@ -87,7 +78,7 @@ class Collection(
|
||||
yield tmp
|
||||
tmp.flush()
|
||||
try:
|
||||
self._fsync(tmp.fileno())
|
||||
self._storage._fsync(tmp.fileno())
|
||||
except OSError as e:
|
||||
raise RuntimeError("Fsync'ing file %r failed: %s" %
|
||||
(path, e)) from e
|
||||
@@ -98,50 +89,7 @@ class Collection(
|
||||
os.remove(tmp.name)
|
||||
raise
|
||||
if sync_directory:
|
||||
self._sync_directory(directory)
|
||||
|
||||
@classmethod
|
||||
def _fsync(cls, fd):
|
||||
if cls.configuration.get("internal", "filesystem_fsync"):
|
||||
pathutils.fsync(fd)
|
||||
|
||||
@classmethod
|
||||
def _sync_directory(cls, path):
|
||||
"""Sync directory to disk.
|
||||
|
||||
This only works on POSIX and does nothing on other systems.
|
||||
|
||||
"""
|
||||
if not cls.configuration.get("internal", "filesystem_fsync"):
|
||||
return
|
||||
if os.name == "posix":
|
||||
try:
|
||||
fd = os.open(path, 0)
|
||||
try:
|
||||
cls._fsync(fd)
|
||||
finally:
|
||||
os.close(fd)
|
||||
except OSError as e:
|
||||
raise RuntimeError("Fsync'ing directory %r failed: %s" %
|
||||
(path, e)) from e
|
||||
|
||||
@classmethod
|
||||
def _makedirs_synced(cls, filesystem_path):
|
||||
"""Recursively create a directory and its parents in a sync'ed way.
|
||||
|
||||
This method acts silently when the folder already exists.
|
||||
|
||||
"""
|
||||
if os.path.isdir(filesystem_path):
|
||||
return
|
||||
parent_filesystem_path = os.path.dirname(filesystem_path)
|
||||
# Prevent infinite loop
|
||||
if filesystem_path != parent_filesystem_path:
|
||||
# Create parent dirs recursively
|
||||
cls._makedirs_synced(parent_filesystem_path)
|
||||
# Possible race!
|
||||
os.makedirs(filesystem_path, exist_ok=True)
|
||||
cls._sync_directory(parent_filesystem_path)
|
||||
self._storage._sync_directory(directory)
|
||||
|
||||
@property
|
||||
def last_modified(self):
|
||||
@@ -155,6 +103,63 @@ class Collection(
|
||||
@property
|
||||
def etag(self):
|
||||
# reuse cached value if the storage is read-only
|
||||
if self._lock.locked == "w" or self._etag_cache is None:
|
||||
if self._storage._lock.locked == "w" or self._etag_cache is None:
|
||||
self._etag_cache = super().etag
|
||||
return self._etag_cache
|
||||
|
||||
|
||||
class Storage(
|
||||
StorageCreateCollectionMixin, StorageDiscoverMixin, StorageLockMixin,
|
||||
StorageMoveMixin, StorageVerifyMixin, storage.BaseStorage):
|
||||
|
||||
_collection_class = Collection
|
||||
|
||||
def __init__(self, configuration):
|
||||
folder = configuration.get("storage", "filesystem_folder")
|
||||
self._makedirs_synced(folder)
|
||||
super().__init__(configuration)
|
||||
|
||||
def _get_collection_root_folder(self):
|
||||
filesystem_folder = self.configuration.get(
|
||||
"storage", "filesystem_folder")
|
||||
return os.path.join(filesystem_folder, "collection-root")
|
||||
|
||||
def _fsync(self, fd):
|
||||
if self.configuration.get("internal", "filesystem_fsync"):
|
||||
pathutils.fsync(fd)
|
||||
|
||||
def _sync_directory(self, path):
|
||||
"""Sync directory to disk.
|
||||
|
||||
This only works on POSIX and does nothing on other systems.
|
||||
|
||||
"""
|
||||
if not self.configuration.get("internal", "filesystem_fsync"):
|
||||
return
|
||||
if os.name == "posix":
|
||||
try:
|
||||
fd = os.open(path, 0)
|
||||
try:
|
||||
self._fsync(fd)
|
||||
finally:
|
||||
os.close(fd)
|
||||
except OSError as e:
|
||||
raise RuntimeError("Fsync'ing directory %r failed: %s" %
|
||||
(path, e)) from e
|
||||
|
||||
def _makedirs_synced(self, filesystem_path):
|
||||
"""Recursively create a directory and its parents in a sync'ed way.
|
||||
|
||||
This method acts silently when the folder already exists.
|
||||
|
||||
"""
|
||||
if os.path.isdir(filesystem_path):
|
||||
return
|
||||
parent_filesystem_path = os.path.dirname(filesystem_path)
|
||||
# Prevent infinite loop
|
||||
if filesystem_path != parent_filesystem_path:
|
||||
# Create parent dirs recursively
|
||||
self._makedirs_synced(parent_filesystem_path)
|
||||
# Possible race!
|
||||
os.makedirs(filesystem_path, exist_ok=True)
|
||||
self._sync_directory(parent_filesystem_path)
|
||||
|
||||
Reference in New Issue
Block a user