mirror of
https://mau.dev/maunium/synapse.git
synced 2024-10-01 01:36:05 -04:00
67 lines
2.6 KiB
Python
67 lines
2.6 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright (C) 2023 New Vector, Ltd
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# See the GNU Affero General Public License for more details:
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
#
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
#
|
|
# [This file includes modifications made by New Vector Limited]
|
|
#
|
|
#
|
|
|
|
import logging
|
|
from typing import Any, Dict, List, Tuple
|
|
|
|
from synapse.config import ConfigError
|
|
from synapse.types import JsonDict
|
|
from synapse.util.module_loader import load_module
|
|
|
|
from ._base import Config
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
LEGACY_SPAM_CHECKER_WARNING = """
|
|
This server is using a spam checker module that is implementing the deprecated spam
|
|
checker interface. Please check with the module's maintainer to see if a new version
|
|
supporting Synapse's generic modules system is available. For more information, please
|
|
see https://element-hq.github.io/synapse/latest/modules/index.html
|
|
---------------------------------------------------------------------------------------"""
|
|
|
|
|
|
class SpamCheckerConfig(Config):
|
|
section = "spamchecker"
|
|
|
|
def read_config(self, config: JsonDict, **kwargs: Any) -> None:
|
|
self.spam_checkers: List[Tuple[Any, Dict]] = []
|
|
|
|
spam_checkers = config.get("spam_checker") or []
|
|
if isinstance(spam_checkers, dict):
|
|
# The spam_checker config option used to only support one
|
|
# spam checker, and thus was simply a dictionary with module
|
|
# and config keys. Support this old behaviour by checking
|
|
# to see if the option resolves to a dictionary
|
|
self.spam_checkers.append(load_module(spam_checkers, ("spam_checker",)))
|
|
elif isinstance(spam_checkers, list):
|
|
for i, spam_checker in enumerate(spam_checkers):
|
|
config_path = ("spam_checker", "<item %i>" % i)
|
|
if not isinstance(spam_checker, dict):
|
|
raise ConfigError("expected a mapping", config_path)
|
|
|
|
self.spam_checkers.append(load_module(spam_checker, config_path))
|
|
else:
|
|
raise ConfigError("spam_checker syntax is incorrect")
|
|
|
|
# If this configuration is being used in any way, warn the admin that it is going
|
|
# away soon.
|
|
if self.spam_checkers:
|
|
logger.warning(LEGACY_SPAM_CHECKER_WARNING)
|