mirror of
https://github.com/Kozea/Radicale.git
synced 2025-04-05 22:27:36 +03:00
773f09fe74
In case a hook fails to load for some reason, fall back to the default hook "none" and treat errors as warnings in the log. This will gracefully ignore typos in hook names without crashing the server, and it will also allow configuration of "rabbitmq" where i.e. "pika" is missing. Closes: #1490 Signed-off-by: Henning Schild <henning@hennsch.de>
69 lines
1.9 KiB
Python
69 lines
1.9 KiB
Python
import json
|
|
from enum import Enum
|
|
from typing import Sequence
|
|
|
|
from radicale import pathutils, utils
|
|
from radicale.log import logger
|
|
|
|
INTERNAL_TYPES: Sequence[str] = ("none", "rabbitmq")
|
|
|
|
|
|
def load(configuration):
|
|
"""Load the storage module chosen in configuration."""
|
|
try:
|
|
return utils.load_plugin(
|
|
INTERNAL_TYPES, "hook", "Hook", BaseHook, configuration)
|
|
except Exception as e:
|
|
logger.warn(e)
|
|
logger.warn("Hook \"%s\" failed to load, falling back to \"none\"." % configuration.get("hook", "type"))
|
|
configuration = configuration.copy()
|
|
configuration.update({"hook": {"type": "none"}}, "hook", privileged=True)
|
|
return utils.load_plugin(
|
|
INTERNAL_TYPES, "hook", "Hook", BaseHook, configuration)
|
|
|
|
|
|
class BaseHook:
|
|
def __init__(self, configuration):
|
|
"""Initialize BaseHook.
|
|
|
|
``configuration`` see ``radicale.config`` module.
|
|
The ``configuration`` must not change during the lifetime of
|
|
this object, it is kept as an internal reference.
|
|
|
|
"""
|
|
self.configuration = configuration
|
|
|
|
def notify(self, notification_item):
|
|
"""Upload a new or replace an existing item."""
|
|
raise NotImplementedError
|
|
|
|
|
|
class HookNotificationItemTypes(Enum):
|
|
CPATCH = "cpatch"
|
|
UPSERT = "upsert"
|
|
DELETE = "delete"
|
|
|
|
|
|
def _cleanup(path):
|
|
sane_path = pathutils.strip_path(path)
|
|
attributes = sane_path.split("/") if sane_path else []
|
|
|
|
if len(attributes) < 2:
|
|
return ""
|
|
return attributes[0] + "/" + attributes[1]
|
|
|
|
|
|
class HookNotificationItem:
|
|
|
|
def __init__(self, notification_item_type, path, content):
|
|
self.type = notification_item_type.value
|
|
self.point = _cleanup(path)
|
|
self.content = content
|
|
|
|
def to_json(self):
|
|
return json.dumps(
|
|
self,
|
|
default=lambda o: o.__dict__,
|
|
sort_keys=True,
|
|
indent=4
|
|
)
|