123 lines
3.9 KiB
Python
123 lines
3.9 KiB
Python
# Copyright 2015, 2016 OpenMarket 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 abc
|
|
from typing import TYPE_CHECKING, Any, Dict, Optional
|
|
|
|
import attr
|
|
|
|
from synapse.types import JsonDict, RoomStreamToken
|
|
|
|
if TYPE_CHECKING:
|
|
from synapse.server import HomeServer
|
|
|
|
|
|
@attr.s(slots=True, auto_attribs=True)
|
|
class PusherConfig:
|
|
"""Parameters necessary to configure a pusher."""
|
|
|
|
id: Optional[str]
|
|
user_name: str
|
|
access_token: Optional[int]
|
|
profile_tag: str
|
|
kind: str
|
|
app_id: str
|
|
app_display_name: str
|
|
device_display_name: str
|
|
pushkey: str
|
|
ts: int
|
|
lang: Optional[str]
|
|
data: Optional[JsonDict]
|
|
last_stream_ordering: int
|
|
last_success: Optional[int]
|
|
failing_since: Optional[int]
|
|
|
|
def as_dict(self) -> Dict[str, Any]:
|
|
"""Information that can be retrieved about a pusher after creation."""
|
|
return {
|
|
"app_display_name": self.app_display_name,
|
|
"app_id": self.app_id,
|
|
"data": self.data,
|
|
"device_display_name": self.device_display_name,
|
|
"kind": self.kind,
|
|
"lang": self.lang,
|
|
"profile_tag": self.profile_tag,
|
|
"pushkey": self.pushkey,
|
|
}
|
|
|
|
|
|
@attr.s(slots=True, auto_attribs=True)
|
|
class ThrottleParams:
|
|
"""Parameters for controlling the rate of sending pushes via email."""
|
|
|
|
last_sent_ts: int
|
|
throttle_ms: int
|
|
|
|
|
|
class Pusher(metaclass=abc.ABCMeta):
|
|
def __init__(self, hs: "HomeServer", pusher_config: PusherConfig):
|
|
self.hs = hs
|
|
self.store = self.hs.get_datastore()
|
|
self.clock = self.hs.get_clock()
|
|
|
|
self.pusher_id = pusher_config.id
|
|
self.user_id = pusher_config.user_name
|
|
self.app_id = pusher_config.app_id
|
|
self.pushkey = pusher_config.pushkey
|
|
|
|
self.last_stream_ordering = pusher_config.last_stream_ordering
|
|
|
|
# This is the highest stream ordering we know it's safe to process.
|
|
# When new events arrive, we'll be given a window of new events: we
|
|
# should honour this rather than just looking for anything higher
|
|
# because of potential out-of-order event serialisation.
|
|
self.max_stream_ordering = self.store.get_room_max_stream_ordering()
|
|
|
|
def on_new_notifications(self, max_token: RoomStreamToken) -> None:
|
|
# We just use the minimum stream ordering and ignore the vector clock
|
|
# component. This is safe to do as long as we *always* ignore the vector
|
|
# clock components.
|
|
max_stream_ordering = max_token.stream
|
|
|
|
self.max_stream_ordering = max(max_stream_ordering, self.max_stream_ordering)
|
|
self._start_processing()
|
|
|
|
@abc.abstractmethod
|
|
def _start_processing(self) -> None:
|
|
"""Start processing push notifications."""
|
|
raise NotImplementedError()
|
|
|
|
@abc.abstractmethod
|
|
def on_new_receipts(self, min_stream_id: int, max_stream_id: int) -> None:
|
|
raise NotImplementedError()
|
|
|
|
@abc.abstractmethod
|
|
def on_started(self, have_notifs: bool) -> None:
|
|
"""Called when this pusher has been started.
|
|
|
|
Args:
|
|
should_check_for_notifs: Whether we should immediately
|
|
check for push to send. Set to False only if it's known there
|
|
is nothing to send
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
@abc.abstractmethod
|
|
def on_stop(self) -> None:
|
|
raise NotImplementedError()
|
|
|
|
|
|
class PusherConfigException(Exception):
|
|
"""An error occurred when creating a pusher."""
|