Matrix-Mirrors/forked-synapse
1
0
Fork 0
mirror of https://mau.dev/maunium/synapse.git synced 2024-10-01 01:36:05 -04:00
Code Issues Packages Projects Releases Wiki Activity

Warn users trying to use the deprecated spam checker interface (#10210)

Browse Source 
So admins aren't surprised if things break when we remove this code in a couple of months.
This commit is contained in:
Brendan Abolivier 2021-06-22 12:24:10 +02:00 committed by GitHub
parent 96f6293de5
commit 34db6bb9f5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/10210.removal Normal file
View File

@ -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
synapse/config/spam_checker.py
View File

@ -12,6 +12,7 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
import logging
from typing import Any, Dict, List, Tuple from typing import Any, Dict, List, Tuple
from synapse.config import ConfigError from synapse.config import ConfigError
@ -19,6 +20,15 @@ from synapse.util.module_loader import load_module
from ._base import Config 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): class SpamCheckerConfig(Config):
section = "spamchecker" section = "spamchecker"
@ -42,3 +52,8 @@ class SpamCheckerConfig(Config):
self.spam_checkers.append(load_module(spam_checker, config_path)) self.spam_checkers.append(load_module(spam_checker, config_path))
else: else:
raise ConfigError("spam_checker syntax is incorrect") 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)