210 lines
7.7 KiB
Python
210 lines
7.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2015 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.
|
|
|
|
from twisted.internet import defer
|
|
|
|
from synapse.http.servlet import (
|
|
RestServlet, parse_string, parse_integer, parse_boolean
|
|
)
|
|
from synapse.handlers.sync import SyncConfig
|
|
from synapse.types import StreamToken
|
|
from synapse.events.utils import (
|
|
serialize_event, format_event_for_client_v2_without_event_id,
|
|
)
|
|
from synapse.api.filtering import Filter
|
|
from ._base import client_v2_pattern
|
|
|
|
import logging
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class SyncRestServlet(RestServlet):
|
|
"""
|
|
|
|
GET parameters::
|
|
timeout(int): How long to wait for new events in milliseconds.
|
|
limit(int): Maxiumum number of events per room to return.
|
|
gap(bool): Create gaps the message history if limit is exceeded to
|
|
ensure that the client has the most recent messages. Defaults to
|
|
"true".
|
|
sort(str,str): tuple of sort key (e.g. "timeline") and direction
|
|
(e.g. "asc", "desc"). Defaults to "timeline,asc".
|
|
since(batch_token): Batch token when asking for incremental deltas.
|
|
set_presence(str): What state the device presence should be set to.
|
|
default is "online".
|
|
backfill(bool): Should the HS request message history from other
|
|
servers. This may take a long time making it unsuitable for clients
|
|
expecting a prompt response. Defaults to "true".
|
|
filter(filter_id): A filter to apply to the events returned.
|
|
filter_*: Filter override parameters.
|
|
|
|
Response JSON::
|
|
{
|
|
"next_batch": // batch token for the next /sync
|
|
"private_user_data": // private events for this user.
|
|
"public_user_data": // public events for all users including the
|
|
// public events for this user.
|
|
"rooms": [{ // List of rooms with updates.
|
|
"room_id": // Id of the room being updated
|
|
"limited": // Was the per-room event limit exceeded?
|
|
"published": // Is the room published by our HS?
|
|
"event_map": // Map of EventID -> event JSON.
|
|
"events": { // The recent events in the room if gap is "true"
|
|
// otherwise the next events in the room.
|
|
"batch": [] // list of EventIDs in the "event_map".
|
|
"prev_batch": // back token for getting previous events.
|
|
}
|
|
"state": [] // list of EventIDs updating the current state to
|
|
// be what it should be at the end of the batch.
|
|
"ephemeral": []
|
|
}]
|
|
}
|
|
"""
|
|
|
|
PATTERN = client_v2_pattern("/sync$")
|
|
ALLOWED_SORT = set(["timeline,asc", "timeline,desc"])
|
|
ALLOWED_PRESENCE = set(["online", "offline", "idle"])
|
|
|
|
def __init__(self, hs):
|
|
super(SyncRestServlet, self).__init__()
|
|
self.auth = hs.get_auth()
|
|
self.sync_handler = hs.get_handlers().sync_handler
|
|
self.clock = hs.get_clock()
|
|
self.filtering = hs.get_filtering()
|
|
|
|
@defer.inlineCallbacks
|
|
def on_GET(self, request):
|
|
user, client = yield self.auth.get_user_by_req(request)
|
|
|
|
timeout = parse_integer(request, "timeout", default=0)
|
|
limit = parse_integer(request, "limit", required=True)
|
|
gap = parse_boolean(request, "gap", default=True)
|
|
sort = parse_string(
|
|
request, "sort", default="timeline,asc",
|
|
allowed_values=self.ALLOWED_SORT
|
|
)
|
|
since = parse_string(request, "since")
|
|
set_presence = parse_string(
|
|
request, "set_presence", default="online",
|
|
allowed_values=self.ALLOWED_PRESENCE
|
|
)
|
|
backfill = parse_boolean(request, "backfill", default=False)
|
|
filter_id = parse_string(request, "filter", default=None)
|
|
|
|
logger.info(
|
|
"/sync: user=%r, timeout=%r, limit=%r, gap=%r, sort=%r, since=%r,"
|
|
" set_presence=%r, backfill=%r, filter_id=%r" % (
|
|
user, timeout, limit, gap, sort, since, set_presence,
|
|
backfill, filter_id
|
|
)
|
|
)
|
|
|
|
# TODO(mjark): Load filter and apply overrides.
|
|
try:
|
|
filter = yield self.filtering.get_user_filter(
|
|
user.localpart, filter_id
|
|
)
|
|
except:
|
|
filter = Filter({})
|
|
# filter = filter.apply_overrides(http_request)
|
|
# if filter.matches(event):
|
|
# # stuff
|
|
|
|
sync_config = SyncConfig(
|
|
user=user,
|
|
client_info=client,
|
|
gap=gap,
|
|
limit=limit,
|
|
sort=sort,
|
|
backfill=backfill,
|
|
filter=filter,
|
|
)
|
|
|
|
if since is not None:
|
|
since_token = StreamToken.from_string(since)
|
|
else:
|
|
since_token = None
|
|
|
|
sync_result = yield self.sync_handler.wait_for_sync_for_user(
|
|
sync_config, since_token=since_token, timeout=timeout
|
|
)
|
|
|
|
time_now = self.clock.time_msec()
|
|
|
|
response_content = {
|
|
"public_user_data": self.encode_user_data(
|
|
sync_result.public_user_data, filter, time_now
|
|
),
|
|
"private_user_data": self.encode_user_data(
|
|
sync_result.private_user_data, filter, time_now
|
|
),
|
|
"rooms": self.encode_rooms(
|
|
sync_result.rooms, filter, time_now, client.token_id
|
|
),
|
|
"next_batch": sync_result.next_batch.to_string(),
|
|
}
|
|
|
|
defer.returnValue((200, response_content))
|
|
|
|
def encode_user_data(self, events, filter, time_now):
|
|
return events
|
|
|
|
def encode_rooms(self, rooms, filter, time_now, token_id):
|
|
return [
|
|
self.encode_room(room, filter, time_now, token_id)
|
|
for room in rooms
|
|
]
|
|
|
|
@staticmethod
|
|
def encode_room(room, filter, time_now, token_id):
|
|
event_map = {}
|
|
state_events = filter.filter_room_state(room.state)
|
|
recent_events = filter.filter_room_events(room.events)
|
|
state_event_ids = []
|
|
recent_event_ids = []
|
|
for event in state_events:
|
|
# TODO(mjark): Respect formatting requirements in the filter.
|
|
event_map[event.event_id] = serialize_event(
|
|
event, time_now, token_id=token_id,
|
|
event_format=format_event_for_client_v2_without_event_id,
|
|
)
|
|
state_event_ids.append(event.event_id)
|
|
|
|
for event in recent_events:
|
|
# TODO(mjark): Respect formatting requirements in the filter.
|
|
event_map[event.event_id] = serialize_event(
|
|
event, time_now, token_id=token_id,
|
|
event_format=format_event_for_client_v2_without_event_id,
|
|
)
|
|
recent_event_ids.append(event.event_id)
|
|
result = {
|
|
"room_id": room.room_id,
|
|
"event_map": event_map,
|
|
"events": {
|
|
"batch": recent_event_ids,
|
|
"prev_batch": room.prev_batch.to_string(),
|
|
},
|
|
"state": state_event_ids,
|
|
"limited": room.limited,
|
|
"published": room.published,
|
|
"ephemeral": room.ephemeral,
|
|
}
|
|
return result
|
|
|
|
|
|
def register_servlets(hs, http_server):
|
|
SyncRestServlet(hs).register(http_server)
|