2014-08-26 13:57:46 -04:00
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright 2014 matrix.org
|
|
|
|
#
|
|
|
|
# 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.api.constants import Membership
|
|
|
|
from synapse.types import StreamToken
|
|
|
|
|
|
|
|
|
2014-08-27 13:28:53 -04:00
|
|
|
class NullSource(object):
|
|
|
|
"""This event source never yields any events and its token remains at
|
|
|
|
zero. It may be useful for unit-testing."""
|
|
|
|
def __init__(self, hs):
|
|
|
|
pass
|
|
|
|
|
|
|
|
def get_new_events_for_user(self, user, from_token, limit):
|
|
|
|
return defer.succeed(([], from_token))
|
|
|
|
|
|
|
|
def get_current_token_part(self):
|
|
|
|
return defer.succeed(0)
|
|
|
|
|
|
|
|
def get_pagination_rows(self, user, pagination_config, key):
|
|
|
|
return defer.succeed(([], from_token))
|
|
|
|
|
|
|
|
|
2014-08-26 13:57:46 -04:00
|
|
|
class RoomEventSource(object):
|
|
|
|
def __init__(self, hs):
|
|
|
|
self.store = hs.get_datastore()
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
2014-08-27 09:03:27 -04:00
|
|
|
def get_new_events_for_user(self, user, from_token, limit):
|
2014-08-26 13:57:46 -04:00
|
|
|
# We just ignore the key for now.
|
|
|
|
|
|
|
|
to_key = yield self.get_current_token_part()
|
|
|
|
|
|
|
|
events, end_key = yield self.store.get_room_events_stream(
|
|
|
|
user_id=user.to_string(),
|
|
|
|
from_key=from_token.events_key,
|
|
|
|
to_key=to_key,
|
|
|
|
room_id=None,
|
|
|
|
limit=limit,
|
|
|
|
)
|
|
|
|
|
|
|
|
end_token = from_token.copy_and_replace("events_key", end_key)
|
|
|
|
|
|
|
|
defer.returnValue((events, end_token))
|
|
|
|
|
|
|
|
def get_current_token_part(self):
|
|
|
|
return self.store.get_room_events_max_id()
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
2014-08-27 10:25:21 -04:00
|
|
|
def get_pagination_rows(self, user, pagination_config, key):
|
|
|
|
from_token = pagination_config.from_token
|
|
|
|
to_token = pagination_config.to_token
|
|
|
|
limit = pagination_config.limit
|
|
|
|
direction = pagination_config.direction
|
|
|
|
|
2014-08-26 13:57:46 -04:00
|
|
|
to_key = to_token.events_key if to_token else None
|
|
|
|
|
|
|
|
events, next_key = yield self.store.paginate_room_events(
|
|
|
|
room_id=key,
|
|
|
|
from_key=from_token.events_key,
|
|
|
|
to_key=to_key,
|
2014-08-27 10:25:21 -04:00
|
|
|
direction=direction,
|
2014-08-26 13:57:46 -04:00
|
|
|
limit=limit,
|
|
|
|
with_feedback=True
|
|
|
|
)
|
|
|
|
|
|
|
|
next_token = from_token.copy_and_replace("events_key", next_key)
|
|
|
|
|
|
|
|
defer.returnValue((events, next_token))
|
|
|
|
|
|
|
|
|
2014-08-27 09:03:27 -04:00
|
|
|
class PresenceSource(object):
|
2014-08-26 13:57:46 -04:00
|
|
|
def __init__(self, hs):
|
|
|
|
self.hs = hs
|
|
|
|
self.clock = hs.get_clock()
|
|
|
|
|
2014-08-27 09:03:27 -04:00
|
|
|
def get_new_events_for_user(self, user, from_token, limit):
|
2014-08-26 13:57:46 -04:00
|
|
|
from_key = int(from_token.presence_key)
|
|
|
|
|
|
|
|
presence = self.hs.get_handlers().presence_handler
|
|
|
|
cachemap = presence._user_cachemap
|
|
|
|
|
|
|
|
# TODO(paul): limit, and filter by visibility
|
|
|
|
updates = [(k, cachemap[k]) for k in cachemap
|
|
|
|
if from_key < cachemap[k].serial]
|
|
|
|
|
|
|
|
if updates:
|
|
|
|
clock = self.clock
|
|
|
|
|
|
|
|
latest_serial = max([x[1].serial for x in updates])
|
|
|
|
data = [x[1].make_event(user=x[0], clock=clock) for x in updates]
|
|
|
|
|
|
|
|
end_token = from_token.copy_and_replace(
|
2014-08-27 09:03:27 -04:00
|
|
|
"presence_key", latest_serial
|
2014-08-26 13:57:46 -04:00
|
|
|
)
|
|
|
|
return ((data, end_token))
|
|
|
|
else:
|
|
|
|
end_token = from_token.copy_and_replace(
|
|
|
|
"presence_key", presence._user_cachemap_latest_serial
|
|
|
|
)
|
|
|
|
return (([], end_token))
|
|
|
|
|
|
|
|
def get_current_token_part(self):
|
|
|
|
presence = self.hs.get_handlers().presence_handler
|
|
|
|
return presence._user_cachemap_latest_serial
|
|
|
|
|
2014-08-27 10:25:21 -04:00
|
|
|
def get_pagination_rows(self, user, pagination_config, key):
|
|
|
|
# TODO (erikj): Does this make sense? Ordering?
|
|
|
|
|
|
|
|
from_token = pagination_config.from_token
|
|
|
|
to_token = pagination_config.to_token
|
|
|
|
|
2014-08-27 09:03:27 -04:00
|
|
|
from_key = int(from_token.presence_key)
|
|
|
|
|
|
|
|
if to_token:
|
|
|
|
to_key = int(to_token.presence_key)
|
|
|
|
else:
|
|
|
|
to_key = -1
|
|
|
|
|
|
|
|
presence = self.hs.get_handlers().presence_handler
|
|
|
|
cachemap = presence._user_cachemap
|
|
|
|
|
|
|
|
# TODO(paul): limit, and filter by visibility
|
|
|
|
updates = [(k, cachemap[k]) for k in cachemap
|
|
|
|
if to_key < cachemap[k].serial < from_key]
|
|
|
|
|
|
|
|
if updates:
|
|
|
|
clock = self.clock
|
|
|
|
|
|
|
|
earliest_serial = max([x[1].serial for x in updates])
|
|
|
|
data = [x[1].make_event(user=x[0], clock=clock) for x in updates]
|
|
|
|
|
|
|
|
if to_token:
|
|
|
|
next_token = to_token
|
|
|
|
else:
|
|
|
|
next_token = from_token
|
|
|
|
|
|
|
|
next_token = next_token.copy_and_replace(
|
|
|
|
"presence_key", earliest_serial
|
|
|
|
)
|
|
|
|
return ((data, next_token))
|
|
|
|
else:
|
|
|
|
if not to_token:
|
|
|
|
to_token = from_token.copy_and_replace(
|
|
|
|
"presence_key", 0
|
|
|
|
)
|
|
|
|
return (([], to_token))
|
|
|
|
|
2014-08-26 13:57:46 -04:00
|
|
|
|
|
|
|
class EventSources(object):
|
2014-08-27 10:33:52 -04:00
|
|
|
SOURCE_TYPES = {
|
|
|
|
"room": RoomEventSource,
|
|
|
|
"presence": PresenceSource,
|
|
|
|
}
|
2014-08-26 13:57:46 -04:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
2014-08-27 10:33:52 -04:00
|
|
|
self.sources = {
|
|
|
|
name: cls(hs)
|
|
|
|
for name, cls in EventSources.SOURCE_TYPES.items()
|
|
|
|
}
|
2014-08-26 13:57:46 -04:00
|
|
|
|
|
|
|
@staticmethod
|
|
|
|
def create_token(events_key, presence_key):
|
|
|
|
return StreamToken(events_key=events_key, presence_key=presence_key)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def get_current_token(self):
|
2014-08-27 10:33:52 -04:00
|
|
|
events_key = yield self.sources["room"].get_current_token_part()
|
|
|
|
presence_key = yield self.sources["presence"].get_current_token_part()
|
2014-08-27 09:03:27 -04:00
|
|
|
token = EventSources.create_token(events_key, presence_key)
|
2014-08-26 13:57:46 -04:00
|
|
|
defer.returnValue(token)
|
|
|
|
|
|
|
|
|
|
|
|
class StreamSource(object):
|
2014-08-27 09:03:27 -04:00
|
|
|
def get_new_events_for_user(self, user, from_token, limit):
|
2014-08-26 13:57:46 -04:00
|
|
|
raise NotImplementedError("get_new_events_for_user")
|
|
|
|
|
|
|
|
def get_current_token_part(self):
|
|
|
|
raise NotImplementedError("get_current_token_part")
|
|
|
|
|
2014-08-27 10:25:21 -04:00
|
|
|
def get_pagination_rows(self, user, pagination_config, key):
|
2014-08-26 13:57:46 -04:00
|
|
|
raise NotImplementedError("get_rows")
|