synapse-product/synapse/handlers/events.py

181 lines
6.2 KiB
Python
Raw Normal View History

2014-08-12 10:10:52 -04:00
# -*- coding: utf-8 -*-
2016-01-06 23:26:29 -05:00
# Copyright 2014-2016 OpenMarket Ltd
2014-08-12 10:10:52 -04:00
#
# 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
import random
from typing import TYPE_CHECKING, Iterable, List, Optional
2018-07-09 02:09:20 -04:00
from synapse.api.constants import EventTypes, Membership
from synapse.api.errors import AuthError, SynapseError
2016-02-15 12:10:40 -05:00
from synapse.events import EventBase
from synapse.handlers.presence import format_user_presence_state
from synapse.logging.utils import log_function
from synapse.streams.config import PaginationConfig
from synapse.types import JsonDict, UserID
from synapse.visibility import filter_events_for_client
2014-08-12 10:10:52 -04:00
from ._base import BaseHandler
if TYPE_CHECKING:
from synapse.server import HomeServer
logger = logging.getLogger(__name__)
class EventStreamHandler(BaseHandler):
def __init__(self, hs: "HomeServer"):
super().__init__(hs)
2014-08-12 10:10:52 -04:00
self.clock = hs.get_clock()
self.notifier = hs.get_notifier()
self.state = hs.get_state_handler()
self._server_notices_sender = hs.get_server_notices_sender()
self._event_serializer = hs.get_event_client_serializer()
2014-08-12 10:10:52 -04:00
@log_function
2019-12-05 12:58:25 -05:00
async def get_stream(
2019-06-20 05:32:02 -04:00
self,
auth_user_id: str,
pagin_config: PaginationConfig,
timeout: int = 0,
as_client_event: bool = True,
affect_presence: bool = True,
room_id: Optional[str] = None,
is_guest: bool = False,
) -> JsonDict:
"""Fetches the events stream for a given user.
"""
if room_id:
2019-12-05 12:58:25 -05:00
blocked = await self.store.is_room_blocked(room_id)
if blocked:
raise SynapseError(403, "This room has been blocked on this server")
# send any outstanding server notices to the user.
2019-12-05 12:58:25 -05:00
await self._server_notices_sender.on_user_syncing(auth_user_id)
auth_user = UserID.from_string(auth_user_id)
presence_handler = self.hs.get_presence_handler()
2014-08-12 10:10:52 -04:00
2019-12-05 12:58:25 -05:00
context = await presence_handler.user_syncing(
2019-06-20 05:32:02 -04:00
auth_user_id, affect_presence=affect_presence
2016-02-15 12:10:40 -05:00
)
with context:
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 12:18:50 -05:00
timeout = random.randint(int(timeout * 0.9), int(timeout * 1.1))
2019-12-05 12:58:25 -05:00
events, tokens = await self.notifier.get_events_for(
2019-06-20 05:32:02 -04:00
auth_user,
pagin_config,
timeout,
is_guest=is_guest,
explicit_room_id=room_id,
)
time_now = self.clock.time_msec()
2016-02-15 12:10:40 -05: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.
to_add = [] # type: List[JsonDict]
2016-02-15 12:10:40 -05: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.
if event.state_key == auth_user_id:
# Send down presence for everyone in the room.
2019-12-05 12:58:25 -05:00
users = await self.state.get_current_users_in_room(
2019-06-20 05:32:02 -04:00
event.room_id
) # type: Iterable[str]
2016-02-15 12:10:40 -05:00
else:
users = [event.state_key]
2016-02-15 12:10:40 -05:00
states = await presence_handler.get_states(users)
to_add.extend(
{
"type": EventTypes.Presence,
"content": format_user_presence_state(state, time_now),
}
for state in states
)
2016-02-15 12:10:40 -05:00
events.extend(to_add)
2019-12-05 12:58:25 -05:00
chunks = await self._event_serializer.serialize_events(
2019-06-20 05:32:02 -04:00
events,
time_now,
as_client_event=as_client_event,
# We don't bundle "live" events, as otherwise clients
# will end up double counting annotations.
bundle_aggregations=False,
)
chunk = {
"chunk": chunks,
"start": tokens[0].to_string(),
"end": tokens[1].to_string(),
}
return chunk
class EventHandler(BaseHandler):
def __init__(self, hs: "HomeServer"):
super().__init__(hs)
2019-10-23 12:25:54 -04:00
self.storage = hs.get_storage()
async def get_event(
self, user: UserID, room_id: Optional[str], event_id: str
) -> Optional[EventBase]:
"""Retrieve a single specified event.
Args:
user: The user requesting the event
room_id: The expected room id. We'll return None if the
event's room does not match.
event_id: The event ID to obtain.
Returns:
An event, or None if there is no event matching this ID.
Raises:
SynapseError if there was a problem retrieving this event, or
AuthError if the user does not have the rights to inspect this
event.
"""
2019-12-05 12:58:25 -05:00
event = await self.store.get_event(event_id, check_room_id=room_id)
if not event:
return None
2019-12-05 12:58:25 -05:00
users = await self.store.get_users_in_room(event.room_id)
is_peeking = user.to_string() not in users
2019-12-05 12:58:25 -05:00
filtered = await filter_events_for_client(
2019-10-23 12:25:54 -04:00
self.storage, user.to_string(), [event], is_peeking=is_peeking
)
if not filtered:
2019-06-20 05:32:02 -04:00
raise AuthError(403, "You don't have permission to access that event.")
return event