2014-08-12 14:10:52 +00:00
|
|
|
#
|
2023-11-21 20:29:58 +00:00
|
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
|
|
#
|
2024-01-23 11:26:48 +00:00
|
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
2023-11-21 20:29:58 +00:00
|
|
|
# Copyright (C) 2023 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:
|
|
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
|
|
#
|
|
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
|
|
#
|
|
|
|
# [This file includes modifications made by New Vector Limited]
|
2014-08-12 14:10:52 +00:00
|
|
|
#
|
|
|
|
#
|
2014-08-13 02:14:34 +00:00
|
|
|
|
2018-07-09 06:09:20 +00:00
|
|
|
import logging
|
|
|
|
import random
|
2020-09-03 21:02:29 +00:00
|
|
|
from typing import TYPE_CHECKING, Iterable, List, Optional
|
2018-07-09 06:09:20 +00:00
|
|
|
|
2022-04-13 15:21:07 +00:00
|
|
|
from synapse.api.constants import EduTypes, EventTypes, Membership, PresenceState
|
2019-03-21 11:20:13 +00:00
|
|
|
from synapse.api.errors import AuthError, SynapseError
|
2016-02-15 17:10:40 +00:00
|
|
|
from synapse.events import EventBase
|
2022-03-03 15:43:06 +00:00
|
|
|
from synapse.events.utils import SerializeEventConfig
|
2020-04-22 21:39:04 +00:00
|
|
|
from synapse.handlers.presence import format_user_presence_state
|
2022-04-20 11:57:39 +00:00
|
|
|
from synapse.storage.databases.main.events_worker import EventRedactBehaviour
|
2020-09-03 21:02:29 +00:00
|
|
|
from synapse.streams.config import PaginationConfig
|
2023-03-06 16:08:39 +00:00
|
|
|
from synapse.types import JsonDict, Requester, UserID
|
2018-08-02 14:03:27 +00:00
|
|
|
from synapse.visibility import filter_events_for_client
|
2014-08-26 18:40:29 +00:00
|
|
|
|
2020-09-03 21:02:29 +00:00
|
|
|
if TYPE_CHECKING:
|
|
|
|
from synapse.server import HomeServer
|
|
|
|
|
|
|
|
|
2014-08-26 17:57:46 +00:00
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
2021-10-08 11:44:43 +00:00
|
|
|
class EventStreamHandler:
|
2020-09-03 21:02:29 +00:00
|
|
|
def __init__(self, hs: "HomeServer"):
|
2022-02-23 11:04:02 +00:00
|
|
|
self.store = hs.get_datastores().main
|
2014-08-12 14:10:52 +00:00
|
|
|
self.clock = hs.get_clock()
|
2021-10-08 11:44:43 +00:00
|
|
|
self.hs = hs
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2014-08-26 17:57:46 +00:00
|
|
|
self.notifier = hs.get_notifier()
|
2016-08-26 13:54:30 +00:00
|
|
|
self.state = hs.get_state_handler()
|
2018-05-22 09:57:56 +00:00
|
|
|
self._server_notices_sender = hs.get_server_notices_sender()
|
2019-05-09 12:21:57 +00:00
|
|
|
self._event_serializer = hs.get_event_client_serializer()
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2019-12-05 17:58:25 +00:00
|
|
|
async def get_stream(
|
2015-01-08 13:57:29 +00:00
|
|
|
self,
|
2023-03-06 16:08:39 +00:00
|
|
|
requester: Requester,
|
2020-09-03 21:02:29 +00:00
|
|
|
pagin_config: PaginationConfig,
|
|
|
|
timeout: int = 0,
|
|
|
|
as_client_event: bool = True,
|
|
|
|
affect_presence: bool = True,
|
|
|
|
room_id: Optional[str] = None,
|
|
|
|
) -> JsonDict:
|
2015-08-24 15:19:43 +00:00
|
|
|
"""Fetches the events stream for a given user."""
|
2018-05-22 09:57:56 +00:00
|
|
|
|
2019-03-21 11:20:13 +00:00
|
|
|
if room_id:
|
2019-12-05 17:58:25 +00:00
|
|
|
blocked = await self.store.is_room_blocked(room_id)
|
2019-03-21 11:20:13 +00:00
|
|
|
if blocked:
|
|
|
|
raise SynapseError(403, "This room has been blocked on this server")
|
|
|
|
|
2018-05-22 09:57:56 +00:00
|
|
|
# send any outstanding server notices to the user.
|
2023-03-06 16:08:39 +00:00
|
|
|
await self._server_notices_sender.on_user_syncing(requester.user.to_string())
|
2018-05-22 09:57:56 +00:00
|
|
|
|
2016-05-16 17:56:37 +00:00
|
|
|
presence_handler = self.hs.get_presence_handler()
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2019-12-05 17:58:25 +00:00
|
|
|
context = await presence_handler.user_syncing(
|
2023-03-06 16:08:39 +00:00
|
|
|
requester.user.to_string(),
|
2023-08-28 17:08:49 +00:00
|
|
|
requester.device_id,
|
2022-04-13 15:21:07 +00:00
|
|
|
affect_presence=affect_presence,
|
|
|
|
presence_state=PresenceState.ONLINE,
|
2016-02-15 17:10:40 +00:00
|
|
|
)
|
|
|
|
with context:
|
2015-03-06 10:25:36 +00:00
|
|
|
if timeout:
|
|
|
|
# If they've set a timeout set a minimum limit.
|
|
|
|
timeout = max(timeout, 500)
|
|
|
|
|
|
|
|
# Add some randomness to this value to try and mitigate against
|
|
|
|
# thundering herds on restart.
|
2016-02-02 17:18:50 +00:00
|
|
|
timeout = random.randint(int(timeout * 0.9), int(timeout * 1.1))
|
2015-03-06 10:25:36 +00:00
|
|
|
|
2021-12-15 16:10:02 +00:00
|
|
|
stream_result = await self.notifier.get_events_for(
|
2023-03-06 16:08:39 +00:00
|
|
|
requester.user,
|
2015-11-02 15:10:59 +00:00
|
|
|
pagin_config,
|
|
|
|
timeout,
|
2023-03-06 16:08:39 +00:00
|
|
|
is_guest=requester.is_guest,
|
2016-01-20 15:34:07 +00:00
|
|
|
explicit_room_id=room_id,
|
2015-05-08 15:32:18 +00:00
|
|
|
)
|
2021-12-15 16:10:02 +00:00
|
|
|
events = stream_result.events
|
2014-08-27 13:13:06 +00:00
|
|
|
|
2020-04-22 21:39:04 +00:00
|
|
|
time_now = self.clock.time_msec()
|
|
|
|
|
2016-02-15 17:10:40 +00:00
|
|
|
# When the user joins a new room, or another user joins a currently
|
|
|
|
# joined room, we need to send down presence for those users.
|
2021-07-16 17:22:36 +00:00
|
|
|
to_add: List[JsonDict] = []
|
2016-02-15 17:10:40 +00:00
|
|
|
for event in events:
|
|
|
|
if not isinstance(event, EventBase):
|
|
|
|
continue
|
|
|
|
if event.type == EventTypes.Member:
|
|
|
|
if event.membership != Membership.JOIN:
|
|
|
|
continue
|
|
|
|
# Send down presence.
|
2023-03-06 16:08:39 +00:00
|
|
|
if event.state_key == requester.user.to_string():
|
2016-02-15 17:10:40 +00:00
|
|
|
# Send down presence for everyone in the room.
|
2021-07-16 17:22:36 +00:00
|
|
|
users: Iterable[str] = await self.store.get_users_in_room(
|
2019-04-03 13:32:20 +00:00
|
|
|
event.room_id
|
2021-07-16 17:22:36 +00:00
|
|
|
)
|
2016-02-15 17:10:40 +00:00
|
|
|
else:
|
2020-04-22 21:39:04 +00:00
|
|
|
users = [event.state_key]
|
2016-02-15 17:10:40 +00:00
|
|
|
|
2020-04-22 21:39:04 +00:00
|
|
|
states = await presence_handler.get_states(users)
|
|
|
|
to_add.extend(
|
|
|
|
{
|
2022-05-27 11:14:36 +00:00
|
|
|
"type": EduTypes.PRESENCE,
|
2020-04-22 21:39:04 +00:00
|
|
|
"content": format_user_presence_state(state, time_now),
|
|
|
|
}
|
|
|
|
for state in states
|
|
|
|
)
|
2016-02-15 17:10:40 +00:00
|
|
|
|
|
|
|
events.extend(to_add)
|
|
|
|
|
2023-10-27 09:04:08 +00:00
|
|
|
chunks = await self._event_serializer.serialize_events(
|
2019-05-09 12:21:57 +00:00
|
|
|
events,
|
|
|
|
time_now,
|
2023-03-06 16:08:39 +00:00
|
|
|
config=SerializeEventConfig(
|
|
|
|
as_client_event=as_client_event, requester=requester
|
|
|
|
),
|
2019-05-09 12:21:57 +00:00
|
|
|
)
|
2014-08-27 13:13:06 +00:00
|
|
|
|
|
|
|
chunk = {
|
|
|
|
"chunk": chunks,
|
2021-12-15 16:10:02 +00:00
|
|
|
"start": await stream_result.start_token.to_string(self.store),
|
|
|
|
"end": await stream_result.end_token.to_string(self.store),
|
2014-08-27 13:13:06 +00:00
|
|
|
}
|
|
|
|
|
2019-07-23 13:00:55 +00:00
|
|
|
return chunk
|
2014-08-27 13:13:06 +00:00
|
|
|
|
2014-08-27 09:33:01 +00:00
|
|
|
|
2021-10-08 11:44:43 +00:00
|
|
|
class EventHandler:
|
2020-09-03 21:02:29 +00:00
|
|
|
def __init__(self, hs: "HomeServer"):
|
2022-02-23 11:04:02 +00:00
|
|
|
self.store = hs.get_datastores().main
|
2022-05-31 12:17:50 +00:00
|
|
|
self._storage_controllers = hs.get_storage_controllers()
|
2024-04-29 14:22:13 +00:00
|
|
|
self._config = hs.config
|
2019-10-23 16:25:54 +00:00
|
|
|
|
2020-09-03 21:02:29 +00:00
|
|
|
async def get_event(
|
2022-04-20 11:57:39 +00:00
|
|
|
self,
|
|
|
|
user: UserID,
|
|
|
|
room_id: Optional[str],
|
|
|
|
event_id: str,
|
|
|
|
show_redacted: bool = False,
|
2020-09-03 21:02:29 +00:00
|
|
|
) -> Optional[EventBase]:
|
2014-08-27 09:33:01 +00:00
|
|
|
"""Retrieve a single specified event.
|
|
|
|
|
|
|
|
Args:
|
2022-08-24 19:13:12 +00:00
|
|
|
user: The local user requesting the event
|
2020-09-03 21:02:29 +00:00
|
|
|
room_id: The expected room id. We'll return None if the
|
2018-08-02 14:03:27 +00:00
|
|
|
event's room does not match.
|
2020-09-03 21:02:29 +00:00
|
|
|
event_id: The event ID to obtain.
|
2022-04-20 11:57:39 +00:00
|
|
|
show_redacted: Should the full content of redacted events be returned?
|
2014-08-27 09:33:01 +00:00
|
|
|
Returns:
|
2020-09-03 21:02:29 +00:00
|
|
|
An event, or None if there is no event matching this ID.
|
2014-08-27 09:33:01 +00:00
|
|
|
Raises:
|
2023-03-21 13:23:47 +00:00
|
|
|
AuthError: if the user does not have the rights to inspect this event.
|
2014-08-27 09:33:01 +00:00
|
|
|
"""
|
2022-04-20 11:57:39 +00:00
|
|
|
redact_behaviour = (
|
2022-05-04 11:26:11 +00:00
|
|
|
EventRedactBehaviour.as_is if show_redacted else EventRedactBehaviour.redact
|
2022-04-20 11:57:39 +00:00
|
|
|
)
|
|
|
|
event = await self.store.get_event(
|
2023-03-21 13:23:47 +00:00
|
|
|
event_id,
|
|
|
|
check_room_id=room_id,
|
|
|
|
redact_behaviour=redact_behaviour,
|
|
|
|
allow_none=True,
|
2022-04-20 11:57:39 +00:00
|
|
|
)
|
2014-08-27 09:33:01 +00:00
|
|
|
|
|
|
|
if not event:
|
2019-07-23 13:00:55 +00:00
|
|
|
return None
|
2014-08-27 09:33:01 +00:00
|
|
|
|
2022-08-24 19:13:12 +00:00
|
|
|
is_user_in_room = await self.store.check_local_user_in_room(
|
|
|
|
user_id=user.to_string(), room_id=event.room_id
|
|
|
|
)
|
|
|
|
# The user is peeking if they aren't in the room already
|
|
|
|
is_peeking = not is_user_in_room
|
2018-08-02 14:03:27 +00:00
|
|
|
|
2019-12-05 17:58:25 +00:00
|
|
|
filtered = await filter_events_for_client(
|
2024-04-29 14:22:13 +00:00
|
|
|
self._storage_controllers,
|
|
|
|
user.to_string(),
|
|
|
|
[event],
|
|
|
|
is_peeking=is_peeking,
|
|
|
|
msc4115_membership_on_events=self._config.experimental.msc4115_membership_on_events,
|
2018-08-02 14:03:27 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
if not filtered:
|
|
|
|
raise AuthError(403, "You don't have permission to access that event.")
|
2014-09-03 10:24:37 +00:00
|
|
|
|
2019-07-23 13:00:55 +00:00
|
|
|
return event
|