# # This file is licensed under the Affero General Public License (AGPL) version 3. # # Copyright (C) 2025 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: # . # import logging from typing import TYPE_CHECKING, Awaitable, Callable, List, Optional from synapse.storage.databases.main.room import RatelimitOverride from synapse.util.async_helpers import delay_cancellation from synapse.util.metrics import Measure if TYPE_CHECKING: from synapse.server import HomeServer logger = logging.getLogger(__name__) GET_RATELIMIT_OVERRIDE_FOR_USER_CALLBACK = Callable[ [str, str], Awaitable[Optional[RatelimitOverride]] ] class RatelimitModuleApiCallbacks: def __init__(self, hs: "HomeServer") -> None: self.clock = hs.get_clock() self._get_ratelimit_override_for_user_callbacks: List[ GET_RATELIMIT_OVERRIDE_FOR_USER_CALLBACK ] = [] def register_callbacks( self, get_ratelimit_override_for_user: Optional[ GET_RATELIMIT_OVERRIDE_FOR_USER_CALLBACK ] = None, ) -> None: """Register callbacks from module for each hook.""" if get_ratelimit_override_for_user is not None: self._get_ratelimit_override_for_user_callbacks.append( get_ratelimit_override_for_user ) async def get_ratelimit_override_for_user( self, user_id: str, limiter_name: str ) -> Optional[RatelimitOverride]: for callback in self._get_ratelimit_override_for_user_callbacks: with Measure(self.clock, f"{callback.__module__}.{callback.__qualname__}"): res: Optional[RatelimitOverride] = await delay_cancellation( callback(user_id, limiter_name) ) if res: return res return None