312 lines
9.9 KiB
Python
312 lines
9.9 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.
|
|
|
|
from ._base import SQLBaseStore, cached
|
|
|
|
from twisted.internet import defer
|
|
|
|
from synapse.util import unwrapFirstError
|
|
from synapse.util.stringutils import random_string
|
|
|
|
import logging
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class StateStore(SQLBaseStore):
|
|
""" Keeps track of the state at a given event.
|
|
|
|
This is done by the concept of `state groups`. Every event is a assigned
|
|
a state group (identified by an arbitrary string), which references a
|
|
collection of state events. The current state of an event is then the
|
|
collection of state events referenced by the event's state group.
|
|
|
|
Hence, every change in the current state causes a new state group to be
|
|
generated. However, if no change happens (e.g., if we get a message event
|
|
with only one parent it inherits the state group from its parent.)
|
|
|
|
There are three tables:
|
|
* `state_groups`: Stores group name, first event with in the group and
|
|
room id.
|
|
* `event_to_state_groups`: Maps events to state groups.
|
|
* `state_groups_state`: Maps state group to state events.
|
|
"""
|
|
|
|
@defer.inlineCallbacks
|
|
def get_state_groups(self, event_ids):
|
|
""" Get the state groups for the given list of event_ids
|
|
|
|
The return value is a dict mapping group names to lists of events.
|
|
"""
|
|
|
|
def f(txn):
|
|
groups = set()
|
|
for event_id in event_ids:
|
|
group = self._simple_select_one_onecol_txn(
|
|
txn,
|
|
table="event_to_state_groups",
|
|
keyvalues={"event_id": event_id},
|
|
retcol="state_group",
|
|
allow_none=True,
|
|
)
|
|
if group:
|
|
groups.add(group)
|
|
|
|
res = {}
|
|
for group in groups:
|
|
state_ids = self._simple_select_onecol_txn(
|
|
txn,
|
|
table="state_groups_state",
|
|
keyvalues={"state_group": group},
|
|
retcol="event_id",
|
|
)
|
|
|
|
res[group] = state_ids
|
|
|
|
return res
|
|
|
|
states = yield self.runInteraction(
|
|
"get_state_groups",
|
|
f,
|
|
)
|
|
|
|
state_list = yield defer.gatherResults(
|
|
[
|
|
self._fetch_events_for_group(group, vals)
|
|
for group, vals in states.items()
|
|
],
|
|
consumeErrors=True,
|
|
)
|
|
|
|
defer.returnValue(dict(state_list))
|
|
|
|
@cached(num_args=1)
|
|
def _fetch_events_for_group(self, key, events):
|
|
return self._get_events(
|
|
events, get_prev_content=False
|
|
).addCallback(
|
|
lambda evs: (key, evs)
|
|
)
|
|
|
|
def _store_state_groups_txn(self, txn, event, context):
|
|
return self._store_mult_state_groups_txn(txn, [(event, context)])
|
|
|
|
def _store_mult_state_groups_txn(self, txn, events_and_contexts):
|
|
state_groups = {}
|
|
for event, context in events_and_contexts:
|
|
if context.current_state is None:
|
|
continue
|
|
|
|
if context.state_group is not None:
|
|
state_groups[event.event_id] = context.state_group
|
|
continue
|
|
|
|
state_events = dict(context.current_state)
|
|
|
|
if event.is_state():
|
|
state_events[(event.type, event.state_key)] = event
|
|
|
|
state_group = self._state_groups_id_gen.get_next_txn(txn)
|
|
self._simple_insert_txn(
|
|
txn,
|
|
table="state_groups",
|
|
values={
|
|
"id": state_group,
|
|
"room_id": event.room_id,
|
|
"event_id": event.event_id,
|
|
},
|
|
)
|
|
|
|
self._simple_insert_many_txn(
|
|
txn,
|
|
table="state_groups_state",
|
|
values=[
|
|
{
|
|
"state_group": state_group,
|
|
"room_id": state.room_id,
|
|
"type": state.type,
|
|
"state_key": state.state_key,
|
|
"event_id": state.event_id,
|
|
}
|
|
for state in state_events.values()
|
|
],
|
|
)
|
|
state_groups[event.event_id] = state_group
|
|
|
|
self._simple_insert_many_txn(
|
|
txn,
|
|
table="event_to_state_groups",
|
|
values=[
|
|
{
|
|
"state_group": state_groups[event.event_id],
|
|
"event_id": event.event_id,
|
|
}
|
|
for event, context in events_and_contexts
|
|
if context.current_state is not None
|
|
],
|
|
)
|
|
|
|
@defer.inlineCallbacks
|
|
def get_current_state(self, room_id, event_type=None, state_key=""):
|
|
if event_type and state_key is not None:
|
|
result = yield self.get_current_state_for_key(
|
|
room_id, event_type, state_key
|
|
)
|
|
defer.returnValue(result)
|
|
|
|
def f(txn):
|
|
sql = (
|
|
"SELECT event_id FROM current_state_events"
|
|
" WHERE room_id = ? "
|
|
)
|
|
|
|
if event_type and state_key is not None:
|
|
sql += " AND type = ? AND state_key = ? "
|
|
args = (room_id, event_type, state_key)
|
|
elif event_type:
|
|
sql += " AND type = ?"
|
|
args = (room_id, event_type)
|
|
else:
|
|
args = (room_id, )
|
|
|
|
txn.execute(sql, args)
|
|
results = txn.fetchall()
|
|
|
|
return [r[0] for r in results]
|
|
|
|
event_ids = yield self.runInteraction("get_current_state", f)
|
|
events = yield self._get_events(event_ids, get_prev_content=False)
|
|
defer.returnValue(events)
|
|
|
|
@cached(num_args=3)
|
|
@defer.inlineCallbacks
|
|
def get_current_state_for_key(self, room_id, event_type, state_key):
|
|
def f(txn):
|
|
sql = (
|
|
"SELECT event_id FROM current_state_events"
|
|
" WHERE room_id = ? AND type = ? AND state_key = ?"
|
|
)
|
|
|
|
args = (room_id, event_type, state_key)
|
|
txn.execute(sql, args)
|
|
results = txn.fetchall()
|
|
return [r[0] for r in results]
|
|
event_ids = yield self.runInteraction("get_current_state_for_key", f)
|
|
events = yield self._get_events(event_ids, get_prev_content=False)
|
|
defer.returnValue(events)
|
|
|
|
@cached(num_args=3, lru=True)
|
|
def _get_state_groups_from_group(self, room_id, group, types):
|
|
def f(txn):
|
|
sql = (
|
|
"SELECT event_id FROM state_groups_state WHERE"
|
|
" room_id = ? AND state_group = ? AND (%s)"
|
|
) % (" OR ".join(["(type = ? AND state_key = ?)"] * len(types)),)
|
|
|
|
args = [room_id, group]
|
|
args.extend([i for typ in types for i in typ])
|
|
txn.execute(sql, args)
|
|
|
|
return group, [
|
|
r[0]
|
|
for r in txn.fetchall()
|
|
]
|
|
|
|
return self.runInteraction(
|
|
"_get_state_groups_from_group",
|
|
f,
|
|
)
|
|
|
|
@cached(num_args=3, lru=True, max_entries=100000)
|
|
def _get_state_for_event_id(self, room_id, event_id, types):
|
|
def f(txn):
|
|
type_and_state_sql = " OR ".join([
|
|
"(type = ? AND state_key = ?)"
|
|
if typ[1] is not None
|
|
else "type = ?"
|
|
for typ in types
|
|
])
|
|
|
|
sql = (
|
|
"SELECT sg.event_id FROM state_groups_state as sg"
|
|
" INNER JOIN event_to_state_groups as e"
|
|
" ON e.state_group = sg.state_group"
|
|
" WHERE e.event_id = ? AND (%s)"
|
|
) % (type_and_state_sql,)
|
|
|
|
args = [event_id]
|
|
for typ, state_key in types:
|
|
args.extend(
|
|
[typ, state_key] if state_key is not None else [typ]
|
|
)
|
|
txn.execute(sql, args)
|
|
|
|
return event_id, [
|
|
r[0]
|
|
for r in txn.fetchall()
|
|
]
|
|
|
|
return self.runInteraction(
|
|
"_get_state_for_event_id",
|
|
f,
|
|
)
|
|
|
|
@defer.inlineCallbacks
|
|
def get_state_for_events(self, room_id, event_ids, types):
|
|
set_types = frozenset(types)
|
|
res = yield defer.gatherResults(
|
|
[
|
|
self._get_state_for_event_id(
|
|
room_id, event_id, set_types,
|
|
)
|
|
for event_id in event_ids
|
|
],
|
|
consumeErrors=True,
|
|
).addErrback(unwrapFirstError)
|
|
|
|
event_to_state_ids = dict(res)
|
|
|
|
event_dict = yield self._get_events(
|
|
[
|
|
item
|
|
for lst in event_to_state_ids.values()
|
|
for item in lst
|
|
],
|
|
get_prev_content=False
|
|
).addCallback(
|
|
lambda evs: {ev.event_id: ev for ev in evs}
|
|
)
|
|
|
|
event_to_state = {
|
|
event_id: {
|
|
(ev.type, ev.state_key): ev
|
|
for ev in [
|
|
event_dict[state_id]
|
|
for state_id in state_ids
|
|
if state_id in event_dict
|
|
]
|
|
}
|
|
for event_id, state_ids in event_to_state_ids.items()
|
|
}
|
|
|
|
defer.returnValue([
|
|
event_to_state[event]
|
|
for event in event_ids
|
|
])
|
|
|
|
|
|
def _make_group_id(clock):
|
|
return str(int(clock.time_msec())) + random_string(5)
|