MatrixSynapse/synapse/server_notices/resource_limits_server_noti...

113 lines
4.2 KiB
Python
Raw Normal View History

2018-08-09 23:16:00 +02:00
# -*- 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.
import logging
from twisted.internet import defer
from synapse.api.errors import AuthError, SynapseError
from synapse.api.constants import EventTypes
2018-08-09 23:16:00 +02:00
logger = logging.getLogger(__name__)
class ResourceLimitsServerNotices(object):
"""
"""
def __init__(self, hs):
"""
Args:
hs (synapse.server.HomeServer):
"""
self._server_notices_manager = hs.get_server_notices_manager()
self._store = hs.get_datastore()
self.auth = hs.get_auth()
2018-08-09 23:16:00 +02:00
self._server_notice_content = hs.config.user_consent_server_notice_content
2018-08-13 23:36:52 +02:00
self._limit_usage_by_mau = hs.config.limit_usage_by_mau
self._hs_disabled = hs.config.hs_disabled
2018-08-09 23:16:00 +02:00
self._notified_of_blocking = set()
2018-08-09 23:16:00 +02:00
self._resouce_limited = False
2018-08-09 23:16:00 +02:00
# Config checks?
@defer.inlineCallbacks
def maybe_send_server_notice_to_user(self, user_id):
"""Check if we need to send a notice to this user, and does so if so
Args:
user_id (str): user to check
Returns:
Deferred
"""
if self._hs_disabled is True:
2018-08-09 23:16:00 +02:00
return
if self._limit_usage_by_mau is True:
timestamp = yield self._store.user_last_seen_monthly_active(user_id)
if timestamp is None:
# This user will be blocked from receiving the notice anyway.
# In practice, not sure we can ever get here
return
try:
# Normally should always pass in user_id if you have it, but in
# this case are checking what would happen to other users if they
# were to arrive.
yield self.auth.check_auth_blocking()
self._resouce_limited = False
2018-08-09 23:16:00 +02:00
# Need to start removing notices
if user_id in self._notified_of_blocking:
# Send message to remove warning
# send state event here
# How do I do this? if drop the id, how to refer to it?
content = {
"pinned":[]
}
yield self._server_notices_manager.send_notice(
user_id, content, EventTypes.Pinned, '',
)
self._notified_of_blocking.remove(user_id)
2018-08-09 23:16:00 +02:00
except AuthError as e:
# Need to start notifying of blocking
try:
self._resouce_limited = True
if user_id not in self._notified_of_blocking:
# TODO use admin email contained in error once PR lands
content = {
'body': e.msg,
'admin_email': 'stunt@adminemail.com',
}
event = yield self._server_notices_manager.send_notice(
user_id, content, EventTypes.ServerNoticeLimitReached
)
# send server notices state event here
# TODO Over writing pinned events
content = {
"pinned":[
event.event_id,
]
}
yield self._server_notices_manager.send_notice(
user_id, content, EventTypes.Pinned, '',
)
self._notified_of_blocking.add(user_id)
except SynapseError as e:
logger.error("Error sending server notice about resource limits: %s", e)