444 lines
16 KiB
Python
444 lines
16 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2014, 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.
|
|
|
|
""" This module is responsible for getting events from the DB for pagination
|
|
and event streaming.
|
|
|
|
The order it returns events in depend on whether we are streaming forwards or
|
|
are paginating backwards. We do this because we want to handle out of order
|
|
messages nicely, while still returning them in the correct order when we
|
|
paginate bacwards.
|
|
|
|
This is implemented by keeping two ordering columns: stream_ordering and
|
|
topological_ordering. Stream ordering is basically insertion/received order
|
|
(except for events from backfill requests). The topolgical_ordering is a
|
|
weak ordering of events based on the pdu graph.
|
|
|
|
This means that we have to have two different types of tokens, depending on
|
|
what sort order was used:
|
|
- stream tokens are of the form: "s%d", which maps directly to the column
|
|
- topological tokems: "t%d-%d", where the integers map to the topological
|
|
and stream ordering columns respectively.
|
|
"""
|
|
|
|
from twisted.internet import defer
|
|
|
|
from ._base import SQLBaseStore
|
|
from synapse.api.constants import EventTypes
|
|
from synapse.api.errors import SynapseError
|
|
from synapse.util.logutils import log_function
|
|
|
|
from collections import namedtuple
|
|
|
|
import logging
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
MAX_STREAM_SIZE = 1000
|
|
|
|
|
|
_STREAM_TOKEN = "stream"
|
|
_TOPOLOGICAL_TOKEN = "topological"
|
|
|
|
|
|
class _StreamToken(namedtuple("_StreamToken", "topological stream")):
|
|
"""Tokens are positions between events. The token "s1" comes after event 1.
|
|
|
|
s0 s1
|
|
| |
|
|
[0] V [1] V [2]
|
|
|
|
Tokens can either be a point in the live event stream or a cursor going
|
|
through historic events.
|
|
|
|
When traversing the live event stream events are ordered by when they
|
|
arrived at the homeserver.
|
|
|
|
When traversing historic events the events are ordered by their depth in
|
|
the event graph "topological_ordering" and then by when they arrived at the
|
|
homeserver "stream_ordering".
|
|
|
|
Live tokens start with an "s" followed by the "stream_ordering" id of the
|
|
event it comes after. Historic tokens start with a "t" followed by the
|
|
"topological_ordering" id of the event it comes after, follewed by "-",
|
|
followed by the "stream_ordering" id of the event it comes after.
|
|
"""
|
|
__slots__ = []
|
|
|
|
@classmethod
|
|
def parse(cls, string):
|
|
try:
|
|
if string[0] == 's':
|
|
return cls(topological=None, stream=int(string[1:]))
|
|
if string[0] == 't':
|
|
parts = string[1:].split('-', 1)
|
|
return cls(topological=int(parts[0]), stream=int(parts[1]))
|
|
except:
|
|
pass
|
|
raise SynapseError(400, "Invalid token %r" % (string,))
|
|
|
|
@classmethod
|
|
def parse_stream_token(cls, string):
|
|
try:
|
|
if string[0] == 's':
|
|
return cls(topological=None, stream=int(string[1:]))
|
|
except:
|
|
pass
|
|
raise SynapseError(400, "Invalid token %r" % (string,))
|
|
|
|
def __str__(self):
|
|
if self.topological is not None:
|
|
return "t%d-%d" % (self.topological, self.stream)
|
|
else:
|
|
return "s%d" % (self.stream,)
|
|
|
|
def lower_bound(self):
|
|
if self.topological is None:
|
|
return "(%d < %s)" % (self.stream, "stream_ordering")
|
|
else:
|
|
return "(%d < %s OR (%d = %s AND %d < %s))" % (
|
|
self.topological, "topological_ordering",
|
|
self.topological, "topological_ordering",
|
|
self.stream, "stream_ordering",
|
|
)
|
|
|
|
def upper_bound(self):
|
|
if self.topological is None:
|
|
return "(%d >= %s)" % (self.stream, "stream_ordering")
|
|
else:
|
|
return "(%d > %s OR (%d = %s AND %d >= %s))" % (
|
|
self.topological, "topological_ordering",
|
|
self.topological, "topological_ordering",
|
|
self.stream, "stream_ordering",
|
|
)
|
|
|
|
|
|
class StreamStore(SQLBaseStore):
|
|
|
|
@defer.inlineCallbacks
|
|
def get_appservice_room_stream(self, service, from_key, to_key, limit=0):
|
|
# NB this lives here instead of appservice.py so we can reuse the
|
|
# 'private' StreamToken class in this file.
|
|
if limit:
|
|
limit = max(limit, MAX_STREAM_SIZE)
|
|
else:
|
|
limit = MAX_STREAM_SIZE
|
|
|
|
# From and to keys should be integers from ordering.
|
|
from_id = _StreamToken.parse_stream_token(from_key)
|
|
to_id = _StreamToken.parse_stream_token(to_key)
|
|
|
|
if from_key == to_key:
|
|
defer.returnValue(([], to_key))
|
|
return
|
|
|
|
# select all the events between from/to with a sensible limit
|
|
sql = (
|
|
"SELECT e.event_id, e.room_id, e.type, s.state_key, "
|
|
"e.stream_ordering FROM events AS e "
|
|
"LEFT JOIN state_events as s ON "
|
|
"e.event_id = s.event_id "
|
|
"WHERE e.stream_ordering > ? AND e.stream_ordering <= ? "
|
|
"ORDER BY stream_ordering ASC LIMIT %(limit)d "
|
|
) % {
|
|
"limit": limit
|
|
}
|
|
|
|
def f(txn):
|
|
# pull out all the events between the tokens
|
|
txn.execute(sql, (from_id.stream, to_id.stream,))
|
|
rows = self.cursor_to_dict(txn)
|
|
|
|
# Logic:
|
|
# - We want ALL events which match the AS room_id regex
|
|
# - We want ALL events which match the rooms represented by the AS
|
|
# room_alias regex
|
|
# - We want ALL events for rooms that AS users have joined.
|
|
# This is currently supported via get_app_service_rooms (which is
|
|
# used for the Notifier listener rooms). We can't reasonably make a
|
|
# SQL query for these room IDs, so we'll pull all the events between
|
|
# from/to and filter in python.
|
|
rooms_for_as = self._get_app_service_rooms_txn(txn, service)
|
|
room_ids_for_as = [r.room_id for r in rooms_for_as]
|
|
|
|
def app_service_interested(row):
|
|
if row["room_id"] in room_ids_for_as:
|
|
return True
|
|
|
|
if row["type"] == EventTypes.Member:
|
|
if service.is_interested_in_user(row.get("state_key")):
|
|
return True
|
|
return False
|
|
|
|
ret = self._get_events_txn(
|
|
txn,
|
|
# apply the filter on the room id list
|
|
[
|
|
r["event_id"] for r in rows
|
|
if app_service_interested(r)
|
|
],
|
|
get_prev_content=True
|
|
)
|
|
|
|
self._set_before_and_after(ret, rows)
|
|
|
|
if rows:
|
|
key = "s%d" % max(r["stream_ordering"] for r in rows)
|
|
else:
|
|
# Assume we didn't get anything because there was nothing to
|
|
# get.
|
|
key = to_key
|
|
|
|
return ret, key
|
|
|
|
results = yield self.runInteraction("get_appservice_room_stream", f)
|
|
defer.returnValue(results)
|
|
|
|
@log_function
|
|
def get_room_events_stream(self, user_id, from_key, to_key, room_id,
|
|
limit=0, with_feedback=False):
|
|
# TODO (erikj): Handle compressed feedback
|
|
|
|
current_room_membership_sql = (
|
|
"SELECT m.room_id FROM room_memberships as m "
|
|
" INNER JOIN current_state_events as c"
|
|
" ON m.event_id = c.event_id AND c.state_key = m.user_id"
|
|
" WHERE m.user_id = ? AND m.membership = 'join'"
|
|
)
|
|
|
|
# We also want to get any membership events about that user, e.g.
|
|
# invites or leave notifications.
|
|
membership_sql = (
|
|
"SELECT m.event_id FROM room_memberships as m "
|
|
"INNER JOIN current_state_events as c ON m.event_id = c.event_id "
|
|
"WHERE m.user_id = ? "
|
|
)
|
|
|
|
if limit:
|
|
limit = max(limit, MAX_STREAM_SIZE)
|
|
else:
|
|
limit = MAX_STREAM_SIZE
|
|
|
|
# From and to keys should be integers from ordering.
|
|
from_id = _StreamToken.parse_stream_token(from_key)
|
|
to_id = _StreamToken.parse_stream_token(to_key)
|
|
|
|
if from_key == to_key:
|
|
return defer.succeed(([], to_key))
|
|
|
|
sql = (
|
|
"SELECT e.event_id, e.stream_ordering FROM events AS e WHERE "
|
|
"(e.outlier = ? AND (room_id IN (%(current)s)) OR "
|
|
"(event_id IN (%(invites)s))) "
|
|
"AND e.stream_ordering > ? AND e.stream_ordering <= ? "
|
|
"ORDER BY stream_ordering ASC LIMIT %(limit)d "
|
|
) % {
|
|
"current": current_room_membership_sql,
|
|
"invites": membership_sql,
|
|
"limit": limit
|
|
}
|
|
|
|
def f(txn):
|
|
txn.execute(sql, (False, user_id, user_id, from_id.stream, to_id.stream,))
|
|
|
|
rows = self.cursor_to_dict(txn)
|
|
|
|
ret = self._get_events_txn(
|
|
txn,
|
|
[r["event_id"] for r in rows],
|
|
get_prev_content=True
|
|
)
|
|
|
|
self._set_before_and_after(ret, rows)
|
|
|
|
if rows:
|
|
key = "s%d" % max(r["stream_ordering"] for r in rows)
|
|
else:
|
|
# Assume we didn't get anything because there was nothing to
|
|
# get.
|
|
key = to_key
|
|
|
|
return ret, key
|
|
|
|
return self.runInteraction("get_room_events_stream", f)
|
|
|
|
@log_function
|
|
def paginate_room_events(self, room_id, from_key, to_key=None,
|
|
direction='b', limit=-1,
|
|
with_feedback=False):
|
|
# TODO (erikj): Handle compressed feedback
|
|
|
|
# Tokens really represent positions between elements, but we use
|
|
# the convention of pointing to the event before the gap. Hence
|
|
# we have a bit of asymmetry when it comes to equalities.
|
|
args = [False, room_id]
|
|
if direction == 'b':
|
|
order = "DESC"
|
|
bounds = _StreamToken.parse(from_key).upper_bound()
|
|
if to_key:
|
|
bounds = "%s AND %s" % (
|
|
bounds, _StreamToken.parse(to_key).lower_bound()
|
|
)
|
|
else:
|
|
order = "ASC"
|
|
bounds = _StreamToken.parse(from_key).lower_bound()
|
|
if to_key:
|
|
bounds = "%s AND %s" % (
|
|
bounds, _StreamToken.parse(to_key).upper_bound()
|
|
)
|
|
|
|
if int(limit) > 0:
|
|
args.append(int(limit))
|
|
limit_str = " LIMIT ?"
|
|
else:
|
|
limit_str = ""
|
|
|
|
sql = (
|
|
"SELECT * FROM events"
|
|
" WHERE outlier = ? AND room_id = ? AND %(bounds)s"
|
|
" ORDER BY topological_ordering %(order)s,"
|
|
" stream_ordering %(order)s %(limit)s"
|
|
) % {
|
|
"bounds": bounds,
|
|
"order": order,
|
|
"limit": limit_str
|
|
}
|
|
|
|
def f(txn):
|
|
txn.execute(sql, args)
|
|
|
|
rows = self.cursor_to_dict(txn)
|
|
|
|
if rows:
|
|
topo = rows[-1]["topological_ordering"]
|
|
toke = rows[-1]["stream_ordering"]
|
|
if direction == 'b':
|
|
# Tokens are positions between events.
|
|
# This token points *after* the last event in the chunk.
|
|
# We need it to point to the event before it in the chunk
|
|
# when we are going backwards so we subtract one from the
|
|
# stream part.
|
|
toke -= 1
|
|
next_token = str(_StreamToken(topo, toke))
|
|
else:
|
|
# TODO (erikj): We should work out what to do here instead.
|
|
next_token = to_key if to_key else from_key
|
|
|
|
events = self._get_events_txn(
|
|
txn,
|
|
[r["event_id"] for r in rows],
|
|
get_prev_content=True
|
|
)
|
|
|
|
self._set_before_and_after(events, rows)
|
|
|
|
return events, next_token,
|
|
|
|
return self.runInteraction("paginate_room_events", f)
|
|
|
|
def get_recent_events_for_room(self, room_id, limit, end_token,
|
|
with_feedback=False, from_token=None):
|
|
# TODO (erikj): Handle compressed feedback
|
|
|
|
end_token = _StreamToken.parse_stream_token(end_token)
|
|
|
|
if from_token is None:
|
|
sql = (
|
|
"SELECT stream_ordering, topological_ordering, event_id"
|
|
" FROM events"
|
|
" WHERE room_id = ? AND stream_ordering <= ? AND outlier = ?"
|
|
" ORDER BY topological_ordering DESC, stream_ordering DESC"
|
|
" LIMIT ?"
|
|
)
|
|
else:
|
|
from_token = _StreamToken.parse_stream_token(from_token)
|
|
sql = (
|
|
"SELECT stream_ordering, topological_ordering, event_id"
|
|
" FROM events"
|
|
" WHERE room_id = ? AND stream_ordering > ?"
|
|
" AND stream_ordering <= ? AND outlier = ?"
|
|
" ORDER BY topological_ordering DESC, stream_ordering DESC"
|
|
" LIMIT ?"
|
|
)
|
|
|
|
def get_recent_events_for_room_txn(txn):
|
|
if from_token is None:
|
|
txn.execute(sql, (room_id, end_token.stream, False, limit,))
|
|
else:
|
|
txn.execute(sql, (
|
|
room_id, from_token.stream, end_token.stream, False, limit
|
|
))
|
|
|
|
rows = self.cursor_to_dict(txn)
|
|
|
|
rows.reverse() # As we selected with reverse ordering
|
|
|
|
if rows:
|
|
# Tokens are positions between events.
|
|
# This token points *after* the last event in the chunk.
|
|
# We need it to point to the event before it in the chunk
|
|
# since we are going backwards so we subtract one from the
|
|
# stream part.
|
|
topo = rows[0]["topological_ordering"]
|
|
toke = rows[0]["stream_ordering"] - 1
|
|
start_token = str(_StreamToken(topo, toke))
|
|
|
|
token = (start_token, str(end_token))
|
|
else:
|
|
token = (str(end_token), str(end_token))
|
|
|
|
events = self._get_events_txn(
|
|
txn,
|
|
[r["event_id"] for r in rows],
|
|
get_prev_content=True
|
|
)
|
|
|
|
self._set_before_and_after(events, rows)
|
|
|
|
return events, token
|
|
|
|
return self.runInteraction(
|
|
"get_recent_events_for_room", get_recent_events_for_room_txn
|
|
)
|
|
|
|
@defer.inlineCallbacks
|
|
def get_room_events_max_id(self):
|
|
token = yield self._stream_id_gen.get_max_token(self)
|
|
defer.returnValue("s%d" % (token,))
|
|
|
|
@defer.inlineCallbacks
|
|
def _get_min_token(self):
|
|
row = yield self._execute(
|
|
"_get_min_token", None, "SELECT MIN(stream_ordering) FROM events"
|
|
)
|
|
|
|
self.min_token = row[0][0] if row and row[0] and row[0][0] else -1
|
|
self.min_token = min(self.min_token, -1)
|
|
|
|
logger.debug("min_token is: %s", self.min_token)
|
|
|
|
defer.returnValue(self.min_token)
|
|
|
|
@staticmethod
|
|
def _set_before_and_after(events, rows):
|
|
for event, row in zip(events, rows):
|
|
stream = row["stream_ordering"]
|
|
topo = event.depth
|
|
internal = event.internal_metadata
|
|
internal.before = str(_StreamToken(topo, stream - 1))
|
|
internal.after = str(_StreamToken(topo, stream))
|