123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162 |
- # -*- coding: utf-8 -*-
- # Copyright 2017 New Vector Ltd
- # Copyright 2019 The Matrix.org Foundation C.I.C.
- #
- # Licensed under the Apache License, Version 2.0 (the "License");
- # you may not use this file except in compliance with the License.
- # You may obtain a copy of the License at
- #
- # http://www.apache.org/licenses/LICENSE-2.0
- #
- # Unless required by applicable law or agreed to in writing, software
- # distributed under the License is distributed on an "AS IS" BASIS,
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- # See the License for the specific language governing permissions and
- # limitations under the License.
- import inspect
- from typing import Any, Dict, List
- from synapse.spam_checker_api import SpamCheckerApi
- MYPY = False
- if MYPY:
- import synapse.server
- class SpamChecker(object):
- def __init__(self, hs: "synapse.server.HomeServer"):
- self.spam_checkers = [] # type: List[Any]
- for module, config in hs.config.spam_checkers:
- # Older spam checkers don't accept the `api` argument, so we
- # try and detect support.
- spam_args = inspect.getfullargspec(module)
- if "api" in spam_args.args:
- api = SpamCheckerApi(hs)
- self.spam_checkers.append(module(config=config, api=api))
- else:
- self.spam_checkers.append(module(config=config))
- def check_event_for_spam(self, event: "synapse.events.EventBase") -> bool:
- """Checks if a given event is considered "spammy" by this server.
- If the server considers an event spammy, then it will be rejected if
- sent by a local user. If it is sent by a user on another server, then
- users receive a blank event.
- Args:
- event: the event to be checked
- Returns:
- True if the event is spammy.
- """
- for spam_checker in self.spam_checkers:
- if spam_checker.check_event_for_spam(event):
- return True
- return False
- def user_may_invite(
- self, inviter_userid: str, invitee_userid: str, room_id: str
- ) -> bool:
- """Checks if a given user may send an invite
- If this method returns false, the invite will be rejected.
- Args:
- inviter_userid: The user ID of the sender of the invitation
- invitee_userid: The user ID targeted in the invitation
- room_id: The room ID
- Returns:
- True if the user may send an invite, otherwise False
- """
- for spam_checker in self.spam_checkers:
- if (
- spam_checker.user_may_invite(inviter_userid, invitee_userid, room_id)
- is False
- ):
- return False
- return True
- def user_may_create_room(self, userid: str) -> bool:
- """Checks if a given user may create a room
- If this method returns false, the creation request will be rejected.
- Args:
- userid: The ID of the user attempting to create a room
- Returns:
- True if the user may create a room, otherwise False
- """
- for spam_checker in self.spam_checkers:
- if spam_checker.user_may_create_room(userid) is False:
- return False
- return True
- def user_may_create_room_alias(self, userid: str, room_alias: str) -> bool:
- """Checks if a given user may create a room alias
- If this method returns false, the association request will be rejected.
- Args:
- userid: The ID of the user attempting to create a room alias
- room_alias: The alias to be created
- Returns:
- True if the user may create a room alias, otherwise False
- """
- for spam_checker in self.spam_checkers:
- if spam_checker.user_may_create_room_alias(userid, room_alias) is False:
- return False
- return True
- def user_may_publish_room(self, userid: str, room_id: str) -> bool:
- """Checks if a given user may publish a room to the directory
- If this method returns false, the publish request will be rejected.
- Args:
- userid: The user ID attempting to publish the room
- room_id: The ID of the room that would be published
- Returns:
- True if the user may publish the room, otherwise False
- """
- for spam_checker in self.spam_checkers:
- if spam_checker.user_may_publish_room(userid, room_id) is False:
- return False
- return True
- def check_username_for_spam(self, user_profile: Dict[str, str]) -> bool:
- """Checks if a user ID or display name are considered "spammy" by this server.
- If the server considers a username spammy, then it will not be included in
- user directory results.
- Args:
- user_profile: The user information to check, it contains the keys:
- * user_id
- * display_name
- * avatar_url
- Returns:
- True if the user is spammy.
- """
- for spam_checker in self.spam_checkers:
- # For backwards compatibility, only run if the method exists on the
- # spam checker
- checker = getattr(spam_checker, "check_username_for_spam", None)
- if checker:
- # Make a copy of the user profile object to ensure the spam checker
- # cannot modify it.
- if checker(user_profile.copy()):
- return True
- return False
|