2326 lines
85 KiB
Python
2326 lines
85 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2014-2016 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 ._base import SQLBaseStore
|
|
|
|
from twisted.internet import defer, reactor
|
|
|
|
from synapse.events import FrozenEvent, USE_FROZEN_DICTS
|
|
from synapse.events.utils import prune_event
|
|
|
|
from synapse.util.async import ObservableDeferred
|
|
from synapse.util.logcontext import (
|
|
preserve_fn, PreserveLoggingContext, make_deferred_yieldable
|
|
)
|
|
from synapse.util.logutils import log_function
|
|
from synapse.util.metrics import Measure
|
|
from synapse.api.constants import EventTypes
|
|
from synapse.api.errors import SynapseError
|
|
from synapse.state import resolve_events_with_factory
|
|
from synapse.util.caches.descriptors import cached
|
|
from synapse.types import get_domain_from_id
|
|
|
|
from canonicaljson import encode_canonical_json
|
|
from collections import deque, namedtuple, OrderedDict
|
|
from functools import wraps
|
|
|
|
import synapse.metrics
|
|
|
|
import logging
|
|
import ujson as json
|
|
|
|
# these are only included to make the type annotations work
|
|
from synapse.events import EventBase # noqa: F401
|
|
from synapse.events.snapshot import EventContext # noqa: F401
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
metrics = synapse.metrics.get_metrics_for(__name__)
|
|
persist_event_counter = metrics.register_counter("persisted_events")
|
|
event_counter = metrics.register_counter(
|
|
"persisted_events_sep", labels=["type", "origin_type", "origin_entity"]
|
|
)
|
|
|
|
|
|
def encode_json(json_object):
|
|
if USE_FROZEN_DICTS:
|
|
# ujson doesn't like frozen_dicts
|
|
return encode_canonical_json(json_object)
|
|
else:
|
|
return json.dumps(json_object, ensure_ascii=False)
|
|
|
|
|
|
# These values are used in the `enqueus_event` and `_do_fetch` methods to
|
|
# control how we batch/bulk fetch events from the database.
|
|
# The values are plucked out of thing air to make initial sync run faster
|
|
# on jki.re
|
|
# TODO: Make these configurable.
|
|
EVENT_QUEUE_THREADS = 3 # Max number of threads that will fetch events
|
|
EVENT_QUEUE_ITERATIONS = 3 # No. times we block waiting for requests for events
|
|
EVENT_QUEUE_TIMEOUT_S = 0.1 # Timeout when waiting for requests for events
|
|
|
|
|
|
class _EventPeristenceQueue(object):
|
|
"""Queues up events so that they can be persisted in bulk with only one
|
|
concurrent transaction per room.
|
|
"""
|
|
|
|
_EventPersistQueueItem = namedtuple("_EventPersistQueueItem", (
|
|
"events_and_contexts", "backfilled", "deferred",
|
|
))
|
|
|
|
def __init__(self):
|
|
self._event_persist_queues = {}
|
|
self._currently_persisting_rooms = set()
|
|
|
|
def add_to_queue(self, room_id, events_and_contexts, backfilled):
|
|
"""Add events to the queue, with the given persist_event options.
|
|
|
|
NB: due to the normal usage pattern of this method, it does *not*
|
|
follow the synapse logcontext rules, and leaves the logcontext in
|
|
place whether or not the returned deferred is ready.
|
|
|
|
Args:
|
|
room_id (str):
|
|
events_and_contexts (list[(EventBase, EventContext)]):
|
|
backfilled (bool):
|
|
|
|
Returns:
|
|
defer.Deferred: a deferred which will resolve once the events are
|
|
persisted. Runs its callbacks *without* a logcontext.
|
|
"""
|
|
queue = self._event_persist_queues.setdefault(room_id, deque())
|
|
if queue:
|
|
# if the last item in the queue has the same `backfilled` setting,
|
|
# we can just add these new events to that item.
|
|
end_item = queue[-1]
|
|
if end_item.backfilled == backfilled:
|
|
end_item.events_and_contexts.extend(events_and_contexts)
|
|
return end_item.deferred.observe()
|
|
|
|
deferred = ObservableDeferred(defer.Deferred())
|
|
|
|
queue.append(self._EventPersistQueueItem(
|
|
events_and_contexts=events_and_contexts,
|
|
backfilled=backfilled,
|
|
deferred=deferred,
|
|
))
|
|
|
|
return deferred.observe()
|
|
|
|
def handle_queue(self, room_id, per_item_callback):
|
|
"""Attempts to handle the queue for a room if not already being handled.
|
|
|
|
The given callback will be invoked with for each item in the queue,
|
|
of type _EventPersistQueueItem. The per_item_callback will continuously
|
|
be called with new items, unless the queue becomnes empty. The return
|
|
value of the function will be given to the deferreds waiting on the item,
|
|
exceptions will be passed to the deferreds as well.
|
|
|
|
This function should therefore be called whenever anything is added
|
|
to the queue.
|
|
|
|
If another callback is currently handling the queue then it will not be
|
|
invoked.
|
|
"""
|
|
|
|
if room_id in self._currently_persisting_rooms:
|
|
return
|
|
|
|
self._currently_persisting_rooms.add(room_id)
|
|
|
|
@defer.inlineCallbacks
|
|
def handle_queue_loop():
|
|
try:
|
|
queue = self._get_drainining_queue(room_id)
|
|
for item in queue:
|
|
# handle_queue_loop runs in the sentinel logcontext, so
|
|
# there is no need to preserve_fn when running the
|
|
# callbacks on the deferred.
|
|
try:
|
|
ret = yield per_item_callback(item)
|
|
item.deferred.callback(ret)
|
|
except Exception as e:
|
|
item.deferred.errback(e)
|
|
finally:
|
|
queue = self._event_persist_queues.pop(room_id, None)
|
|
if queue:
|
|
self._event_persist_queues[room_id] = queue
|
|
self._currently_persisting_rooms.discard(room_id)
|
|
|
|
# set handle_queue_loop off on the background. We don't want to
|
|
# attribute work done in it to the current request, so we drop the
|
|
# logcontext altogether.
|
|
with PreserveLoggingContext():
|
|
handle_queue_loop()
|
|
|
|
def _get_drainining_queue(self, room_id):
|
|
queue = self._event_persist_queues.setdefault(room_id, deque())
|
|
|
|
try:
|
|
while True:
|
|
yield queue.popleft()
|
|
except IndexError:
|
|
# Queue has been drained.
|
|
pass
|
|
|
|
|
|
_EventCacheEntry = namedtuple("_EventCacheEntry", ("event", "redacted_event"))
|
|
|
|
|
|
def _retry_on_integrity_error(func):
|
|
"""Wraps a database function so that it gets retried on IntegrityError,
|
|
with `delete_existing=True` passed in.
|
|
|
|
Args:
|
|
func: function that returns a Deferred and accepts a `delete_existing` arg
|
|
"""
|
|
@wraps(func)
|
|
@defer.inlineCallbacks
|
|
def f(self, *args, **kwargs):
|
|
try:
|
|
res = yield func(self, *args, **kwargs)
|
|
except self.database_engine.module.IntegrityError:
|
|
logger.exception("IntegrityError, retrying.")
|
|
res = yield func(self, *args, delete_existing=True, **kwargs)
|
|
defer.returnValue(res)
|
|
|
|
return f
|
|
|
|
|
|
class EventsStore(SQLBaseStore):
|
|
EVENT_ORIGIN_SERVER_TS_NAME = "event_origin_server_ts"
|
|
EVENT_FIELDS_SENDER_URL_UPDATE_NAME = "event_fields_sender_url"
|
|
|
|
def __init__(self, db_conn, hs):
|
|
super(EventsStore, self).__init__(db_conn, hs)
|
|
self._clock = hs.get_clock()
|
|
self.register_background_update_handler(
|
|
self.EVENT_ORIGIN_SERVER_TS_NAME, self._background_reindex_origin_server_ts
|
|
)
|
|
self.register_background_update_handler(
|
|
self.EVENT_FIELDS_SENDER_URL_UPDATE_NAME,
|
|
self._background_reindex_fields_sender,
|
|
)
|
|
|
|
self.register_background_index_update(
|
|
"event_contains_url_index",
|
|
index_name="event_contains_url_index",
|
|
table="events",
|
|
columns=["room_id", "topological_ordering", "stream_ordering"],
|
|
where_clause="contains_url = true AND outlier = false",
|
|
)
|
|
|
|
# an event_id index on event_search is useful for the purge_history
|
|
# api. Plus it means we get to enforce some integrity with a UNIQUE
|
|
# clause
|
|
self.register_background_index_update(
|
|
"event_search_event_id_idx",
|
|
index_name="event_search_event_id_idx",
|
|
table="event_search",
|
|
columns=["event_id"],
|
|
unique=True,
|
|
psql_only=True,
|
|
)
|
|
|
|
self._event_persist_queue = _EventPeristenceQueue()
|
|
|
|
def persist_events(self, events_and_contexts, backfilled=False):
|
|
"""
|
|
Write events to the database
|
|
Args:
|
|
events_and_contexts: list of tuples of (event, context)
|
|
backfilled: ?
|
|
"""
|
|
partitioned = {}
|
|
for event, ctx in events_and_contexts:
|
|
partitioned.setdefault(event.room_id, []).append((event, ctx))
|
|
|
|
deferreds = []
|
|
for room_id, evs_ctxs in partitioned.iteritems():
|
|
d = self._event_persist_queue.add_to_queue(
|
|
room_id, evs_ctxs,
|
|
backfilled=backfilled,
|
|
)
|
|
deferreds.append(d)
|
|
|
|
for room_id in partitioned:
|
|
self._maybe_start_persisting(room_id)
|
|
|
|
return make_deferred_yieldable(
|
|
defer.gatherResults(deferreds, consumeErrors=True)
|
|
)
|
|
|
|
@defer.inlineCallbacks
|
|
@log_function
|
|
def persist_event(self, event, context, backfilled=False):
|
|
"""
|
|
|
|
Args:
|
|
event (EventBase):
|
|
context (EventContext):
|
|
backfilled (bool):
|
|
|
|
Returns:
|
|
Deferred: resolves to (int, int): the stream ordering of ``event``,
|
|
and the stream ordering of the latest persisted event
|
|
"""
|
|
deferred = self._event_persist_queue.add_to_queue(
|
|
event.room_id, [(event, context)],
|
|
backfilled=backfilled,
|
|
)
|
|
|
|
self._maybe_start_persisting(event.room_id)
|
|
|
|
yield make_deferred_yieldable(deferred)
|
|
|
|
max_persisted_id = yield self._stream_id_gen.get_current_token()
|
|
defer.returnValue((event.internal_metadata.stream_ordering, max_persisted_id))
|
|
|
|
def _maybe_start_persisting(self, room_id):
|
|
@defer.inlineCallbacks
|
|
def persisting_queue(item):
|
|
yield self._persist_events(
|
|
item.events_and_contexts,
|
|
backfilled=item.backfilled,
|
|
)
|
|
|
|
self._event_persist_queue.handle_queue(room_id, persisting_queue)
|
|
|
|
@_retry_on_integrity_error
|
|
@defer.inlineCallbacks
|
|
def _persist_events(self, events_and_contexts, backfilled=False,
|
|
delete_existing=False):
|
|
"""Persist events to db
|
|
|
|
Args:
|
|
events_and_contexts (list[(EventBase, EventContext)]):
|
|
backfilled (bool):
|
|
delete_existing (bool):
|
|
|
|
Returns:
|
|
Deferred: resolves when the events have been persisted
|
|
"""
|
|
if not events_and_contexts:
|
|
return
|
|
|
|
if backfilled:
|
|
stream_ordering_manager = self._backfill_id_gen.get_next_mult(
|
|
len(events_and_contexts)
|
|
)
|
|
else:
|
|
stream_ordering_manager = self._stream_id_gen.get_next_mult(
|
|
len(events_and_contexts)
|
|
)
|
|
|
|
with stream_ordering_manager as stream_orderings:
|
|
for (event, context), stream, in zip(
|
|
events_and_contexts, stream_orderings
|
|
):
|
|
event.internal_metadata.stream_ordering = stream
|
|
|
|
chunks = [
|
|
events_and_contexts[x:x + 100]
|
|
for x in xrange(0, len(events_and_contexts), 100)
|
|
]
|
|
|
|
for chunk in chunks:
|
|
# We can't easily parallelize these since different chunks
|
|
# might contain the same event. :(
|
|
|
|
# NB: Assumes that we are only persisting events for one room
|
|
# at a time.
|
|
new_forward_extremeties = {}
|
|
current_state_for_room = {}
|
|
if not backfilled:
|
|
with Measure(self._clock, "_calculate_state_and_extrem"):
|
|
# Work out the new "current state" for each room.
|
|
# We do this by working out what the new extremities are and then
|
|
# calculating the state from that.
|
|
events_by_room = {}
|
|
for event, context in chunk:
|
|
events_by_room.setdefault(event.room_id, []).append(
|
|
(event, context)
|
|
)
|
|
|
|
for room_id, ev_ctx_rm in events_by_room.iteritems():
|
|
# Work out new extremities by recursively adding and removing
|
|
# the new events.
|
|
latest_event_ids = yield self.get_latest_event_ids_in_room(
|
|
room_id
|
|
)
|
|
new_latest_event_ids = yield self._calculate_new_extremeties(
|
|
room_id, ev_ctx_rm, latest_event_ids
|
|
)
|
|
|
|
if new_latest_event_ids == set(latest_event_ids):
|
|
# No change in extremities, so no change in state
|
|
continue
|
|
|
|
new_forward_extremeties[room_id] = new_latest_event_ids
|
|
|
|
len_1 = (
|
|
len(latest_event_ids) == 1
|
|
and len(new_latest_event_ids) == 1
|
|
)
|
|
if len_1:
|
|
all_single_prev_not_state = all(
|
|
len(event.prev_events) == 1
|
|
and not event.is_state()
|
|
for event, ctx in ev_ctx_rm
|
|
)
|
|
# Don't bother calculating state if they're just
|
|
# a long chain of single ancestor non-state events.
|
|
if all_single_prev_not_state:
|
|
continue
|
|
|
|
state = yield self._calculate_state_delta(
|
|
room_id, ev_ctx_rm, new_latest_event_ids
|
|
)
|
|
if state:
|
|
current_state_for_room[room_id] = state
|
|
|
|
yield self.runInteraction(
|
|
"persist_events",
|
|
self._persist_events_txn,
|
|
events_and_contexts=chunk,
|
|
backfilled=backfilled,
|
|
delete_existing=delete_existing,
|
|
current_state_for_room=current_state_for_room,
|
|
new_forward_extremeties=new_forward_extremeties,
|
|
)
|
|
persist_event_counter.inc_by(len(chunk))
|
|
for event, context in chunk:
|
|
if context.app_service:
|
|
origin_type = "local"
|
|
origin_entity = context.app_service.id
|
|
elif self.hs.is_mine_id(event.sender):
|
|
origin_type = "local"
|
|
origin_entity = "*client*"
|
|
else:
|
|
origin_type = "remote"
|
|
origin_entity = get_domain_from_id(event.sender)
|
|
|
|
event_counter.inc(event.type, origin_type, origin_entity)
|
|
|
|
for room_id, (_, _, new_state) in current_state_for_room.iteritems():
|
|
self.get_current_state_ids.prefill(
|
|
(room_id, ), new_state
|
|
)
|
|
|
|
for room_id, latest_event_ids in new_forward_extremeties.iteritems():
|
|
self.get_latest_event_ids_in_room.prefill(
|
|
(room_id,), list(latest_event_ids)
|
|
)
|
|
|
|
@defer.inlineCallbacks
|
|
def _calculate_new_extremeties(self, room_id, event_contexts, latest_event_ids):
|
|
"""Calculates the new forward extremeties for a room given events to
|
|
persist.
|
|
|
|
Assumes that we are only persisting events for one room at a time.
|
|
"""
|
|
new_latest_event_ids = set(latest_event_ids)
|
|
# First, add all the new events to the list
|
|
new_latest_event_ids.update(
|
|
event.event_id for event, ctx in event_contexts
|
|
if not event.internal_metadata.is_outlier() and not ctx.rejected
|
|
)
|
|
# Now remove all events that are referenced by the to-be-added events
|
|
new_latest_event_ids.difference_update(
|
|
e_id
|
|
for event, ctx in event_contexts
|
|
for e_id, _ in event.prev_events
|
|
if not event.internal_metadata.is_outlier() and not ctx.rejected
|
|
)
|
|
|
|
# And finally remove any events that are referenced by previously added
|
|
# events.
|
|
rows = yield self._simple_select_many_batch(
|
|
table="event_edges",
|
|
column="prev_event_id",
|
|
iterable=list(new_latest_event_ids),
|
|
retcols=["prev_event_id"],
|
|
keyvalues={
|
|
"room_id": room_id,
|
|
"is_state": False,
|
|
},
|
|
desc="_calculate_new_extremeties",
|
|
)
|
|
|
|
new_latest_event_ids.difference_update(
|
|
row["prev_event_id"] for row in rows
|
|
)
|
|
|
|
defer.returnValue(new_latest_event_ids)
|
|
|
|
@defer.inlineCallbacks
|
|
def _calculate_state_delta(self, room_id, events_context, new_latest_event_ids):
|
|
"""Calculate the new state deltas for a room.
|
|
|
|
Assumes that we are only persisting events for one room at a time.
|
|
|
|
Returns:
|
|
3-tuple (to_delete, to_insert, new_state) where both are state dicts,
|
|
i.e. (type, state_key) -> event_id. `to_delete` are the entries to
|
|
first be deleted from current_state_events, `to_insert` are entries
|
|
to insert. `new_state` is the full set of state.
|
|
May return None if there are no changes to be applied.
|
|
"""
|
|
# Now we need to work out the different state sets for
|
|
# each state extremities
|
|
state_sets = []
|
|
state_groups = set()
|
|
missing_event_ids = []
|
|
was_updated = False
|
|
for event_id in new_latest_event_ids:
|
|
# First search in the list of new events we're adding,
|
|
# and then use the current state from that
|
|
for ev, ctx in events_context:
|
|
if event_id == ev.event_id:
|
|
if ctx.current_state_ids is None:
|
|
raise Exception("Unknown current state")
|
|
|
|
# If we've already seen the state group don't bother adding
|
|
# it to the state sets again
|
|
if ctx.state_group not in state_groups:
|
|
state_sets.append(ctx.current_state_ids)
|
|
if ctx.delta_ids or hasattr(ev, "state_key"):
|
|
was_updated = True
|
|
if ctx.state_group:
|
|
# Add this as a seen state group (if it has a state
|
|
# group)
|
|
state_groups.add(ctx.state_group)
|
|
break
|
|
else:
|
|
# If we couldn't find it, then we'll need to pull
|
|
# the state from the database
|
|
was_updated = True
|
|
missing_event_ids.append(event_id)
|
|
|
|
if missing_event_ids:
|
|
# Now pull out the state for any missing events from DB
|
|
event_to_groups = yield self._get_state_group_for_events(
|
|
missing_event_ids,
|
|
)
|
|
|
|
groups = set(event_to_groups.itervalues()) - state_groups
|
|
|
|
if groups:
|
|
group_to_state = yield self._get_state_for_groups(groups)
|
|
state_sets.extend(group_to_state.itervalues())
|
|
|
|
if not new_latest_event_ids:
|
|
current_state = {}
|
|
elif was_updated:
|
|
if len(state_sets) == 1:
|
|
# If there is only one state set, then we know what the current
|
|
# state is.
|
|
current_state = state_sets[0]
|
|
else:
|
|
# We work out the current state by passing the state sets to the
|
|
# state resolution algorithm. It may ask for some events, including
|
|
# the events we have yet to persist, so we need a slightly more
|
|
# complicated event lookup function than simply looking the events
|
|
# up in the db.
|
|
|
|
logger.info(
|
|
"Resolving state for %s with %i state sets",
|
|
room_id, len(state_sets),
|
|
)
|
|
|
|
events_map = {ev.event_id: ev for ev, _ in events_context}
|
|
|
|
@defer.inlineCallbacks
|
|
def get_events(ev_ids):
|
|
# We get the events by first looking at the list of events we
|
|
# are trying to persist, and then fetching the rest from the DB.
|
|
db = []
|
|
to_return = {}
|
|
for ev_id in ev_ids:
|
|
ev = events_map.get(ev_id, None)
|
|
if ev:
|
|
to_return[ev_id] = ev
|
|
else:
|
|
db.append(ev_id)
|
|
|
|
if db:
|
|
evs = yield self.get_events(
|
|
ev_ids, get_prev_content=False, check_redacted=False,
|
|
)
|
|
to_return.update(evs)
|
|
defer.returnValue(to_return)
|
|
|
|
current_state = yield resolve_events_with_factory(
|
|
state_sets,
|
|
state_map_factory=get_events,
|
|
)
|
|
else:
|
|
return
|
|
|
|
existing_state = yield self.get_current_state_ids(room_id)
|
|
|
|
existing_events = set(existing_state.itervalues())
|
|
new_events = set(ev_id for ev_id in current_state.itervalues())
|
|
changed_events = existing_events ^ new_events
|
|
|
|
if not changed_events:
|
|
return
|
|
|
|
to_delete = {
|
|
key: ev_id for key, ev_id in existing_state.iteritems()
|
|
if ev_id in changed_events
|
|
}
|
|
events_to_insert = (new_events - existing_events)
|
|
to_insert = {
|
|
key: ev_id for key, ev_id in current_state.iteritems()
|
|
if ev_id in events_to_insert
|
|
}
|
|
|
|
defer.returnValue((to_delete, to_insert, current_state))
|
|
|
|
@defer.inlineCallbacks
|
|
def get_event(self, event_id, check_redacted=True,
|
|
get_prev_content=False, allow_rejected=False,
|
|
allow_none=False):
|
|
"""Get an event from the database by event_id.
|
|
|
|
Args:
|
|
event_id (str): The event_id of the event to fetch
|
|
check_redacted (bool): If True, check if event has been redacted
|
|
and redact it.
|
|
get_prev_content (bool): If True and event is a state event,
|
|
include the previous states content in the unsigned field.
|
|
allow_rejected (bool): If True return rejected events.
|
|
allow_none (bool): If True, return None if no event found, if
|
|
False throw an exception.
|
|
|
|
Returns:
|
|
Deferred : A FrozenEvent.
|
|
"""
|
|
events = yield self._get_events(
|
|
[event_id],
|
|
check_redacted=check_redacted,
|
|
get_prev_content=get_prev_content,
|
|
allow_rejected=allow_rejected,
|
|
)
|
|
|
|
if not events and not allow_none:
|
|
raise SynapseError(404, "Could not find event %s" % (event_id,))
|
|
|
|
defer.returnValue(events[0] if events else None)
|
|
|
|
@defer.inlineCallbacks
|
|
def get_events(self, event_ids, check_redacted=True,
|
|
get_prev_content=False, allow_rejected=False):
|
|
"""Get events from the database
|
|
|
|
Args:
|
|
event_ids (list): The event_ids of the events to fetch
|
|
check_redacted (bool): If True, check if event has been redacted
|
|
and redact it.
|
|
get_prev_content (bool): If True and event is a state event,
|
|
include the previous states content in the unsigned field.
|
|
allow_rejected (bool): If True return rejected events.
|
|
|
|
Returns:
|
|
Deferred : Dict from event_id to event.
|
|
"""
|
|
events = yield self._get_events(
|
|
event_ids,
|
|
check_redacted=check_redacted,
|
|
get_prev_content=get_prev_content,
|
|
allow_rejected=allow_rejected,
|
|
)
|
|
|
|
defer.returnValue({e.event_id: e for e in events})
|
|
|
|
@log_function
|
|
def _persist_events_txn(self, txn, events_and_contexts, backfilled,
|
|
delete_existing=False, current_state_for_room={},
|
|
new_forward_extremeties={}):
|
|
"""Insert some number of room events into the necessary database tables.
|
|
|
|
Rejected events are only inserted into the events table, the events_json table,
|
|
and the rejections table. Things reading from those table will need to check
|
|
whether the event was rejected.
|
|
|
|
Args:
|
|
txn (twisted.enterprise.adbapi.Connection): db connection
|
|
events_and_contexts (list[(EventBase, EventContext)]):
|
|
events to persist
|
|
backfilled (bool): True if the events were backfilled
|
|
delete_existing (bool): True to purge existing table rows for the
|
|
events from the database. This is useful when retrying due to
|
|
IntegrityError.
|
|
current_state_for_room (dict[str, (list[str], list[str])]):
|
|
The current-state delta for each room. For each room, a tuple
|
|
(to_delete, to_insert), being a list of event ids to be removed
|
|
from the current state, and a list of event ids to be added to
|
|
the current state.
|
|
new_forward_extremeties (dict[str, list[str]]):
|
|
The new forward extremities for each room. For each room, a
|
|
list of the event ids which are the forward extremities.
|
|
|
|
"""
|
|
max_stream_order = events_and_contexts[-1][0].internal_metadata.stream_ordering
|
|
|
|
self._update_current_state_txn(txn, current_state_for_room, max_stream_order)
|
|
|
|
self._update_forward_extremities_txn(
|
|
txn,
|
|
new_forward_extremities=new_forward_extremeties,
|
|
max_stream_order=max_stream_order,
|
|
)
|
|
|
|
# Ensure that we don't have the same event twice.
|
|
events_and_contexts = self._filter_events_and_contexts_for_duplicates(
|
|
events_and_contexts,
|
|
)
|
|
|
|
self._update_room_depths_txn(
|
|
txn,
|
|
events_and_contexts=events_and_contexts,
|
|
backfilled=backfilled,
|
|
)
|
|
|
|
# _update_outliers_txn filters out any events which have already been
|
|
# persisted, and returns the filtered list.
|
|
events_and_contexts = self._update_outliers_txn(
|
|
txn,
|
|
events_and_contexts=events_and_contexts,
|
|
)
|
|
|
|
# From this point onwards the events are only events that we haven't
|
|
# seen before.
|
|
|
|
if delete_existing:
|
|
# For paranoia reasons, we go and delete all the existing entries
|
|
# for these events so we can reinsert them.
|
|
# This gets around any problems with some tables already having
|
|
# entries.
|
|
self._delete_existing_rows_txn(
|
|
txn,
|
|
events_and_contexts=events_and_contexts,
|
|
)
|
|
|
|
self._store_event_txn(
|
|
txn,
|
|
events_and_contexts=events_and_contexts,
|
|
)
|
|
|
|
# Insert into the state_groups, state_groups_state, and
|
|
# event_to_state_groups tables.
|
|
self._store_mult_state_groups_txn(txn, events_and_contexts)
|
|
|
|
# _store_rejected_events_txn filters out any events which were
|
|
# rejected, and returns the filtered list.
|
|
events_and_contexts = self._store_rejected_events_txn(
|
|
txn,
|
|
events_and_contexts=events_and_contexts,
|
|
)
|
|
|
|
# From this point onwards the events are only ones that weren't
|
|
# rejected.
|
|
|
|
self._update_metadata_tables_txn(
|
|
txn,
|
|
events_and_contexts=events_and_contexts,
|
|
backfilled=backfilled,
|
|
)
|
|
|
|
def _update_current_state_txn(self, txn, state_delta_by_room, max_stream_order):
|
|
for room_id, current_state_tuple in state_delta_by_room.iteritems():
|
|
to_delete, to_insert, _ = current_state_tuple
|
|
txn.executemany(
|
|
"DELETE FROM current_state_events WHERE event_id = ?",
|
|
[(ev_id,) for ev_id in to_delete.itervalues()],
|
|
)
|
|
|
|
self._simple_insert_many_txn(
|
|
txn,
|
|
table="current_state_events",
|
|
values=[
|
|
{
|
|
"event_id": ev_id,
|
|
"room_id": room_id,
|
|
"type": key[0],
|
|
"state_key": key[1],
|
|
}
|
|
for key, ev_id in to_insert.iteritems()
|
|
],
|
|
)
|
|
|
|
state_deltas = {key: None for key in to_delete}
|
|
state_deltas.update(to_insert)
|
|
|
|
self._simple_insert_many_txn(
|
|
txn,
|
|
table="current_state_delta_stream",
|
|
values=[
|
|
{
|
|
"stream_id": max_stream_order,
|
|
"room_id": room_id,
|
|
"type": key[0],
|
|
"state_key": key[1],
|
|
"event_id": ev_id,
|
|
"prev_event_id": to_delete.get(key, None),
|
|
}
|
|
for key, ev_id in state_deltas.iteritems()
|
|
]
|
|
)
|
|
|
|
self._curr_state_delta_stream_cache.entity_has_changed(
|
|
room_id, max_stream_order,
|
|
)
|
|
|
|
# Invalidate the various caches
|
|
|
|
# Figure out the changes of membership to invalidate the
|
|
# `get_rooms_for_user` cache.
|
|
# We find out which membership events we may have deleted
|
|
# and which we have added, then we invlidate the caches for all
|
|
# those users.
|
|
members_changed = set(
|
|
state_key for ev_type, state_key in state_deltas
|
|
if ev_type == EventTypes.Member
|
|
)
|
|
|
|
for member in members_changed:
|
|
self._invalidate_cache_and_stream(
|
|
txn, self.get_rooms_for_user, (member,)
|
|
)
|
|
|
|
for host in set(get_domain_from_id(u) for u in members_changed):
|
|
self._invalidate_cache_and_stream(
|
|
txn, self.is_host_joined, (room_id, host)
|
|
)
|
|
self._invalidate_cache_and_stream(
|
|
txn, self.was_host_joined, (room_id, host)
|
|
)
|
|
|
|
self._invalidate_cache_and_stream(
|
|
txn, self.get_users_in_room, (room_id,)
|
|
)
|
|
|
|
self._invalidate_cache_and_stream(
|
|
txn, self.get_current_state_ids, (room_id,)
|
|
)
|
|
|
|
def _update_forward_extremities_txn(self, txn, new_forward_extremities,
|
|
max_stream_order):
|
|
for room_id, new_extrem in new_forward_extremities.iteritems():
|
|
self._simple_delete_txn(
|
|
txn,
|
|
table="event_forward_extremities",
|
|
keyvalues={"room_id": room_id},
|
|
)
|
|
txn.call_after(
|
|
self.get_latest_event_ids_in_room.invalidate, (room_id,)
|
|
)
|
|
|
|
self._simple_insert_many_txn(
|
|
txn,
|
|
table="event_forward_extremities",
|
|
values=[
|
|
{
|
|
"event_id": ev_id,
|
|
"room_id": room_id,
|
|
}
|
|
for room_id, new_extrem in new_forward_extremities.iteritems()
|
|
for ev_id in new_extrem
|
|
],
|
|
)
|
|
# We now insert into stream_ordering_to_exterm a mapping from room_id,
|
|
# new stream_ordering to new forward extremeties in the room.
|
|
# This allows us to later efficiently look up the forward extremeties
|
|
# for a room before a given stream_ordering
|
|
self._simple_insert_many_txn(
|
|
txn,
|
|
table="stream_ordering_to_exterm",
|
|
values=[
|
|
{
|
|
"room_id": room_id,
|
|
"event_id": event_id,
|
|
"stream_ordering": max_stream_order,
|
|
}
|
|
for room_id, new_extrem in new_forward_extremities.iteritems()
|
|
for event_id in new_extrem
|
|
]
|
|
)
|
|
|
|
@classmethod
|
|
def _filter_events_and_contexts_for_duplicates(cls, events_and_contexts):
|
|
"""Ensure that we don't have the same event twice.
|
|
|
|
Pick the earliest non-outlier if there is one, else the earliest one.
|
|
|
|
Args:
|
|
events_and_contexts (list[(EventBase, EventContext)]):
|
|
Returns:
|
|
list[(EventBase, EventContext)]: filtered list
|
|
"""
|
|
new_events_and_contexts = OrderedDict()
|
|
for event, context in events_and_contexts:
|
|
prev_event_context = new_events_and_contexts.get(event.event_id)
|
|
if prev_event_context:
|
|
if not event.internal_metadata.is_outlier():
|
|
if prev_event_context[0].internal_metadata.is_outlier():
|
|
# To ensure correct ordering we pop, as OrderedDict is
|
|
# ordered by first insertion.
|
|
new_events_and_contexts.pop(event.event_id, None)
|
|
new_events_and_contexts[event.event_id] = (event, context)
|
|
else:
|
|
new_events_and_contexts[event.event_id] = (event, context)
|
|
return new_events_and_contexts.values()
|
|
|
|
def _update_room_depths_txn(self, txn, events_and_contexts, backfilled):
|
|
"""Update min_depth for each room
|
|
|
|
Args:
|
|
txn (twisted.enterprise.adbapi.Connection): db connection
|
|
events_and_contexts (list[(EventBase, EventContext)]): events
|
|
we are persisting
|
|
backfilled (bool): True if the events were backfilled
|
|
"""
|
|
depth_updates = {}
|
|
for event, context in events_and_contexts:
|
|
# Remove the any existing cache entries for the event_ids
|
|
txn.call_after(self._invalidate_get_event_cache, event.event_id)
|
|
if not backfilled:
|
|
txn.call_after(
|
|
self._events_stream_cache.entity_has_changed,
|
|
event.room_id, event.internal_metadata.stream_ordering,
|
|
)
|
|
|
|
if not event.internal_metadata.is_outlier() and not context.rejected:
|
|
depth_updates[event.room_id] = max(
|
|
event.depth, depth_updates.get(event.room_id, event.depth)
|
|
)
|
|
|
|
for room_id, depth in depth_updates.iteritems():
|
|
self._update_min_depth_for_room_txn(txn, room_id, depth)
|
|
|
|
def _update_outliers_txn(self, txn, events_and_contexts):
|
|
"""Update any outliers with new event info.
|
|
|
|
This turns outliers into ex-outliers (unless the new event was
|
|
rejected).
|
|
|
|
Args:
|
|
txn (twisted.enterprise.adbapi.Connection): db connection
|
|
events_and_contexts (list[(EventBase, EventContext)]): events
|
|
we are persisting
|
|
|
|
Returns:
|
|
list[(EventBase, EventContext)] new list, without events which
|
|
are already in the events table.
|
|
"""
|
|
txn.execute(
|
|
"SELECT event_id, outlier FROM events WHERE event_id in (%s)" % (
|
|
",".join(["?"] * len(events_and_contexts)),
|
|
),
|
|
[event.event_id for event, _ in events_and_contexts]
|
|
)
|
|
|
|
have_persisted = {
|
|
event_id: outlier
|
|
for event_id, outlier in txn
|
|
}
|
|
|
|
to_remove = set()
|
|
for event, context in events_and_contexts:
|
|
if event.event_id not in have_persisted:
|
|
continue
|
|
|
|
to_remove.add(event)
|
|
|
|
if context.rejected:
|
|
# If the event is rejected then we don't care if the event
|
|
# was an outlier or not.
|
|
continue
|
|
|
|
outlier_persisted = have_persisted[event.event_id]
|
|
if not event.internal_metadata.is_outlier() and outlier_persisted:
|
|
# We received a copy of an event that we had already stored as
|
|
# an outlier in the database. We now have some state at that
|
|
# so we need to update the state_groups table with that state.
|
|
|
|
# insert into the state_group, state_groups_state and
|
|
# event_to_state_groups tables.
|
|
try:
|
|
self._store_mult_state_groups_txn(txn, ((event, context),))
|
|
except Exception:
|
|
logger.exception("")
|
|
raise
|
|
|
|
metadata_json = encode_json(
|
|
event.internal_metadata.get_dict()
|
|
).decode("UTF-8")
|
|
|
|
sql = (
|
|
"UPDATE event_json SET internal_metadata = ?"
|
|
" WHERE event_id = ?"
|
|
)
|
|
txn.execute(
|
|
sql,
|
|
(metadata_json, event.event_id,)
|
|
)
|
|
|
|
# Add an entry to the ex_outlier_stream table to replicate the
|
|
# change in outlier status to our workers.
|
|
stream_order = event.internal_metadata.stream_ordering
|
|
state_group_id = context.state_group
|
|
self._simple_insert_txn(
|
|
txn,
|
|
table="ex_outlier_stream",
|
|
values={
|
|
"event_stream_ordering": stream_order,
|
|
"event_id": event.event_id,
|
|
"state_group": state_group_id,
|
|
}
|
|
)
|
|
|
|
sql = (
|
|
"UPDATE events SET outlier = ?"
|
|
" WHERE event_id = ?"
|
|
)
|
|
txn.execute(
|
|
sql,
|
|
(False, event.event_id,)
|
|
)
|
|
|
|
# Update the event_backward_extremities table now that this
|
|
# event isn't an outlier any more.
|
|
self._update_backward_extremeties(txn, [event])
|
|
|
|
return [
|
|
ec for ec in events_and_contexts if ec[0] not in to_remove
|
|
]
|
|
|
|
@classmethod
|
|
def _delete_existing_rows_txn(cls, txn, events_and_contexts):
|
|
if not events_and_contexts:
|
|
# nothing to do here
|
|
return
|
|
|
|
logger.info("Deleting existing")
|
|
|
|
for table in (
|
|
"events",
|
|
"event_auth",
|
|
"event_json",
|
|
"event_content_hashes",
|
|
"event_destinations",
|
|
"event_edge_hashes",
|
|
"event_edges",
|
|
"event_forward_extremities",
|
|
"event_push_actions",
|
|
"event_reference_hashes",
|
|
"event_search",
|
|
"event_signatures",
|
|
"event_to_state_groups",
|
|
"guest_access",
|
|
"history_visibility",
|
|
"local_invites",
|
|
"room_names",
|
|
"state_events",
|
|
"rejections",
|
|
"redactions",
|
|
"room_memberships",
|
|
"topics"
|
|
):
|
|
txn.executemany(
|
|
"DELETE FROM %s WHERE event_id = ?" % (table,),
|
|
[(ev.event_id,) for ev, _ in events_and_contexts]
|
|
)
|
|
|
|
def _store_event_txn(self, txn, events_and_contexts):
|
|
"""Insert new events into the event and event_json tables
|
|
|
|
Args:
|
|
txn (twisted.enterprise.adbapi.Connection): db connection
|
|
events_and_contexts (list[(EventBase, EventContext)]): events
|
|
we are persisting
|
|
"""
|
|
|
|
if not events_and_contexts:
|
|
# nothing to do here
|
|
return
|
|
|
|
def event_dict(event):
|
|
d = event.get_dict()
|
|
d.pop("redacted", None)
|
|
d.pop("redacted_because", None)
|
|
return d
|
|
|
|
self._simple_insert_many_txn(
|
|
txn,
|
|
table="event_json",
|
|
values=[
|
|
{
|
|
"event_id": event.event_id,
|
|
"room_id": event.room_id,
|
|
"internal_metadata": encode_json(
|
|
event.internal_metadata.get_dict()
|
|
).decode("UTF-8"),
|
|
"json": encode_json(event_dict(event)).decode("UTF-8"),
|
|
}
|
|
for event, _ in events_and_contexts
|
|
],
|
|
)
|
|
|
|
self._simple_insert_many_txn(
|
|
txn,
|
|
table="events",
|
|
values=[
|
|
{
|
|
"stream_ordering": event.internal_metadata.stream_ordering,
|
|
"topological_ordering": event.depth,
|
|
"depth": event.depth,
|
|
"event_id": event.event_id,
|
|
"room_id": event.room_id,
|
|
"type": event.type,
|
|
"processed": True,
|
|
"outlier": event.internal_metadata.is_outlier(),
|
|
"content": encode_json(event.content).decode("UTF-8"),
|
|
"origin_server_ts": int(event.origin_server_ts),
|
|
"received_ts": self._clock.time_msec(),
|
|
"sender": event.sender,
|
|
"contains_url": (
|
|
"url" in event.content
|
|
and isinstance(event.content["url"], basestring)
|
|
),
|
|
}
|
|
for event, _ in events_and_contexts
|
|
],
|
|
)
|
|
|
|
def _store_rejected_events_txn(self, txn, events_and_contexts):
|
|
"""Add rows to the 'rejections' table for received events which were
|
|
rejected
|
|
|
|
Args:
|
|
txn (twisted.enterprise.adbapi.Connection): db connection
|
|
events_and_contexts (list[(EventBase, EventContext)]): events
|
|
we are persisting
|
|
|
|
Returns:
|
|
list[(EventBase, EventContext)] new list, without the rejected
|
|
events.
|
|
"""
|
|
# Remove the rejected events from the list now that we've added them
|
|
# to the events table and the events_json table.
|
|
to_remove = set()
|
|
for event, context in events_and_contexts:
|
|
if context.rejected:
|
|
# Insert the event_id into the rejections table
|
|
self._store_rejections_txn(
|
|
txn, event.event_id, context.rejected
|
|
)
|
|
to_remove.add(event)
|
|
|
|
return [
|
|
ec for ec in events_and_contexts if ec[0] not in to_remove
|
|
]
|
|
|
|
def _update_metadata_tables_txn(self, txn, events_and_contexts, backfilled):
|
|
"""Update all the miscellaneous tables for new events
|
|
|
|
Args:
|
|
txn (twisted.enterprise.adbapi.Connection): db connection
|
|
events_and_contexts (list[(EventBase, EventContext)]): events
|
|
we are persisting
|
|
backfilled (bool): True if the events were backfilled
|
|
"""
|
|
|
|
if not events_and_contexts:
|
|
# nothing to do here
|
|
return
|
|
|
|
for event, context in events_and_contexts:
|
|
# Insert all the push actions into the event_push_actions table.
|
|
if context.push_actions:
|
|
self._set_push_actions_for_event_and_users_txn(
|
|
txn, event, context.push_actions
|
|
)
|
|
|
|
if event.type == EventTypes.Redaction and event.redacts is not None:
|
|
# Remove the entries in the event_push_actions table for the
|
|
# redacted event.
|
|
self._remove_push_actions_for_event_id_txn(
|
|
txn, event.room_id, event.redacts
|
|
)
|
|
|
|
self._simple_insert_many_txn(
|
|
txn,
|
|
table="event_auth",
|
|
values=[
|
|
{
|
|
"event_id": event.event_id,
|
|
"room_id": event.room_id,
|
|
"auth_id": auth_id,
|
|
}
|
|
for event, _ in events_and_contexts
|
|
for auth_id, _ in event.auth_events
|
|
if event.is_state()
|
|
],
|
|
)
|
|
|
|
# Update the event_forward_extremities, event_backward_extremities and
|
|
# event_edges tables.
|
|
self._handle_mult_prev_events(
|
|
txn,
|
|
events=[event for event, _ in events_and_contexts],
|
|
)
|
|
|
|
for event, _ in events_and_contexts:
|
|
if event.type == EventTypes.Name:
|
|
# Insert into the room_names and event_search tables.
|
|
self._store_room_name_txn(txn, event)
|
|
elif event.type == EventTypes.Topic:
|
|
# Insert into the topics table and event_search table.
|
|
self._store_room_topic_txn(txn, event)
|
|
elif event.type == EventTypes.Message:
|
|
# Insert into the event_search table.
|
|
self._store_room_message_txn(txn, event)
|
|
elif event.type == EventTypes.Redaction:
|
|
# Insert into the redactions table.
|
|
self._store_redaction(txn, event)
|
|
elif event.type == EventTypes.RoomHistoryVisibility:
|
|
# Insert into the event_search table.
|
|
self._store_history_visibility_txn(txn, event)
|
|
elif event.type == EventTypes.GuestAccess:
|
|
# Insert into the event_search table.
|
|
self._store_guest_access_txn(txn, event)
|
|
|
|
# Insert into the room_memberships table.
|
|
self._store_room_members_txn(
|
|
txn,
|
|
[
|
|
event
|
|
for event, _ in events_and_contexts
|
|
if event.type == EventTypes.Member
|
|
],
|
|
backfilled=backfilled,
|
|
)
|
|
|
|
# Insert event_reference_hashes table.
|
|
self._store_event_reference_hashes_txn(
|
|
txn, [event for event, _ in events_and_contexts]
|
|
)
|
|
|
|
state_events_and_contexts = [
|
|
ec for ec in events_and_contexts if ec[0].is_state()
|
|
]
|
|
|
|
state_values = []
|
|
for event, context in state_events_and_contexts:
|
|
vals = {
|
|
"event_id": event.event_id,
|
|
"room_id": event.room_id,
|
|
"type": event.type,
|
|
"state_key": event.state_key,
|
|
}
|
|
|
|
# TODO: How does this work with backfilling?
|
|
if hasattr(event, "replaces_state"):
|
|
vals["prev_state"] = event.replaces_state
|
|
|
|
state_values.append(vals)
|
|
|
|
self._simple_insert_many_txn(
|
|
txn,
|
|
table="state_events",
|
|
values=state_values,
|
|
)
|
|
|
|
self._simple_insert_many_txn(
|
|
txn,
|
|
table="event_edges",
|
|
values=[
|
|
{
|
|
"event_id": event.event_id,
|
|
"prev_event_id": prev_id,
|
|
"room_id": event.room_id,
|
|
"is_state": True,
|
|
}
|
|
for event, _ in state_events_and_contexts
|
|
for prev_id, _ in event.prev_state
|
|
],
|
|
)
|
|
|
|
# Prefill the event cache
|
|
self._add_to_cache(txn, events_and_contexts)
|
|
|
|
def _add_to_cache(self, txn, events_and_contexts):
|
|
to_prefill = []
|
|
|
|
rows = []
|
|
N = 200
|
|
for i in range(0, len(events_and_contexts), N):
|
|
ev_map = {
|
|
e[0].event_id: e[0]
|
|
for e in events_and_contexts[i:i + N]
|
|
}
|
|
if not ev_map:
|
|
break
|
|
|
|
sql = (
|
|
"SELECT "
|
|
" e.event_id as event_id, "
|
|
" r.redacts as redacts,"
|
|
" rej.event_id as rejects "
|
|
" FROM events as e"
|
|
" LEFT JOIN rejections as rej USING (event_id)"
|
|
" LEFT JOIN redactions as r ON e.event_id = r.redacts"
|
|
" WHERE e.event_id IN (%s)"
|
|
) % (",".join(["?"] * len(ev_map)),)
|
|
|
|
txn.execute(sql, ev_map.keys())
|
|
rows = self.cursor_to_dict(txn)
|
|
for row in rows:
|
|
event = ev_map[row["event_id"]]
|
|
if not row["rejects"] and not row["redacts"]:
|
|
to_prefill.append(_EventCacheEntry(
|
|
event=event,
|
|
redacted_event=None,
|
|
))
|
|
|
|
def prefill():
|
|
for cache_entry in to_prefill:
|
|
self._get_event_cache.prefill((cache_entry[0].event_id,), cache_entry)
|
|
txn.call_after(prefill)
|
|
|
|
def _store_redaction(self, txn, event):
|
|
# invalidate the cache for the redacted event
|
|
txn.call_after(self._invalidate_get_event_cache, event.redacts)
|
|
txn.execute(
|
|
"INSERT INTO redactions (event_id, redacts) VALUES (?,?)",
|
|
(event.event_id, event.redacts)
|
|
)
|
|
|
|
@defer.inlineCallbacks
|
|
def have_events_in_timeline(self, event_ids):
|
|
"""Given a list of event ids, check if we have already processed and
|
|
stored them as non outliers.
|
|
"""
|
|
rows = yield self._simple_select_many_batch(
|
|
table="events",
|
|
retcols=("event_id",),
|
|
column="event_id",
|
|
iterable=list(event_ids),
|
|
keyvalues={"outlier": False},
|
|
desc="have_events_in_timeline",
|
|
)
|
|
|
|
defer.returnValue(set(r["event_id"] for r in rows))
|
|
|
|
def have_events(self, event_ids):
|
|
"""Given a list of event ids, check if we have already processed them.
|
|
|
|
Returns:
|
|
dict: Has an entry for each event id we already have seen. Maps to
|
|
the rejected reason string if we rejected the event, else maps to
|
|
None.
|
|
"""
|
|
if not event_ids:
|
|
return defer.succeed({})
|
|
|
|
def f(txn):
|
|
sql = (
|
|
"SELECT e.event_id, reason FROM events as e "
|
|
"LEFT JOIN rejections as r ON e.event_id = r.event_id "
|
|
"WHERE e.event_id = ?"
|
|
)
|
|
|
|
res = {}
|
|
for event_id in event_ids:
|
|
txn.execute(sql, (event_id,))
|
|
row = txn.fetchone()
|
|
if row:
|
|
_, rejected = row
|
|
res[event_id] = rejected
|
|
|
|
return res
|
|
|
|
return self.runInteraction(
|
|
"have_events", f,
|
|
)
|
|
|
|
@defer.inlineCallbacks
|
|
def _get_events(self, event_ids, check_redacted=True,
|
|
get_prev_content=False, allow_rejected=False):
|
|
if not event_ids:
|
|
defer.returnValue([])
|
|
|
|
event_id_list = event_ids
|
|
event_ids = set(event_ids)
|
|
|
|
event_entry_map = self._get_events_from_cache(
|
|
event_ids,
|
|
allow_rejected=allow_rejected,
|
|
)
|
|
|
|
missing_events_ids = [e for e in event_ids if e not in event_entry_map]
|
|
|
|
if missing_events_ids:
|
|
missing_events = yield self._enqueue_events(
|
|
missing_events_ids,
|
|
check_redacted=check_redacted,
|
|
allow_rejected=allow_rejected,
|
|
)
|
|
|
|
event_entry_map.update(missing_events)
|
|
|
|
events = []
|
|
for event_id in event_id_list:
|
|
entry = event_entry_map.get(event_id, None)
|
|
if not entry:
|
|
continue
|
|
|
|
if allow_rejected or not entry.event.rejected_reason:
|
|
if check_redacted and entry.redacted_event:
|
|
event = entry.redacted_event
|
|
else:
|
|
event = entry.event
|
|
|
|
events.append(event)
|
|
|
|
if get_prev_content:
|
|
if "replaces_state" in event.unsigned:
|
|
prev = yield self.get_event(
|
|
event.unsigned["replaces_state"],
|
|
get_prev_content=False,
|
|
allow_none=True,
|
|
)
|
|
if prev:
|
|
event.unsigned = dict(event.unsigned)
|
|
event.unsigned["prev_content"] = prev.content
|
|
event.unsigned["prev_sender"] = prev.sender
|
|
|
|
defer.returnValue(events)
|
|
|
|
def _invalidate_get_event_cache(self, event_id):
|
|
self._get_event_cache.invalidate((event_id,))
|
|
|
|
def _get_events_from_cache(self, events, allow_rejected, update_metrics=True):
|
|
"""Fetch events from the caches
|
|
|
|
Args:
|
|
events (list(str)): list of event_ids to fetch
|
|
allow_rejected (bool): Whether to teturn events that were rejected
|
|
update_metrics (bool): Whether to update the cache hit ratio metrics
|
|
|
|
Returns:
|
|
dict of event_id -> _EventCacheEntry for each event_id in cache. If
|
|
allow_rejected is `False` then there will still be an entry but it
|
|
will be `None`
|
|
"""
|
|
event_map = {}
|
|
|
|
for event_id in events:
|
|
ret = self._get_event_cache.get(
|
|
(event_id,), None,
|
|
update_metrics=update_metrics,
|
|
)
|
|
if not ret:
|
|
continue
|
|
|
|
if allow_rejected or not ret.event.rejected_reason:
|
|
event_map[event_id] = ret
|
|
else:
|
|
event_map[event_id] = None
|
|
|
|
return event_map
|
|
|
|
def _do_fetch(self, conn):
|
|
"""Takes a database connection and waits for requests for events from
|
|
the _event_fetch_list queue.
|
|
"""
|
|
event_list = []
|
|
i = 0
|
|
while True:
|
|
try:
|
|
with self._event_fetch_lock:
|
|
event_list = self._event_fetch_list
|
|
self._event_fetch_list = []
|
|
|
|
if not event_list:
|
|
single_threaded = self.database_engine.single_threaded
|
|
if single_threaded or i > EVENT_QUEUE_ITERATIONS:
|
|
self._event_fetch_ongoing -= 1
|
|
return
|
|
else:
|
|
self._event_fetch_lock.wait(EVENT_QUEUE_TIMEOUT_S)
|
|
i += 1
|
|
continue
|
|
i = 0
|
|
|
|
event_id_lists = zip(*event_list)[0]
|
|
event_ids = [
|
|
item for sublist in event_id_lists for item in sublist
|
|
]
|
|
|
|
rows = self._new_transaction(
|
|
conn, "do_fetch", [], [], None, self._fetch_event_rows, event_ids
|
|
)
|
|
|
|
row_dict = {
|
|
r["event_id"]: r
|
|
for r in rows
|
|
}
|
|
|
|
# We only want to resolve deferreds from the main thread
|
|
def fire(lst, res):
|
|
for ids, d in lst:
|
|
if not d.called:
|
|
try:
|
|
with PreserveLoggingContext():
|
|
d.callback([
|
|
res[i]
|
|
for i in ids
|
|
if i in res
|
|
])
|
|
except Exception:
|
|
logger.exception("Failed to callback")
|
|
with PreserveLoggingContext():
|
|
reactor.callFromThread(fire, event_list, row_dict)
|
|
except Exception as e:
|
|
logger.exception("do_fetch")
|
|
|
|
# We only want to resolve deferreds from the main thread
|
|
def fire(evs):
|
|
for _, d in evs:
|
|
if not d.called:
|
|
with PreserveLoggingContext():
|
|
d.errback(e)
|
|
|
|
if event_list:
|
|
with PreserveLoggingContext():
|
|
reactor.callFromThread(fire, event_list)
|
|
|
|
@defer.inlineCallbacks
|
|
def _enqueue_events(self, events, check_redacted=True, allow_rejected=False):
|
|
"""Fetches events from the database using the _event_fetch_list. This
|
|
allows batch and bulk fetching of events - it allows us to fetch events
|
|
without having to create a new transaction for each request for events.
|
|
"""
|
|
if not events:
|
|
defer.returnValue({})
|
|
|
|
events_d = defer.Deferred()
|
|
with self._event_fetch_lock:
|
|
self._event_fetch_list.append(
|
|
(events, events_d)
|
|
)
|
|
|
|
self._event_fetch_lock.notify()
|
|
|
|
if self._event_fetch_ongoing < EVENT_QUEUE_THREADS:
|
|
self._event_fetch_ongoing += 1
|
|
should_start = True
|
|
else:
|
|
should_start = False
|
|
|
|
if should_start:
|
|
with PreserveLoggingContext():
|
|
self.runWithConnection(
|
|
self._do_fetch
|
|
)
|
|
|
|
logger.debug("Loading %d events", len(events))
|
|
with PreserveLoggingContext():
|
|
rows = yield events_d
|
|
logger.debug("Loaded %d events (%d rows)", len(events), len(rows))
|
|
|
|
if not allow_rejected:
|
|
rows[:] = [r for r in rows if not r["rejects"]]
|
|
|
|
res = yield make_deferred_yieldable(defer.gatherResults(
|
|
[
|
|
preserve_fn(self._get_event_from_row)(
|
|
row["internal_metadata"], row["json"], row["redacts"],
|
|
rejected_reason=row["rejects"],
|
|
)
|
|
for row in rows
|
|
],
|
|
consumeErrors=True
|
|
))
|
|
|
|
defer.returnValue({
|
|
e.event.event_id: e
|
|
for e in res if e
|
|
})
|
|
|
|
def _fetch_event_rows(self, txn, events):
|
|
rows = []
|
|
N = 200
|
|
for i in range(1 + len(events) / N):
|
|
evs = events[i * N:(i + 1) * N]
|
|
if not evs:
|
|
break
|
|
|
|
sql = (
|
|
"SELECT "
|
|
" e.event_id as event_id, "
|
|
" e.internal_metadata,"
|
|
" e.json,"
|
|
" r.redacts as redacts,"
|
|
" rej.event_id as rejects "
|
|
" FROM event_json as e"
|
|
" LEFT JOIN rejections as rej USING (event_id)"
|
|
" LEFT JOIN redactions as r ON e.event_id = r.redacts"
|
|
" WHERE e.event_id IN (%s)"
|
|
) % (",".join(["?"] * len(evs)),)
|
|
|
|
txn.execute(sql, evs)
|
|
rows.extend(self.cursor_to_dict(txn))
|
|
|
|
return rows
|
|
|
|
@defer.inlineCallbacks
|
|
def _get_event_from_row(self, internal_metadata, js, redacted,
|
|
rejected_reason=None):
|
|
with Measure(self._clock, "_get_event_from_row"):
|
|
d = json.loads(js)
|
|
internal_metadata = json.loads(internal_metadata)
|
|
|
|
if rejected_reason:
|
|
rejected_reason = yield self._simple_select_one_onecol(
|
|
table="rejections",
|
|
keyvalues={"event_id": rejected_reason},
|
|
retcol="reason",
|
|
desc="_get_event_from_row_rejected_reason",
|
|
)
|
|
|
|
original_ev = FrozenEvent(
|
|
d,
|
|
internal_metadata_dict=internal_metadata,
|
|
rejected_reason=rejected_reason,
|
|
)
|
|
|
|
redacted_event = None
|
|
if redacted:
|
|
redacted_event = prune_event(original_ev)
|
|
|
|
redaction_id = yield self._simple_select_one_onecol(
|
|
table="redactions",
|
|
keyvalues={"redacts": redacted_event.event_id},
|
|
retcol="event_id",
|
|
desc="_get_event_from_row_redactions",
|
|
)
|
|
|
|
redacted_event.unsigned["redacted_by"] = redaction_id
|
|
# Get the redaction event.
|
|
|
|
because = yield self.get_event(
|
|
redaction_id,
|
|
check_redacted=False,
|
|
allow_none=True,
|
|
)
|
|
|
|
if because:
|
|
# It's fine to do add the event directly, since get_pdu_json
|
|
# will serialise this field correctly
|
|
redacted_event.unsigned["redacted_because"] = because
|
|
|
|
cache_entry = _EventCacheEntry(
|
|
event=original_ev,
|
|
redacted_event=redacted_event,
|
|
)
|
|
|
|
self._get_event_cache.prefill((original_ev.event_id,), cache_entry)
|
|
|
|
defer.returnValue(cache_entry)
|
|
|
|
@defer.inlineCallbacks
|
|
def count_daily_messages(self):
|
|
"""
|
|
Returns an estimate of the number of messages sent in the last day.
|
|
|
|
If it has been significantly less or more than one day since the last
|
|
call to this function, it will return None.
|
|
"""
|
|
def _count_messages(txn):
|
|
sql = """
|
|
SELECT COALESCE(COUNT(*), 0) FROM events
|
|
WHERE type = 'm.room.message'
|
|
AND stream_ordering > ?
|
|
"""
|
|
txn.execute(sql, (self.stream_ordering_day_ago,))
|
|
count, = txn.fetchone()
|
|
return count
|
|
|
|
ret = yield self.runInteraction("count_messages", _count_messages)
|
|
defer.returnValue(ret)
|
|
|
|
@defer.inlineCallbacks
|
|
def count_daily_sent_messages(self):
|
|
def _count_messages(txn):
|
|
# This is good enough as if you have silly characters in your own
|
|
# hostname then thats your own fault.
|
|
like_clause = "%:" + self.hs.hostname
|
|
|
|
sql = """
|
|
SELECT COALESCE(COUNT(*), 0) FROM events
|
|
WHERE type = 'm.room.message'
|
|
AND sender LIKE ?
|
|
AND stream_ordering > ?
|
|
"""
|
|
|
|
txn.execute(sql, (like_clause, self.stream_ordering_day_ago,))
|
|
count, = txn.fetchone()
|
|
return count
|
|
|
|
ret = yield self.runInteraction("count_daily_sent_messages", _count_messages)
|
|
defer.returnValue(ret)
|
|
|
|
@defer.inlineCallbacks
|
|
def count_daily_active_rooms(self):
|
|
def _count(txn):
|
|
sql = """
|
|
SELECT COALESCE(COUNT(DISTINCT room_id), 0) FROM events
|
|
WHERE type = 'm.room.message'
|
|
AND stream_ordering > ?
|
|
"""
|
|
txn.execute(sql, (self.stream_ordering_day_ago,))
|
|
count, = txn.fetchone()
|
|
return count
|
|
|
|
ret = yield self.runInteraction("count_daily_active_rooms", _count)
|
|
defer.returnValue(ret)
|
|
|
|
@defer.inlineCallbacks
|
|
def _background_reindex_fields_sender(self, progress, batch_size):
|
|
target_min_stream_id = progress["target_min_stream_id_inclusive"]
|
|
max_stream_id = progress["max_stream_id_exclusive"]
|
|
rows_inserted = progress.get("rows_inserted", 0)
|
|
|
|
INSERT_CLUMP_SIZE = 1000
|
|
|
|
def reindex_txn(txn):
|
|
sql = (
|
|
"SELECT stream_ordering, event_id, json FROM events"
|
|
" INNER JOIN event_json USING (event_id)"
|
|
" WHERE ? <= stream_ordering AND stream_ordering < ?"
|
|
" ORDER BY stream_ordering DESC"
|
|
" LIMIT ?"
|
|
)
|
|
|
|
txn.execute(sql, (target_min_stream_id, max_stream_id, batch_size))
|
|
|
|
rows = txn.fetchall()
|
|
if not rows:
|
|
return 0
|
|
|
|
min_stream_id = rows[-1][0]
|
|
|
|
update_rows = []
|
|
for row in rows:
|
|
try:
|
|
event_id = row[1]
|
|
event_json = json.loads(row[2])
|
|
sender = event_json["sender"]
|
|
content = event_json["content"]
|
|
|
|
contains_url = "url" in content
|
|
if contains_url:
|
|
contains_url &= isinstance(content["url"], basestring)
|
|
except (KeyError, AttributeError):
|
|
# If the event is missing a necessary field then
|
|
# skip over it.
|
|
continue
|
|
|
|
update_rows.append((sender, contains_url, event_id))
|
|
|
|
sql = (
|
|
"UPDATE events SET sender = ?, contains_url = ? WHERE event_id = ?"
|
|
)
|
|
|
|
for index in range(0, len(update_rows), INSERT_CLUMP_SIZE):
|
|
clump = update_rows[index:index + INSERT_CLUMP_SIZE]
|
|
txn.executemany(sql, clump)
|
|
|
|
progress = {
|
|
"target_min_stream_id_inclusive": target_min_stream_id,
|
|
"max_stream_id_exclusive": min_stream_id,
|
|
"rows_inserted": rows_inserted + len(rows)
|
|
}
|
|
|
|
self._background_update_progress_txn(
|
|
txn, self.EVENT_FIELDS_SENDER_URL_UPDATE_NAME, progress
|
|
)
|
|
|
|
return len(rows)
|
|
|
|
result = yield self.runInteraction(
|
|
self.EVENT_FIELDS_SENDER_URL_UPDATE_NAME, reindex_txn
|
|
)
|
|
|
|
if not result:
|
|
yield self._end_background_update(self.EVENT_FIELDS_SENDER_URL_UPDATE_NAME)
|
|
|
|
defer.returnValue(result)
|
|
|
|
@defer.inlineCallbacks
|
|
def _background_reindex_origin_server_ts(self, progress, batch_size):
|
|
target_min_stream_id = progress["target_min_stream_id_inclusive"]
|
|
max_stream_id = progress["max_stream_id_exclusive"]
|
|
rows_inserted = progress.get("rows_inserted", 0)
|
|
|
|
INSERT_CLUMP_SIZE = 1000
|
|
|
|
def reindex_search_txn(txn):
|
|
sql = (
|
|
"SELECT stream_ordering, event_id FROM events"
|
|
" WHERE ? <= stream_ordering AND stream_ordering < ?"
|
|
" ORDER BY stream_ordering DESC"
|
|
" LIMIT ?"
|
|
)
|
|
|
|
txn.execute(sql, (target_min_stream_id, max_stream_id, batch_size))
|
|
|
|
rows = txn.fetchall()
|
|
if not rows:
|
|
return 0
|
|
|
|
min_stream_id = rows[-1][0]
|
|
event_ids = [row[1] for row in rows]
|
|
|
|
rows_to_update = []
|
|
|
|
chunks = [
|
|
event_ids[i:i + 100]
|
|
for i in xrange(0, len(event_ids), 100)
|
|
]
|
|
for chunk in chunks:
|
|
ev_rows = self._simple_select_many_txn(
|
|
txn,
|
|
table="event_json",
|
|
column="event_id",
|
|
iterable=chunk,
|
|
retcols=["event_id", "json"],
|
|
keyvalues={},
|
|
)
|
|
|
|
for row in ev_rows:
|
|
event_id = row["event_id"]
|
|
event_json = json.loads(row["json"])
|
|
try:
|
|
origin_server_ts = event_json["origin_server_ts"]
|
|
except (KeyError, AttributeError):
|
|
# If the event is missing a necessary field then
|
|
# skip over it.
|
|
continue
|
|
|
|
rows_to_update.append((origin_server_ts, event_id))
|
|
|
|
sql = (
|
|
"UPDATE events SET origin_server_ts = ? WHERE event_id = ?"
|
|
)
|
|
|
|
for index in range(0, len(rows_to_update), INSERT_CLUMP_SIZE):
|
|
clump = rows_to_update[index:index + INSERT_CLUMP_SIZE]
|
|
txn.executemany(sql, clump)
|
|
|
|
progress = {
|
|
"target_min_stream_id_inclusive": target_min_stream_id,
|
|
"max_stream_id_exclusive": min_stream_id,
|
|
"rows_inserted": rows_inserted + len(rows_to_update)
|
|
}
|
|
|
|
self._background_update_progress_txn(
|
|
txn, self.EVENT_ORIGIN_SERVER_TS_NAME, progress
|
|
)
|
|
|
|
return len(rows_to_update)
|
|
|
|
result = yield self.runInteraction(
|
|
self.EVENT_ORIGIN_SERVER_TS_NAME, reindex_search_txn
|
|
)
|
|
|
|
if not result:
|
|
yield self._end_background_update(self.EVENT_ORIGIN_SERVER_TS_NAME)
|
|
|
|
defer.returnValue(result)
|
|
|
|
def get_current_backfill_token(self):
|
|
"""The current minimum token that backfilled events have reached"""
|
|
return -self._backfill_id_gen.get_current_token()
|
|
|
|
def get_current_events_token(self):
|
|
"""The current maximum token that events have reached"""
|
|
return self._stream_id_gen.get_current_token()
|
|
|
|
def get_all_new_forward_event_rows(self, last_id, current_id, limit):
|
|
if last_id == current_id:
|
|
return defer.succeed([])
|
|
|
|
def get_all_new_forward_event_rows(txn):
|
|
sql = (
|
|
"SELECT e.stream_ordering, e.event_id, e.room_id, e.type,"
|
|
" state_key, redacts"
|
|
" FROM events AS e"
|
|
" LEFT JOIN redactions USING (event_id)"
|
|
" LEFT JOIN state_events USING (event_id)"
|
|
" WHERE ? < stream_ordering AND stream_ordering <= ?"
|
|
" ORDER BY stream_ordering ASC"
|
|
" LIMIT ?"
|
|
)
|
|
txn.execute(sql, (last_id, current_id, limit))
|
|
new_event_updates = txn.fetchall()
|
|
|
|
if len(new_event_updates) == limit:
|
|
upper_bound = new_event_updates[-1][0]
|
|
else:
|
|
upper_bound = current_id
|
|
|
|
sql = (
|
|
"SELECT event_stream_ordering, e.event_id, e.room_id, e.type,"
|
|
" state_key, redacts"
|
|
" FROM events AS e"
|
|
" INNER JOIN ex_outlier_stream USING (event_id)"
|
|
" LEFT JOIN redactions USING (event_id)"
|
|
" LEFT JOIN state_events USING (event_id)"
|
|
" WHERE ? < event_stream_ordering"
|
|
" AND event_stream_ordering <= ?"
|
|
" ORDER BY event_stream_ordering DESC"
|
|
)
|
|
txn.execute(sql, (last_id, upper_bound))
|
|
new_event_updates.extend(txn)
|
|
|
|
return new_event_updates
|
|
return self.runInteraction(
|
|
"get_all_new_forward_event_rows", get_all_new_forward_event_rows
|
|
)
|
|
|
|
def get_all_new_backfill_event_rows(self, last_id, current_id, limit):
|
|
if last_id == current_id:
|
|
return defer.succeed([])
|
|
|
|
def get_all_new_backfill_event_rows(txn):
|
|
sql = (
|
|
"SELECT -e.stream_ordering, e.event_id, e.room_id, e.type,"
|
|
" state_key, redacts"
|
|
" FROM events AS e"
|
|
" LEFT JOIN redactions USING (event_id)"
|
|
" LEFT JOIN state_events USING (event_id)"
|
|
" WHERE ? > stream_ordering AND stream_ordering >= ?"
|
|
" ORDER BY stream_ordering ASC"
|
|
" LIMIT ?"
|
|
)
|
|
txn.execute(sql, (-last_id, -current_id, limit))
|
|
new_event_updates = txn.fetchall()
|
|
|
|
if len(new_event_updates) == limit:
|
|
upper_bound = new_event_updates[-1][0]
|
|
else:
|
|
upper_bound = current_id
|
|
|
|
sql = (
|
|
"SELECT -event_stream_ordering, e.event_id, e.room_id, e.type,"
|
|
" state_key, redacts"
|
|
" FROM events AS e"
|
|
" INNER JOIN ex_outlier_stream USING (event_id)"
|
|
" LEFT JOIN redactions USING (event_id)"
|
|
" LEFT JOIN state_events USING (event_id)"
|
|
" WHERE ? > event_stream_ordering"
|
|
" AND event_stream_ordering >= ?"
|
|
" ORDER BY event_stream_ordering DESC"
|
|
)
|
|
txn.execute(sql, (-last_id, -upper_bound))
|
|
new_event_updates.extend(txn.fetchall())
|
|
|
|
return new_event_updates
|
|
return self.runInteraction(
|
|
"get_all_new_backfill_event_rows", get_all_new_backfill_event_rows
|
|
)
|
|
|
|
@cached(num_args=5, max_entries=10)
|
|
def get_all_new_events(self, last_backfill_id, last_forward_id,
|
|
current_backfill_id, current_forward_id, limit):
|
|
"""Get all the new events that have arrived at the server either as
|
|
new events or as backfilled events"""
|
|
have_backfill_events = last_backfill_id != current_backfill_id
|
|
have_forward_events = last_forward_id != current_forward_id
|
|
|
|
if not have_backfill_events and not have_forward_events:
|
|
return defer.succeed(AllNewEventsResult([], [], [], [], []))
|
|
|
|
def get_all_new_events_txn(txn):
|
|
sql = (
|
|
"SELECT e.stream_ordering, e.event_id, e.room_id, e.type,"
|
|
" state_key, redacts"
|
|
" FROM events AS e"
|
|
" LEFT JOIN redactions USING (event_id)"
|
|
" LEFT JOIN state_events USING (event_id)"
|
|
" WHERE ? < stream_ordering AND stream_ordering <= ?"
|
|
" ORDER BY stream_ordering ASC"
|
|
" LIMIT ?"
|
|
)
|
|
if have_forward_events:
|
|
txn.execute(sql, (last_forward_id, current_forward_id, limit))
|
|
new_forward_events = txn.fetchall()
|
|
|
|
if len(new_forward_events) == limit:
|
|
upper_bound = new_forward_events[-1][0]
|
|
else:
|
|
upper_bound = current_forward_id
|
|
|
|
sql = (
|
|
"SELECT event_stream_ordering, event_id, state_group"
|
|
" FROM ex_outlier_stream"
|
|
" WHERE ? > event_stream_ordering"
|
|
" AND event_stream_ordering >= ?"
|
|
" ORDER BY event_stream_ordering DESC"
|
|
)
|
|
txn.execute(sql, (last_forward_id, upper_bound))
|
|
forward_ex_outliers = txn.fetchall()
|
|
else:
|
|
new_forward_events = []
|
|
forward_ex_outliers = []
|
|
|
|
sql = (
|
|
"SELECT -e.stream_ordering, e.event_id, e.room_id, e.type,"
|
|
" state_key, redacts"
|
|
" FROM events AS e"
|
|
" LEFT JOIN redactions USING (event_id)"
|
|
" LEFT JOIN state_events USING (event_id)"
|
|
" WHERE ? > stream_ordering AND stream_ordering >= ?"
|
|
" ORDER BY stream_ordering DESC"
|
|
" LIMIT ?"
|
|
)
|
|
if have_backfill_events:
|
|
txn.execute(sql, (-last_backfill_id, -current_backfill_id, limit))
|
|
new_backfill_events = txn.fetchall()
|
|
|
|
if len(new_backfill_events) == limit:
|
|
upper_bound = new_backfill_events[-1][0]
|
|
else:
|
|
upper_bound = current_backfill_id
|
|
|
|
sql = (
|
|
"SELECT -event_stream_ordering, event_id, state_group"
|
|
" FROM ex_outlier_stream"
|
|
" WHERE ? > event_stream_ordering"
|
|
" AND event_stream_ordering >= ?"
|
|
" ORDER BY event_stream_ordering DESC"
|
|
)
|
|
txn.execute(sql, (-last_backfill_id, -upper_bound))
|
|
backward_ex_outliers = txn.fetchall()
|
|
else:
|
|
new_backfill_events = []
|
|
backward_ex_outliers = []
|
|
|
|
return AllNewEventsResult(
|
|
new_forward_events, new_backfill_events,
|
|
forward_ex_outliers, backward_ex_outliers,
|
|
)
|
|
return self.runInteraction("get_all_new_events", get_all_new_events_txn)
|
|
|
|
def delete_old_state(self, room_id, topological_ordering):
|
|
return self.runInteraction(
|
|
"delete_old_state",
|
|
self._delete_old_state_txn, room_id, topological_ordering
|
|
)
|
|
|
|
def _delete_old_state_txn(self, txn, room_id, topological_ordering):
|
|
"""Deletes old room state
|
|
"""
|
|
|
|
# Tables that should be pruned:
|
|
# event_auth
|
|
# event_backward_extremities
|
|
# event_content_hashes
|
|
# event_destinations
|
|
# event_edge_hashes
|
|
# event_edges
|
|
# event_forward_extremities
|
|
# event_json
|
|
# event_push_actions
|
|
# event_reference_hashes
|
|
# event_search
|
|
# event_signatures
|
|
# event_to_state_groups
|
|
# events
|
|
# rejections
|
|
# room_depth
|
|
# state_groups
|
|
# state_groups_state
|
|
|
|
# First ensure that we're not about to delete all the forward extremeties
|
|
txn.execute(
|
|
"SELECT e.event_id, e.depth FROM events as e "
|
|
"INNER JOIN event_forward_extremities as f "
|
|
"ON e.event_id = f.event_id "
|
|
"AND e.room_id = f.room_id "
|
|
"WHERE f.room_id = ?",
|
|
(room_id,)
|
|
)
|
|
rows = txn.fetchall()
|
|
max_depth = max(row[0] for row in rows)
|
|
|
|
if max_depth <= topological_ordering:
|
|
# We need to ensure we don't delete all the events from the datanase
|
|
# otherwise we wouldn't be able to send any events (due to not
|
|
# having any backwards extremeties)
|
|
raise SynapseError(
|
|
400, "topological_ordering is greater than forward extremeties"
|
|
)
|
|
|
|
logger.debug("[purge] looking for events to delete")
|
|
|
|
txn.execute(
|
|
"SELECT event_id, state_key FROM events"
|
|
" LEFT JOIN state_events USING (room_id, event_id)"
|
|
" WHERE room_id = ? AND topological_ordering < ?",
|
|
(room_id, topological_ordering,)
|
|
)
|
|
event_rows = txn.fetchall()
|
|
|
|
to_delete = [
|
|
(event_id,) for event_id, state_key in event_rows
|
|
if state_key is None and not self.hs.is_mine_id(event_id)
|
|
]
|
|
logger.info(
|
|
"[purge] found %i events before cutoff, of which %i are remote"
|
|
" non-state events to delete", len(event_rows), len(to_delete))
|
|
|
|
for event_id, state_key in event_rows:
|
|
txn.call_after(self._get_state_group_for_event.invalidate, (event_id,))
|
|
|
|
logger.debug("[purge] Finding new backward extremities")
|
|
|
|
# We calculate the new entries for the backward extremeties by finding
|
|
# all events that point to events that are to be purged
|
|
txn.execute(
|
|
"SELECT DISTINCT e.event_id FROM events as e"
|
|
" INNER JOIN event_edges as ed ON e.event_id = ed.prev_event_id"
|
|
" INNER JOIN events as e2 ON e2.event_id = ed.event_id"
|
|
" WHERE e.room_id = ? AND e.topological_ordering < ?"
|
|
" AND e2.topological_ordering >= ?",
|
|
(room_id, topological_ordering, topological_ordering)
|
|
)
|
|
new_backwards_extrems = txn.fetchall()
|
|
|
|
logger.debug("[purge] replacing backward extremities: %r", new_backwards_extrems)
|
|
|
|
txn.execute(
|
|
"DELETE FROM event_backward_extremities WHERE room_id = ?",
|
|
(room_id,)
|
|
)
|
|
|
|
# Update backward extremeties
|
|
txn.executemany(
|
|
"INSERT INTO event_backward_extremities (room_id, event_id)"
|
|
" VALUES (?, ?)",
|
|
[
|
|
(room_id, event_id) for event_id, in new_backwards_extrems
|
|
]
|
|
)
|
|
|
|
logger.debug("[purge] finding redundant state groups")
|
|
|
|
# Get all state groups that are only referenced by events that are
|
|
# to be deleted.
|
|
txn.execute(
|
|
"SELECT state_group FROM event_to_state_groups"
|
|
" INNER JOIN events USING (event_id)"
|
|
" WHERE state_group IN ("
|
|
" SELECT DISTINCT state_group FROM events"
|
|
" INNER JOIN event_to_state_groups USING (event_id)"
|
|
" WHERE room_id = ? AND topological_ordering < ?"
|
|
" )"
|
|
" GROUP BY state_group HAVING MAX(topological_ordering) < ?",
|
|
(room_id, topological_ordering, topological_ordering)
|
|
)
|
|
|
|
state_rows = txn.fetchall()
|
|
logger.debug("[purge] found %i redundant state groups", len(state_rows))
|
|
|
|
# make a set of the redundant state groups, so that we can look them up
|
|
# efficiently
|
|
state_groups_to_delete = set([sg for sg, in state_rows])
|
|
|
|
# Now we get all the state groups that rely on these state groups
|
|
logger.debug("[purge] finding state groups which depend on redundant"
|
|
" state groups")
|
|
remaining_state_groups = []
|
|
for i in xrange(0, len(state_rows), 100):
|
|
chunk = [sg for sg, in state_rows[i:i + 100]]
|
|
# look for state groups whose prev_state_group is one we are about
|
|
# to delete
|
|
rows = self._simple_select_many_txn(
|
|
txn,
|
|
table="state_group_edges",
|
|
column="prev_state_group",
|
|
iterable=chunk,
|
|
retcols=["state_group"],
|
|
keyvalues={},
|
|
)
|
|
remaining_state_groups.extend(
|
|
row["state_group"] for row in rows
|
|
|
|
# exclude state groups we are about to delete: no point in
|
|
# updating them
|
|
if row["state_group"] not in state_groups_to_delete
|
|
)
|
|
|
|
# Now we turn the state groups that reference to-be-deleted state
|
|
# groups to non delta versions.
|
|
for sg in remaining_state_groups:
|
|
logger.debug("[purge] de-delta-ing remaining state group %s", sg)
|
|
curr_state = self._get_state_groups_from_groups_txn(
|
|
txn, [sg], types=None
|
|
)
|
|
curr_state = curr_state[sg]
|
|
|
|
self._simple_delete_txn(
|
|
txn,
|
|
table="state_groups_state",
|
|
keyvalues={
|
|
"state_group": sg,
|
|
}
|
|
)
|
|
|
|
self._simple_delete_txn(
|
|
txn,
|
|
table="state_group_edges",
|
|
keyvalues={
|
|
"state_group": sg,
|
|
}
|
|
)
|
|
|
|
self._simple_insert_many_txn(
|
|
txn,
|
|
table="state_groups_state",
|
|
values=[
|
|
{
|
|
"state_group": sg,
|
|
"room_id": room_id,
|
|
"type": key[0],
|
|
"state_key": key[1],
|
|
"event_id": state_id,
|
|
}
|
|
for key, state_id in curr_state.iteritems()
|
|
],
|
|
)
|
|
|
|
logger.debug("[purge] removing redundant state groups")
|
|
txn.executemany(
|
|
"DELETE FROM state_groups_state WHERE state_group = ?",
|
|
state_rows
|
|
)
|
|
txn.executemany(
|
|
"DELETE FROM state_groups WHERE id = ?",
|
|
state_rows
|
|
)
|
|
|
|
# Delete all non-state
|
|
logger.debug("[purge] removing events from event_to_state_groups")
|
|
txn.executemany(
|
|
"DELETE FROM event_to_state_groups WHERE event_id = ?",
|
|
[(event_id,) for event_id, _ in event_rows]
|
|
)
|
|
|
|
logger.debug("[purge] updating room_depth")
|
|
txn.execute(
|
|
"UPDATE room_depth SET min_depth = ? WHERE room_id = ?",
|
|
(topological_ordering, room_id,)
|
|
)
|
|
|
|
# Delete all remote non-state events
|
|
for table in (
|
|
"events",
|
|
"event_json",
|
|
"event_auth",
|
|
"event_content_hashes",
|
|
"event_destinations",
|
|
"event_edge_hashes",
|
|
"event_edges",
|
|
"event_forward_extremities",
|
|
"event_push_actions",
|
|
"event_reference_hashes",
|
|
"event_search",
|
|
"event_signatures",
|
|
"rejections",
|
|
):
|
|
logger.debug("[purge] removing remote non-state events from %s", table)
|
|
|
|
txn.executemany(
|
|
"DELETE FROM %s WHERE event_id = ?" % (table,),
|
|
to_delete
|
|
)
|
|
|
|
# Mark all state and own events as outliers
|
|
logger.debug("[purge] marking remaining events as outliers")
|
|
txn.executemany(
|
|
"UPDATE events SET outlier = ?"
|
|
" WHERE event_id = ?",
|
|
[
|
|
(True, event_id,) for event_id, state_key in event_rows
|
|
if state_key is not None or self.hs.is_mine_id(event_id)
|
|
]
|
|
)
|
|
|
|
logger.info("[purge] done")
|
|
|
|
@defer.inlineCallbacks
|
|
def is_event_after(self, event_id1, event_id2):
|
|
"""Returns True if event_id1 is after event_id2 in the stream
|
|
"""
|
|
to_1, so_1 = yield self._get_event_ordering(event_id1)
|
|
to_2, so_2 = yield self._get_event_ordering(event_id2)
|
|
defer.returnValue((to_1, so_1) > (to_2, so_2))
|
|
|
|
@defer.inlineCallbacks
|
|
def _get_event_ordering(self, event_id):
|
|
res = yield self._simple_select_one(
|
|
table="events",
|
|
retcols=["topological_ordering", "stream_ordering"],
|
|
keyvalues={"event_id": event_id},
|
|
allow_none=True
|
|
)
|
|
|
|
if not res:
|
|
raise SynapseError(404, "Could not find event %s" % (event_id,))
|
|
|
|
defer.returnValue((int(res["topological_ordering"]), int(res["stream_ordering"])))
|
|
|
|
def get_max_current_state_delta_stream_id(self):
|
|
return self._stream_id_gen.get_current_token()
|
|
|
|
def get_all_updated_current_state_deltas(self, from_token, to_token, limit):
|
|
def get_all_updated_current_state_deltas_txn(txn):
|
|
sql = """
|
|
SELECT stream_id, room_id, type, state_key, event_id
|
|
FROM current_state_delta_stream
|
|
WHERE ? < stream_id AND stream_id <= ?
|
|
ORDER BY stream_id ASC LIMIT ?
|
|
"""
|
|
txn.execute(sql, (from_token, to_token, limit))
|
|
return txn.fetchall()
|
|
return self.runInteraction(
|
|
"get_all_updated_current_state_deltas",
|
|
get_all_updated_current_state_deltas_txn,
|
|
)
|
|
|
|
|
|
AllNewEventsResult = namedtuple("AllNewEventsResult", [
|
|
"new_forward_events", "new_backfill_events",
|
|
"forward_ex_outliers", "backward_ex_outliers",
|
|
])
|