synapse-product/synapse/rest/client/notifications.py

105 lines
3.6 KiB
Python
Raw Normal View History

2016-05-23 13:33:51 -04:00
# Copyright 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.
2018-07-09 02:09:20 -04:00
import logging
from typing import TYPE_CHECKING, Tuple
2018-07-09 02:09:20 -04:00
from synapse.api.constants import ReceiptTypes
from synapse.events.utils import (
SerializeEventConfig,
format_event_for_client_v2_without_room_id,
)
from synapse.http.server import HttpServer
2018-07-09 02:09:20 -04:00
from synapse.http.servlet import RestServlet, parse_integer, parse_string
from synapse.http.site import SynapseRequest
from synapse.types import JsonDict
2016-05-23 13:33:51 -04:00
from ._base import client_patterns
2016-05-23 13:33:51 -04:00
if TYPE_CHECKING:
from synapse.server import HomeServer
2016-05-23 13:33:51 -04:00
logger = logging.getLogger(__name__)
class NotificationsServlet(RestServlet):
PATTERNS = client_patterns("/notifications$")
2016-05-23 13:33:51 -04:00
def __init__(self, hs: "HomeServer"):
super().__init__()
self.store = hs.get_datastores().main
2016-05-23 13:33:51 -04:00
self.auth = hs.get_auth()
self.clock = hs.get_clock()
self._event_serializer = hs.get_event_client_serializer()
2016-05-23 13:33:51 -04:00
async def on_GET(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
2019-12-05 11:46:37 -05:00
requester = await self.auth.get_user_by_req(request)
2016-05-23 13:33:51 -04:00
user_id = requester.user.to_string()
from_token = parse_string(request, "from", required=False)
limit = parse_integer(request, "limit", default=50)
only = parse_string(request, "only", required=False)
2016-05-23 13:33:51 -04:00
limit = min(limit, 500)
2019-12-05 11:46:37 -05:00
push_actions = await self.store.get_push_actions_for_user(
user_id, from_token, limit, only_highlight=(only == "highlight")
2016-05-23 13:33:51 -04:00
)
2019-12-05 11:46:37 -05:00
receipts_by_room = await self.store.get_receipts_for_user_with_orderings(
user_id, ReceiptTypes.READ
2016-05-23 13:33:51 -04:00
)
notif_event_ids = [pa.event_id for pa in push_actions]
2019-12-05 11:46:37 -05:00
notif_events = await self.store.get_events(notif_event_ids)
2016-05-23 13:33:51 -04:00
returned_push_actions = []
next_token = None
for pa in push_actions:
returned_pa = {
"room_id": pa.room_id,
"profile_tag": pa.profile_tag,
"actions": pa.actions,
"ts": pa.received_ts,
2019-06-20 05:32:02 -04:00
"event": (
self._event_serializer.serialize_event(
notif_events[pa.event_id],
2019-06-20 05:32:02 -04:00
self.clock.time_msec(),
config=SerializeEventConfig(
event_format=format_event_for_client_v2_without_room_id
),
2019-06-20 05:32:02 -04:00
)
),
2016-05-23 13:33:51 -04:00
}
if pa.room_id not in receipts_by_room:
2016-05-23 13:33:51 -04:00
returned_pa["read"] = False
else:
receipt = receipts_by_room[pa.room_id]
2016-05-23 13:33:51 -04:00
returned_pa["read"] = (
2019-06-20 05:32:02 -04:00
receipt["topological_ordering"],
receipt["stream_ordering"],
) >= (pa.topological_ordering, pa.stream_ordering)
2016-05-23 13:33:51 -04:00
returned_push_actions.append(returned_pa)
next_token = str(pa.stream_ordering)
2016-05-23 13:33:51 -04:00
return 200, {"notifications": returned_push_actions, "next_token": next_token}
2016-05-23 13:33:51 -04:00
def register_servlets(hs: "HomeServer", http_server: HttpServer) -> None:
2016-05-23 13:33:51 -04:00
NotificationsServlet(hs).register(http_server)