events.py 62 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737
  1. # -*- coding: utf-8 -*-
  2. # Copyright 2014-2016 OpenMarket Ltd
  3. #
  4. # Licensed under the Apache License, Version 2.0 (the "License");
  5. # you may not use this file except in compliance with the License.
  6. # You may obtain a copy of the License at
  7. #
  8. # http://www.apache.org/licenses/LICENSE-2.0
  9. #
  10. # Unless required by applicable law or agreed to in writing, software
  11. # distributed under the License is distributed on an "AS IS" BASIS,
  12. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. # See the License for the specific language governing permissions and
  14. # limitations under the License.
  15. from ._base import SQLBaseStore, _RollbackButIsFineException
  16. from twisted.internet import defer, reactor
  17. from synapse.events import FrozenEvent, USE_FROZEN_DICTS
  18. from synapse.events.utils import prune_event
  19. from synapse.util.async import ObservableDeferred
  20. from synapse.util.logcontext import (
  21. preserve_fn, PreserveLoggingContext, preserve_context_over_deferred
  22. )
  23. from synapse.util.logutils import log_function
  24. from synapse.util.metrics import Measure
  25. from synapse.api.constants import EventTypes
  26. from synapse.api.errors import SynapseError
  27. from canonicaljson import encode_canonical_json
  28. from collections import deque, namedtuple, OrderedDict
  29. from functools import wraps
  30. import synapse
  31. import synapse.metrics
  32. import logging
  33. import math
  34. import ujson as json
  35. logger = logging.getLogger(__name__)
  36. metrics = synapse.metrics.get_metrics_for(__name__)
  37. persist_event_counter = metrics.register_counter("persisted_events")
  38. def encode_json(json_object):
  39. if USE_FROZEN_DICTS:
  40. # ujson doesn't like frozen_dicts
  41. return encode_canonical_json(json_object)
  42. else:
  43. return json.dumps(json_object, ensure_ascii=False)
  44. # These values are used in the `enqueus_event` and `_do_fetch` methods to
  45. # control how we batch/bulk fetch events from the database.
  46. # The values are plucked out of thing air to make initial sync run faster
  47. # on jki.re
  48. # TODO: Make these configurable.
  49. EVENT_QUEUE_THREADS = 3 # Max number of threads that will fetch events
  50. EVENT_QUEUE_ITERATIONS = 3 # No. times we block waiting for requests for events
  51. EVENT_QUEUE_TIMEOUT_S = 0.1 # Timeout when waiting for requests for events
  52. class _EventPeristenceQueue(object):
  53. """Queues up events so that they can be persisted in bulk with only one
  54. concurrent transaction per room.
  55. """
  56. _EventPersistQueueItem = namedtuple("_EventPersistQueueItem", (
  57. "events_and_contexts", "current_state", "backfilled", "deferred",
  58. ))
  59. def __init__(self):
  60. self._event_persist_queues = {}
  61. self._currently_persisting_rooms = set()
  62. def add_to_queue(self, room_id, events_and_contexts, backfilled, current_state):
  63. """Add events to the queue, with the given persist_event options.
  64. """
  65. queue = self._event_persist_queues.setdefault(room_id, deque())
  66. if queue:
  67. end_item = queue[-1]
  68. if end_item.current_state or current_state:
  69. # We perist events with current_state set to True one at a time
  70. pass
  71. if end_item.backfilled == backfilled:
  72. end_item.events_and_contexts.extend(events_and_contexts)
  73. return end_item.deferred.observe()
  74. deferred = ObservableDeferred(defer.Deferred())
  75. queue.append(self._EventPersistQueueItem(
  76. events_and_contexts=events_and_contexts,
  77. backfilled=backfilled,
  78. current_state=current_state,
  79. deferred=deferred,
  80. ))
  81. return deferred.observe()
  82. def handle_queue(self, room_id, per_item_callback):
  83. """Attempts to handle the queue for a room if not already being handled.
  84. The given callback will be invoked with for each item in the queue,1
  85. of type _EventPersistQueueItem. The per_item_callback will continuously
  86. be called with new items, unless the queue becomnes empty. The return
  87. value of the function will be given to the deferreds waiting on the item,
  88. exceptions will be passed to the deferres as well.
  89. This function should therefore be called whenever anything is added
  90. to the queue.
  91. If another callback is currently handling the queue then it will not be
  92. invoked.
  93. """
  94. if room_id in self._currently_persisting_rooms:
  95. return
  96. self._currently_persisting_rooms.add(room_id)
  97. @defer.inlineCallbacks
  98. def handle_queue_loop():
  99. try:
  100. queue = self._get_drainining_queue(room_id)
  101. for item in queue:
  102. try:
  103. ret = yield per_item_callback(item)
  104. item.deferred.callback(ret)
  105. except Exception as e:
  106. item.deferred.errback(e)
  107. finally:
  108. queue = self._event_persist_queues.pop(room_id, None)
  109. if queue:
  110. self._event_persist_queues[room_id] = queue
  111. self._currently_persisting_rooms.discard(room_id)
  112. preserve_fn(handle_queue_loop)()
  113. def _get_drainining_queue(self, room_id):
  114. queue = self._event_persist_queues.setdefault(room_id, deque())
  115. try:
  116. while True:
  117. yield queue.popleft()
  118. except IndexError:
  119. # Queue has been drained.
  120. pass
  121. _EventCacheEntry = namedtuple("_EventCacheEntry", ("event", "redacted_event"))
  122. def _retry_on_integrity_error(func):
  123. """Wraps a database function so that it gets retried on IntegrityError,
  124. with `delete_existing=True` passed in.
  125. Args:
  126. func: function that returns a Deferred and accepts a `delete_existing` arg
  127. """
  128. @wraps(func)
  129. @defer.inlineCallbacks
  130. def f(self, *args, **kwargs):
  131. try:
  132. res = yield func(self, *args, **kwargs)
  133. except self.database_engine.module.IntegrityError:
  134. logger.exception("IntegrityError, retrying.")
  135. res = yield func(self, *args, delete_existing=True, **kwargs)
  136. defer.returnValue(res)
  137. return f
  138. class EventsStore(SQLBaseStore):
  139. EVENT_ORIGIN_SERVER_TS_NAME = "event_origin_server_ts"
  140. EVENT_FIELDS_SENDER_URL_UPDATE_NAME = "event_fields_sender_url"
  141. def __init__(self, hs):
  142. super(EventsStore, self).__init__(hs)
  143. self._clock = hs.get_clock()
  144. self.register_background_update_handler(
  145. self.EVENT_ORIGIN_SERVER_TS_NAME, self._background_reindex_origin_server_ts
  146. )
  147. self.register_background_update_handler(
  148. self.EVENT_FIELDS_SENDER_URL_UPDATE_NAME,
  149. self._background_reindex_fields_sender,
  150. )
  151. self.register_background_index_update(
  152. "event_contains_url_index",
  153. index_name="event_contains_url_index",
  154. table="events",
  155. columns=["room_id", "topological_ordering", "stream_ordering"],
  156. where_clause="contains_url = true AND outlier = false",
  157. )
  158. self._event_persist_queue = _EventPeristenceQueue()
  159. def persist_events(self, events_and_contexts, backfilled=False):
  160. """
  161. Write events to the database
  162. Args:
  163. events_and_contexts: list of tuples of (event, context)
  164. backfilled: ?
  165. """
  166. partitioned = {}
  167. for event, ctx in events_and_contexts:
  168. partitioned.setdefault(event.room_id, []).append((event, ctx))
  169. deferreds = []
  170. for room_id, evs_ctxs in partitioned.items():
  171. d = preserve_fn(self._event_persist_queue.add_to_queue)(
  172. room_id, evs_ctxs,
  173. backfilled=backfilled,
  174. current_state=None,
  175. )
  176. deferreds.append(d)
  177. for room_id in partitioned.keys():
  178. self._maybe_start_persisting(room_id)
  179. return preserve_context_over_deferred(
  180. defer.gatherResults(deferreds, consumeErrors=True)
  181. )
  182. @defer.inlineCallbacks
  183. @log_function
  184. def persist_event(self, event, context, current_state=None, backfilled=False):
  185. deferred = self._event_persist_queue.add_to_queue(
  186. event.room_id, [(event, context)],
  187. backfilled=backfilled,
  188. current_state=current_state,
  189. )
  190. self._maybe_start_persisting(event.room_id)
  191. yield preserve_context_over_deferred(deferred)
  192. max_persisted_id = yield self._stream_id_gen.get_current_token()
  193. defer.returnValue((event.internal_metadata.stream_ordering, max_persisted_id))
  194. def _maybe_start_persisting(self, room_id):
  195. @defer.inlineCallbacks
  196. def persisting_queue(item):
  197. if item.current_state:
  198. for event, context in item.events_and_contexts:
  199. # There should only ever be one item in
  200. # events_and_contexts when current_state is
  201. # not None
  202. yield self._persist_event(
  203. event, context,
  204. current_state=item.current_state,
  205. backfilled=item.backfilled,
  206. )
  207. else:
  208. yield self._persist_events(
  209. item.events_and_contexts,
  210. backfilled=item.backfilled,
  211. )
  212. self._event_persist_queue.handle_queue(room_id, persisting_queue)
  213. @_retry_on_integrity_error
  214. @defer.inlineCallbacks
  215. def _persist_events(self, events_and_contexts, backfilled=False,
  216. delete_existing=False):
  217. if not events_and_contexts:
  218. return
  219. if backfilled:
  220. stream_ordering_manager = self._backfill_id_gen.get_next_mult(
  221. len(events_and_contexts)
  222. )
  223. else:
  224. stream_ordering_manager = self._stream_id_gen.get_next_mult(
  225. len(events_and_contexts)
  226. )
  227. with stream_ordering_manager as stream_orderings:
  228. for (event, context), stream, in zip(
  229. events_and_contexts, stream_orderings
  230. ):
  231. event.internal_metadata.stream_ordering = stream
  232. chunks = [
  233. events_and_contexts[x:x + 100]
  234. for x in xrange(0, len(events_and_contexts), 100)
  235. ]
  236. for chunk in chunks:
  237. # We can't easily parallelize these since different chunks
  238. # might contain the same event. :(
  239. yield self.runInteraction(
  240. "persist_events",
  241. self._persist_events_txn,
  242. events_and_contexts=chunk,
  243. backfilled=backfilled,
  244. delete_existing=delete_existing,
  245. )
  246. persist_event_counter.inc_by(len(chunk))
  247. @_retry_on_integrity_error
  248. @defer.inlineCallbacks
  249. @log_function
  250. def _persist_event(self, event, context, current_state=None, backfilled=False,
  251. delete_existing=False):
  252. try:
  253. with self._stream_id_gen.get_next() as stream_ordering:
  254. event.internal_metadata.stream_ordering = stream_ordering
  255. yield self.runInteraction(
  256. "persist_event",
  257. self._persist_event_txn,
  258. event=event,
  259. context=context,
  260. current_state=current_state,
  261. backfilled=backfilled,
  262. delete_existing=delete_existing,
  263. )
  264. persist_event_counter.inc()
  265. except _RollbackButIsFineException:
  266. pass
  267. @defer.inlineCallbacks
  268. def get_event(self, event_id, check_redacted=True,
  269. get_prev_content=False, allow_rejected=False,
  270. allow_none=False):
  271. """Get an event from the database by event_id.
  272. Args:
  273. event_id (str): The event_id of the event to fetch
  274. check_redacted (bool): If True, check if event has been redacted
  275. and redact it.
  276. get_prev_content (bool): If True and event is a state event,
  277. include the previous states content in the unsigned field.
  278. allow_rejected (bool): If True return rejected events.
  279. allow_none (bool): If True, return None if no event found, if
  280. False throw an exception.
  281. Returns:
  282. Deferred : A FrozenEvent.
  283. """
  284. events = yield self._get_events(
  285. [event_id],
  286. check_redacted=check_redacted,
  287. get_prev_content=get_prev_content,
  288. allow_rejected=allow_rejected,
  289. )
  290. if not events and not allow_none:
  291. raise SynapseError(404, "Could not find event %s" % (event_id,))
  292. defer.returnValue(events[0] if events else None)
  293. @defer.inlineCallbacks
  294. def get_events(self, event_ids, check_redacted=True,
  295. get_prev_content=False, allow_rejected=False):
  296. """Get events from the database
  297. Args:
  298. event_ids (list): The event_ids of the events to fetch
  299. check_redacted (bool): If True, check if event has been redacted
  300. and redact it.
  301. get_prev_content (bool): If True and event is a state event,
  302. include the previous states content in the unsigned field.
  303. allow_rejected (bool): If True return rejected events.
  304. Returns:
  305. Deferred : Dict from event_id to event.
  306. """
  307. events = yield self._get_events(
  308. event_ids,
  309. check_redacted=check_redacted,
  310. get_prev_content=get_prev_content,
  311. allow_rejected=allow_rejected,
  312. )
  313. defer.returnValue({e.event_id: e for e in events})
  314. @log_function
  315. def _persist_event_txn(self, txn, event, context, current_state, backfilled=False,
  316. delete_existing=False):
  317. # We purposefully do this first since if we include a `current_state`
  318. # key, we *want* to update the `current_state_events` table
  319. if current_state:
  320. txn.call_after(self._get_current_state_for_key.invalidate_all)
  321. txn.call_after(self.get_rooms_for_user.invalidate_all)
  322. txn.call_after(self.get_users_in_room.invalidate, (event.room_id,))
  323. # Add an entry to the current_state_resets table to record the point
  324. # where we clobbered the current state
  325. stream_order = event.internal_metadata.stream_ordering
  326. self._simple_insert_txn(
  327. txn,
  328. table="current_state_resets",
  329. values={"event_stream_ordering": stream_order}
  330. )
  331. self._simple_delete_txn(
  332. txn,
  333. table="current_state_events",
  334. keyvalues={"room_id": event.room_id},
  335. )
  336. for s in current_state:
  337. self._simple_insert_txn(
  338. txn,
  339. "current_state_events",
  340. {
  341. "event_id": s.event_id,
  342. "room_id": s.room_id,
  343. "type": s.type,
  344. "state_key": s.state_key,
  345. }
  346. )
  347. return self._persist_events_txn(
  348. txn,
  349. [(event, context)],
  350. backfilled=backfilled,
  351. delete_existing=delete_existing,
  352. )
  353. @log_function
  354. def _persist_events_txn(self, txn, events_and_contexts, backfilled,
  355. delete_existing=False):
  356. """Insert some number of room events into the necessary database tables.
  357. Rejected events are only inserted into the events table, the events_json table,
  358. and the rejections table. Things reading from those table will need to check
  359. whether the event was rejected.
  360. If delete_existing is True then existing events will be purged from the
  361. database before insertion. This is useful when retrying due to IntegrityError.
  362. """
  363. # Ensure that we don't have the same event twice.
  364. # Pick the earliest non-outlier if there is one, else the earliest one.
  365. new_events_and_contexts = OrderedDict()
  366. for event, context in events_and_contexts:
  367. prev_event_context = new_events_and_contexts.get(event.event_id)
  368. if prev_event_context:
  369. if not event.internal_metadata.is_outlier():
  370. if prev_event_context[0].internal_metadata.is_outlier():
  371. # To ensure correct ordering we pop, as OrderedDict is
  372. # ordered by first insertion.
  373. new_events_and_contexts.pop(event.event_id, None)
  374. new_events_and_contexts[event.event_id] = (event, context)
  375. else:
  376. new_events_and_contexts[event.event_id] = (event, context)
  377. events_and_contexts = new_events_and_contexts.values()
  378. depth_updates = {}
  379. for event, context in events_and_contexts:
  380. # Remove the any existing cache entries for the event_ids
  381. txn.call_after(self._invalidate_get_event_cache, event.event_id)
  382. if not backfilled:
  383. txn.call_after(
  384. self._events_stream_cache.entity_has_changed,
  385. event.room_id, event.internal_metadata.stream_ordering,
  386. )
  387. if not event.internal_metadata.is_outlier() and not context.rejected:
  388. depth_updates[event.room_id] = max(
  389. event.depth, depth_updates.get(event.room_id, event.depth)
  390. )
  391. for room_id, depth in depth_updates.items():
  392. self._update_min_depth_for_room_txn(txn, room_id, depth)
  393. txn.execute(
  394. "SELECT event_id, outlier FROM events WHERE event_id in (%s)" % (
  395. ",".join(["?"] * len(events_and_contexts)),
  396. ),
  397. [event.event_id for event, _ in events_and_contexts]
  398. )
  399. have_persisted = {
  400. event_id: outlier
  401. for event_id, outlier in txn.fetchall()
  402. }
  403. to_remove = set()
  404. for event, context in events_and_contexts:
  405. if context.rejected:
  406. # If the event is rejected then we don't care if the event
  407. # was an outlier or not.
  408. if event.event_id in have_persisted:
  409. # If we have already seen the event then ignore it.
  410. to_remove.add(event)
  411. continue
  412. if event.event_id not in have_persisted:
  413. continue
  414. to_remove.add(event)
  415. outlier_persisted = have_persisted[event.event_id]
  416. if not event.internal_metadata.is_outlier() and outlier_persisted:
  417. # We received a copy of an event that we had already stored as
  418. # an outlier in the database. We now have some state at that
  419. # so we need to update the state_groups table with that state.
  420. # insert into the state_group, state_groups_state and
  421. # event_to_state_groups tables.
  422. try:
  423. self._store_mult_state_groups_txn(txn, ((event, context),))
  424. except Exception:
  425. logger.exception("")
  426. raise
  427. metadata_json = encode_json(
  428. event.internal_metadata.get_dict()
  429. ).decode("UTF-8")
  430. sql = (
  431. "UPDATE event_json SET internal_metadata = ?"
  432. " WHERE event_id = ?"
  433. )
  434. txn.execute(
  435. sql,
  436. (metadata_json, event.event_id,)
  437. )
  438. # Add an entry to the ex_outlier_stream table to replicate the
  439. # change in outlier status to our workers.
  440. stream_order = event.internal_metadata.stream_ordering
  441. state_group_id = context.state_group
  442. self._simple_insert_txn(
  443. txn,
  444. table="ex_outlier_stream",
  445. values={
  446. "event_stream_ordering": stream_order,
  447. "event_id": event.event_id,
  448. "state_group": state_group_id,
  449. }
  450. )
  451. sql = (
  452. "UPDATE events SET outlier = ?"
  453. " WHERE event_id = ?"
  454. )
  455. txn.execute(
  456. sql,
  457. (False, event.event_id,)
  458. )
  459. # Update the event_backward_extremities table now that this
  460. # event isn't an outlier any more.
  461. self._update_extremeties(txn, [event])
  462. events_and_contexts = [
  463. ec for ec in events_and_contexts if ec[0] not in to_remove
  464. ]
  465. if not events_and_contexts:
  466. # Make sure we don't pass an empty list to functions that expect to
  467. # be storing at least one element.
  468. return
  469. # From this point onwards the events are only events that we haven't
  470. # seen before.
  471. def event_dict(event):
  472. return {
  473. k: v
  474. for k, v in event.get_dict().items()
  475. if k not in [
  476. "redacted",
  477. "redacted_because",
  478. ]
  479. }
  480. if delete_existing:
  481. # For paranoia reasons, we go and delete all the existing entries
  482. # for these events so we can reinsert them.
  483. # This gets around any problems with some tables already having
  484. # entries.
  485. logger.info("Deleting existing")
  486. for table in (
  487. "events",
  488. "event_auth",
  489. "event_json",
  490. "event_content_hashes",
  491. "event_destinations",
  492. "event_edge_hashes",
  493. "event_edges",
  494. "event_forward_extremities",
  495. "event_push_actions",
  496. "event_reference_hashes",
  497. "event_search",
  498. "event_signatures",
  499. "event_to_state_groups",
  500. "guest_access",
  501. "history_visibility",
  502. "local_invites",
  503. "room_names",
  504. "state_events",
  505. "rejections",
  506. "redactions",
  507. "room_memberships",
  508. "topics"
  509. ):
  510. txn.executemany(
  511. "DELETE FROM %s WHERE event_id = ?" % (table,),
  512. [(ev.event_id,) for ev, _ in events_and_contexts]
  513. )
  514. self._simple_insert_many_txn(
  515. txn,
  516. table="event_json",
  517. values=[
  518. {
  519. "event_id": event.event_id,
  520. "room_id": event.room_id,
  521. "internal_metadata": encode_json(
  522. event.internal_metadata.get_dict()
  523. ).decode("UTF-8"),
  524. "json": encode_json(event_dict(event)).decode("UTF-8"),
  525. }
  526. for event, _ in events_and_contexts
  527. ],
  528. )
  529. self._simple_insert_many_txn(
  530. txn,
  531. table="events",
  532. values=[
  533. {
  534. "stream_ordering": event.internal_metadata.stream_ordering,
  535. "topological_ordering": event.depth,
  536. "depth": event.depth,
  537. "event_id": event.event_id,
  538. "room_id": event.room_id,
  539. "type": event.type,
  540. "processed": True,
  541. "outlier": event.internal_metadata.is_outlier(),
  542. "content": encode_json(event.content).decode("UTF-8"),
  543. "origin_server_ts": int(event.origin_server_ts),
  544. "received_ts": self._clock.time_msec(),
  545. "sender": event.sender,
  546. "contains_url": (
  547. "url" in event.content
  548. and isinstance(event.content["url"], basestring)
  549. ),
  550. }
  551. for event, _ in events_and_contexts
  552. ],
  553. )
  554. # Remove the rejected events from the list now that we've added them
  555. # to the events table and the events_json table.
  556. to_remove = set()
  557. for event, context in events_and_contexts:
  558. if context.rejected:
  559. # Insert the event_id into the rejections table
  560. self._store_rejections_txn(
  561. txn, event.event_id, context.rejected
  562. )
  563. to_remove.add(event)
  564. events_and_contexts = [
  565. ec for ec in events_and_contexts if ec[0] not in to_remove
  566. ]
  567. if not events_and_contexts:
  568. # Make sure we don't pass an empty list to functions that expect to
  569. # be storing at least one element.
  570. return
  571. # From this point onwards the events are only ones that weren't rejected.
  572. for event, context in events_and_contexts:
  573. # Insert all the push actions into the event_push_actions table.
  574. if context.push_actions:
  575. self._set_push_actions_for_event_and_users_txn(
  576. txn, event, context.push_actions
  577. )
  578. if event.type == EventTypes.Redaction and event.redacts is not None:
  579. # Remove the entries in the event_push_actions table for the
  580. # redacted event.
  581. self._remove_push_actions_for_event_id_txn(
  582. txn, event.room_id, event.redacts
  583. )
  584. self._simple_insert_many_txn(
  585. txn,
  586. table="event_auth",
  587. values=[
  588. {
  589. "event_id": event.event_id,
  590. "room_id": event.room_id,
  591. "auth_id": auth_id,
  592. }
  593. for event, _ in events_and_contexts
  594. for auth_id, _ in event.auth_events
  595. ],
  596. )
  597. # Insert into the state_groups, state_groups_state, and
  598. # event_to_state_groups tables.
  599. self._store_mult_state_groups_txn(txn, events_and_contexts)
  600. # Update the event_forward_extremities, event_backward_extremities and
  601. # event_edges tables.
  602. self._handle_mult_prev_events(
  603. txn,
  604. events=[event for event, _ in events_and_contexts],
  605. )
  606. for event, _ in events_and_contexts:
  607. if event.type == EventTypes.Name:
  608. # Insert into the room_names and event_search tables.
  609. self._store_room_name_txn(txn, event)
  610. elif event.type == EventTypes.Topic:
  611. # Insert into the topics table and event_search table.
  612. self._store_room_topic_txn(txn, event)
  613. elif event.type == EventTypes.Message:
  614. # Insert into the event_search table.
  615. self._store_room_message_txn(txn, event)
  616. elif event.type == EventTypes.Redaction:
  617. # Insert into the redactions table.
  618. self._store_redaction(txn, event)
  619. elif event.type == EventTypes.RoomHistoryVisibility:
  620. # Insert into the event_search table.
  621. self._store_history_visibility_txn(txn, event)
  622. elif event.type == EventTypes.GuestAccess:
  623. # Insert into the event_search table.
  624. self._store_guest_access_txn(txn, event)
  625. # Insert into the room_memberships table.
  626. self._store_room_members_txn(
  627. txn,
  628. [
  629. event
  630. for event, _ in events_and_contexts
  631. if event.type == EventTypes.Member
  632. ],
  633. backfilled=backfilled,
  634. )
  635. # Insert event_reference_hashes table.
  636. self._store_event_reference_hashes_txn(
  637. txn, [event for event, _ in events_and_contexts]
  638. )
  639. state_events_and_contexts = [
  640. ec for ec in events_and_contexts if ec[0].is_state()
  641. ]
  642. state_values = []
  643. for event, context in state_events_and_contexts:
  644. vals = {
  645. "event_id": event.event_id,
  646. "room_id": event.room_id,
  647. "type": event.type,
  648. "state_key": event.state_key,
  649. }
  650. # TODO: How does this work with backfilling?
  651. if hasattr(event, "replaces_state"):
  652. vals["prev_state"] = event.replaces_state
  653. state_values.append(vals)
  654. self._simple_insert_many_txn(
  655. txn,
  656. table="state_events",
  657. values=state_values,
  658. )
  659. self._simple_insert_many_txn(
  660. txn,
  661. table="event_edges",
  662. values=[
  663. {
  664. "event_id": event.event_id,
  665. "prev_event_id": prev_id,
  666. "room_id": event.room_id,
  667. "is_state": True,
  668. }
  669. for event, _ in state_events_and_contexts
  670. for prev_id, _ in event.prev_state
  671. ],
  672. )
  673. # Prefill the event cache
  674. self._add_to_cache(txn, events_and_contexts)
  675. if backfilled:
  676. # Backfilled events come before the current state so we don't need
  677. # to update the current state table
  678. return
  679. for event, _ in state_events_and_contexts:
  680. if event.internal_metadata.is_outlier():
  681. # Outlier events shouldn't clobber the current state.
  682. continue
  683. txn.call_after(
  684. self._get_current_state_for_key.invalidate,
  685. (event.room_id, event.type, event.state_key,)
  686. )
  687. self._simple_upsert_txn(
  688. txn,
  689. "current_state_events",
  690. keyvalues={
  691. "room_id": event.room_id,
  692. "type": event.type,
  693. "state_key": event.state_key,
  694. },
  695. values={
  696. "event_id": event.event_id,
  697. }
  698. )
  699. return
  700. def _add_to_cache(self, txn, events_and_contexts):
  701. to_prefill = []
  702. rows = []
  703. N = 200
  704. for i in range(0, len(events_and_contexts), N):
  705. ev_map = {
  706. e[0].event_id: e[0]
  707. for e in events_and_contexts[i:i + N]
  708. }
  709. if not ev_map:
  710. break
  711. sql = (
  712. "SELECT "
  713. " e.event_id as event_id, "
  714. " r.redacts as redacts,"
  715. " rej.event_id as rejects "
  716. " FROM events as e"
  717. " LEFT JOIN rejections as rej USING (event_id)"
  718. " LEFT JOIN redactions as r ON e.event_id = r.redacts"
  719. " WHERE e.event_id IN (%s)"
  720. ) % (",".join(["?"] * len(ev_map)),)
  721. txn.execute(sql, ev_map.keys())
  722. rows = self.cursor_to_dict(txn)
  723. for row in rows:
  724. event = ev_map[row["event_id"]]
  725. if not row["rejects"] and not row["redacts"]:
  726. to_prefill.append(_EventCacheEntry(
  727. event=event,
  728. redacted_event=None,
  729. ))
  730. def prefill():
  731. for cache_entry in to_prefill:
  732. self._get_event_cache.prefill((cache_entry[0].event_id,), cache_entry)
  733. txn.call_after(prefill)
  734. def _store_redaction(self, txn, event):
  735. # invalidate the cache for the redacted event
  736. txn.call_after(self._invalidate_get_event_cache, event.redacts)
  737. txn.execute(
  738. "INSERT INTO redactions (event_id, redacts) VALUES (?,?)",
  739. (event.event_id, event.redacts)
  740. )
  741. @defer.inlineCallbacks
  742. def have_events_in_timeline(self, event_ids):
  743. """Given a list of event ids, check if we have already processed and
  744. stored them as non outliers.
  745. """
  746. rows = yield self._simple_select_many_batch(
  747. table="events",
  748. retcols=("event_id",),
  749. column="event_id",
  750. iterable=list(event_ids),
  751. keyvalues={"outlier": False},
  752. desc="have_events_in_timeline",
  753. )
  754. defer.returnValue(set(r["event_id"] for r in rows))
  755. def have_events(self, event_ids):
  756. """Given a list of event ids, check if we have already processed them.
  757. Returns:
  758. dict: Has an entry for each event id we already have seen. Maps to
  759. the rejected reason string if we rejected the event, else maps to
  760. None.
  761. """
  762. if not event_ids:
  763. return defer.succeed({})
  764. def f(txn):
  765. sql = (
  766. "SELECT e.event_id, reason FROM events as e "
  767. "LEFT JOIN rejections as r ON e.event_id = r.event_id "
  768. "WHERE e.event_id = ?"
  769. )
  770. res = {}
  771. for event_id in event_ids:
  772. txn.execute(sql, (event_id,))
  773. row = txn.fetchone()
  774. if row:
  775. _, rejected = row
  776. res[event_id] = rejected
  777. return res
  778. return self.runInteraction(
  779. "have_events", f,
  780. )
  781. @defer.inlineCallbacks
  782. def _get_events(self, event_ids, check_redacted=True,
  783. get_prev_content=False, allow_rejected=False):
  784. if not event_ids:
  785. defer.returnValue([])
  786. event_id_list = event_ids
  787. event_ids = set(event_ids)
  788. event_entry_map = self._get_events_from_cache(
  789. event_ids,
  790. allow_rejected=allow_rejected,
  791. )
  792. missing_events_ids = [e for e in event_ids if e not in event_entry_map]
  793. if missing_events_ids:
  794. missing_events = yield self._enqueue_events(
  795. missing_events_ids,
  796. check_redacted=check_redacted,
  797. allow_rejected=allow_rejected,
  798. )
  799. event_entry_map.update(missing_events)
  800. events = []
  801. for event_id in event_id_list:
  802. entry = event_entry_map.get(event_id, None)
  803. if not entry:
  804. continue
  805. if allow_rejected or not entry.event.rejected_reason:
  806. if check_redacted and entry.redacted_event:
  807. event = entry.redacted_event
  808. else:
  809. event = entry.event
  810. events.append(event)
  811. if get_prev_content:
  812. if "replaces_state" in event.unsigned:
  813. prev = yield self.get_event(
  814. event.unsigned["replaces_state"],
  815. get_prev_content=False,
  816. allow_none=True,
  817. )
  818. if prev:
  819. event.unsigned = dict(event.unsigned)
  820. event.unsigned["prev_content"] = prev.content
  821. event.unsigned["prev_sender"] = prev.sender
  822. defer.returnValue(events)
  823. def _invalidate_get_event_cache(self, event_id):
  824. self._get_event_cache.invalidate((event_id,))
  825. def _get_events_from_cache(self, events, allow_rejected):
  826. event_map = {}
  827. for event_id in events:
  828. ret = self._get_event_cache.get((event_id,), None)
  829. if not ret:
  830. continue
  831. if allow_rejected or not ret.event.rejected_reason:
  832. event_map[event_id] = ret
  833. else:
  834. event_map[event_id] = None
  835. return event_map
  836. def _do_fetch(self, conn):
  837. """Takes a database connection and waits for requests for events from
  838. the _event_fetch_list queue.
  839. """
  840. event_list = []
  841. i = 0
  842. while True:
  843. try:
  844. with self._event_fetch_lock:
  845. event_list = self._event_fetch_list
  846. self._event_fetch_list = []
  847. if not event_list:
  848. single_threaded = self.database_engine.single_threaded
  849. if single_threaded or i > EVENT_QUEUE_ITERATIONS:
  850. self._event_fetch_ongoing -= 1
  851. return
  852. else:
  853. self._event_fetch_lock.wait(EVENT_QUEUE_TIMEOUT_S)
  854. i += 1
  855. continue
  856. i = 0
  857. event_id_lists = zip(*event_list)[0]
  858. event_ids = [
  859. item for sublist in event_id_lists for item in sublist
  860. ]
  861. rows = self._new_transaction(
  862. conn, "do_fetch", [], None, self._fetch_event_rows, event_ids
  863. )
  864. row_dict = {
  865. r["event_id"]: r
  866. for r in rows
  867. }
  868. # We only want to resolve deferreds from the main thread
  869. def fire(lst, res):
  870. for ids, d in lst:
  871. if not d.called:
  872. try:
  873. with PreserveLoggingContext():
  874. d.callback([
  875. res[i]
  876. for i in ids
  877. if i in res
  878. ])
  879. except:
  880. logger.exception("Failed to callback")
  881. with PreserveLoggingContext():
  882. reactor.callFromThread(fire, event_list, row_dict)
  883. except Exception as e:
  884. logger.exception("do_fetch")
  885. # We only want to resolve deferreds from the main thread
  886. def fire(evs):
  887. for _, d in evs:
  888. if not d.called:
  889. with PreserveLoggingContext():
  890. d.errback(e)
  891. if event_list:
  892. with PreserveLoggingContext():
  893. reactor.callFromThread(fire, event_list)
  894. @defer.inlineCallbacks
  895. def _enqueue_events(self, events, check_redacted=True, allow_rejected=False):
  896. """Fetches events from the database using the _event_fetch_list. This
  897. allows batch and bulk fetching of events - it allows us to fetch events
  898. without having to create a new transaction for each request for events.
  899. """
  900. if not events:
  901. defer.returnValue({})
  902. events_d = defer.Deferred()
  903. with self._event_fetch_lock:
  904. self._event_fetch_list.append(
  905. (events, events_d)
  906. )
  907. self._event_fetch_lock.notify()
  908. if self._event_fetch_ongoing < EVENT_QUEUE_THREADS:
  909. self._event_fetch_ongoing += 1
  910. should_start = True
  911. else:
  912. should_start = False
  913. if should_start:
  914. with PreserveLoggingContext():
  915. self.runWithConnection(
  916. self._do_fetch
  917. )
  918. with PreserveLoggingContext():
  919. rows = yield events_d
  920. if not allow_rejected:
  921. rows[:] = [r for r in rows if not r["rejects"]]
  922. res = yield preserve_context_over_deferred(defer.gatherResults(
  923. [
  924. preserve_fn(self._get_event_from_row)(
  925. row["internal_metadata"], row["json"], row["redacts"],
  926. rejected_reason=row["rejects"],
  927. )
  928. for row in rows
  929. ],
  930. consumeErrors=True
  931. ))
  932. defer.returnValue({
  933. e.event.event_id: e
  934. for e in res if e
  935. })
  936. def _fetch_event_rows(self, txn, events):
  937. rows = []
  938. N = 200
  939. for i in range(1 + len(events) / N):
  940. evs = events[i * N:(i + 1) * N]
  941. if not evs:
  942. break
  943. sql = (
  944. "SELECT "
  945. " e.event_id as event_id, "
  946. " e.internal_metadata,"
  947. " e.json,"
  948. " r.redacts as redacts,"
  949. " rej.event_id as rejects "
  950. " FROM event_json as e"
  951. " LEFT JOIN rejections as rej USING (event_id)"
  952. " LEFT JOIN redactions as r ON e.event_id = r.redacts"
  953. " WHERE e.event_id IN (%s)"
  954. ) % (",".join(["?"] * len(evs)),)
  955. txn.execute(sql, evs)
  956. rows.extend(self.cursor_to_dict(txn))
  957. return rows
  958. @defer.inlineCallbacks
  959. def _get_event_from_row(self, internal_metadata, js, redacted,
  960. rejected_reason=None):
  961. with Measure(self._clock, "_get_event_from_row"):
  962. d = json.loads(js)
  963. internal_metadata = json.loads(internal_metadata)
  964. if rejected_reason:
  965. rejected_reason = yield self._simple_select_one_onecol(
  966. table="rejections",
  967. keyvalues={"event_id": rejected_reason},
  968. retcol="reason",
  969. desc="_get_event_from_row_rejected_reason",
  970. )
  971. original_ev = FrozenEvent(
  972. d,
  973. internal_metadata_dict=internal_metadata,
  974. rejected_reason=rejected_reason,
  975. )
  976. redacted_event = None
  977. if redacted:
  978. redacted_event = prune_event(original_ev)
  979. redaction_id = yield self._simple_select_one_onecol(
  980. table="redactions",
  981. keyvalues={"redacts": redacted_event.event_id},
  982. retcol="event_id",
  983. desc="_get_event_from_row_redactions",
  984. )
  985. redacted_event.unsigned["redacted_by"] = redaction_id
  986. # Get the redaction event.
  987. because = yield self.get_event(
  988. redaction_id,
  989. check_redacted=False,
  990. allow_none=True,
  991. )
  992. if because:
  993. # It's fine to do add the event directly, since get_pdu_json
  994. # will serialise this field correctly
  995. redacted_event.unsigned["redacted_because"] = because
  996. cache_entry = _EventCacheEntry(
  997. event=original_ev,
  998. redacted_event=redacted_event,
  999. )
  1000. self._get_event_cache.prefill((original_ev.event_id,), cache_entry)
  1001. defer.returnValue(cache_entry)
  1002. @defer.inlineCallbacks
  1003. def count_daily_messages(self):
  1004. """
  1005. Returns an estimate of the number of messages sent in the last day.
  1006. If it has been significantly less or more than one day since the last
  1007. call to this function, it will return None.
  1008. """
  1009. def _count_messages(txn):
  1010. now = self.hs.get_clock().time()
  1011. txn.execute(
  1012. "SELECT reported_stream_token, reported_time FROM stats_reporting"
  1013. )
  1014. last_reported = self.cursor_to_dict(txn)
  1015. txn.execute(
  1016. "SELECT stream_ordering"
  1017. " FROM events"
  1018. " ORDER BY stream_ordering DESC"
  1019. " LIMIT 1"
  1020. )
  1021. now_reporting = self.cursor_to_dict(txn)
  1022. if not now_reporting:
  1023. logger.info("Calculating daily messages skipped; no now_reporting")
  1024. return None
  1025. now_reporting = now_reporting[0]["stream_ordering"]
  1026. txn.execute("DELETE FROM stats_reporting")
  1027. txn.execute(
  1028. "INSERT INTO stats_reporting"
  1029. " (reported_stream_token, reported_time)"
  1030. " VALUES (?, ?)",
  1031. (now_reporting, now,)
  1032. )
  1033. if not last_reported:
  1034. logger.info("Calculating daily messages skipped; no last_reported")
  1035. return None
  1036. # Close enough to correct for our purposes.
  1037. yesterday = (now - 24 * 60 * 60)
  1038. since_yesterday_seconds = yesterday - last_reported[0]["reported_time"]
  1039. any_since_yesterday = math.fabs(since_yesterday_seconds) > 60 * 60
  1040. if any_since_yesterday:
  1041. logger.info(
  1042. "Calculating daily messages skipped; since_yesterday_seconds: %d" %
  1043. (since_yesterday_seconds,)
  1044. )
  1045. return None
  1046. txn.execute(
  1047. "SELECT COUNT(*) as messages"
  1048. " FROM events NATURAL JOIN event_json"
  1049. " WHERE json like '%m.room.message%'"
  1050. " AND stream_ordering > ?"
  1051. " AND stream_ordering <= ?",
  1052. (
  1053. last_reported[0]["reported_stream_token"],
  1054. now_reporting,
  1055. )
  1056. )
  1057. rows = self.cursor_to_dict(txn)
  1058. if not rows:
  1059. logger.info("Calculating daily messages skipped; messages count missing")
  1060. return None
  1061. return rows[0]["messages"]
  1062. ret = yield self.runInteraction("count_messages", _count_messages)
  1063. defer.returnValue(ret)
  1064. @defer.inlineCallbacks
  1065. def _background_reindex_fields_sender(self, progress, batch_size):
  1066. target_min_stream_id = progress["target_min_stream_id_inclusive"]
  1067. max_stream_id = progress["max_stream_id_exclusive"]
  1068. rows_inserted = progress.get("rows_inserted", 0)
  1069. INSERT_CLUMP_SIZE = 1000
  1070. def reindex_txn(txn):
  1071. sql = (
  1072. "SELECT stream_ordering, event_id, json FROM events"
  1073. " INNER JOIN event_json USING (event_id)"
  1074. " WHERE ? <= stream_ordering AND stream_ordering < ?"
  1075. " ORDER BY stream_ordering DESC"
  1076. " LIMIT ?"
  1077. )
  1078. txn.execute(sql, (target_min_stream_id, max_stream_id, batch_size))
  1079. rows = txn.fetchall()
  1080. if not rows:
  1081. return 0
  1082. min_stream_id = rows[-1][0]
  1083. update_rows = []
  1084. for row in rows:
  1085. try:
  1086. event_id = row[1]
  1087. event_json = json.loads(row[2])
  1088. sender = event_json["sender"]
  1089. content = event_json["content"]
  1090. contains_url = "url" in content
  1091. if contains_url:
  1092. contains_url &= isinstance(content["url"], basestring)
  1093. except (KeyError, AttributeError):
  1094. # If the event is missing a necessary field then
  1095. # skip over it.
  1096. continue
  1097. update_rows.append((sender, contains_url, event_id))
  1098. sql = (
  1099. "UPDATE events SET sender = ?, contains_url = ? WHERE event_id = ?"
  1100. )
  1101. for index in range(0, len(update_rows), INSERT_CLUMP_SIZE):
  1102. clump = update_rows[index:index + INSERT_CLUMP_SIZE]
  1103. txn.executemany(sql, clump)
  1104. progress = {
  1105. "target_min_stream_id_inclusive": target_min_stream_id,
  1106. "max_stream_id_exclusive": min_stream_id,
  1107. "rows_inserted": rows_inserted + len(rows)
  1108. }
  1109. self._background_update_progress_txn(
  1110. txn, self.EVENT_FIELDS_SENDER_URL_UPDATE_NAME, progress
  1111. )
  1112. return len(rows)
  1113. result = yield self.runInteraction(
  1114. self.EVENT_FIELDS_SENDER_URL_UPDATE_NAME, reindex_txn
  1115. )
  1116. if not result:
  1117. yield self._end_background_update(self.EVENT_FIELDS_SENDER_URL_UPDATE_NAME)
  1118. defer.returnValue(result)
  1119. @defer.inlineCallbacks
  1120. def _background_reindex_origin_server_ts(self, progress, batch_size):
  1121. target_min_stream_id = progress["target_min_stream_id_inclusive"]
  1122. max_stream_id = progress["max_stream_id_exclusive"]
  1123. rows_inserted = progress.get("rows_inserted", 0)
  1124. INSERT_CLUMP_SIZE = 1000
  1125. def reindex_search_txn(txn):
  1126. sql = (
  1127. "SELECT stream_ordering, event_id FROM events"
  1128. " WHERE ? <= stream_ordering AND stream_ordering < ?"
  1129. " ORDER BY stream_ordering DESC"
  1130. " LIMIT ?"
  1131. )
  1132. txn.execute(sql, (target_min_stream_id, max_stream_id, batch_size))
  1133. rows = txn.fetchall()
  1134. if not rows:
  1135. return 0
  1136. min_stream_id = rows[-1][0]
  1137. event_ids = [row[1] for row in rows]
  1138. rows_to_update = []
  1139. chunks = [
  1140. event_ids[i:i + 100]
  1141. for i in xrange(0, len(event_ids), 100)
  1142. ]
  1143. for chunk in chunks:
  1144. ev_rows = self._simple_select_many_txn(
  1145. txn,
  1146. table="event_json",
  1147. column="event_id",
  1148. iterable=chunk,
  1149. retcols=["event_id", "json"],
  1150. keyvalues={},
  1151. )
  1152. for row in ev_rows:
  1153. event_id = row["event_id"]
  1154. event_json = json.loads(row["json"])
  1155. try:
  1156. origin_server_ts = event_json["origin_server_ts"]
  1157. except (KeyError, AttributeError):
  1158. # If the event is missing a necessary field then
  1159. # skip over it.
  1160. continue
  1161. rows_to_update.append((origin_server_ts, event_id))
  1162. sql = (
  1163. "UPDATE events SET origin_server_ts = ? WHERE event_id = ?"
  1164. )
  1165. for index in range(0, len(rows_to_update), INSERT_CLUMP_SIZE):
  1166. clump = rows_to_update[index:index + INSERT_CLUMP_SIZE]
  1167. txn.executemany(sql, clump)
  1168. progress = {
  1169. "target_min_stream_id_inclusive": target_min_stream_id,
  1170. "max_stream_id_exclusive": min_stream_id,
  1171. "rows_inserted": rows_inserted + len(rows_to_update)
  1172. }
  1173. self._background_update_progress_txn(
  1174. txn, self.EVENT_ORIGIN_SERVER_TS_NAME, progress
  1175. )
  1176. return len(rows_to_update)
  1177. result = yield self.runInteraction(
  1178. self.EVENT_ORIGIN_SERVER_TS_NAME, reindex_search_txn
  1179. )
  1180. if not result:
  1181. yield self._end_background_update(self.EVENT_ORIGIN_SERVER_TS_NAME)
  1182. defer.returnValue(result)
  1183. def get_current_backfill_token(self):
  1184. """The current minimum token that backfilled events have reached"""
  1185. return -self._backfill_id_gen.get_current_token()
  1186. def get_all_new_events(self, last_backfill_id, last_forward_id,
  1187. current_backfill_id, current_forward_id, limit):
  1188. """Get all the new events that have arrived at the server either as
  1189. new events or as backfilled events"""
  1190. have_backfill_events = last_backfill_id != current_backfill_id
  1191. have_forward_events = last_forward_id != current_forward_id
  1192. if not have_backfill_events and not have_forward_events:
  1193. return defer.succeed(AllNewEventsResult([], [], [], [], []))
  1194. def get_all_new_events_txn(txn):
  1195. sql = (
  1196. "SELECT e.stream_ordering, ej.internal_metadata, ej.json, eg.state_group"
  1197. " FROM events as e"
  1198. " JOIN event_json as ej"
  1199. " ON e.event_id = ej.event_id AND e.room_id = ej.room_id"
  1200. " LEFT JOIN event_to_state_groups as eg"
  1201. " ON e.event_id = eg.event_id"
  1202. " WHERE ? < e.stream_ordering AND e.stream_ordering <= ?"
  1203. " ORDER BY e.stream_ordering ASC"
  1204. " LIMIT ?"
  1205. )
  1206. if have_forward_events:
  1207. txn.execute(sql, (last_forward_id, current_forward_id, limit))
  1208. new_forward_events = txn.fetchall()
  1209. if len(new_forward_events) == limit:
  1210. upper_bound = new_forward_events[-1][0]
  1211. else:
  1212. upper_bound = current_forward_id
  1213. sql = (
  1214. "SELECT event_stream_ordering FROM current_state_resets"
  1215. " WHERE ? < event_stream_ordering"
  1216. " AND event_stream_ordering <= ?"
  1217. " ORDER BY event_stream_ordering ASC"
  1218. )
  1219. txn.execute(sql, (last_forward_id, upper_bound))
  1220. state_resets = txn.fetchall()
  1221. sql = (
  1222. "SELECT event_stream_ordering, event_id, state_group"
  1223. " FROM ex_outlier_stream"
  1224. " WHERE ? > event_stream_ordering"
  1225. " AND event_stream_ordering >= ?"
  1226. " ORDER BY event_stream_ordering DESC"
  1227. )
  1228. txn.execute(sql, (last_forward_id, upper_bound))
  1229. forward_ex_outliers = txn.fetchall()
  1230. else:
  1231. new_forward_events = []
  1232. state_resets = []
  1233. forward_ex_outliers = []
  1234. sql = (
  1235. "SELECT -e.stream_ordering, ej.internal_metadata, ej.json,"
  1236. " eg.state_group"
  1237. " FROM events as e"
  1238. " JOIN event_json as ej"
  1239. " ON e.event_id = ej.event_id AND e.room_id = ej.room_id"
  1240. " LEFT JOIN event_to_state_groups as eg"
  1241. " ON e.event_id = eg.event_id"
  1242. " WHERE ? > e.stream_ordering AND e.stream_ordering >= ?"
  1243. " ORDER BY e.stream_ordering DESC"
  1244. " LIMIT ?"
  1245. )
  1246. if have_backfill_events:
  1247. txn.execute(sql, (-last_backfill_id, -current_backfill_id, limit))
  1248. new_backfill_events = txn.fetchall()
  1249. if len(new_backfill_events) == limit:
  1250. upper_bound = new_backfill_events[-1][0]
  1251. else:
  1252. upper_bound = current_backfill_id
  1253. sql = (
  1254. "SELECT -event_stream_ordering, event_id, state_group"
  1255. " FROM ex_outlier_stream"
  1256. " WHERE ? > event_stream_ordering"
  1257. " AND event_stream_ordering >= ?"
  1258. " ORDER BY event_stream_ordering DESC"
  1259. )
  1260. txn.execute(sql, (-last_backfill_id, -upper_bound))
  1261. backward_ex_outliers = txn.fetchall()
  1262. else:
  1263. new_backfill_events = []
  1264. backward_ex_outliers = []
  1265. return AllNewEventsResult(
  1266. new_forward_events, new_backfill_events,
  1267. forward_ex_outliers, backward_ex_outliers,
  1268. state_resets,
  1269. )
  1270. return self.runInteraction("get_all_new_events", get_all_new_events_txn)
  1271. def delete_old_state(self, room_id, topological_ordering):
  1272. return self.runInteraction(
  1273. "delete_old_state",
  1274. self._delete_old_state_txn, room_id, topological_ordering
  1275. )
  1276. def _delete_old_state_txn(self, txn, room_id, topological_ordering):
  1277. """Deletes old room state
  1278. """
  1279. # Tables that should be pruned:
  1280. # event_auth
  1281. # event_backward_extremities
  1282. # event_content_hashes
  1283. # event_destinations
  1284. # event_edge_hashes
  1285. # event_edges
  1286. # event_forward_extremities
  1287. # event_json
  1288. # event_push_actions
  1289. # event_reference_hashes
  1290. # event_search
  1291. # event_signatures
  1292. # event_to_state_groups
  1293. # events
  1294. # rejections
  1295. # room_depth
  1296. # state_groups
  1297. # state_groups_state
  1298. # First ensure that we're not about to delete all the forward extremeties
  1299. txn.execute(
  1300. "SELECT e.event_id, e.depth FROM events as e "
  1301. "INNER JOIN event_forward_extremities as f "
  1302. "ON e.event_id = f.event_id "
  1303. "AND e.room_id = f.room_id "
  1304. "WHERE f.room_id = ?",
  1305. (room_id,)
  1306. )
  1307. rows = txn.fetchall()
  1308. max_depth = max(row[0] for row in rows)
  1309. if max_depth <= topological_ordering:
  1310. # We need to ensure we don't delete all the events from the datanase
  1311. # otherwise we wouldn't be able to send any events (due to not
  1312. # having any backwards extremeties)
  1313. raise SynapseError(
  1314. 400, "topological_ordering is greater than forward extremeties"
  1315. )
  1316. txn.execute(
  1317. "SELECT event_id, state_key FROM events"
  1318. " LEFT JOIN state_events USING (room_id, event_id)"
  1319. " WHERE room_id = ? AND topological_ordering < ?",
  1320. (room_id, topological_ordering,)
  1321. )
  1322. event_rows = txn.fetchall()
  1323. for event_id, state_key in event_rows:
  1324. txn.call_after(self._get_state_group_for_event.invalidate, (event_id,))
  1325. # We calculate the new entries for the backward extremeties by finding
  1326. # all events that point to events that are to be purged
  1327. txn.execute(
  1328. "SELECT DISTINCT e.event_id FROM events as e"
  1329. " INNER JOIN event_edges as ed ON e.event_id = ed.prev_event_id"
  1330. " INNER JOIN events as e2 ON e2.event_id = ed.event_id"
  1331. " WHERE e.room_id = ? AND e.topological_ordering < ?"
  1332. " AND e2.topological_ordering >= ?",
  1333. (room_id, topological_ordering, topological_ordering)
  1334. )
  1335. new_backwards_extrems = txn.fetchall()
  1336. txn.execute(
  1337. "DELETE FROM event_backward_extremities WHERE room_id = ?",
  1338. (room_id,)
  1339. )
  1340. # Update backward extremeties
  1341. txn.executemany(
  1342. "INSERT INTO event_backward_extremities (room_id, event_id)"
  1343. " VALUES (?, ?)",
  1344. [
  1345. (room_id, event_id) for event_id, in new_backwards_extrems
  1346. ]
  1347. )
  1348. # Get all state groups that are only referenced by events that are
  1349. # to be deleted.
  1350. txn.execute(
  1351. "SELECT state_group FROM event_to_state_groups"
  1352. " INNER JOIN events USING (event_id)"
  1353. " WHERE state_group IN ("
  1354. " SELECT DISTINCT state_group FROM events"
  1355. " INNER JOIN event_to_state_groups USING (event_id)"
  1356. " WHERE room_id = ? AND topological_ordering < ?"
  1357. " )"
  1358. " GROUP BY state_group HAVING MAX(topological_ordering) < ?",
  1359. (room_id, topological_ordering, topological_ordering)
  1360. )
  1361. state_rows = txn.fetchall()
  1362. state_groups_to_delete = [sg for sg, in state_rows]
  1363. # Now we get all the state groups that rely on these state groups
  1364. new_state_edges = []
  1365. chunks = [
  1366. state_groups_to_delete[i:i + 100]
  1367. for i in xrange(0, len(state_groups_to_delete), 100)
  1368. ]
  1369. for chunk in chunks:
  1370. rows = self._simple_select_many_txn(
  1371. txn,
  1372. table="state_group_edges",
  1373. column="prev_state_group",
  1374. iterable=chunk,
  1375. retcols=["state_group"],
  1376. keyvalues={},
  1377. )
  1378. new_state_edges.extend(row["state_group"] for row in rows)
  1379. # Now we turn the state groups that reference to-be-deleted state groups
  1380. # to non delta versions.
  1381. for new_state_edge in new_state_edges:
  1382. curr_state = self._get_state_groups_from_groups_txn(
  1383. txn, [new_state_edge], types=None
  1384. )
  1385. curr_state = curr_state[new_state_edge]
  1386. self._simple_delete_txn(
  1387. txn,
  1388. table="state_groups_state",
  1389. keyvalues={
  1390. "state_group": new_state_edge,
  1391. }
  1392. )
  1393. self._simple_delete_txn(
  1394. txn,
  1395. table="state_group_edges",
  1396. keyvalues={
  1397. "state_group": new_state_edge,
  1398. }
  1399. )
  1400. self._simple_insert_many_txn(
  1401. txn,
  1402. table="state_groups_state",
  1403. values=[
  1404. {
  1405. "state_group": new_state_edge,
  1406. "room_id": room_id,
  1407. "type": key[0],
  1408. "state_key": key[1],
  1409. "event_id": state_id,
  1410. }
  1411. for key, state_id in curr_state.items()
  1412. ],
  1413. )
  1414. txn.executemany(
  1415. "DELETE FROM state_groups_state WHERE state_group = ?",
  1416. state_rows
  1417. )
  1418. txn.executemany(
  1419. "DELETE FROM state_groups WHERE id = ?",
  1420. state_rows
  1421. )
  1422. # Delete all non-state
  1423. txn.executemany(
  1424. "DELETE FROM event_to_state_groups WHERE event_id = ?",
  1425. [(event_id,) for event_id, _ in event_rows]
  1426. )
  1427. txn.execute(
  1428. "UPDATE room_depth SET min_depth = ? WHERE room_id = ?",
  1429. (topological_ordering, room_id,)
  1430. )
  1431. # Delete all remote non-state events
  1432. to_delete = [
  1433. (event_id,) for event_id, state_key in event_rows
  1434. if state_key is None and not self.hs.is_mine_id(event_id)
  1435. ]
  1436. for table in (
  1437. "events",
  1438. "event_json",
  1439. "event_auth",
  1440. "event_content_hashes",
  1441. "event_destinations",
  1442. "event_edge_hashes",
  1443. "event_edges",
  1444. "event_forward_extremities",
  1445. "event_push_actions",
  1446. "event_reference_hashes",
  1447. "event_search",
  1448. "event_signatures",
  1449. "rejections",
  1450. ):
  1451. txn.executemany(
  1452. "DELETE FROM %s WHERE event_id = ?" % (table,),
  1453. to_delete
  1454. )
  1455. txn.executemany(
  1456. "DELETE FROM events WHERE event_id = ?",
  1457. to_delete
  1458. )
  1459. # Mark all state and own events as outliers
  1460. txn.executemany(
  1461. "UPDATE events SET outlier = ?"
  1462. " WHERE event_id = ?",
  1463. [
  1464. (True, event_id,) for event_id, state_key in event_rows
  1465. if state_key is not None or self.hs.is_mine_id(event_id)
  1466. ]
  1467. )
  1468. AllNewEventsResult = namedtuple("AllNewEventsResult", [
  1469. "new_forward_events", "new_backfill_events",
  1470. "forward_ex_outliers", "backward_ex_outliers",
  1471. "state_resets"
  1472. ])