synapse-product/synapse/rest/client/v1/events.py

102 lines
3.5 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.
2014-08-12 10:10:52 -04:00
"""This module contains REST servlets to do with event streaming, /events."""
2018-07-09 02:09:20 -04:00
import logging
2014-08-12 10:10:52 -04:00
from twisted.internet import defer
from synapse.api.errors import SynapseError
from synapse.http.servlet import RestServlet
from synapse.rest.client.v2_alpha._base import client_patterns
2018-07-09 02:09:20 -04:00
from synapse.streams.config import PaginationConfig
2014-08-12 10:10:52 -04:00
logger = logging.getLogger(__name__)
class EventStreamRestServlet(RestServlet):
PATTERNS = client_patterns("/events$", v1=True)
2014-08-12 10:10:52 -04:00
DEFAULT_LONGPOLL_TIME_MS = 30000
2014-08-12 10:10:52 -04:00
def __init__(self, hs):
super(EventStreamRestServlet, self).__init__()
2016-08-12 10:31:44 -04:00
self.event_stream_handler = hs.get_event_stream_handler()
self.auth = hs.get_auth()
2014-08-12 10:10:52 -04:00
@defer.inlineCallbacks
def on_GET(self, request):
2019-06-20 05:32:02 -04:00
requester = yield self.auth.get_user_by_req(request, allow_guest=True)
is_guest = requester.is_guest
room_id = None
if is_guest:
2018-09-12 06:41:31 -04:00
if b"room_id" not in request.args:
raise SynapseError(400, "Guest users must specify room_id param")
2018-09-12 06:41:31 -04:00
if b"room_id" in request.args:
2019-06-20 05:32:02 -04:00
room_id = request.args[b"room_id"][0].decode("ascii")
pagin_config = PaginationConfig.from_request(request)
timeout = EventStreamRestServlet.DEFAULT_LONGPOLL_TIME_MS
2018-09-12 06:41:31 -04:00
if b"timeout" in request.args:
try:
2018-09-12 06:41:31 -04:00
timeout = int(request.args[b"timeout"][0])
except ValueError:
raise SynapseError(400, "timeout must be in milliseconds.")
2018-09-12 06:41:31 -04:00
as_client_event = b"raw" not in request.args
2016-08-12 10:31:44 -04:00
chunk = yield self.event_stream_handler.get_stream(
requester.user.to_string(),
pagin_config,
timeout=timeout,
as_client_event=as_client_event,
affect_presence=(not is_guest),
room_id=room_id,
is_guest=is_guest,
)
return 200, chunk
2014-08-12 10:10:52 -04:00
def on_OPTIONS(self, request):
return 200, {}
2014-08-12 10:10:52 -04:00
# TODO: Unit test gets, with and without auth, with different kinds of events.
class EventRestServlet(RestServlet):
PATTERNS = client_patterns("/events/(?P<event_id>[^/]*)$", v1=True)
def __init__(self, hs):
super(EventRestServlet, self).__init__()
self.clock = hs.get_clock()
2016-08-12 10:31:44 -04:00
self.event_handler = hs.get_event_handler()
self._event_serializer = hs.get_event_client_serializer()
@defer.inlineCallbacks
def on_GET(self, request, event_id):
requester = yield self.auth.get_user_by_req(request)
event = yield self.event_handler.get_event(requester.user, None, event_id)
time_now = self.clock.time_msec()
if event:
event = yield self._event_serializer.serialize_event(event, time_now)
return 200, event
else:
return 404, "Event not found."
2014-08-12 10:10:52 -04:00
def register_servlets(hs, http_server):
EventStreamRestServlet(hs).register(http_server)
EventRestServlet(hs).register(http_server)