events.py 89 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348
  1. # -*- coding: utf-8 -*-
  2. # Copyright 2014-2016 OpenMarket Ltd
  3. # Copyright 2018 New Vector Ltd
  4. #
  5. # Licensed under the Apache License, Version 2.0 (the "License");
  6. # you may not use this file except in compliance with the License.
  7. # You may obtain a copy of the License at
  8. #
  9. # http://www.apache.org/licenses/LICENSE-2.0
  10. #
  11. # Unless required by applicable law or agreed to in writing, software
  12. # distributed under the License is distributed on an "AS IS" BASIS,
  13. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. # See the License for the specific language governing permissions and
  15. # limitations under the License.
  16. import itertools
  17. import logging
  18. from collections import OrderedDict, deque, namedtuple
  19. from functools import wraps
  20. from six import iteritems, text_type
  21. from six.moves import range
  22. from canonicaljson import json
  23. from prometheus_client import Counter
  24. from twisted.internet import defer
  25. import synapse.metrics
  26. from synapse.api.constants import EventTypes
  27. from synapse.api.errors import SynapseError
  28. # these are only included to make the type annotations work
  29. from synapse.events import EventBase # noqa: F401
  30. from synapse.events.snapshot import EventContext # noqa: F401
  31. from synapse.metrics.background_process_metrics import run_as_background_process
  32. from synapse.state import StateResolutionStore
  33. from synapse.storage.background_updates import BackgroundUpdateStore
  34. from synapse.storage.event_federation import EventFederationStore
  35. from synapse.storage.events_worker import EventsWorkerStore
  36. from synapse.storage.state import StateGroupWorkerStore
  37. from synapse.types import RoomStreamToken, get_domain_from_id
  38. from synapse.util import batch_iter
  39. from synapse.util.async_helpers import ObservableDeferred
  40. from synapse.util.caches.descriptors import cached, cachedInlineCallbacks
  41. from synapse.util.frozenutils import frozendict_json_encoder
  42. from synapse.util.logcontext import PreserveLoggingContext, make_deferred_yieldable
  43. from synapse.util.logutils import log_function
  44. from synapse.util.metrics import Measure
  45. logger = logging.getLogger(__name__)
  46. persist_event_counter = Counter("synapse_storage_events_persisted_events", "")
  47. event_counter = Counter("synapse_storage_events_persisted_events_sep", "",
  48. ["type", "origin_type", "origin_entity"])
  49. # The number of times we are recalculating the current state
  50. state_delta_counter = Counter("synapse_storage_events_state_delta", "")
  51. # The number of times we are recalculating state when there is only a
  52. # single forward extremity
  53. state_delta_single_event_counter = Counter(
  54. "synapse_storage_events_state_delta_single_event", "")
  55. # The number of times we are reculating state when we could have resonably
  56. # calculated the delta when we calculated the state for an event we were
  57. # persisting.
  58. state_delta_reuse_delta_counter = Counter(
  59. "synapse_storage_events_state_delta_reuse_delta", "")
  60. def encode_json(json_object):
  61. """
  62. Encode a Python object as JSON and return it in a Unicode string.
  63. """
  64. out = frozendict_json_encoder.encode(json_object)
  65. if isinstance(out, bytes):
  66. out = out.decode('utf8')
  67. return out
  68. class _EventPeristenceQueue(object):
  69. """Queues up events so that they can be persisted in bulk with only one
  70. concurrent transaction per room.
  71. """
  72. _EventPersistQueueItem = namedtuple("_EventPersistQueueItem", (
  73. "events_and_contexts", "backfilled", "deferred",
  74. ))
  75. def __init__(self):
  76. self._event_persist_queues = {}
  77. self._currently_persisting_rooms = set()
  78. def add_to_queue(self, room_id, events_and_contexts, backfilled):
  79. """Add events to the queue, with the given persist_event options.
  80. NB: due to the normal usage pattern of this method, it does *not*
  81. follow the synapse logcontext rules, and leaves the logcontext in
  82. place whether or not the returned deferred is ready.
  83. Args:
  84. room_id (str):
  85. events_and_contexts (list[(EventBase, EventContext)]):
  86. backfilled (bool):
  87. Returns:
  88. defer.Deferred: a deferred which will resolve once the events are
  89. persisted. Runs its callbacks *without* a logcontext.
  90. """
  91. queue = self._event_persist_queues.setdefault(room_id, deque())
  92. if queue:
  93. # if the last item in the queue has the same `backfilled` setting,
  94. # we can just add these new events to that item.
  95. end_item = queue[-1]
  96. if end_item.backfilled == backfilled:
  97. end_item.events_and_contexts.extend(events_and_contexts)
  98. return end_item.deferred.observe()
  99. deferred = ObservableDeferred(defer.Deferred(), consumeErrors=True)
  100. queue.append(self._EventPersistQueueItem(
  101. events_and_contexts=events_and_contexts,
  102. backfilled=backfilled,
  103. deferred=deferred,
  104. ))
  105. return deferred.observe()
  106. def handle_queue(self, room_id, per_item_callback):
  107. """Attempts to handle the queue for a room if not already being handled.
  108. The given callback will be invoked with for each item in the queue,
  109. of type _EventPersistQueueItem. The per_item_callback will continuously
  110. be called with new items, unless the queue becomnes empty. The return
  111. value of the function will be given to the deferreds waiting on the item,
  112. exceptions will be passed to the deferreds as well.
  113. This function should therefore be called whenever anything is added
  114. to the queue.
  115. If another callback is currently handling the queue then it will not be
  116. invoked.
  117. """
  118. if room_id in self._currently_persisting_rooms:
  119. return
  120. self._currently_persisting_rooms.add(room_id)
  121. @defer.inlineCallbacks
  122. def handle_queue_loop():
  123. try:
  124. queue = self._get_drainining_queue(room_id)
  125. for item in queue:
  126. try:
  127. ret = yield per_item_callback(item)
  128. except Exception:
  129. with PreserveLoggingContext():
  130. item.deferred.errback()
  131. else:
  132. with PreserveLoggingContext():
  133. item.deferred.callback(ret)
  134. finally:
  135. queue = self._event_persist_queues.pop(room_id, None)
  136. if queue:
  137. self._event_persist_queues[room_id] = queue
  138. self._currently_persisting_rooms.discard(room_id)
  139. # set handle_queue_loop off in the background
  140. run_as_background_process("persist_events", handle_queue_loop)
  141. def _get_drainining_queue(self, room_id):
  142. queue = self._event_persist_queues.setdefault(room_id, deque())
  143. try:
  144. while True:
  145. yield queue.popleft()
  146. except IndexError:
  147. # Queue has been drained.
  148. pass
  149. _EventCacheEntry = namedtuple("_EventCacheEntry", ("event", "redacted_event"))
  150. def _retry_on_integrity_error(func):
  151. """Wraps a database function so that it gets retried on IntegrityError,
  152. with `delete_existing=True` passed in.
  153. Args:
  154. func: function that returns a Deferred and accepts a `delete_existing` arg
  155. """
  156. @wraps(func)
  157. @defer.inlineCallbacks
  158. def f(self, *args, **kwargs):
  159. try:
  160. res = yield func(self, *args, **kwargs)
  161. except self.database_engine.module.IntegrityError:
  162. logger.exception("IntegrityError, retrying.")
  163. res = yield func(self, *args, delete_existing=True, **kwargs)
  164. defer.returnValue(res)
  165. return f
  166. # inherits from EventFederationStore so that we can call _update_backward_extremities
  167. # and _handle_mult_prev_events (though arguably those could both be moved in here)
  168. class EventsStore(StateGroupWorkerStore, EventFederationStore, EventsWorkerStore,
  169. BackgroundUpdateStore):
  170. EVENT_ORIGIN_SERVER_TS_NAME = "event_origin_server_ts"
  171. EVENT_FIELDS_SENDER_URL_UPDATE_NAME = "event_fields_sender_url"
  172. def __init__(self, db_conn, hs):
  173. super(EventsStore, self).__init__(db_conn, hs)
  174. self.register_background_update_handler(
  175. self.EVENT_ORIGIN_SERVER_TS_NAME, self._background_reindex_origin_server_ts
  176. )
  177. self.register_background_update_handler(
  178. self.EVENT_FIELDS_SENDER_URL_UPDATE_NAME,
  179. self._background_reindex_fields_sender,
  180. )
  181. self.register_background_index_update(
  182. "event_contains_url_index",
  183. index_name="event_contains_url_index",
  184. table="events",
  185. columns=["room_id", "topological_ordering", "stream_ordering"],
  186. where_clause="contains_url = true AND outlier = false",
  187. )
  188. # an event_id index on event_search is useful for the purge_history
  189. # api. Plus it means we get to enforce some integrity with a UNIQUE
  190. # clause
  191. self.register_background_index_update(
  192. "event_search_event_id_idx",
  193. index_name="event_search_event_id_idx",
  194. table="event_search",
  195. columns=["event_id"],
  196. unique=True,
  197. psql_only=True,
  198. )
  199. self._event_persist_queue = _EventPeristenceQueue()
  200. self._state_resolution_handler = hs.get_state_resolution_handler()
  201. @defer.inlineCallbacks
  202. def persist_events(self, events_and_contexts, backfilled=False):
  203. """
  204. Write events to the database
  205. Args:
  206. events_and_contexts: list of tuples of (event, context)
  207. backfilled (bool): Whether the results are retrieved from federation
  208. via backfill or not. Used to determine if they're "new" events
  209. which might update the current state etc.
  210. Returns:
  211. Deferred[int]: the stream ordering of the latest persisted event
  212. """
  213. partitioned = {}
  214. for event, ctx in events_and_contexts:
  215. partitioned.setdefault(event.room_id, []).append((event, ctx))
  216. deferreds = []
  217. for room_id, evs_ctxs in iteritems(partitioned):
  218. d = self._event_persist_queue.add_to_queue(
  219. room_id, evs_ctxs,
  220. backfilled=backfilled,
  221. )
  222. deferreds.append(d)
  223. for room_id in partitioned:
  224. self._maybe_start_persisting(room_id)
  225. yield make_deferred_yieldable(
  226. defer.gatherResults(deferreds, consumeErrors=True)
  227. )
  228. max_persisted_id = yield self._stream_id_gen.get_current_token()
  229. defer.returnValue(max_persisted_id)
  230. @defer.inlineCallbacks
  231. @log_function
  232. def persist_event(self, event, context, backfilled=False):
  233. """
  234. Args:
  235. event (EventBase):
  236. context (EventContext):
  237. backfilled (bool):
  238. Returns:
  239. Deferred: resolves to (int, int): the stream ordering of ``event``,
  240. and the stream ordering of the latest persisted event
  241. """
  242. deferred = self._event_persist_queue.add_to_queue(
  243. event.room_id, [(event, context)],
  244. backfilled=backfilled,
  245. )
  246. self._maybe_start_persisting(event.room_id)
  247. yield make_deferred_yieldable(deferred)
  248. max_persisted_id = yield self._stream_id_gen.get_current_token()
  249. defer.returnValue((event.internal_metadata.stream_ordering, max_persisted_id))
  250. def _maybe_start_persisting(self, room_id):
  251. @defer.inlineCallbacks
  252. def persisting_queue(item):
  253. with Measure(self._clock, "persist_events"):
  254. yield self._persist_events(
  255. item.events_and_contexts,
  256. backfilled=item.backfilled,
  257. )
  258. self._event_persist_queue.handle_queue(room_id, persisting_queue)
  259. @_retry_on_integrity_error
  260. @defer.inlineCallbacks
  261. def _persist_events(self, events_and_contexts, backfilled=False,
  262. delete_existing=False):
  263. """Persist events to db
  264. Args:
  265. events_and_contexts (list[(EventBase, EventContext)]):
  266. backfilled (bool):
  267. delete_existing (bool):
  268. Returns:
  269. Deferred: resolves when the events have been persisted
  270. """
  271. if not events_and_contexts:
  272. return
  273. if backfilled:
  274. stream_ordering_manager = self._backfill_id_gen.get_next_mult(
  275. len(events_and_contexts)
  276. )
  277. else:
  278. stream_ordering_manager = self._stream_id_gen.get_next_mult(
  279. len(events_and_contexts)
  280. )
  281. with stream_ordering_manager as stream_orderings:
  282. for (event, context), stream, in zip(
  283. events_and_contexts, stream_orderings
  284. ):
  285. event.internal_metadata.stream_ordering = stream
  286. chunks = [
  287. events_and_contexts[x:x + 100]
  288. for x in range(0, len(events_and_contexts), 100)
  289. ]
  290. for chunk in chunks:
  291. # We can't easily parallelize these since different chunks
  292. # might contain the same event. :(
  293. # NB: Assumes that we are only persisting events for one room
  294. # at a time.
  295. # map room_id->list[event_ids] giving the new forward
  296. # extremities in each room
  297. new_forward_extremeties = {}
  298. # map room_id->(type,state_key)->event_id tracking the full
  299. # state in each room after adding these events.
  300. # This is simply used to prefill the get_current_state_ids
  301. # cache
  302. current_state_for_room = {}
  303. # map room_id->(to_delete, to_insert) where to_delete is a list
  304. # of type/state keys to remove from current state, and to_insert
  305. # is a map (type,key)->event_id giving the state delta in each
  306. # room
  307. state_delta_for_room = {}
  308. if not backfilled:
  309. with Measure(self._clock, "_calculate_state_and_extrem"):
  310. # Work out the new "current state" for each room.
  311. # We do this by working out what the new extremities are and then
  312. # calculating the state from that.
  313. events_by_room = {}
  314. for event, context in chunk:
  315. events_by_room.setdefault(event.room_id, []).append(
  316. (event, context)
  317. )
  318. for room_id, ev_ctx_rm in iteritems(events_by_room):
  319. latest_event_ids = yield self.get_latest_event_ids_in_room(
  320. room_id
  321. )
  322. new_latest_event_ids = yield self._calculate_new_extremities(
  323. room_id, ev_ctx_rm, latest_event_ids
  324. )
  325. latest_event_ids = set(latest_event_ids)
  326. if new_latest_event_ids == latest_event_ids:
  327. # No change in extremities, so no change in state
  328. continue
  329. # there should always be at least one forward extremity.
  330. # (except during the initial persistence of the send_join
  331. # results, in which case there will be no existing
  332. # extremities, so we'll `continue` above and skip this bit.)
  333. assert new_latest_event_ids, "No forward extremities left!"
  334. new_forward_extremeties[room_id] = new_latest_event_ids
  335. len_1 = (
  336. len(latest_event_ids) == 1
  337. and len(new_latest_event_ids) == 1
  338. )
  339. if len_1:
  340. all_single_prev_not_state = all(
  341. len(event.prev_event_ids()) == 1
  342. and not event.is_state()
  343. for event, ctx in ev_ctx_rm
  344. )
  345. # Don't bother calculating state if they're just
  346. # a long chain of single ancestor non-state events.
  347. if all_single_prev_not_state:
  348. continue
  349. state_delta_counter.inc()
  350. if len(new_latest_event_ids) == 1:
  351. state_delta_single_event_counter.inc()
  352. # This is a fairly handwavey check to see if we could
  353. # have guessed what the delta would have been when
  354. # processing one of these events.
  355. # What we're interested in is if the latest extremities
  356. # were the same when we created the event as they are
  357. # now. When this server creates a new event (as opposed
  358. # to receiving it over federation) it will use the
  359. # forward extremities as the prev_events, so we can
  360. # guess this by looking at the prev_events and checking
  361. # if they match the current forward extremities.
  362. for ev, _ in ev_ctx_rm:
  363. prev_event_ids = set(ev.prev_event_ids())
  364. if latest_event_ids == prev_event_ids:
  365. state_delta_reuse_delta_counter.inc()
  366. break
  367. logger.info(
  368. "Calculating state delta for room %s", room_id,
  369. )
  370. with Measure(
  371. self._clock,
  372. "persist_events.get_new_state_after_events",
  373. ):
  374. res = yield self._get_new_state_after_events(
  375. room_id,
  376. ev_ctx_rm,
  377. latest_event_ids,
  378. new_latest_event_ids,
  379. )
  380. current_state, delta_ids = res
  381. # If either are not None then there has been a change,
  382. # and we need to work out the delta (or use that
  383. # given)
  384. if delta_ids is not None:
  385. # If there is a delta we know that we've
  386. # only added or replaced state, never
  387. # removed keys entirely.
  388. state_delta_for_room[room_id] = ([], delta_ids)
  389. elif current_state is not None:
  390. with Measure(
  391. self._clock,
  392. "persist_events.calculate_state_delta",
  393. ):
  394. delta = yield self._calculate_state_delta(
  395. room_id, current_state,
  396. )
  397. state_delta_for_room[room_id] = delta
  398. # If we have the current_state then lets prefill
  399. # the cache with it.
  400. if current_state is not None:
  401. current_state_for_room[room_id] = current_state
  402. yield self.runInteraction(
  403. "persist_events",
  404. self._persist_events_txn,
  405. events_and_contexts=chunk,
  406. backfilled=backfilled,
  407. delete_existing=delete_existing,
  408. state_delta_for_room=state_delta_for_room,
  409. new_forward_extremeties=new_forward_extremeties,
  410. )
  411. persist_event_counter.inc(len(chunk))
  412. if not backfilled:
  413. # backfilled events have negative stream orderings, so we don't
  414. # want to set the event_persisted_position to that.
  415. synapse.metrics.event_persisted_position.set(
  416. chunk[-1][0].internal_metadata.stream_ordering,
  417. )
  418. for event, context in chunk:
  419. if context.app_service:
  420. origin_type = "local"
  421. origin_entity = context.app_service.id
  422. elif self.hs.is_mine_id(event.sender):
  423. origin_type = "local"
  424. origin_entity = "*client*"
  425. else:
  426. origin_type = "remote"
  427. origin_entity = get_domain_from_id(event.sender)
  428. event_counter.labels(event.type, origin_type, origin_entity).inc()
  429. for room_id, new_state in iteritems(current_state_for_room):
  430. self.get_current_state_ids.prefill(
  431. (room_id, ), new_state
  432. )
  433. for room_id, latest_event_ids in iteritems(new_forward_extremeties):
  434. self.get_latest_event_ids_in_room.prefill(
  435. (room_id,), list(latest_event_ids)
  436. )
  437. @defer.inlineCallbacks
  438. def _calculate_new_extremities(self, room_id, event_contexts, latest_event_ids):
  439. """Calculates the new forward extremities for a room given events to
  440. persist.
  441. Assumes that we are only persisting events for one room at a time.
  442. """
  443. # we're only interested in new events which aren't outliers and which aren't
  444. # being rejected.
  445. new_events = [
  446. event for event, ctx in event_contexts
  447. if not event.internal_metadata.is_outlier() and not ctx.rejected
  448. ]
  449. # start with the existing forward extremities
  450. result = set(latest_event_ids)
  451. # add all the new events to the list
  452. result.update(
  453. event.event_id for event in new_events
  454. )
  455. # Now remove all events which are prev_events of any of the new events
  456. result.difference_update(
  457. e_id
  458. for event in new_events
  459. for e_id in event.prev_event_ids()
  460. )
  461. # Finally, remove any events which are prev_events of any existing events.
  462. existing_prevs = yield self._get_events_which_are_prevs(result)
  463. result.difference_update(existing_prevs)
  464. defer.returnValue(result)
  465. @defer.inlineCallbacks
  466. def _get_events_which_are_prevs(self, event_ids):
  467. """Filter the supplied list of event_ids to get those which are prev_events of
  468. existing (non-outlier/rejected) events.
  469. Args:
  470. event_ids (Iterable[str]): event ids to filter
  471. Returns:
  472. Deferred[List[str]]: filtered event ids
  473. """
  474. results = []
  475. def _get_events(txn, batch):
  476. sql = """
  477. SELECT prev_event_id
  478. FROM event_edges
  479. INNER JOIN events USING (event_id)
  480. LEFT JOIN rejections USING (event_id)
  481. WHERE
  482. prev_event_id IN (%s)
  483. AND NOT events.outlier
  484. AND rejections.event_id IS NULL
  485. """ % (
  486. ",".join("?" for _ in batch),
  487. )
  488. txn.execute(sql, batch)
  489. results.extend(r[0] for r in txn)
  490. for chunk in batch_iter(event_ids, 100):
  491. yield self.runInteraction(
  492. "_get_events_which_are_prevs",
  493. _get_events,
  494. chunk,
  495. )
  496. defer.returnValue(results)
  497. @defer.inlineCallbacks
  498. def _get_new_state_after_events(self, room_id, events_context, old_latest_event_ids,
  499. new_latest_event_ids):
  500. """Calculate the current state dict after adding some new events to
  501. a room
  502. Args:
  503. room_id (str):
  504. room to which the events are being added. Used for logging etc
  505. events_context (list[(EventBase, EventContext)]):
  506. events and contexts which are being added to the room
  507. old_latest_event_ids (iterable[str]):
  508. the old forward extremities for the room.
  509. new_latest_event_ids (iterable[str]):
  510. the new forward extremities for the room.
  511. Returns:
  512. Deferred[tuple[dict[(str,str), str]|None, dict[(str,str), str]|None]]:
  513. Returns a tuple of two state maps, the first being the full new current
  514. state and the second being the delta to the existing current state.
  515. If both are None then there has been no change.
  516. If there has been a change then we only return the delta if its
  517. already been calculated. Conversely if we do know the delta then
  518. the new current state is only returned if we've already calculated
  519. it.
  520. """
  521. # map from state_group to ((type, key) -> event_id) state map
  522. state_groups_map = {}
  523. # Map from (prev state group, new state group) -> delta state dict
  524. state_group_deltas = {}
  525. for ev, ctx in events_context:
  526. if ctx.state_group is None:
  527. # This should only happen for outlier events.
  528. if not ev.internal_metadata.is_outlier():
  529. raise Exception(
  530. "Context for new event %s has no state "
  531. "group" % (ev.event_id, ),
  532. )
  533. continue
  534. if ctx.state_group in state_groups_map:
  535. continue
  536. # We're only interested in pulling out state that has already
  537. # been cached in the context. We'll pull stuff out of the DB later
  538. # if necessary.
  539. current_state_ids = ctx.get_cached_current_state_ids()
  540. if current_state_ids is not None:
  541. state_groups_map[ctx.state_group] = current_state_ids
  542. if ctx.prev_group:
  543. state_group_deltas[(ctx.prev_group, ctx.state_group)] = ctx.delta_ids
  544. # We need to map the event_ids to their state groups. First, let's
  545. # check if the event is one we're persisting, in which case we can
  546. # pull the state group from its context.
  547. # Otherwise we need to pull the state group from the database.
  548. # Set of events we need to fetch groups for. (We know none of the old
  549. # extremities are going to be in events_context).
  550. missing_event_ids = set(old_latest_event_ids)
  551. event_id_to_state_group = {}
  552. for event_id in new_latest_event_ids:
  553. # First search in the list of new events we're adding.
  554. for ev, ctx in events_context:
  555. if event_id == ev.event_id and ctx.state_group is not None:
  556. event_id_to_state_group[event_id] = ctx.state_group
  557. break
  558. else:
  559. # If we couldn't find it, then we'll need to pull
  560. # the state from the database
  561. missing_event_ids.add(event_id)
  562. if missing_event_ids:
  563. # Now pull out the state groups for any missing events from DB
  564. event_to_groups = yield self._get_state_group_for_events(
  565. missing_event_ids,
  566. )
  567. event_id_to_state_group.update(event_to_groups)
  568. # State groups of old_latest_event_ids
  569. old_state_groups = set(
  570. event_id_to_state_group[evid] for evid in old_latest_event_ids
  571. )
  572. # State groups of new_latest_event_ids
  573. new_state_groups = set(
  574. event_id_to_state_group[evid] for evid in new_latest_event_ids
  575. )
  576. # If they old and new groups are the same then we don't need to do
  577. # anything.
  578. if old_state_groups == new_state_groups:
  579. defer.returnValue((None, None))
  580. if len(new_state_groups) == 1 and len(old_state_groups) == 1:
  581. # If we're going from one state group to another, lets check if
  582. # we have a delta for that transition. If we do then we can just
  583. # return that.
  584. new_state_group = next(iter(new_state_groups))
  585. old_state_group = next(iter(old_state_groups))
  586. delta_ids = state_group_deltas.get(
  587. (old_state_group, new_state_group,), None
  588. )
  589. if delta_ids is not None:
  590. # We have a delta from the existing to new current state,
  591. # so lets just return that. If we happen to already have
  592. # the current state in memory then lets also return that,
  593. # but it doesn't matter if we don't.
  594. new_state = state_groups_map.get(new_state_group)
  595. defer.returnValue((new_state, delta_ids))
  596. # Now that we have calculated new_state_groups we need to get
  597. # their state IDs so we can resolve to a single state set.
  598. missing_state = new_state_groups - set(state_groups_map)
  599. if missing_state:
  600. group_to_state = yield self._get_state_for_groups(missing_state)
  601. state_groups_map.update(group_to_state)
  602. if len(new_state_groups) == 1:
  603. # If there is only one state group, then we know what the current
  604. # state is.
  605. defer.returnValue((state_groups_map[new_state_groups.pop()], None))
  606. # Ok, we need to defer to the state handler to resolve our state sets.
  607. state_groups = {
  608. sg: state_groups_map[sg] for sg in new_state_groups
  609. }
  610. events_map = {ev.event_id: ev for ev, _ in events_context}
  611. # We need to get the room version, which is in the create event.
  612. # Normally that'd be in the database, but its also possible that we're
  613. # currently trying to persist it.
  614. room_version = None
  615. for ev, _ in events_context:
  616. if ev.type == EventTypes.Create and ev.state_key == "":
  617. room_version = ev.content.get("room_version", "1")
  618. break
  619. if not room_version:
  620. room_version = yield self.get_room_version(room_id)
  621. logger.debug("calling resolve_state_groups from preserve_events")
  622. res = yield self._state_resolution_handler.resolve_state_groups(
  623. room_id, room_version, state_groups, events_map,
  624. state_res_store=StateResolutionStore(self)
  625. )
  626. defer.returnValue((res.state, None))
  627. @defer.inlineCallbacks
  628. def _calculate_state_delta(self, room_id, current_state):
  629. """Calculate the new state deltas for a room.
  630. Assumes that we are only persisting events for one room at a time.
  631. Returns:
  632. tuple[list, dict] (to_delete, to_insert): where to_delete are the
  633. type/state_keys to remove from current_state_events and `to_insert`
  634. are the updates to current_state_events.
  635. """
  636. existing_state = yield self.get_current_state_ids(room_id)
  637. to_delete = [
  638. key for key in existing_state
  639. if key not in current_state
  640. ]
  641. to_insert = {
  642. key: ev_id for key, ev_id in iteritems(current_state)
  643. if ev_id != existing_state.get(key)
  644. }
  645. defer.returnValue((to_delete, to_insert))
  646. @log_function
  647. def _persist_events_txn(self, txn, events_and_contexts, backfilled,
  648. delete_existing=False, state_delta_for_room={},
  649. new_forward_extremeties={}):
  650. """Insert some number of room events into the necessary database tables.
  651. Rejected events are only inserted into the events table, the events_json table,
  652. and the rejections table. Things reading from those table will need to check
  653. whether the event was rejected.
  654. Args:
  655. txn (twisted.enterprise.adbapi.Connection): db connection
  656. events_and_contexts (list[(EventBase, EventContext)]):
  657. events to persist
  658. backfilled (bool): True if the events were backfilled
  659. delete_existing (bool): True to purge existing table rows for the
  660. events from the database. This is useful when retrying due to
  661. IntegrityError.
  662. state_delta_for_room (dict[str, (list, dict)]):
  663. The current-state delta for each room. For each room, a tuple
  664. (to_delete, to_insert), being a list of type/state keys to be
  665. removed from the current state, and a state set to be added to
  666. the current state.
  667. new_forward_extremeties (dict[str, list[str]]):
  668. The new forward extremities for each room. For each room, a
  669. list of the event ids which are the forward extremities.
  670. """
  671. all_events_and_contexts = events_and_contexts
  672. max_stream_order = events_and_contexts[-1][0].internal_metadata.stream_ordering
  673. self._update_current_state_txn(txn, state_delta_for_room, max_stream_order)
  674. self._update_forward_extremities_txn(
  675. txn,
  676. new_forward_extremities=new_forward_extremeties,
  677. max_stream_order=max_stream_order,
  678. )
  679. # Ensure that we don't have the same event twice.
  680. events_and_contexts = self._filter_events_and_contexts_for_duplicates(
  681. events_and_contexts,
  682. )
  683. self._update_room_depths_txn(
  684. txn,
  685. events_and_contexts=events_and_contexts,
  686. backfilled=backfilled,
  687. )
  688. # _update_outliers_txn filters out any events which have already been
  689. # persisted, and returns the filtered list.
  690. events_and_contexts = self._update_outliers_txn(
  691. txn,
  692. events_and_contexts=events_and_contexts,
  693. )
  694. # From this point onwards the events are only events that we haven't
  695. # seen before.
  696. if delete_existing:
  697. # For paranoia reasons, we go and delete all the existing entries
  698. # for these events so we can reinsert them.
  699. # This gets around any problems with some tables already having
  700. # entries.
  701. self._delete_existing_rows_txn(
  702. txn,
  703. events_and_contexts=events_and_contexts,
  704. )
  705. self._store_event_txn(
  706. txn,
  707. events_and_contexts=events_and_contexts,
  708. )
  709. # Insert into event_to_state_groups.
  710. self._store_event_state_mappings_txn(txn, events_and_contexts)
  711. # We want to store event_auth mappings for rejected events, as they're
  712. # used in state res v2.
  713. # This is only necessary if the rejected event appears in an accepted
  714. # event's auth chain, but its easier for now just to store them (and
  715. # it doesn't take much storage compared to storing the entire event
  716. # anyway).
  717. self._simple_insert_many_txn(
  718. txn,
  719. table="event_auth",
  720. values=[
  721. {
  722. "event_id": event.event_id,
  723. "room_id": event.room_id,
  724. "auth_id": auth_id,
  725. }
  726. for event, _ in events_and_contexts
  727. for auth_id in event.auth_event_ids()
  728. if event.is_state()
  729. ],
  730. )
  731. # _store_rejected_events_txn filters out any events which were
  732. # rejected, and returns the filtered list.
  733. events_and_contexts = self._store_rejected_events_txn(
  734. txn,
  735. events_and_contexts=events_and_contexts,
  736. )
  737. # From this point onwards the events are only ones that weren't
  738. # rejected.
  739. self._update_metadata_tables_txn(
  740. txn,
  741. events_and_contexts=events_and_contexts,
  742. all_events_and_contexts=all_events_and_contexts,
  743. backfilled=backfilled,
  744. )
  745. def _update_current_state_txn(self, txn, state_delta_by_room, max_stream_order):
  746. for room_id, current_state_tuple in iteritems(state_delta_by_room):
  747. to_delete, to_insert = current_state_tuple
  748. # First we add entries to the current_state_delta_stream. We
  749. # do this before updating the current_state_events table so
  750. # that we can use it to calculate the `prev_event_id`. (This
  751. # allows us to not have to pull out the existing state
  752. # unnecessarily).
  753. sql = """
  754. INSERT INTO current_state_delta_stream
  755. (stream_id, room_id, type, state_key, event_id, prev_event_id)
  756. SELECT ?, ?, ?, ?, ?, (
  757. SELECT event_id FROM current_state_events
  758. WHERE room_id = ? AND type = ? AND state_key = ?
  759. )
  760. """
  761. txn.executemany(sql, (
  762. (
  763. max_stream_order, room_id, etype, state_key, None,
  764. room_id, etype, state_key,
  765. )
  766. for etype, state_key in to_delete
  767. # We sanity check that we're deleting rather than updating
  768. if (etype, state_key) not in to_insert
  769. ))
  770. txn.executemany(sql, (
  771. (
  772. max_stream_order, room_id, etype, state_key, ev_id,
  773. room_id, etype, state_key,
  774. )
  775. for (etype, state_key), ev_id in iteritems(to_insert)
  776. ))
  777. # Now we actually update the current_state_events table
  778. txn.executemany(
  779. "DELETE FROM current_state_events"
  780. " WHERE room_id = ? AND type = ? AND state_key = ?",
  781. (
  782. (room_id, etype, state_key)
  783. for etype, state_key in itertools.chain(to_delete, to_insert)
  784. ),
  785. )
  786. self._simple_insert_many_txn(
  787. txn,
  788. table="current_state_events",
  789. values=[
  790. {
  791. "event_id": ev_id,
  792. "room_id": room_id,
  793. "type": key[0],
  794. "state_key": key[1],
  795. }
  796. for key, ev_id in iteritems(to_insert)
  797. ],
  798. )
  799. txn.call_after(
  800. self._curr_state_delta_stream_cache.entity_has_changed,
  801. room_id, max_stream_order,
  802. )
  803. # Invalidate the various caches
  804. # Figure out the changes of membership to invalidate the
  805. # `get_rooms_for_user` cache.
  806. # We find out which membership events we may have deleted
  807. # and which we have added, then we invlidate the caches for all
  808. # those users.
  809. members_changed = set(
  810. state_key
  811. for ev_type, state_key in itertools.chain(to_delete, to_insert)
  812. if ev_type == EventTypes.Member
  813. )
  814. for member in members_changed:
  815. self._invalidate_cache_and_stream(
  816. txn, self.get_rooms_for_user_with_stream_ordering, (member,)
  817. )
  818. for host in set(get_domain_from_id(u) for u in members_changed):
  819. self._invalidate_cache_and_stream(
  820. txn, self.is_host_joined, (room_id, host)
  821. )
  822. self._invalidate_cache_and_stream(
  823. txn, self.was_host_joined, (room_id, host)
  824. )
  825. self._invalidate_cache_and_stream(
  826. txn, self.get_users_in_room, (room_id,)
  827. )
  828. self._invalidate_cache_and_stream(
  829. txn, self.get_room_summary, (room_id,)
  830. )
  831. self._invalidate_cache_and_stream(
  832. txn, self.get_current_state_ids, (room_id,)
  833. )
  834. def _update_forward_extremities_txn(self, txn, new_forward_extremities,
  835. max_stream_order):
  836. for room_id, new_extrem in iteritems(new_forward_extremities):
  837. self._simple_delete_txn(
  838. txn,
  839. table="event_forward_extremities",
  840. keyvalues={"room_id": room_id},
  841. )
  842. txn.call_after(
  843. self.get_latest_event_ids_in_room.invalidate, (room_id,)
  844. )
  845. self._simple_insert_many_txn(
  846. txn,
  847. table="event_forward_extremities",
  848. values=[
  849. {
  850. "event_id": ev_id,
  851. "room_id": room_id,
  852. }
  853. for room_id, new_extrem in iteritems(new_forward_extremities)
  854. for ev_id in new_extrem
  855. ],
  856. )
  857. # We now insert into stream_ordering_to_exterm a mapping from room_id,
  858. # new stream_ordering to new forward extremeties in the room.
  859. # This allows us to later efficiently look up the forward extremeties
  860. # for a room before a given stream_ordering
  861. self._simple_insert_many_txn(
  862. txn,
  863. table="stream_ordering_to_exterm",
  864. values=[
  865. {
  866. "room_id": room_id,
  867. "event_id": event_id,
  868. "stream_ordering": max_stream_order,
  869. }
  870. for room_id, new_extrem in iteritems(new_forward_extremities)
  871. for event_id in new_extrem
  872. ]
  873. )
  874. @classmethod
  875. def _filter_events_and_contexts_for_duplicates(cls, events_and_contexts):
  876. """Ensure that we don't have the same event twice.
  877. Pick the earliest non-outlier if there is one, else the earliest one.
  878. Args:
  879. events_and_contexts (list[(EventBase, EventContext)]):
  880. Returns:
  881. list[(EventBase, EventContext)]: filtered list
  882. """
  883. new_events_and_contexts = OrderedDict()
  884. for event, context in events_and_contexts:
  885. prev_event_context = new_events_and_contexts.get(event.event_id)
  886. if prev_event_context:
  887. if not event.internal_metadata.is_outlier():
  888. if prev_event_context[0].internal_metadata.is_outlier():
  889. # To ensure correct ordering we pop, as OrderedDict is
  890. # ordered by first insertion.
  891. new_events_and_contexts.pop(event.event_id, None)
  892. new_events_and_contexts[event.event_id] = (event, context)
  893. else:
  894. new_events_and_contexts[event.event_id] = (event, context)
  895. return list(new_events_and_contexts.values())
  896. def _update_room_depths_txn(self, txn, events_and_contexts, backfilled):
  897. """Update min_depth for each room
  898. Args:
  899. txn (twisted.enterprise.adbapi.Connection): db connection
  900. events_and_contexts (list[(EventBase, EventContext)]): events
  901. we are persisting
  902. backfilled (bool): True if the events were backfilled
  903. """
  904. depth_updates = {}
  905. for event, context in events_and_contexts:
  906. # Remove the any existing cache entries for the event_ids
  907. txn.call_after(self._invalidate_get_event_cache, event.event_id)
  908. if not backfilled:
  909. txn.call_after(
  910. self._events_stream_cache.entity_has_changed,
  911. event.room_id, event.internal_metadata.stream_ordering,
  912. )
  913. if not event.internal_metadata.is_outlier() and not context.rejected:
  914. depth_updates[event.room_id] = max(
  915. event.depth, depth_updates.get(event.room_id, event.depth)
  916. )
  917. for room_id, depth in iteritems(depth_updates):
  918. self._update_min_depth_for_room_txn(txn, room_id, depth)
  919. def _update_outliers_txn(self, txn, events_and_contexts):
  920. """Update any outliers with new event info.
  921. This turns outliers into ex-outliers (unless the new event was
  922. rejected).
  923. Args:
  924. txn (twisted.enterprise.adbapi.Connection): db connection
  925. events_and_contexts (list[(EventBase, EventContext)]): events
  926. we are persisting
  927. Returns:
  928. list[(EventBase, EventContext)] new list, without events which
  929. are already in the events table.
  930. """
  931. txn.execute(
  932. "SELECT event_id, outlier FROM events WHERE event_id in (%s)" % (
  933. ",".join(["?"] * len(events_and_contexts)),
  934. ),
  935. [event.event_id for event, _ in events_and_contexts]
  936. )
  937. have_persisted = {
  938. event_id: outlier
  939. for event_id, outlier in txn
  940. }
  941. to_remove = set()
  942. for event, context in events_and_contexts:
  943. if event.event_id not in have_persisted:
  944. continue
  945. to_remove.add(event)
  946. if context.rejected:
  947. # If the event is rejected then we don't care if the event
  948. # was an outlier or not.
  949. continue
  950. outlier_persisted = have_persisted[event.event_id]
  951. if not event.internal_metadata.is_outlier() and outlier_persisted:
  952. # We received a copy of an event that we had already stored as
  953. # an outlier in the database. We now have some state at that
  954. # so we need to update the state_groups table with that state.
  955. # insert into event_to_state_groups.
  956. try:
  957. self._store_event_state_mappings_txn(txn, ((event, context),))
  958. except Exception:
  959. logger.exception("")
  960. raise
  961. metadata_json = encode_json(
  962. event.internal_metadata.get_dict()
  963. )
  964. sql = (
  965. "UPDATE event_json SET internal_metadata = ?"
  966. " WHERE event_id = ?"
  967. )
  968. txn.execute(
  969. sql,
  970. (metadata_json, event.event_id,)
  971. )
  972. # Add an entry to the ex_outlier_stream table to replicate the
  973. # change in outlier status to our workers.
  974. stream_order = event.internal_metadata.stream_ordering
  975. state_group_id = context.state_group
  976. self._simple_insert_txn(
  977. txn,
  978. table="ex_outlier_stream",
  979. values={
  980. "event_stream_ordering": stream_order,
  981. "event_id": event.event_id,
  982. "state_group": state_group_id,
  983. }
  984. )
  985. sql = (
  986. "UPDATE events SET outlier = ?"
  987. " WHERE event_id = ?"
  988. )
  989. txn.execute(
  990. sql,
  991. (False, event.event_id,)
  992. )
  993. # Update the event_backward_extremities table now that this
  994. # event isn't an outlier any more.
  995. self._update_backward_extremeties(txn, [event])
  996. return [
  997. ec for ec in events_and_contexts if ec[0] not in to_remove
  998. ]
  999. @classmethod
  1000. def _delete_existing_rows_txn(cls, txn, events_and_contexts):
  1001. if not events_and_contexts:
  1002. # nothing to do here
  1003. return
  1004. logger.info("Deleting existing")
  1005. for table in (
  1006. "events",
  1007. "event_auth",
  1008. "event_json",
  1009. "event_content_hashes",
  1010. "event_destinations",
  1011. "event_edge_hashes",
  1012. "event_edges",
  1013. "event_forward_extremities",
  1014. "event_reference_hashes",
  1015. "event_search",
  1016. "event_signatures",
  1017. "event_to_state_groups",
  1018. "guest_access",
  1019. "history_visibility",
  1020. "local_invites",
  1021. "room_names",
  1022. "state_events",
  1023. "rejections",
  1024. "redactions",
  1025. "room_memberships",
  1026. "topics"
  1027. ):
  1028. txn.executemany(
  1029. "DELETE FROM %s WHERE event_id = ?" % (table,),
  1030. [(ev.event_id,) for ev, _ in events_and_contexts]
  1031. )
  1032. for table in (
  1033. "event_push_actions",
  1034. ):
  1035. txn.executemany(
  1036. "DELETE FROM %s WHERE room_id = ? AND event_id = ?" % (table,),
  1037. [(ev.room_id, ev.event_id) for ev, _ in events_and_contexts]
  1038. )
  1039. def _store_event_txn(self, txn, events_and_contexts):
  1040. """Insert new events into the event and event_json tables
  1041. Args:
  1042. txn (twisted.enterprise.adbapi.Connection): db connection
  1043. events_and_contexts (list[(EventBase, EventContext)]): events
  1044. we are persisting
  1045. """
  1046. if not events_and_contexts:
  1047. # nothing to do here
  1048. return
  1049. def event_dict(event):
  1050. d = event.get_dict()
  1051. d.pop("redacted", None)
  1052. d.pop("redacted_because", None)
  1053. return d
  1054. self._simple_insert_many_txn(
  1055. txn,
  1056. table="event_json",
  1057. values=[
  1058. {
  1059. "event_id": event.event_id,
  1060. "room_id": event.room_id,
  1061. "internal_metadata": encode_json(
  1062. event.internal_metadata.get_dict()
  1063. ),
  1064. "json": encode_json(event_dict(event)),
  1065. }
  1066. for event, _ in events_and_contexts
  1067. ],
  1068. )
  1069. self._simple_insert_many_txn(
  1070. txn,
  1071. table="events",
  1072. values=[
  1073. {
  1074. "stream_ordering": event.internal_metadata.stream_ordering,
  1075. "topological_ordering": event.depth,
  1076. "depth": event.depth,
  1077. "event_id": event.event_id,
  1078. "room_id": event.room_id,
  1079. "type": event.type,
  1080. "processed": True,
  1081. "outlier": event.internal_metadata.is_outlier(),
  1082. "origin_server_ts": int(event.origin_server_ts),
  1083. "received_ts": self._clock.time_msec(),
  1084. "sender": event.sender,
  1085. "contains_url": (
  1086. "url" in event.content
  1087. and isinstance(event.content["url"], text_type)
  1088. ),
  1089. }
  1090. for event, _ in events_and_contexts
  1091. ],
  1092. )
  1093. def _store_rejected_events_txn(self, txn, events_and_contexts):
  1094. """Add rows to the 'rejections' table for received events which were
  1095. rejected
  1096. Args:
  1097. txn (twisted.enterprise.adbapi.Connection): db connection
  1098. events_and_contexts (list[(EventBase, EventContext)]): events
  1099. we are persisting
  1100. Returns:
  1101. list[(EventBase, EventContext)] new list, without the rejected
  1102. events.
  1103. """
  1104. # Remove the rejected events from the list now that we've added them
  1105. # to the events table and the events_json table.
  1106. to_remove = set()
  1107. for event, context in events_and_contexts:
  1108. if context.rejected:
  1109. # Insert the event_id into the rejections table
  1110. self._store_rejections_txn(
  1111. txn, event.event_id, context.rejected
  1112. )
  1113. to_remove.add(event)
  1114. return [
  1115. ec for ec in events_and_contexts if ec[0] not in to_remove
  1116. ]
  1117. def _update_metadata_tables_txn(self, txn, events_and_contexts,
  1118. all_events_and_contexts, backfilled):
  1119. """Update all the miscellaneous tables for new events
  1120. Args:
  1121. txn (twisted.enterprise.adbapi.Connection): db connection
  1122. events_and_contexts (list[(EventBase, EventContext)]): events
  1123. we are persisting
  1124. all_events_and_contexts (list[(EventBase, EventContext)]): all
  1125. events that we were going to persist. This includes events
  1126. we've already persisted, etc, that wouldn't appear in
  1127. events_and_context.
  1128. backfilled (bool): True if the events were backfilled
  1129. """
  1130. # Insert all the push actions into the event_push_actions table.
  1131. self._set_push_actions_for_event_and_users_txn(
  1132. txn,
  1133. events_and_contexts=events_and_contexts,
  1134. all_events_and_contexts=all_events_and_contexts,
  1135. )
  1136. if not events_and_contexts:
  1137. # nothing to do here
  1138. return
  1139. for event, context in events_and_contexts:
  1140. if event.type == EventTypes.Redaction and event.redacts is not None:
  1141. # Remove the entries in the event_push_actions table for the
  1142. # redacted event.
  1143. self._remove_push_actions_for_event_id_txn(
  1144. txn, event.room_id, event.redacts
  1145. )
  1146. # Update the event_forward_extremities, event_backward_extremities and
  1147. # event_edges tables.
  1148. self._handle_mult_prev_events(
  1149. txn,
  1150. events=[event for event, _ in events_and_contexts],
  1151. )
  1152. for event, _ in events_and_contexts:
  1153. if event.type == EventTypes.Name:
  1154. # Insert into the room_names and event_search tables.
  1155. self._store_room_name_txn(txn, event)
  1156. elif event.type == EventTypes.Topic:
  1157. # Insert into the topics table and event_search table.
  1158. self._store_room_topic_txn(txn, event)
  1159. elif event.type == EventTypes.Message:
  1160. # Insert into the event_search table.
  1161. self._store_room_message_txn(txn, event)
  1162. elif event.type == EventTypes.Redaction:
  1163. # Insert into the redactions table.
  1164. self._store_redaction(txn, event)
  1165. elif event.type == EventTypes.RoomHistoryVisibility:
  1166. # Insert into the event_search table.
  1167. self._store_history_visibility_txn(txn, event)
  1168. elif event.type == EventTypes.GuestAccess:
  1169. # Insert into the event_search table.
  1170. self._store_guest_access_txn(txn, event)
  1171. # Insert into the room_memberships table.
  1172. self._store_room_members_txn(
  1173. txn,
  1174. [
  1175. event
  1176. for event, _ in events_and_contexts
  1177. if event.type == EventTypes.Member
  1178. ],
  1179. backfilled=backfilled,
  1180. )
  1181. # Insert event_reference_hashes table.
  1182. self._store_event_reference_hashes_txn(
  1183. txn, [event for event, _ in events_and_contexts]
  1184. )
  1185. state_events_and_contexts = [
  1186. ec for ec in events_and_contexts if ec[0].is_state()
  1187. ]
  1188. state_values = []
  1189. for event, context in state_events_and_contexts:
  1190. vals = {
  1191. "event_id": event.event_id,
  1192. "room_id": event.room_id,
  1193. "type": event.type,
  1194. "state_key": event.state_key,
  1195. }
  1196. # TODO: How does this work with backfilling?
  1197. if hasattr(event, "replaces_state"):
  1198. vals["prev_state"] = event.replaces_state
  1199. state_values.append(vals)
  1200. self._simple_insert_many_txn(
  1201. txn,
  1202. table="state_events",
  1203. values=state_values,
  1204. )
  1205. self._simple_insert_many_txn(
  1206. txn,
  1207. table="event_edges",
  1208. values=[
  1209. {
  1210. "event_id": event.event_id,
  1211. "prev_event_id": prev_id,
  1212. "room_id": event.room_id,
  1213. "is_state": True,
  1214. }
  1215. for event, _ in state_events_and_contexts
  1216. for prev_id, _ in event.prev_state
  1217. ],
  1218. )
  1219. # Prefill the event cache
  1220. self._add_to_cache(txn, events_and_contexts)
  1221. def _add_to_cache(self, txn, events_and_contexts):
  1222. to_prefill = []
  1223. rows = []
  1224. N = 200
  1225. for i in range(0, len(events_and_contexts), N):
  1226. ev_map = {
  1227. e[0].event_id: e[0]
  1228. for e in events_and_contexts[i:i + N]
  1229. }
  1230. if not ev_map:
  1231. break
  1232. sql = (
  1233. "SELECT "
  1234. " e.event_id as event_id, "
  1235. " r.redacts as redacts,"
  1236. " rej.event_id as rejects "
  1237. " FROM events as e"
  1238. " LEFT JOIN rejections as rej USING (event_id)"
  1239. " LEFT JOIN redactions as r ON e.event_id = r.redacts"
  1240. " WHERE e.event_id IN (%s)"
  1241. ) % (",".join(["?"] * len(ev_map)),)
  1242. txn.execute(sql, list(ev_map))
  1243. rows = self.cursor_to_dict(txn)
  1244. for row in rows:
  1245. event = ev_map[row["event_id"]]
  1246. if not row["rejects"] and not row["redacts"]:
  1247. to_prefill.append(_EventCacheEntry(
  1248. event=event,
  1249. redacted_event=None,
  1250. ))
  1251. def prefill():
  1252. for cache_entry in to_prefill:
  1253. self._get_event_cache.prefill((cache_entry[0].event_id,), cache_entry)
  1254. txn.call_after(prefill)
  1255. def _store_redaction(self, txn, event):
  1256. # invalidate the cache for the redacted event
  1257. txn.call_after(self._invalidate_get_event_cache, event.redacts)
  1258. txn.execute(
  1259. "INSERT INTO redactions (event_id, redacts) VALUES (?,?)",
  1260. (event.event_id, event.redacts)
  1261. )
  1262. @defer.inlineCallbacks
  1263. def count_daily_messages(self):
  1264. """
  1265. Returns an estimate of the number of messages sent in the last day.
  1266. If it has been significantly less or more than one day since the last
  1267. call to this function, it will return None.
  1268. """
  1269. def _count_messages(txn):
  1270. sql = """
  1271. SELECT COALESCE(COUNT(*), 0) FROM events
  1272. WHERE type = 'm.room.message'
  1273. AND stream_ordering > ?
  1274. """
  1275. txn.execute(sql, (self.stream_ordering_day_ago,))
  1276. count, = txn.fetchone()
  1277. return count
  1278. ret = yield self.runInteraction("count_messages", _count_messages)
  1279. defer.returnValue(ret)
  1280. @defer.inlineCallbacks
  1281. def count_daily_sent_messages(self):
  1282. def _count_messages(txn):
  1283. # This is good enough as if you have silly characters in your own
  1284. # hostname then thats your own fault.
  1285. like_clause = "%:" + self.hs.hostname
  1286. sql = """
  1287. SELECT COALESCE(COUNT(*), 0) FROM events
  1288. WHERE type = 'm.room.message'
  1289. AND sender LIKE ?
  1290. AND stream_ordering > ?
  1291. """
  1292. txn.execute(sql, (like_clause, self.stream_ordering_day_ago,))
  1293. count, = txn.fetchone()
  1294. return count
  1295. ret = yield self.runInteraction("count_daily_sent_messages", _count_messages)
  1296. defer.returnValue(ret)
  1297. @defer.inlineCallbacks
  1298. def count_daily_active_rooms(self):
  1299. def _count(txn):
  1300. sql = """
  1301. SELECT COALESCE(COUNT(DISTINCT room_id), 0) FROM events
  1302. WHERE type = 'm.room.message'
  1303. AND stream_ordering > ?
  1304. """
  1305. txn.execute(sql, (self.stream_ordering_day_ago,))
  1306. count, = txn.fetchone()
  1307. return count
  1308. ret = yield self.runInteraction("count_daily_active_rooms", _count)
  1309. defer.returnValue(ret)
  1310. @defer.inlineCallbacks
  1311. def _background_reindex_fields_sender(self, progress, batch_size):
  1312. target_min_stream_id = progress["target_min_stream_id_inclusive"]
  1313. max_stream_id = progress["max_stream_id_exclusive"]
  1314. rows_inserted = progress.get("rows_inserted", 0)
  1315. INSERT_CLUMP_SIZE = 1000
  1316. def reindex_txn(txn):
  1317. sql = (
  1318. "SELECT stream_ordering, event_id, json FROM events"
  1319. " INNER JOIN event_json USING (event_id)"
  1320. " WHERE ? <= stream_ordering AND stream_ordering < ?"
  1321. " ORDER BY stream_ordering DESC"
  1322. " LIMIT ?"
  1323. )
  1324. txn.execute(sql, (target_min_stream_id, max_stream_id, batch_size))
  1325. rows = txn.fetchall()
  1326. if not rows:
  1327. return 0
  1328. min_stream_id = rows[-1][0]
  1329. update_rows = []
  1330. for row in rows:
  1331. try:
  1332. event_id = row[1]
  1333. event_json = json.loads(row[2])
  1334. sender = event_json["sender"]
  1335. content = event_json["content"]
  1336. contains_url = "url" in content
  1337. if contains_url:
  1338. contains_url &= isinstance(content["url"], text_type)
  1339. except (KeyError, AttributeError):
  1340. # If the event is missing a necessary field then
  1341. # skip over it.
  1342. continue
  1343. update_rows.append((sender, contains_url, event_id))
  1344. sql = (
  1345. "UPDATE events SET sender = ?, contains_url = ? WHERE event_id = ?"
  1346. )
  1347. for index in range(0, len(update_rows), INSERT_CLUMP_SIZE):
  1348. clump = update_rows[index:index + INSERT_CLUMP_SIZE]
  1349. txn.executemany(sql, clump)
  1350. progress = {
  1351. "target_min_stream_id_inclusive": target_min_stream_id,
  1352. "max_stream_id_exclusive": min_stream_id,
  1353. "rows_inserted": rows_inserted + len(rows)
  1354. }
  1355. self._background_update_progress_txn(
  1356. txn, self.EVENT_FIELDS_SENDER_URL_UPDATE_NAME, progress
  1357. )
  1358. return len(rows)
  1359. result = yield self.runInteraction(
  1360. self.EVENT_FIELDS_SENDER_URL_UPDATE_NAME, reindex_txn
  1361. )
  1362. if not result:
  1363. yield self._end_background_update(self.EVENT_FIELDS_SENDER_URL_UPDATE_NAME)
  1364. defer.returnValue(result)
  1365. @defer.inlineCallbacks
  1366. def _background_reindex_origin_server_ts(self, progress, batch_size):
  1367. target_min_stream_id = progress["target_min_stream_id_inclusive"]
  1368. max_stream_id = progress["max_stream_id_exclusive"]
  1369. rows_inserted = progress.get("rows_inserted", 0)
  1370. INSERT_CLUMP_SIZE = 1000
  1371. def reindex_search_txn(txn):
  1372. sql = (
  1373. "SELECT stream_ordering, event_id FROM events"
  1374. " WHERE ? <= stream_ordering AND stream_ordering < ?"
  1375. " ORDER BY stream_ordering DESC"
  1376. " LIMIT ?"
  1377. )
  1378. txn.execute(sql, (target_min_stream_id, max_stream_id, batch_size))
  1379. rows = txn.fetchall()
  1380. if not rows:
  1381. return 0
  1382. min_stream_id = rows[-1][0]
  1383. event_ids = [row[1] for row in rows]
  1384. rows_to_update = []
  1385. chunks = [
  1386. event_ids[i:i + 100]
  1387. for i in range(0, len(event_ids), 100)
  1388. ]
  1389. for chunk in chunks:
  1390. ev_rows = self._simple_select_many_txn(
  1391. txn,
  1392. table="event_json",
  1393. column="event_id",
  1394. iterable=chunk,
  1395. retcols=["event_id", "json"],
  1396. keyvalues={},
  1397. )
  1398. for row in ev_rows:
  1399. event_id = row["event_id"]
  1400. event_json = json.loads(row["json"])
  1401. try:
  1402. origin_server_ts = event_json["origin_server_ts"]
  1403. except (KeyError, AttributeError):
  1404. # If the event is missing a necessary field then
  1405. # skip over it.
  1406. continue
  1407. rows_to_update.append((origin_server_ts, event_id))
  1408. sql = (
  1409. "UPDATE events SET origin_server_ts = ? WHERE event_id = ?"
  1410. )
  1411. for index in range(0, len(rows_to_update), INSERT_CLUMP_SIZE):
  1412. clump = rows_to_update[index:index + INSERT_CLUMP_SIZE]
  1413. txn.executemany(sql, clump)
  1414. progress = {
  1415. "target_min_stream_id_inclusive": target_min_stream_id,
  1416. "max_stream_id_exclusive": min_stream_id,
  1417. "rows_inserted": rows_inserted + len(rows_to_update)
  1418. }
  1419. self._background_update_progress_txn(
  1420. txn, self.EVENT_ORIGIN_SERVER_TS_NAME, progress
  1421. )
  1422. return len(rows_to_update)
  1423. result = yield self.runInteraction(
  1424. self.EVENT_ORIGIN_SERVER_TS_NAME, reindex_search_txn
  1425. )
  1426. if not result:
  1427. yield self._end_background_update(self.EVENT_ORIGIN_SERVER_TS_NAME)
  1428. defer.returnValue(result)
  1429. def get_current_backfill_token(self):
  1430. """The current minimum token that backfilled events have reached"""
  1431. return -self._backfill_id_gen.get_current_token()
  1432. def get_current_events_token(self):
  1433. """The current maximum token that events have reached"""
  1434. return self._stream_id_gen.get_current_token()
  1435. def get_all_new_forward_event_rows(self, last_id, current_id, limit):
  1436. if last_id == current_id:
  1437. return defer.succeed([])
  1438. def get_all_new_forward_event_rows(txn):
  1439. sql = (
  1440. "SELECT e.stream_ordering, e.event_id, e.room_id, e.type,"
  1441. " state_key, redacts"
  1442. " FROM events AS e"
  1443. " LEFT JOIN redactions USING (event_id)"
  1444. " LEFT JOIN state_events USING (event_id)"
  1445. " WHERE ? < stream_ordering AND stream_ordering <= ?"
  1446. " ORDER BY stream_ordering ASC"
  1447. " LIMIT ?"
  1448. )
  1449. txn.execute(sql, (last_id, current_id, limit))
  1450. new_event_updates = txn.fetchall()
  1451. if len(new_event_updates) == limit:
  1452. upper_bound = new_event_updates[-1][0]
  1453. else:
  1454. upper_bound = current_id
  1455. sql = (
  1456. "SELECT event_stream_ordering, e.event_id, e.room_id, e.type,"
  1457. " state_key, redacts"
  1458. " FROM events AS e"
  1459. " INNER JOIN ex_outlier_stream USING (event_id)"
  1460. " LEFT JOIN redactions USING (event_id)"
  1461. " LEFT JOIN state_events USING (event_id)"
  1462. " WHERE ? < event_stream_ordering"
  1463. " AND event_stream_ordering <= ?"
  1464. " ORDER BY event_stream_ordering DESC"
  1465. )
  1466. txn.execute(sql, (last_id, upper_bound))
  1467. new_event_updates.extend(txn)
  1468. return new_event_updates
  1469. return self.runInteraction(
  1470. "get_all_new_forward_event_rows", get_all_new_forward_event_rows
  1471. )
  1472. def get_all_new_backfill_event_rows(self, last_id, current_id, limit):
  1473. if last_id == current_id:
  1474. return defer.succeed([])
  1475. def get_all_new_backfill_event_rows(txn):
  1476. sql = (
  1477. "SELECT -e.stream_ordering, e.event_id, e.room_id, e.type,"
  1478. " state_key, redacts"
  1479. " FROM events AS e"
  1480. " LEFT JOIN redactions USING (event_id)"
  1481. " LEFT JOIN state_events USING (event_id)"
  1482. " WHERE ? > stream_ordering AND stream_ordering >= ?"
  1483. " ORDER BY stream_ordering ASC"
  1484. " LIMIT ?"
  1485. )
  1486. txn.execute(sql, (-last_id, -current_id, limit))
  1487. new_event_updates = txn.fetchall()
  1488. if len(new_event_updates) == limit:
  1489. upper_bound = new_event_updates[-1][0]
  1490. else:
  1491. upper_bound = current_id
  1492. sql = (
  1493. "SELECT -event_stream_ordering, e.event_id, e.room_id, e.type,"
  1494. " state_key, redacts"
  1495. " FROM events AS e"
  1496. " INNER JOIN ex_outlier_stream USING (event_id)"
  1497. " LEFT JOIN redactions USING (event_id)"
  1498. " LEFT JOIN state_events USING (event_id)"
  1499. " WHERE ? > event_stream_ordering"
  1500. " AND event_stream_ordering >= ?"
  1501. " ORDER BY event_stream_ordering DESC"
  1502. )
  1503. txn.execute(sql, (-last_id, -upper_bound))
  1504. new_event_updates.extend(txn.fetchall())
  1505. return new_event_updates
  1506. return self.runInteraction(
  1507. "get_all_new_backfill_event_rows", get_all_new_backfill_event_rows
  1508. )
  1509. @cached(num_args=5, max_entries=10)
  1510. def get_all_new_events(self, last_backfill_id, last_forward_id,
  1511. current_backfill_id, current_forward_id, limit):
  1512. """Get all the new events that have arrived at the server either as
  1513. new events or as backfilled events"""
  1514. have_backfill_events = last_backfill_id != current_backfill_id
  1515. have_forward_events = last_forward_id != current_forward_id
  1516. if not have_backfill_events and not have_forward_events:
  1517. return defer.succeed(AllNewEventsResult([], [], [], [], []))
  1518. def get_all_new_events_txn(txn):
  1519. sql = (
  1520. "SELECT e.stream_ordering, e.event_id, e.room_id, e.type,"
  1521. " state_key, redacts"
  1522. " FROM events AS e"
  1523. " LEFT JOIN redactions USING (event_id)"
  1524. " LEFT JOIN state_events USING (event_id)"
  1525. " WHERE ? < stream_ordering AND stream_ordering <= ?"
  1526. " ORDER BY stream_ordering ASC"
  1527. " LIMIT ?"
  1528. )
  1529. if have_forward_events:
  1530. txn.execute(sql, (last_forward_id, current_forward_id, limit))
  1531. new_forward_events = txn.fetchall()
  1532. if len(new_forward_events) == limit:
  1533. upper_bound = new_forward_events[-1][0]
  1534. else:
  1535. upper_bound = current_forward_id
  1536. sql = (
  1537. "SELECT event_stream_ordering, event_id, state_group"
  1538. " FROM ex_outlier_stream"
  1539. " WHERE ? > event_stream_ordering"
  1540. " AND event_stream_ordering >= ?"
  1541. " ORDER BY event_stream_ordering DESC"
  1542. )
  1543. txn.execute(sql, (last_forward_id, upper_bound))
  1544. forward_ex_outliers = txn.fetchall()
  1545. else:
  1546. new_forward_events = []
  1547. forward_ex_outliers = []
  1548. sql = (
  1549. "SELECT -e.stream_ordering, e.event_id, e.room_id, e.type,"
  1550. " state_key, redacts"
  1551. " FROM events AS e"
  1552. " LEFT JOIN redactions USING (event_id)"
  1553. " LEFT JOIN state_events USING (event_id)"
  1554. " WHERE ? > stream_ordering AND stream_ordering >= ?"
  1555. " ORDER BY stream_ordering DESC"
  1556. " LIMIT ?"
  1557. )
  1558. if have_backfill_events:
  1559. txn.execute(sql, (-last_backfill_id, -current_backfill_id, limit))
  1560. new_backfill_events = txn.fetchall()
  1561. if len(new_backfill_events) == limit:
  1562. upper_bound = new_backfill_events[-1][0]
  1563. else:
  1564. upper_bound = current_backfill_id
  1565. sql = (
  1566. "SELECT -event_stream_ordering, event_id, state_group"
  1567. " FROM ex_outlier_stream"
  1568. " WHERE ? > event_stream_ordering"
  1569. " AND event_stream_ordering >= ?"
  1570. " ORDER BY event_stream_ordering DESC"
  1571. )
  1572. txn.execute(sql, (-last_backfill_id, -upper_bound))
  1573. backward_ex_outliers = txn.fetchall()
  1574. else:
  1575. new_backfill_events = []
  1576. backward_ex_outliers = []
  1577. return AllNewEventsResult(
  1578. new_forward_events, new_backfill_events,
  1579. forward_ex_outliers, backward_ex_outliers,
  1580. )
  1581. return self.runInteraction("get_all_new_events", get_all_new_events_txn)
  1582. def purge_history(
  1583. self, room_id, token, delete_local_events,
  1584. ):
  1585. """Deletes room history before a certain point
  1586. Args:
  1587. room_id (str):
  1588. token (str): A topological token to delete events before
  1589. delete_local_events (bool):
  1590. if True, we will delete local events as well as remote ones
  1591. (instead of just marking them as outliers and deleting their
  1592. state groups).
  1593. """
  1594. return self.runInteraction(
  1595. "purge_history",
  1596. self._purge_history_txn, room_id, token,
  1597. delete_local_events,
  1598. )
  1599. def _purge_history_txn(
  1600. self, txn, room_id, token_str, delete_local_events,
  1601. ):
  1602. token = RoomStreamToken.parse(token_str)
  1603. # Tables that should be pruned:
  1604. # event_auth
  1605. # event_backward_extremities
  1606. # event_content_hashes
  1607. # event_destinations
  1608. # event_edge_hashes
  1609. # event_edges
  1610. # event_forward_extremities
  1611. # event_json
  1612. # event_push_actions
  1613. # event_reference_hashes
  1614. # event_search
  1615. # event_signatures
  1616. # event_to_state_groups
  1617. # events
  1618. # rejections
  1619. # room_depth
  1620. # state_groups
  1621. # state_groups_state
  1622. # we will build a temporary table listing the events so that we don't
  1623. # have to keep shovelling the list back and forth across the
  1624. # connection. Annoyingly the python sqlite driver commits the
  1625. # transaction on CREATE, so let's do this first.
  1626. #
  1627. # furthermore, we might already have the table from a previous (failed)
  1628. # purge attempt, so let's drop the table first.
  1629. txn.execute("DROP TABLE IF EXISTS events_to_purge")
  1630. txn.execute(
  1631. "CREATE TEMPORARY TABLE events_to_purge ("
  1632. " event_id TEXT NOT NULL,"
  1633. " should_delete BOOLEAN NOT NULL"
  1634. ")"
  1635. )
  1636. # First ensure that we're not about to delete all the forward extremeties
  1637. txn.execute(
  1638. "SELECT e.event_id, e.depth FROM events as e "
  1639. "INNER JOIN event_forward_extremities as f "
  1640. "ON e.event_id = f.event_id "
  1641. "AND e.room_id = f.room_id "
  1642. "WHERE f.room_id = ?",
  1643. (room_id,)
  1644. )
  1645. rows = txn.fetchall()
  1646. max_depth = max(row[1] for row in rows)
  1647. if max_depth < token.topological:
  1648. # We need to ensure we don't delete all the events from the database
  1649. # otherwise we wouldn't be able to send any events (due to not
  1650. # having any backwards extremeties)
  1651. raise SynapseError(
  1652. 400, "topological_ordering is greater than forward extremeties"
  1653. )
  1654. logger.info("[purge] looking for events to delete")
  1655. should_delete_expr = "state_key IS NULL"
  1656. should_delete_params = ()
  1657. if not delete_local_events:
  1658. should_delete_expr += " AND event_id NOT LIKE ?"
  1659. # We include the parameter twice since we use the expression twice
  1660. should_delete_params += (
  1661. "%:" + self.hs.hostname,
  1662. "%:" + self.hs.hostname,
  1663. )
  1664. should_delete_params += (room_id, token.topological)
  1665. # Note that we insert events that are outliers and aren't going to be
  1666. # deleted, as nothing will happen to them.
  1667. txn.execute(
  1668. "INSERT INTO events_to_purge"
  1669. " SELECT event_id, %s"
  1670. " FROM events AS e LEFT JOIN state_events USING (event_id)"
  1671. " WHERE (NOT outlier OR (%s)) AND e.room_id = ? AND topological_ordering < ?"
  1672. % (
  1673. should_delete_expr,
  1674. should_delete_expr,
  1675. ),
  1676. should_delete_params,
  1677. )
  1678. # We create the indices *after* insertion as that's a lot faster.
  1679. # create an index on should_delete because later we'll be looking for
  1680. # the should_delete / shouldn't_delete subsets
  1681. txn.execute(
  1682. "CREATE INDEX events_to_purge_should_delete"
  1683. " ON events_to_purge(should_delete)",
  1684. )
  1685. # We do joins against events_to_purge for e.g. calculating state
  1686. # groups to purge, etc., so lets make an index.
  1687. txn.execute(
  1688. "CREATE INDEX events_to_purge_id"
  1689. " ON events_to_purge(event_id)",
  1690. )
  1691. txn.execute(
  1692. "SELECT event_id, should_delete FROM events_to_purge"
  1693. )
  1694. event_rows = txn.fetchall()
  1695. logger.info(
  1696. "[purge] found %i events before cutoff, of which %i can be deleted",
  1697. len(event_rows), sum(1 for e in event_rows if e[1]),
  1698. )
  1699. logger.info("[purge] Finding new backward extremities")
  1700. # We calculate the new entries for the backward extremeties by finding
  1701. # events to be purged that are pointed to by events we're not going to
  1702. # purge.
  1703. txn.execute(
  1704. "SELECT DISTINCT e.event_id FROM events_to_purge AS e"
  1705. " INNER JOIN event_edges AS ed ON e.event_id = ed.prev_event_id"
  1706. " LEFT JOIN events_to_purge AS ep2 ON ed.event_id = ep2.event_id"
  1707. " WHERE ep2.event_id IS NULL",
  1708. )
  1709. new_backwards_extrems = txn.fetchall()
  1710. logger.info("[purge] replacing backward extremities: %r", new_backwards_extrems)
  1711. txn.execute(
  1712. "DELETE FROM event_backward_extremities WHERE room_id = ?",
  1713. (room_id,)
  1714. )
  1715. # Update backward extremeties
  1716. txn.executemany(
  1717. "INSERT INTO event_backward_extremities (room_id, event_id)"
  1718. " VALUES (?, ?)",
  1719. [
  1720. (room_id, event_id) for event_id, in new_backwards_extrems
  1721. ]
  1722. )
  1723. logger.info("[purge] finding redundant state groups")
  1724. # Get all state groups that are referenced by events that are to be
  1725. # deleted. We then go and check if they are referenced by other events
  1726. # or state groups, and if not we delete them.
  1727. txn.execute("""
  1728. SELECT DISTINCT state_group FROM events_to_purge
  1729. INNER JOIN event_to_state_groups USING (event_id)
  1730. """)
  1731. referenced_state_groups = set(sg for sg, in txn)
  1732. logger.info(
  1733. "[purge] found %i referenced state groups",
  1734. len(referenced_state_groups),
  1735. )
  1736. logger.info("[purge] finding state groups that can be deleted")
  1737. state_groups_to_delete, remaining_state_groups = (
  1738. self._find_unreferenced_groups_during_purge(
  1739. txn, referenced_state_groups,
  1740. )
  1741. )
  1742. logger.info(
  1743. "[purge] found %i state groups to delete",
  1744. len(state_groups_to_delete),
  1745. )
  1746. logger.info(
  1747. "[purge] de-delta-ing %i remaining state groups",
  1748. len(remaining_state_groups),
  1749. )
  1750. # Now we turn the state groups that reference to-be-deleted state
  1751. # groups to non delta versions.
  1752. for sg in remaining_state_groups:
  1753. logger.info("[purge] de-delta-ing remaining state group %s", sg)
  1754. curr_state = self._get_state_groups_from_groups_txn(
  1755. txn, [sg],
  1756. )
  1757. curr_state = curr_state[sg]
  1758. self._simple_delete_txn(
  1759. txn,
  1760. table="state_groups_state",
  1761. keyvalues={
  1762. "state_group": sg,
  1763. }
  1764. )
  1765. self._simple_delete_txn(
  1766. txn,
  1767. table="state_group_edges",
  1768. keyvalues={
  1769. "state_group": sg,
  1770. }
  1771. )
  1772. self._simple_insert_many_txn(
  1773. txn,
  1774. table="state_groups_state",
  1775. values=[
  1776. {
  1777. "state_group": sg,
  1778. "room_id": room_id,
  1779. "type": key[0],
  1780. "state_key": key[1],
  1781. "event_id": state_id,
  1782. }
  1783. for key, state_id in iteritems(curr_state)
  1784. ],
  1785. )
  1786. logger.info("[purge] removing redundant state groups")
  1787. txn.executemany(
  1788. "DELETE FROM state_groups_state WHERE state_group = ?",
  1789. ((sg,) for sg in state_groups_to_delete),
  1790. )
  1791. txn.executemany(
  1792. "DELETE FROM state_groups WHERE id = ?",
  1793. ((sg,) for sg in state_groups_to_delete),
  1794. )
  1795. logger.info("[purge] removing events from event_to_state_groups")
  1796. txn.execute(
  1797. "DELETE FROM event_to_state_groups "
  1798. "WHERE event_id IN (SELECT event_id from events_to_purge)"
  1799. )
  1800. for event_id, _ in event_rows:
  1801. txn.call_after(self._get_state_group_for_event.invalidate, (
  1802. event_id,
  1803. ))
  1804. # Delete all remote non-state events
  1805. for table in (
  1806. "events",
  1807. "event_json",
  1808. "event_auth",
  1809. "event_content_hashes",
  1810. "event_destinations",
  1811. "event_edge_hashes",
  1812. "event_edges",
  1813. "event_forward_extremities",
  1814. "event_reference_hashes",
  1815. "event_search",
  1816. "event_signatures",
  1817. "rejections",
  1818. ):
  1819. logger.info("[purge] removing events from %s", table)
  1820. txn.execute(
  1821. "DELETE FROM %s WHERE event_id IN ("
  1822. " SELECT event_id FROM events_to_purge WHERE should_delete"
  1823. ")" % (table,),
  1824. )
  1825. # event_push_actions lacks an index on event_id, and has one on
  1826. # (room_id, event_id) instead.
  1827. for table in (
  1828. "event_push_actions",
  1829. ):
  1830. logger.info("[purge] removing events from %s", table)
  1831. txn.execute(
  1832. "DELETE FROM %s WHERE room_id = ? AND event_id IN ("
  1833. " SELECT event_id FROM events_to_purge WHERE should_delete"
  1834. ")" % (table,),
  1835. (room_id, )
  1836. )
  1837. # Mark all state and own events as outliers
  1838. logger.info("[purge] marking remaining events as outliers")
  1839. txn.execute(
  1840. "UPDATE events SET outlier = ?"
  1841. " WHERE event_id IN ("
  1842. " SELECT event_id FROM events_to_purge "
  1843. " WHERE NOT should_delete"
  1844. ")",
  1845. (True,),
  1846. )
  1847. # synapse tries to take out an exclusive lock on room_depth whenever it
  1848. # persists events (because upsert), and once we run this update, we
  1849. # will block that for the rest of our transaction.
  1850. #
  1851. # So, let's stick it at the end so that we don't block event
  1852. # persistence.
  1853. #
  1854. # We do this by calculating the minimum depth of the backwards
  1855. # extremities. However, the events in event_backward_extremities
  1856. # are ones we don't have yet so we need to look at the events that
  1857. # point to it via event_edges table.
  1858. txn.execute("""
  1859. SELECT COALESCE(MIN(depth), 0)
  1860. FROM event_backward_extremities AS eb
  1861. INNER JOIN event_edges AS eg ON eg.prev_event_id = eb.event_id
  1862. INNER JOIN events AS e ON e.event_id = eg.event_id
  1863. WHERE eb.room_id = ?
  1864. """, (room_id,))
  1865. min_depth, = txn.fetchone()
  1866. logger.info("[purge] updating room_depth to %d", min_depth)
  1867. txn.execute(
  1868. "UPDATE room_depth SET min_depth = ? WHERE room_id = ?",
  1869. (min_depth, room_id,)
  1870. )
  1871. # finally, drop the temp table. this will commit the txn in sqlite,
  1872. # so make sure to keep this actually last.
  1873. txn.execute(
  1874. "DROP TABLE events_to_purge"
  1875. )
  1876. logger.info("[purge] done")
  1877. def _find_unreferenced_groups_during_purge(self, txn, state_groups):
  1878. """Used when purging history to figure out which state groups can be
  1879. deleted and which need to be de-delta'ed (due to one of its prev groups
  1880. being scheduled for deletion).
  1881. Args:
  1882. txn
  1883. state_groups (set[int]): Set of state groups referenced by events
  1884. that are going to be deleted.
  1885. Returns:
  1886. tuple[set[int], set[int]]: The set of state groups that can be
  1887. deleted and the set of state groups that need to be de-delta'ed
  1888. """
  1889. # Graph of state group -> previous group
  1890. graph = {}
  1891. # Set of events that we have found to be referenced by events
  1892. referenced_groups = set()
  1893. # Set of state groups we've already seen
  1894. state_groups_seen = set(state_groups)
  1895. # Set of state groups to handle next.
  1896. next_to_search = set(state_groups)
  1897. while next_to_search:
  1898. # We bound size of groups we're looking up at once, to stop the
  1899. # SQL query getting too big
  1900. if len(next_to_search) < 100:
  1901. current_search = next_to_search
  1902. next_to_search = set()
  1903. else:
  1904. current_search = set(itertools.islice(next_to_search, 100))
  1905. next_to_search -= current_search
  1906. # Check if state groups are referenced
  1907. sql = """
  1908. SELECT DISTINCT state_group FROM event_to_state_groups
  1909. LEFT JOIN events_to_purge AS ep USING (event_id)
  1910. WHERE state_group IN (%s) AND ep.event_id IS NULL
  1911. """ % (",".join("?" for _ in current_search),)
  1912. txn.execute(sql, list(current_search))
  1913. referenced = set(sg for sg, in txn)
  1914. referenced_groups |= referenced
  1915. # We don't continue iterating up the state group graphs for state
  1916. # groups that are referenced.
  1917. current_search -= referenced
  1918. rows = self._simple_select_many_txn(
  1919. txn,
  1920. table="state_group_edges",
  1921. column="prev_state_group",
  1922. iterable=current_search,
  1923. keyvalues={},
  1924. retcols=("prev_state_group", "state_group",),
  1925. )
  1926. prevs = set(row["state_group"] for row in rows)
  1927. # We don't bother re-handling groups we've already seen
  1928. prevs -= state_groups_seen
  1929. next_to_search |= prevs
  1930. state_groups_seen |= prevs
  1931. for row in rows:
  1932. # Note: Each state group can have at most one prev group
  1933. graph[row["state_group"]] = row["prev_state_group"]
  1934. to_delete = state_groups_seen - referenced_groups
  1935. to_dedelta = set()
  1936. for sg in referenced_groups:
  1937. prev_sg = graph.get(sg)
  1938. if prev_sg and prev_sg in to_delete:
  1939. to_dedelta.add(sg)
  1940. return to_delete, to_dedelta
  1941. @defer.inlineCallbacks
  1942. def is_event_after(self, event_id1, event_id2):
  1943. """Returns True if event_id1 is after event_id2 in the stream
  1944. """
  1945. to_1, so_1 = yield self._get_event_ordering(event_id1)
  1946. to_2, so_2 = yield self._get_event_ordering(event_id2)
  1947. defer.returnValue((to_1, so_1) > (to_2, so_2))
  1948. @cachedInlineCallbacks(max_entries=5000)
  1949. def _get_event_ordering(self, event_id):
  1950. res = yield self._simple_select_one(
  1951. table="events",
  1952. retcols=["topological_ordering", "stream_ordering"],
  1953. keyvalues={"event_id": event_id},
  1954. allow_none=True
  1955. )
  1956. if not res:
  1957. raise SynapseError(404, "Could not find event %s" % (event_id,))
  1958. defer.returnValue((int(res["topological_ordering"]), int(res["stream_ordering"])))
  1959. def get_max_current_state_delta_stream_id(self):
  1960. return self._stream_id_gen.get_current_token()
  1961. def get_all_updated_current_state_deltas(self, from_token, to_token, limit):
  1962. def get_all_updated_current_state_deltas_txn(txn):
  1963. sql = """
  1964. SELECT stream_id, room_id, type, state_key, event_id
  1965. FROM current_state_delta_stream
  1966. WHERE ? < stream_id AND stream_id <= ?
  1967. ORDER BY stream_id ASC LIMIT ?
  1968. """
  1969. txn.execute(sql, (from_token, to_token, limit))
  1970. return txn.fetchall()
  1971. return self.runInteraction(
  1972. "get_all_updated_current_state_deltas",
  1973. get_all_updated_current_state_deltas_txn,
  1974. )
  1975. AllNewEventsResult = namedtuple("AllNewEventsResult", [
  1976. "new_forward_events", "new_backfill_events",
  1977. "forward_ex_outliers", "backward_ex_outliers",
  1978. ])