Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Warn users trying to use the deprecated spam checker interface (#10210)
Browse files Browse the repository at this point in the history
So admins aren't surprised if things break when we remove this code in a couple of months.
  • Loading branch information
babolivier authored Jun 22, 2021
1 parent 96f6293 commit 34db6bb
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
1 change: 1 addition & 0 deletions changelog.d/10210.removal
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The current spam checker interface is deprecated in favour of a new generic modules system. See the [upgrade notes](https://github.com/matrix-org/synapse/blob/master/UPGRADE.rst#deprecation-of-the-current-spam-checker-interface) for more information on how to update to the new system.
15 changes: 15 additions & 0 deletions synapse/config/spam_checker.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,23 @@
# See the License for the specific language governing permissions and
# limitations under the License.

import logging
from typing import Any, Dict, List, Tuple

from synapse.config import ConfigError
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://matrix-org.github.io/synapse/develop/modules.html
---------------------------------------------------------------------------------------"""


class SpamCheckerConfig(Config):
section = "spamchecker"
Expand All @@ -42,3 +52,8 @@ def read_config(self, config, **kwargs):
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)

0 comments on commit 34db6bb

Please sign in to comment.