59 lines
2.0 KiB
Python
59 lines
2.0 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2018 New Vector Ltd
|
|
#
|
|
# 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.
|
|
from typing import Iterable, Union
|
|
|
|
from synapse.server_notices.consent_server_notices import ConsentServerNotices
|
|
from synapse.server_notices.resource_limits_server_notices import (
|
|
ResourceLimitsServerNotices,
|
|
)
|
|
|
|
|
|
class ServerNoticesSender:
|
|
"""A centralised place which sends server notices automatically when
|
|
Certain Events take place
|
|
"""
|
|
|
|
def __init__(self, hs):
|
|
"""
|
|
|
|
Args:
|
|
hs (synapse.server.HomeServer):
|
|
"""
|
|
self._server_notices = (
|
|
ConsentServerNotices(hs),
|
|
ResourceLimitsServerNotices(hs),
|
|
) # type: Iterable[Union[ConsentServerNotices, ResourceLimitsServerNotices]]
|
|
|
|
async def on_user_syncing(self, user_id: str) -> None:
|
|
"""Called when the user performs a sync operation.
|
|
|
|
Args:
|
|
user_id: mxid of user who synced
|
|
"""
|
|
for sn in self._server_notices:
|
|
await sn.maybe_send_server_notice_to_user(user_id)
|
|
|
|
async def on_user_ip(self, user_id: str) -> None:
|
|
"""Called on the master when a worker process saw a client request.
|
|
|
|
Args:
|
|
user_id: mxid
|
|
"""
|
|
# The synchrotrons use a stubbed version of ServerNoticesSender, so
|
|
# we check for notices to send to the user in on_user_ip as well as
|
|
# in on_user_syncing
|
|
for sn in self._server_notices:
|
|
await sn.maybe_send_server_notice_to_user(user_id)
|