matrix-synapse 1.143.0__cp310-abi3-manylinux_2_28_aarch64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of matrix-synapse might be problematic. Click here for more details.

Files changed (1058) hide show
  1. matrix_synapse-1.143.0.dist-info/AUTHORS.rst +51 -0
  2. matrix_synapse-1.143.0.dist-info/LICENSE-AGPL-3.0 +661 -0
  3. matrix_synapse-1.143.0.dist-info/LICENSE-COMMERCIAL +6 -0
  4. matrix_synapse-1.143.0.dist-info/METADATA +385 -0
  5. matrix_synapse-1.143.0.dist-info/RECORD +1058 -0
  6. matrix_synapse-1.143.0.dist-info/WHEEL +4 -0
  7. matrix_synapse-1.143.0.dist-info/entry_points.txt +14 -0
  8. synapse/__init__.py +97 -0
  9. synapse/_scripts/__init__.py +0 -0
  10. synapse/_scripts/export_signing_key.py +109 -0
  11. synapse/_scripts/generate_config.py +83 -0
  12. synapse/_scripts/generate_log_config.py +56 -0
  13. synapse/_scripts/generate_signing_key.py +55 -0
  14. synapse/_scripts/generate_workers_map.py +318 -0
  15. synapse/_scripts/hash_password.py +95 -0
  16. synapse/_scripts/move_remote_media_to_new_store.py +128 -0
  17. synapse/_scripts/register_new_matrix_user.py +402 -0
  18. synapse/_scripts/review_recent_signups.py +212 -0
  19. synapse/_scripts/synapse_port_db.py +1604 -0
  20. synapse/_scripts/synctl.py +365 -0
  21. synapse/_scripts/update_synapse_database.py +130 -0
  22. synapse/api/__init__.py +20 -0
  23. synapse/api/auth/__init__.py +207 -0
  24. synapse/api/auth/base.py +406 -0
  25. synapse/api/auth/internal.py +299 -0
  26. synapse/api/auth/mas.py +436 -0
  27. synapse/api/auth/msc3861_delegated.py +617 -0
  28. synapse/api/auth_blocking.py +144 -0
  29. synapse/api/constants.py +362 -0
  30. synapse/api/errors.py +907 -0
  31. synapse/api/filtering.py +537 -0
  32. synapse/api/presence.py +102 -0
  33. synapse/api/ratelimiting.py +480 -0
  34. synapse/api/room_versions.py +535 -0
  35. synapse/api/urls.py +118 -0
  36. synapse/app/__init__.py +60 -0
  37. synapse/app/_base.py +862 -0
  38. synapse/app/admin_cmd.py +388 -0
  39. synapse/app/appservice.py +30 -0
  40. synapse/app/client_reader.py +30 -0
  41. synapse/app/complement_fork_starter.py +206 -0
  42. synapse/app/event_creator.py +29 -0
  43. synapse/app/federation_reader.py +30 -0
  44. synapse/app/federation_sender.py +30 -0
  45. synapse/app/frontend_proxy.py +30 -0
  46. synapse/app/generic_worker.py +474 -0
  47. synapse/app/homeserver.py +505 -0
  48. synapse/app/media_repository.py +30 -0
  49. synapse/app/phone_stats_home.py +296 -0
  50. synapse/app/pusher.py +30 -0
  51. synapse/app/synchrotron.py +30 -0
  52. synapse/app/user_dir.py +31 -0
  53. synapse/appservice/__init__.py +458 -0
  54. synapse/appservice/api.py +567 -0
  55. synapse/appservice/scheduler.py +564 -0
  56. synapse/config/__init__.py +27 -0
  57. synapse/config/__main__.py +62 -0
  58. synapse/config/_base.py +1106 -0
  59. synapse/config/_base.pyi +215 -0
  60. synapse/config/_util.py +99 -0
  61. synapse/config/account_validity.py +116 -0
  62. synapse/config/api.py +141 -0
  63. synapse/config/appservice.py +210 -0
  64. synapse/config/auth.py +80 -0
  65. synapse/config/auto_accept_invites.py +43 -0
  66. synapse/config/background_updates.py +44 -0
  67. synapse/config/cache.py +231 -0
  68. synapse/config/captcha.py +90 -0
  69. synapse/config/cas.py +116 -0
  70. synapse/config/consent.py +73 -0
  71. synapse/config/database.py +184 -0
  72. synapse/config/emailconfig.py +367 -0
  73. synapse/config/experimental.py +595 -0
  74. synapse/config/federation.py +114 -0
  75. synapse/config/homeserver.py +141 -0
  76. synapse/config/jwt.py +55 -0
  77. synapse/config/key.py +447 -0
  78. synapse/config/logger.py +390 -0
  79. synapse/config/mas.py +192 -0
  80. synapse/config/matrixrtc.py +66 -0
  81. synapse/config/metrics.py +84 -0
  82. synapse/config/modules.py +40 -0
  83. synapse/config/oembed.py +185 -0
  84. synapse/config/oidc.py +509 -0
  85. synapse/config/password_auth_providers.py +82 -0
  86. synapse/config/push.py +64 -0
  87. synapse/config/ratelimiting.py +254 -0
  88. synapse/config/redis.py +74 -0
  89. synapse/config/registration.py +296 -0
  90. synapse/config/repository.py +311 -0
  91. synapse/config/retention.py +162 -0
  92. synapse/config/room.py +88 -0
  93. synapse/config/room_directory.py +165 -0
  94. synapse/config/saml2.py +251 -0
  95. synapse/config/server.py +1170 -0
  96. synapse/config/server_notices.py +84 -0
  97. synapse/config/spam_checker.py +66 -0
  98. synapse/config/sso.py +121 -0
  99. synapse/config/stats.py +54 -0
  100. synapse/config/third_party_event_rules.py +40 -0
  101. synapse/config/tls.py +192 -0
  102. synapse/config/tracer.py +71 -0
  103. synapse/config/user_directory.py +47 -0
  104. synapse/config/user_types.py +42 -0
  105. synapse/config/voip.py +59 -0
  106. synapse/config/workers.py +642 -0
  107. synapse/crypto/__init__.py +20 -0
  108. synapse/crypto/context_factory.py +278 -0
  109. synapse/crypto/event_signing.py +194 -0
  110. synapse/crypto/keyring.py +931 -0
  111. synapse/event_auth.py +1266 -0
  112. synapse/events/__init__.py +667 -0
  113. synapse/events/auto_accept_invites.py +216 -0
  114. synapse/events/builder.py +387 -0
  115. synapse/events/presence_router.py +243 -0
  116. synapse/events/snapshot.py +559 -0
  117. synapse/events/utils.py +924 -0
  118. synapse/events/validator.py +305 -0
  119. synapse/federation/__init__.py +22 -0
  120. synapse/federation/federation_base.py +382 -0
  121. synapse/federation/federation_client.py +2132 -0
  122. synapse/federation/federation_server.py +1540 -0
  123. synapse/federation/persistence.py +70 -0
  124. synapse/federation/send_queue.py +531 -0
  125. synapse/federation/sender/__init__.py +1164 -0
  126. synapse/federation/sender/per_destination_queue.py +886 -0
  127. synapse/federation/sender/transaction_manager.py +210 -0
  128. synapse/federation/transport/__init__.py +28 -0
  129. synapse/federation/transport/client.py +1199 -0
  130. synapse/federation/transport/server/__init__.py +334 -0
  131. synapse/federation/transport/server/_base.py +429 -0
  132. synapse/federation/transport/server/federation.py +910 -0
  133. synapse/federation/units.py +133 -0
  134. synapse/handlers/__init__.py +20 -0
  135. synapse/handlers/account.py +162 -0
  136. synapse/handlers/account_data.py +360 -0
  137. synapse/handlers/account_validity.py +361 -0
  138. synapse/handlers/admin.py +615 -0
  139. synapse/handlers/appservice.py +989 -0
  140. synapse/handlers/auth.py +2481 -0
  141. synapse/handlers/cas.py +413 -0
  142. synapse/handlers/deactivate_account.py +363 -0
  143. synapse/handlers/delayed_events.py +599 -0
  144. synapse/handlers/device.py +1870 -0
  145. synapse/handlers/devicemessage.py +399 -0
  146. synapse/handlers/directory.py +545 -0
  147. synapse/handlers/e2e_keys.py +1834 -0
  148. synapse/handlers/e2e_room_keys.py +455 -0
  149. synapse/handlers/event_auth.py +390 -0
  150. synapse/handlers/events.py +201 -0
  151. synapse/handlers/federation.py +2039 -0
  152. synapse/handlers/federation_event.py +2419 -0
  153. synapse/handlers/identity.py +812 -0
  154. synapse/handlers/initial_sync.py +528 -0
  155. synapse/handlers/jwt.py +120 -0
  156. synapse/handlers/message.py +2347 -0
  157. synapse/handlers/oidc.py +1801 -0
  158. synapse/handlers/pagination.py +768 -0
  159. synapse/handlers/password_policy.py +102 -0
  160. synapse/handlers/presence.py +2633 -0
  161. synapse/handlers/profile.py +655 -0
  162. synapse/handlers/push_rules.py +164 -0
  163. synapse/handlers/read_marker.py +79 -0
  164. synapse/handlers/receipts.py +351 -0
  165. synapse/handlers/register.py +1059 -0
  166. synapse/handlers/relations.py +623 -0
  167. synapse/handlers/reports.py +98 -0
  168. synapse/handlers/room.py +2448 -0
  169. synapse/handlers/room_list.py +632 -0
  170. synapse/handlers/room_member.py +2365 -0
  171. synapse/handlers/room_member_worker.py +146 -0
  172. synapse/handlers/room_policy.py +186 -0
  173. synapse/handlers/room_summary.py +1057 -0
  174. synapse/handlers/saml.py +524 -0
  175. synapse/handlers/search.py +723 -0
  176. synapse/handlers/send_email.py +209 -0
  177. synapse/handlers/set_password.py +71 -0
  178. synapse/handlers/sliding_sync/__init__.py +1701 -0
  179. synapse/handlers/sliding_sync/extensions.py +969 -0
  180. synapse/handlers/sliding_sync/room_lists.py +2262 -0
  181. synapse/handlers/sliding_sync/store.py +128 -0
  182. synapse/handlers/sso.py +1291 -0
  183. synapse/handlers/state_deltas.py +82 -0
  184. synapse/handlers/stats.py +321 -0
  185. synapse/handlers/sync.py +3106 -0
  186. synapse/handlers/thread_subscriptions.py +190 -0
  187. synapse/handlers/typing.py +606 -0
  188. synapse/handlers/ui_auth/__init__.py +48 -0
  189. synapse/handlers/ui_auth/checkers.py +332 -0
  190. synapse/handlers/user_directory.py +783 -0
  191. synapse/handlers/worker_lock.py +371 -0
  192. synapse/http/__init__.py +105 -0
  193. synapse/http/additional_resource.py +62 -0
  194. synapse/http/client.py +1373 -0
  195. synapse/http/connectproxyclient.py +316 -0
  196. synapse/http/federation/__init__.py +19 -0
  197. synapse/http/federation/matrix_federation_agent.py +490 -0
  198. synapse/http/federation/srv_resolver.py +196 -0
  199. synapse/http/federation/well_known_resolver.py +367 -0
  200. synapse/http/matrixfederationclient.py +1873 -0
  201. synapse/http/proxy.py +290 -0
  202. synapse/http/proxyagent.py +497 -0
  203. synapse/http/replicationagent.py +202 -0
  204. synapse/http/request_metrics.py +309 -0
  205. synapse/http/server.py +1110 -0
  206. synapse/http/servlet.py +1018 -0
  207. synapse/http/site.py +825 -0
  208. synapse/http/types.py +27 -0
  209. synapse/logging/__init__.py +31 -0
  210. synapse/logging/_remote.py +261 -0
  211. synapse/logging/_terse_json.py +95 -0
  212. synapse/logging/context.py +1209 -0
  213. synapse/logging/formatter.py +62 -0
  214. synapse/logging/handlers.py +99 -0
  215. synapse/logging/loggers.py +25 -0
  216. synapse/logging/opentracing.py +1132 -0
  217. synapse/logging/scopecontextmanager.py +160 -0
  218. synapse/media/_base.py +830 -0
  219. synapse/media/filepath.py +417 -0
  220. synapse/media/media_repository.py +1580 -0
  221. synapse/media/media_storage.py +702 -0
  222. synapse/media/oembed.py +277 -0
  223. synapse/media/preview_html.py +556 -0
  224. synapse/media/storage_provider.py +195 -0
  225. synapse/media/thumbnailer.py +833 -0
  226. synapse/media/url_previewer.py +875 -0
  227. synapse/metrics/__init__.py +748 -0
  228. synapse/metrics/_gc.py +219 -0
  229. synapse/metrics/_reactor_metrics.py +171 -0
  230. synapse/metrics/_types.py +38 -0
  231. synapse/metrics/background_process_metrics.py +555 -0
  232. synapse/metrics/common_usage_metrics.py +94 -0
  233. synapse/metrics/jemalloc.py +248 -0
  234. synapse/module_api/__init__.py +2131 -0
  235. synapse/module_api/callbacks/__init__.py +50 -0
  236. synapse/module_api/callbacks/account_validity_callbacks.py +106 -0
  237. synapse/module_api/callbacks/media_repository_callbacks.py +157 -0
  238. synapse/module_api/callbacks/ratelimit_callbacks.py +78 -0
  239. synapse/module_api/callbacks/spamchecker_callbacks.py +991 -0
  240. synapse/module_api/callbacks/third_party_event_rules_callbacks.py +592 -0
  241. synapse/module_api/errors.py +42 -0
  242. synapse/notifier.py +970 -0
  243. synapse/push/__init__.py +212 -0
  244. synapse/push/bulk_push_rule_evaluator.py +635 -0
  245. synapse/push/clientformat.py +126 -0
  246. synapse/push/emailpusher.py +333 -0
  247. synapse/push/httppusher.py +564 -0
  248. synapse/push/mailer.py +1010 -0
  249. synapse/push/presentable_names.py +216 -0
  250. synapse/push/push_tools.py +114 -0
  251. synapse/push/push_types.py +141 -0
  252. synapse/push/pusher.py +87 -0
  253. synapse/push/pusherpool.py +501 -0
  254. synapse/push/rulekinds.py +33 -0
  255. synapse/py.typed +0 -0
  256. synapse/replication/__init__.py +20 -0
  257. synapse/replication/http/__init__.py +68 -0
  258. synapse/replication/http/_base.py +468 -0
  259. synapse/replication/http/account_data.py +297 -0
  260. synapse/replication/http/deactivate_account.py +81 -0
  261. synapse/replication/http/delayed_events.py +62 -0
  262. synapse/replication/http/devices.py +254 -0
  263. synapse/replication/http/federation.py +334 -0
  264. synapse/replication/http/login.py +106 -0
  265. synapse/replication/http/membership.py +364 -0
  266. synapse/replication/http/presence.py +133 -0
  267. synapse/replication/http/push.py +156 -0
  268. synapse/replication/http/register.py +172 -0
  269. synapse/replication/http/send_events.py +182 -0
  270. synapse/replication/http/state.py +82 -0
  271. synapse/replication/http/streams.py +101 -0
  272. synapse/replication/tcp/__init__.py +56 -0
  273. synapse/replication/tcp/client.py +552 -0
  274. synapse/replication/tcp/commands.py +569 -0
  275. synapse/replication/tcp/context.py +41 -0
  276. synapse/replication/tcp/external_cache.py +156 -0
  277. synapse/replication/tcp/handler.py +922 -0
  278. synapse/replication/tcp/protocol.py +608 -0
  279. synapse/replication/tcp/redis.py +509 -0
  280. synapse/replication/tcp/resource.py +348 -0
  281. synapse/replication/tcp/streams/__init__.py +96 -0
  282. synapse/replication/tcp/streams/_base.py +765 -0
  283. synapse/replication/tcp/streams/events.py +287 -0
  284. synapse/replication/tcp/streams/federation.py +92 -0
  285. synapse/replication/tcp/streams/partial_state.py +80 -0
  286. synapse/res/providers.json +29 -0
  287. synapse/res/templates/_base.html +29 -0
  288. synapse/res/templates/account_previously_renewed.html +6 -0
  289. synapse/res/templates/account_renewed.html +6 -0
  290. synapse/res/templates/add_threepid.html +8 -0
  291. synapse/res/templates/add_threepid.txt +6 -0
  292. synapse/res/templates/add_threepid_failure.html +7 -0
  293. synapse/res/templates/add_threepid_success.html +6 -0
  294. synapse/res/templates/already_in_use.html +12 -0
  295. synapse/res/templates/already_in_use.txt +10 -0
  296. synapse/res/templates/auth_success.html +21 -0
  297. synapse/res/templates/invalid_token.html +6 -0
  298. synapse/res/templates/mail-Element.css +7 -0
  299. synapse/res/templates/mail-Vector.css +7 -0
  300. synapse/res/templates/mail-expiry.css +4 -0
  301. synapse/res/templates/mail.css +156 -0
  302. synapse/res/templates/notice_expiry.html +46 -0
  303. synapse/res/templates/notice_expiry.txt +7 -0
  304. synapse/res/templates/notif.html +51 -0
  305. synapse/res/templates/notif.txt +22 -0
  306. synapse/res/templates/notif_mail.html +59 -0
  307. synapse/res/templates/notif_mail.txt +10 -0
  308. synapse/res/templates/password_reset.html +10 -0
  309. synapse/res/templates/password_reset.txt +7 -0
  310. synapse/res/templates/password_reset_confirmation.html +15 -0
  311. synapse/res/templates/password_reset_failure.html +7 -0
  312. synapse/res/templates/password_reset_success.html +6 -0
  313. synapse/res/templates/recaptcha.html +42 -0
  314. synapse/res/templates/registration.html +12 -0
  315. synapse/res/templates/registration.txt +10 -0
  316. synapse/res/templates/registration_failure.html +6 -0
  317. synapse/res/templates/registration_success.html +6 -0
  318. synapse/res/templates/registration_token.html +18 -0
  319. synapse/res/templates/room.html +33 -0
  320. synapse/res/templates/room.txt +9 -0
  321. synapse/res/templates/sso.css +129 -0
  322. synapse/res/templates/sso_account_deactivated.html +25 -0
  323. synapse/res/templates/sso_auth_account_details.html +186 -0
  324. synapse/res/templates/sso_auth_account_details.js +116 -0
  325. synapse/res/templates/sso_auth_bad_user.html +26 -0
  326. synapse/res/templates/sso_auth_confirm.html +27 -0
  327. synapse/res/templates/sso_auth_success.html +26 -0
  328. synapse/res/templates/sso_error.html +71 -0
  329. synapse/res/templates/sso_footer.html +19 -0
  330. synapse/res/templates/sso_login_idp_picker.html +60 -0
  331. synapse/res/templates/sso_new_user_consent.html +30 -0
  332. synapse/res/templates/sso_partial_profile.html +19 -0
  333. synapse/res/templates/sso_redirect_confirm.html +39 -0
  334. synapse/res/templates/style.css +33 -0
  335. synapse/res/templates/terms.html +27 -0
  336. synapse/rest/__init__.py +197 -0
  337. synapse/rest/admin/__init__.py +390 -0
  338. synapse/rest/admin/_base.py +72 -0
  339. synapse/rest/admin/background_updates.py +171 -0
  340. synapse/rest/admin/devices.py +221 -0
  341. synapse/rest/admin/event_reports.py +173 -0
  342. synapse/rest/admin/events.py +69 -0
  343. synapse/rest/admin/experimental_features.py +137 -0
  344. synapse/rest/admin/federation.py +243 -0
  345. synapse/rest/admin/media.py +540 -0
  346. synapse/rest/admin/registration_tokens.py +358 -0
  347. synapse/rest/admin/rooms.py +1061 -0
  348. synapse/rest/admin/scheduled_tasks.py +70 -0
  349. synapse/rest/admin/server_notice_servlet.py +132 -0
  350. synapse/rest/admin/statistics.py +132 -0
  351. synapse/rest/admin/username_available.py +58 -0
  352. synapse/rest/admin/users.py +1606 -0
  353. synapse/rest/client/__init__.py +20 -0
  354. synapse/rest/client/_base.py +113 -0
  355. synapse/rest/client/account.py +930 -0
  356. synapse/rest/client/account_data.py +319 -0
  357. synapse/rest/client/account_validity.py +103 -0
  358. synapse/rest/client/appservice_ping.py +125 -0
  359. synapse/rest/client/auth.py +218 -0
  360. synapse/rest/client/auth_metadata.py +122 -0
  361. synapse/rest/client/capabilities.py +121 -0
  362. synapse/rest/client/delayed_events.py +165 -0
  363. synapse/rest/client/devices.py +587 -0
  364. synapse/rest/client/directory.py +211 -0
  365. synapse/rest/client/events.py +116 -0
  366. synapse/rest/client/filter.py +112 -0
  367. synapse/rest/client/initial_sync.py +65 -0
  368. synapse/rest/client/keys.py +678 -0
  369. synapse/rest/client/knock.py +104 -0
  370. synapse/rest/client/login.py +750 -0
  371. synapse/rest/client/login_token_request.py +127 -0
  372. synapse/rest/client/logout.py +93 -0
  373. synapse/rest/client/matrixrtc.py +52 -0
  374. synapse/rest/client/media.py +285 -0
  375. synapse/rest/client/mutual_rooms.py +93 -0
  376. synapse/rest/client/notifications.py +137 -0
  377. synapse/rest/client/openid.py +109 -0
  378. synapse/rest/client/password_policy.py +69 -0
  379. synapse/rest/client/presence.py +131 -0
  380. synapse/rest/client/profile.py +291 -0
  381. synapse/rest/client/push_rule.py +331 -0
  382. synapse/rest/client/pusher.py +181 -0
  383. synapse/rest/client/read_marker.py +104 -0
  384. synapse/rest/client/receipts.py +165 -0
  385. synapse/rest/client/register.py +1067 -0
  386. synapse/rest/client/relations.py +138 -0
  387. synapse/rest/client/rendezvous.py +76 -0
  388. synapse/rest/client/reporting.py +207 -0
  389. synapse/rest/client/room.py +1669 -0
  390. synapse/rest/client/room_keys.py +426 -0
  391. synapse/rest/client/room_upgrade_rest_servlet.py +112 -0
  392. synapse/rest/client/sendtodevice.py +85 -0
  393. synapse/rest/client/sync.py +1131 -0
  394. synapse/rest/client/tags.py +129 -0
  395. synapse/rest/client/thirdparty.py +130 -0
  396. synapse/rest/client/thread_subscriptions.py +247 -0
  397. synapse/rest/client/tokenrefresh.py +52 -0
  398. synapse/rest/client/transactions.py +149 -0
  399. synapse/rest/client/user_directory.py +90 -0
  400. synapse/rest/client/versions.py +191 -0
  401. synapse/rest/client/voip.py +88 -0
  402. synapse/rest/consent/__init__.py +0 -0
  403. synapse/rest/consent/consent_resource.py +210 -0
  404. synapse/rest/health.py +38 -0
  405. synapse/rest/key/__init__.py +20 -0
  406. synapse/rest/key/v2/__init__.py +40 -0
  407. synapse/rest/key/v2/local_key_resource.py +125 -0
  408. synapse/rest/key/v2/remote_key_resource.py +302 -0
  409. synapse/rest/media/__init__.py +0 -0
  410. synapse/rest/media/config_resource.py +53 -0
  411. synapse/rest/media/create_resource.py +90 -0
  412. synapse/rest/media/download_resource.py +110 -0
  413. synapse/rest/media/media_repository_resource.py +113 -0
  414. synapse/rest/media/preview_url_resource.py +77 -0
  415. synapse/rest/media/thumbnail_resource.py +142 -0
  416. synapse/rest/media/upload_resource.py +187 -0
  417. synapse/rest/media/v1/__init__.py +39 -0
  418. synapse/rest/media/v1/_base.py +23 -0
  419. synapse/rest/media/v1/media_storage.py +23 -0
  420. synapse/rest/media/v1/storage_provider.py +23 -0
  421. synapse/rest/synapse/__init__.py +20 -0
  422. synapse/rest/synapse/client/__init__.py +93 -0
  423. synapse/rest/synapse/client/federation_whitelist.py +66 -0
  424. synapse/rest/synapse/client/jwks.py +77 -0
  425. synapse/rest/synapse/client/new_user_consent.py +115 -0
  426. synapse/rest/synapse/client/oidc/__init__.py +45 -0
  427. synapse/rest/synapse/client/oidc/backchannel_logout_resource.py +42 -0
  428. synapse/rest/synapse/client/oidc/callback_resource.py +48 -0
  429. synapse/rest/synapse/client/password_reset.py +129 -0
  430. synapse/rest/synapse/client/pick_idp.py +107 -0
  431. synapse/rest/synapse/client/pick_username.py +153 -0
  432. synapse/rest/synapse/client/rendezvous.py +58 -0
  433. synapse/rest/synapse/client/saml2/__init__.py +42 -0
  434. synapse/rest/synapse/client/saml2/metadata_resource.py +46 -0
  435. synapse/rest/synapse/client/saml2/response_resource.py +52 -0
  436. synapse/rest/synapse/client/sso_register.py +56 -0
  437. synapse/rest/synapse/client/unsubscribe.py +88 -0
  438. synapse/rest/synapse/mas/__init__.py +71 -0
  439. synapse/rest/synapse/mas/_base.py +55 -0
  440. synapse/rest/synapse/mas/devices.py +239 -0
  441. synapse/rest/synapse/mas/users.py +469 -0
  442. synapse/rest/well_known.py +148 -0
  443. synapse/server.py +1257 -0
  444. synapse/server_notices/__init__.py +0 -0
  445. synapse/server_notices/consent_server_notices.py +136 -0
  446. synapse/server_notices/resource_limits_server_notices.py +215 -0
  447. synapse/server_notices/server_notices_manager.py +388 -0
  448. synapse/server_notices/server_notices_sender.py +67 -0
  449. synapse/server_notices/worker_server_notices_sender.py +46 -0
  450. synapse/spam_checker_api/__init__.py +31 -0
  451. synapse/state/__init__.py +1022 -0
  452. synapse/state/v1.py +369 -0
  453. synapse/state/v2.py +984 -0
  454. synapse/static/client/login/index.html +47 -0
  455. synapse/static/client/login/js/jquery-3.4.1.min.js +2 -0
  456. synapse/static/client/login/js/login.js +291 -0
  457. synapse/static/client/login/spinner.gif +0 -0
  458. synapse/static/client/login/style.css +79 -0
  459. synapse/static/index.html +63 -0
  460. synapse/storage/__init__.py +43 -0
  461. synapse/storage/_base.py +245 -0
  462. synapse/storage/admin_client_config.py +25 -0
  463. synapse/storage/background_updates.py +1188 -0
  464. synapse/storage/controllers/__init__.py +57 -0
  465. synapse/storage/controllers/persist_events.py +1237 -0
  466. synapse/storage/controllers/purge_events.py +455 -0
  467. synapse/storage/controllers/state.py +950 -0
  468. synapse/storage/controllers/stats.py +119 -0
  469. synapse/storage/database.py +2719 -0
  470. synapse/storage/databases/__init__.py +175 -0
  471. synapse/storage/databases/main/__init__.py +420 -0
  472. synapse/storage/databases/main/account_data.py +1059 -0
  473. synapse/storage/databases/main/appservice.py +473 -0
  474. synapse/storage/databases/main/cache.py +911 -0
  475. synapse/storage/databases/main/censor_events.py +225 -0
  476. synapse/storage/databases/main/client_ips.py +815 -0
  477. synapse/storage/databases/main/delayed_events.py +562 -0
  478. synapse/storage/databases/main/deviceinbox.py +1271 -0
  479. synapse/storage/databases/main/devices.py +2578 -0
  480. synapse/storage/databases/main/directory.py +212 -0
  481. synapse/storage/databases/main/e2e_room_keys.py +689 -0
  482. synapse/storage/databases/main/end_to_end_keys.py +1894 -0
  483. synapse/storage/databases/main/event_federation.py +2508 -0
  484. synapse/storage/databases/main/event_push_actions.py +1933 -0
  485. synapse/storage/databases/main/events.py +3765 -0
  486. synapse/storage/databases/main/events_bg_updates.py +2910 -0
  487. synapse/storage/databases/main/events_forward_extremities.py +126 -0
  488. synapse/storage/databases/main/events_worker.py +2786 -0
  489. synapse/storage/databases/main/experimental_features.py +130 -0
  490. synapse/storage/databases/main/filtering.py +231 -0
  491. synapse/storage/databases/main/keys.py +291 -0
  492. synapse/storage/databases/main/lock.py +553 -0
  493. synapse/storage/databases/main/media_repository.py +1068 -0
  494. synapse/storage/databases/main/metrics.py +460 -0
  495. synapse/storage/databases/main/monthly_active_users.py +443 -0
  496. synapse/storage/databases/main/openid.py +60 -0
  497. synapse/storage/databases/main/presence.py +509 -0
  498. synapse/storage/databases/main/profile.py +539 -0
  499. synapse/storage/databases/main/purge_events.py +521 -0
  500. synapse/storage/databases/main/push_rule.py +970 -0
  501. synapse/storage/databases/main/pusher.py +793 -0
  502. synapse/storage/databases/main/receipts.py +1341 -0
  503. synapse/storage/databases/main/registration.py +3072 -0
  504. synapse/storage/databases/main/rejections.py +37 -0
  505. synapse/storage/databases/main/relations.py +1116 -0
  506. synapse/storage/databases/main/room.py +2779 -0
  507. synapse/storage/databases/main/roommember.py +2110 -0
  508. synapse/storage/databases/main/search.py +939 -0
  509. synapse/storage/databases/main/session.py +151 -0
  510. synapse/storage/databases/main/signatures.py +94 -0
  511. synapse/storage/databases/main/sliding_sync.py +603 -0
  512. synapse/storage/databases/main/state.py +1002 -0
  513. synapse/storage/databases/main/state_deltas.py +329 -0
  514. synapse/storage/databases/main/stats.py +789 -0
  515. synapse/storage/databases/main/stream.py +2577 -0
  516. synapse/storage/databases/main/tags.py +360 -0
  517. synapse/storage/databases/main/task_scheduler.py +225 -0
  518. synapse/storage/databases/main/thread_subscriptions.py +589 -0
  519. synapse/storage/databases/main/transactions.py +675 -0
  520. synapse/storage/databases/main/ui_auth.py +420 -0
  521. synapse/storage/databases/main/user_directory.py +1330 -0
  522. synapse/storage/databases/main/user_erasure_store.py +117 -0
  523. synapse/storage/databases/state/__init__.py +22 -0
  524. synapse/storage/databases/state/bg_updates.py +497 -0
  525. synapse/storage/databases/state/deletion.py +557 -0
  526. synapse/storage/databases/state/store.py +948 -0
  527. synapse/storage/engines/__init__.py +70 -0
  528. synapse/storage/engines/_base.py +154 -0
  529. synapse/storage/engines/postgres.py +261 -0
  530. synapse/storage/engines/sqlite.py +199 -0
  531. synapse/storage/invite_rule.py +112 -0
  532. synapse/storage/keys.py +40 -0
  533. synapse/storage/prepare_database.py +730 -0
  534. synapse/storage/push_rule.py +28 -0
  535. synapse/storage/roommember.py +88 -0
  536. synapse/storage/schema/README.md +4 -0
  537. synapse/storage/schema/__init__.py +186 -0
  538. synapse/storage/schema/common/delta/25/00background_updates.sql +40 -0
  539. synapse/storage/schema/common/delta/35/00background_updates_add_col.sql +36 -0
  540. synapse/storage/schema/common/delta/58/00background_update_ordering.sql +38 -0
  541. synapse/storage/schema/common/full_schemas/72/full.sql.postgres +8 -0
  542. synapse/storage/schema/common/full_schemas/72/full.sql.sqlite +6 -0
  543. synapse/storage/schema/common/schema_version.sql +60 -0
  544. synapse/storage/schema/main/delta/12/v12.sql +82 -0
  545. synapse/storage/schema/main/delta/13/v13.sql +38 -0
  546. synapse/storage/schema/main/delta/14/v14.sql +42 -0
  547. synapse/storage/schema/main/delta/15/appservice_txns.sql +50 -0
  548. synapse/storage/schema/main/delta/15/presence_indices.sql +2 -0
  549. synapse/storage/schema/main/delta/15/v15.sql +24 -0
  550. synapse/storage/schema/main/delta/16/events_order_index.sql +4 -0
  551. synapse/storage/schema/main/delta/16/remote_media_cache_index.sql +2 -0
  552. synapse/storage/schema/main/delta/16/remove_duplicates.sql +9 -0
  553. synapse/storage/schema/main/delta/16/room_alias_index.sql +3 -0
  554. synapse/storage/schema/main/delta/16/unique_constraints.sql +72 -0
  555. synapse/storage/schema/main/delta/16/users.sql +56 -0
  556. synapse/storage/schema/main/delta/17/drop_indexes.sql +37 -0
  557. synapse/storage/schema/main/delta/17/server_keys.sql +43 -0
  558. synapse/storage/schema/main/delta/17/user_threepids.sql +9 -0
  559. synapse/storage/schema/main/delta/18/server_keys_bigger_ints.sql +51 -0
  560. synapse/storage/schema/main/delta/19/event_index.sql +38 -0
  561. synapse/storage/schema/main/delta/20/dummy.sql +1 -0
  562. synapse/storage/schema/main/delta/20/pushers.py +93 -0
  563. synapse/storage/schema/main/delta/21/end_to_end_keys.sql +53 -0
  564. synapse/storage/schema/main/delta/21/receipts.sql +57 -0
  565. synapse/storage/schema/main/delta/22/receipts_index.sql +41 -0
  566. synapse/storage/schema/main/delta/22/user_threepids_unique.sql +19 -0
  567. synapse/storage/schema/main/delta/24/stats_reporting.sql +37 -0
  568. synapse/storage/schema/main/delta/25/fts.py +81 -0
  569. synapse/storage/schema/main/delta/25/guest_access.sql +44 -0
  570. synapse/storage/schema/main/delta/25/history_visibility.sql +44 -0
  571. synapse/storage/schema/main/delta/25/tags.sql +57 -0
  572. synapse/storage/schema/main/delta/26/account_data.sql +36 -0
  573. synapse/storage/schema/main/delta/27/account_data.sql +55 -0
  574. synapse/storage/schema/main/delta/27/forgotten_memberships.sql +45 -0
  575. synapse/storage/schema/main/delta/27/ts.py +61 -0
  576. synapse/storage/schema/main/delta/28/event_push_actions.sql +46 -0
  577. synapse/storage/schema/main/delta/28/events_room_stream.sql +39 -0
  578. synapse/storage/schema/main/delta/28/public_roms_index.sql +39 -0
  579. synapse/storage/schema/main/delta/28/receipts_user_id_index.sql +41 -0
  580. synapse/storage/schema/main/delta/28/upgrade_times.sql +40 -0
  581. synapse/storage/schema/main/delta/28/users_is_guest.sql +41 -0
  582. synapse/storage/schema/main/delta/29/push_actions.sql +54 -0
  583. synapse/storage/schema/main/delta/30/alias_creator.sql +35 -0
  584. synapse/storage/schema/main/delta/30/as_users.py +82 -0
  585. synapse/storage/schema/main/delta/30/deleted_pushers.sql +44 -0
  586. synapse/storage/schema/main/delta/30/presence_stream.sql +49 -0
  587. synapse/storage/schema/main/delta/30/public_rooms.sql +42 -0
  588. synapse/storage/schema/main/delta/30/push_rule_stream.sql +57 -0
  589. synapse/storage/schema/main/delta/30/threepid_guest_access_tokens.sql +43 -0
  590. synapse/storage/schema/main/delta/31/invites.sql +61 -0
  591. synapse/storage/schema/main/delta/31/local_media_repository_url_cache.sql +46 -0
  592. synapse/storage/schema/main/delta/31/pushers_0.py +92 -0
  593. synapse/storage/schema/main/delta/31/pushers_index.sql +41 -0
  594. synapse/storage/schema/main/delta/31/search_update.py +65 -0
  595. synapse/storage/schema/main/delta/32/events.sql +35 -0
  596. synapse/storage/schema/main/delta/32/openid.sql +9 -0
  597. synapse/storage/schema/main/delta/32/pusher_throttle.sql +42 -0
  598. synapse/storage/schema/main/delta/32/remove_indices.sql +52 -0
  599. synapse/storage/schema/main/delta/32/reports.sql +44 -0
  600. synapse/storage/schema/main/delta/33/access_tokens_device_index.sql +36 -0
  601. synapse/storage/schema/main/delta/33/devices.sql +40 -0
  602. synapse/storage/schema/main/delta/33/devices_for_e2e_keys.sql +38 -0
  603. synapse/storage/schema/main/delta/33/devices_for_e2e_keys_clear_unknown_device.sql +39 -0
  604. synapse/storage/schema/main/delta/33/event_fields.py +61 -0
  605. synapse/storage/schema/main/delta/33/remote_media_ts.py +43 -0
  606. synapse/storage/schema/main/delta/33/user_ips_index.sql +36 -0
  607. synapse/storage/schema/main/delta/34/appservice_stream.sql +42 -0
  608. synapse/storage/schema/main/delta/34/cache_stream.py +50 -0
  609. synapse/storage/schema/main/delta/34/device_inbox.sql +43 -0
  610. synapse/storage/schema/main/delta/34/push_display_name_rename.sql +39 -0
  611. synapse/storage/schema/main/delta/34/received_txn_purge.py +36 -0
  612. synapse/storage/schema/main/delta/35/contains_url.sql +36 -0
  613. synapse/storage/schema/main/delta/35/device_outbox.sql +58 -0
  614. synapse/storage/schema/main/delta/35/device_stream_id.sql +40 -0
  615. synapse/storage/schema/main/delta/35/event_push_actions_index.sql +36 -0
  616. synapse/storage/schema/main/delta/35/public_room_list_change_stream.sql +52 -0
  617. synapse/storage/schema/main/delta/35/stream_order_to_extrem.sql +56 -0
  618. synapse/storage/schema/main/delta/36/readd_public_rooms.sql +45 -0
  619. synapse/storage/schema/main/delta/37/remove_auth_idx.py +89 -0
  620. synapse/storage/schema/main/delta/37/user_threepids.sql +71 -0
  621. synapse/storage/schema/main/delta/38/postgres_fts_gist.sql +38 -0
  622. synapse/storage/schema/main/delta/39/appservice_room_list.sql +48 -0
  623. synapse/storage/schema/main/delta/39/device_federation_stream_idx.sql +35 -0
  624. synapse/storage/schema/main/delta/39/event_push_index.sql +36 -0
  625. synapse/storage/schema/main/delta/39/federation_out_position.sql +41 -0
  626. synapse/storage/schema/main/delta/39/membership_profile.sql +39 -0
  627. synapse/storage/schema/main/delta/40/current_state_idx.sql +36 -0
  628. synapse/storage/schema/main/delta/40/device_inbox.sql +40 -0
  629. synapse/storage/schema/main/delta/40/device_list_streams.sql +79 -0
  630. synapse/storage/schema/main/delta/40/event_push_summary.sql +57 -0
  631. synapse/storage/schema/main/delta/40/pushers.sql +58 -0
  632. synapse/storage/schema/main/delta/41/device_list_stream_idx.sql +36 -0
  633. synapse/storage/schema/main/delta/41/device_outbound_index.sql +35 -0
  634. synapse/storage/schema/main/delta/41/event_search_event_id_idx.sql +36 -0
  635. synapse/storage/schema/main/delta/41/ratelimit.sql +41 -0
  636. synapse/storage/schema/main/delta/42/current_state_delta.sql +48 -0
  637. synapse/storage/schema/main/delta/42/device_list_last_id.sql +52 -0
  638. synapse/storage/schema/main/delta/42/event_auth_state_only.sql +36 -0
  639. synapse/storage/schema/main/delta/42/user_dir.py +88 -0
  640. synapse/storage/schema/main/delta/43/blocked_rooms.sql +40 -0
  641. synapse/storage/schema/main/delta/43/quarantine_media.sql +36 -0
  642. synapse/storage/schema/main/delta/43/url_cache.sql +35 -0
  643. synapse/storage/schema/main/delta/43/user_share.sql +52 -0
  644. synapse/storage/schema/main/delta/44/expire_url_cache.sql +60 -0
  645. synapse/storage/schema/main/delta/45/group_server.sql +186 -0
  646. synapse/storage/schema/main/delta/45/profile_cache.sql +47 -0
  647. synapse/storage/schema/main/delta/46/drop_refresh_tokens.sql +36 -0
  648. synapse/storage/schema/main/delta/46/drop_unique_deleted_pushers.sql +54 -0
  649. synapse/storage/schema/main/delta/46/group_server.sql +51 -0
  650. synapse/storage/schema/main/delta/46/local_media_repository_url_idx.sql +43 -0
  651. synapse/storage/schema/main/delta/46/user_dir_null_room_ids.sql +54 -0
  652. synapse/storage/schema/main/delta/46/user_dir_typos.sql +43 -0
  653. synapse/storage/schema/main/delta/47/last_access_media.sql +35 -0
  654. synapse/storage/schema/main/delta/47/postgres_fts_gin.sql +36 -0
  655. synapse/storage/schema/main/delta/47/push_actions_staging.sql +47 -0
  656. synapse/storage/schema/main/delta/48/add_user_consent.sql +37 -0
  657. synapse/storage/schema/main/delta/48/add_user_ips_last_seen_index.sql +36 -0
  658. synapse/storage/schema/main/delta/48/deactivated_users.sql +44 -0
  659. synapse/storage/schema/main/delta/48/group_unique_indexes.py +67 -0
  660. synapse/storage/schema/main/delta/48/groups_joinable.sql +41 -0
  661. synapse/storage/schema/main/delta/49/add_user_consent_server_notice_sent.sql +39 -0
  662. synapse/storage/schema/main/delta/49/add_user_daily_visits.sql +40 -0
  663. synapse/storage/schema/main/delta/49/add_user_ips_last_seen_only_index.sql +36 -0
  664. synapse/storage/schema/main/delta/50/add_creation_ts_users_index.sql +38 -0
  665. synapse/storage/schema/main/delta/50/erasure_store.sql +40 -0
  666. synapse/storage/schema/main/delta/50/make_event_content_nullable.py +102 -0
  667. synapse/storage/schema/main/delta/51/e2e_room_keys.sql +58 -0
  668. synapse/storage/schema/main/delta/51/monthly_active_users.sql +46 -0
  669. synapse/storage/schema/main/delta/52/add_event_to_state_group_index.sql +38 -0
  670. synapse/storage/schema/main/delta/52/device_list_streams_unique_idx.sql +55 -0
  671. synapse/storage/schema/main/delta/52/e2e_room_keys.sql +72 -0
  672. synapse/storage/schema/main/delta/53/add_user_type_to_users.sql +38 -0
  673. synapse/storage/schema/main/delta/53/drop_sent_transactions.sql +35 -0
  674. synapse/storage/schema/main/delta/53/event_format_version.sql +35 -0
  675. synapse/storage/schema/main/delta/53/user_dir_populate.sql +49 -0
  676. synapse/storage/schema/main/delta/53/user_ips_index.sql +49 -0
  677. synapse/storage/schema/main/delta/53/user_share.sql +63 -0
  678. synapse/storage/schema/main/delta/53/user_threepid_id.sql +48 -0
  679. synapse/storage/schema/main/delta/53/users_in_public_rooms.sql +47 -0
  680. synapse/storage/schema/main/delta/54/account_validity_with_renewal.sql +49 -0
  681. synapse/storage/schema/main/delta/54/add_validity_to_server_keys.sql +42 -0
  682. synapse/storage/schema/main/delta/54/delete_forward_extremities.sql +42 -0
  683. synapse/storage/schema/main/delta/54/drop_legacy_tables.sql +49 -0
  684. synapse/storage/schema/main/delta/54/drop_presence_list.sql +35 -0
  685. synapse/storage/schema/main/delta/54/relations.sql +46 -0
  686. synapse/storage/schema/main/delta/54/stats.sql +99 -0
  687. synapse/storage/schema/main/delta/54/stats2.sql +47 -0
  688. synapse/storage/schema/main/delta/55/access_token_expiry.sql +37 -0
  689. synapse/storage/schema/main/delta/55/track_threepid_validations.sql +50 -0
  690. synapse/storage/schema/main/delta/55/users_alter_deactivated.sql +38 -0
  691. synapse/storage/schema/main/delta/56/add_spans_to_device_lists.sql +39 -0
  692. synapse/storage/schema/main/delta/56/current_state_events_membership.sql +41 -0
  693. synapse/storage/schema/main/delta/56/current_state_events_membership_mk2.sql +43 -0
  694. synapse/storage/schema/main/delta/56/delete_keys_from_deleted_backups.sql +44 -0
  695. synapse/storage/schema/main/delta/56/destinations_failure_ts.sql +44 -0
  696. synapse/storage/schema/main/delta/56/destinations_retry_interval_type.sql.postgres +18 -0
  697. synapse/storage/schema/main/delta/56/device_stream_id_insert.sql +39 -0
  698. synapse/storage/schema/main/delta/56/devices_last_seen.sql +43 -0
  699. synapse/storage/schema/main/delta/56/drop_unused_event_tables.sql +39 -0
  700. synapse/storage/schema/main/delta/56/event_expiry.sql +40 -0
  701. synapse/storage/schema/main/delta/56/event_labels.sql +49 -0
  702. synapse/storage/schema/main/delta/56/event_labels_background_update.sql +36 -0
  703. synapse/storage/schema/main/delta/56/fix_room_keys_index.sql +37 -0
  704. synapse/storage/schema/main/delta/56/hidden_devices.sql +37 -0
  705. synapse/storage/schema/main/delta/56/hidden_devices_fix.sql.sqlite +42 -0
  706. synapse/storage/schema/main/delta/56/nuke_empty_communities_from_db.sql +48 -0
  707. synapse/storage/schema/main/delta/56/public_room_list_idx.sql +35 -0
  708. synapse/storage/schema/main/delta/56/redaction_censor.sql +35 -0
  709. synapse/storage/schema/main/delta/56/redaction_censor2.sql +41 -0
  710. synapse/storage/schema/main/delta/56/redaction_censor3_fix_update.sql.postgres +25 -0
  711. synapse/storage/schema/main/delta/56/redaction_censor4.sql +35 -0
  712. synapse/storage/schema/main/delta/56/remove_tombstoned_rooms_from_directory.sql +38 -0
  713. synapse/storage/schema/main/delta/56/room_key_etag.sql +36 -0
  714. synapse/storage/schema/main/delta/56/room_membership_idx.sql +37 -0
  715. synapse/storage/schema/main/delta/56/room_retention.sql +52 -0
  716. synapse/storage/schema/main/delta/56/signing_keys.sql +75 -0
  717. synapse/storage/schema/main/delta/56/signing_keys_nonunique_signatures.sql +41 -0
  718. synapse/storage/schema/main/delta/56/stats_separated.sql +175 -0
  719. synapse/storage/schema/main/delta/56/unique_user_filter_index.py +46 -0
  720. synapse/storage/schema/main/delta/56/user_external_ids.sql +43 -0
  721. synapse/storage/schema/main/delta/56/users_in_public_rooms_idx.sql +36 -0
  722. synapse/storage/schema/main/delta/57/delete_old_current_state_events.sql +41 -0
  723. synapse/storage/schema/main/delta/57/device_list_remote_cache_stale.sql +44 -0
  724. synapse/storage/schema/main/delta/57/local_current_membership.py +111 -0
  725. synapse/storage/schema/main/delta/57/remove_sent_outbound_pokes.sql +40 -0
  726. synapse/storage/schema/main/delta/57/rooms_version_column.sql +43 -0
  727. synapse/storage/schema/main/delta/57/rooms_version_column_2.sql.postgres +35 -0
  728. synapse/storage/schema/main/delta/57/rooms_version_column_2.sql.sqlite +22 -0
  729. synapse/storage/schema/main/delta/57/rooms_version_column_3.sql.postgres +39 -0
  730. synapse/storage/schema/main/delta/57/rooms_version_column_3.sql.sqlite +23 -0
  731. synapse/storage/schema/main/delta/58/02remove_dup_outbound_pokes.sql +41 -0
  732. synapse/storage/schema/main/delta/58/03persist_ui_auth.sql +55 -0
  733. synapse/storage/schema/main/delta/58/05cache_instance.sql.postgres +30 -0
  734. synapse/storage/schema/main/delta/58/06dlols_unique_idx.py +83 -0
  735. synapse/storage/schema/main/delta/58/07add_method_to_thumbnail_constraint.sql.postgres +33 -0
  736. synapse/storage/schema/main/delta/58/07add_method_to_thumbnail_constraint.sql.sqlite +44 -0
  737. synapse/storage/schema/main/delta/58/07persist_ui_auth_ips.sql +44 -0
  738. synapse/storage/schema/main/delta/58/08_media_safe_from_quarantine.sql.postgres +18 -0
  739. synapse/storage/schema/main/delta/58/08_media_safe_from_quarantine.sql.sqlite +18 -0
  740. synapse/storage/schema/main/delta/58/09shadow_ban.sql +37 -0
  741. synapse/storage/schema/main/delta/58/10_pushrules_enabled_delete_obsolete.sql +47 -0
  742. synapse/storage/schema/main/delta/58/10drop_local_rejections_stream.sql +41 -0
  743. synapse/storage/schema/main/delta/58/10federation_pos_instance_name.sql +41 -0
  744. synapse/storage/schema/main/delta/58/11dehydration.sql +39 -0
  745. synapse/storage/schema/main/delta/58/11fallback.sql +43 -0
  746. synapse/storage/schema/main/delta/58/11user_id_seq.py +38 -0
  747. synapse/storage/schema/main/delta/58/12room_stats.sql +51 -0
  748. synapse/storage/schema/main/delta/58/13remove_presence_allow_inbound.sql +36 -0
  749. synapse/storage/schema/main/delta/58/14events_instance_name.sql +35 -0
  750. synapse/storage/schema/main/delta/58/14events_instance_name.sql.postgres +28 -0
  751. synapse/storage/schema/main/delta/58/15_catchup_destination_rooms.sql +61 -0
  752. synapse/storage/schema/main/delta/58/15unread_count.sql +45 -0
  753. synapse/storage/schema/main/delta/58/16populate_stats_process_rooms_fix.sql +41 -0
  754. synapse/storage/schema/main/delta/58/17_catchup_last_successful.sql +40 -0
  755. synapse/storage/schema/main/delta/58/18stream_positions.sql +41 -0
  756. synapse/storage/schema/main/delta/58/19instance_map.sql.postgres +25 -0
  757. synapse/storage/schema/main/delta/58/19txn_id.sql +59 -0
  758. synapse/storage/schema/main/delta/58/20instance_name_event_tables.sql +36 -0
  759. synapse/storage/schema/main/delta/58/20user_daily_visits.sql +37 -0
  760. synapse/storage/schema/main/delta/58/21as_device_stream.sql +36 -0
  761. synapse/storage/schema/main/delta/58/21drop_device_max_stream_id.sql +1 -0
  762. synapse/storage/schema/main/delta/58/22puppet_token.sql +36 -0
  763. synapse/storage/schema/main/delta/58/22users_have_local_media.sql +2 -0
  764. synapse/storage/schema/main/delta/58/23e2e_cross_signing_keys_idx.sql +36 -0
  765. synapse/storage/schema/main/delta/58/24drop_event_json_index.sql +38 -0
  766. synapse/storage/schema/main/delta/58/25user_external_ids_user_id_idx.sql +36 -0
  767. synapse/storage/schema/main/delta/58/26access_token_last_validated.sql +37 -0
  768. synapse/storage/schema/main/delta/58/27local_invites.sql +37 -0
  769. synapse/storage/schema/main/delta/58/28drop_last_used_column.sql.postgres +16 -0
  770. synapse/storage/schema/main/delta/58/28drop_last_used_column.sql.sqlite +62 -0
  771. synapse/storage/schema/main/delta/59/01ignored_user.py +85 -0
  772. synapse/storage/schema/main/delta/59/02shard_send_to_device.sql +37 -0
  773. synapse/storage/schema/main/delta/59/03shard_send_to_device_sequence.sql.postgres +25 -0
  774. synapse/storage/schema/main/delta/59/04_event_auth_chains.sql +71 -0
  775. synapse/storage/schema/main/delta/59/04_event_auth_chains.sql.postgres +16 -0
  776. synapse/storage/schema/main/delta/59/04drop_account_data.sql +36 -0
  777. synapse/storage/schema/main/delta/59/05cache_invalidation.sql +36 -0
  778. synapse/storage/schema/main/delta/59/06chain_cover_index.sql +36 -0
  779. synapse/storage/schema/main/delta/59/06shard_account_data.sql +39 -0
  780. synapse/storage/schema/main/delta/59/06shard_account_data.sql.postgres +32 -0
  781. synapse/storage/schema/main/delta/59/07shard_account_data_fix.sql +37 -0
  782. synapse/storage/schema/main/delta/59/08delete_pushers_for_deactivated_accounts.sql +39 -0
  783. synapse/storage/schema/main/delta/59/08delete_stale_pushers.sql +39 -0
  784. synapse/storage/schema/main/delta/59/09rejected_events_metadata.sql +45 -0
  785. synapse/storage/schema/main/delta/59/10delete_purged_chain_cover.sql +36 -0
  786. synapse/storage/schema/main/delta/59/11add_knock_members_to_stats.sql +39 -0
  787. synapse/storage/schema/main/delta/59/11drop_thumbnail_constraint.sql.postgres +22 -0
  788. synapse/storage/schema/main/delta/59/12account_validity_token_used_ts_ms.sql +37 -0
  789. synapse/storage/schema/main/delta/59/12presence_stream_instance.sql +37 -0
  790. synapse/storage/schema/main/delta/59/12presence_stream_instance_seq.sql.postgres +20 -0
  791. synapse/storage/schema/main/delta/59/13users_to_send_full_presence_to.sql +53 -0
  792. synapse/storage/schema/main/delta/59/14refresh_tokens.sql +53 -0
  793. synapse/storage/schema/main/delta/59/15locks.sql +56 -0
  794. synapse/storage/schema/main/delta/59/16federation_inbound_staging.sql +51 -0
  795. synapse/storage/schema/main/delta/60/01recreate_stream_ordering.sql.postgres +45 -0
  796. synapse/storage/schema/main/delta/60/02change_stream_ordering_columns.sql.postgres +30 -0
  797. synapse/storage/schema/main/delta/61/01change_appservices_txns.sql.postgres +23 -0
  798. synapse/storage/schema/main/delta/61/01insertion_event_lookups.sql +68 -0
  799. synapse/storage/schema/main/delta/61/02drop_redundant_room_depth_index.sql +37 -0
  800. synapse/storage/schema/main/delta/61/03recreate_min_depth.py +74 -0
  801. synapse/storage/schema/main/delta/62/01insertion_event_extremities.sql +43 -0
  802. synapse/storage/schema/main/delta/63/01create_registration_tokens.sql +42 -0
  803. synapse/storage/schema/main/delta/63/02delete_unlinked_email_pushers.sql +39 -0
  804. synapse/storage/schema/main/delta/63/02populate-rooms-creator.sql +36 -0
  805. synapse/storage/schema/main/delta/63/03session_store.sql +42 -0
  806. synapse/storage/schema/main/delta/63/04add_presence_stream_not_offline_index.sql +37 -0
  807. synapse/storage/schema/main/delta/64/01msc2716_chunk_to_batch_rename.sql.postgres +23 -0
  808. synapse/storage/schema/main/delta/64/01msc2716_chunk_to_batch_rename.sql.sqlite +37 -0
  809. synapse/storage/schema/main/delta/65/01msc2716_insertion_event_edges.sql +38 -0
  810. synapse/storage/schema/main/delta/65/03remove_hidden_devices_from_device_inbox.sql +41 -0
  811. synapse/storage/schema/main/delta/65/04_local_group_updates.sql +37 -0
  812. synapse/storage/schema/main/delta/65/05_remove_room_stats_historical_and_user_stats_historical.sql +38 -0
  813. synapse/storage/schema/main/delta/65/06remove_deleted_devices_from_device_inbox.sql +53 -0
  814. synapse/storage/schema/main/delta/65/07_arbitrary_relations.sql +37 -0
  815. synapse/storage/schema/main/delta/65/08_device_inbox_background_updates.sql +37 -0
  816. synapse/storage/schema/main/delta/65/10_expirable_refresh_tokens.sql +47 -0
  817. synapse/storage/schema/main/delta/65/11_devices_auth_provider_session.sql +46 -0
  818. synapse/storage/schema/main/delta/67/01drop_public_room_list_stream.sql +37 -0
  819. synapse/storage/schema/main/delta/68/01event_columns.sql +45 -0
  820. synapse/storage/schema/main/delta/68/02_msc2409_add_device_id_appservice_stream_type.sql +40 -0
  821. synapse/storage/schema/main/delta/68/03_delete_account_data_for_deactivated_accounts.sql +39 -0
  822. synapse/storage/schema/main/delta/68/04_refresh_tokens_index_next_token_id.sql +47 -0
  823. synapse/storage/schema/main/delta/68/04partial_state_rooms.sql +60 -0
  824. synapse/storage/schema/main/delta/68/05_delete_non_strings_from_event_search.sql.sqlite +22 -0
  825. synapse/storage/schema/main/delta/68/05partial_state_rooms_triggers.py +80 -0
  826. synapse/storage/schema/main/delta/68/06_msc3202_add_device_list_appservice_stream_type.sql +42 -0
  827. synapse/storage/schema/main/delta/69/01as_txn_seq.py +54 -0
  828. synapse/storage/schema/main/delta/69/01device_list_oubound_by_room.sql +57 -0
  829. synapse/storage/schema/main/delta/69/02cache_invalidation_index.sql +37 -0
  830. synapse/storage/schema/main/delta/70/01clean_table_purged_rooms.sql +39 -0
  831. synapse/storage/schema/main/delta/71/01rebuild_event_edges.sql.postgres +43 -0
  832. synapse/storage/schema/main/delta/71/01rebuild_event_edges.sql.sqlite +47 -0
  833. synapse/storage/schema/main/delta/71/01remove_noop_background_updates.sql +80 -0
  834. synapse/storage/schema/main/delta/71/02event_push_summary_unique.sql +37 -0
  835. synapse/storage/schema/main/delta/72/01add_room_type_to_state_stats.sql +38 -0
  836. synapse/storage/schema/main/delta/72/01event_push_summary_receipt.sql +54 -0
  837. synapse/storage/schema/main/delta/72/02event_push_actions_index.sql +38 -0
  838. synapse/storage/schema/main/delta/72/03bg_populate_events_columns.py +57 -0
  839. synapse/storage/schema/main/delta/72/03drop_event_reference_hashes.sql +36 -0
  840. synapse/storage/schema/main/delta/72/03remove_groups.sql +50 -0
  841. synapse/storage/schema/main/delta/72/04drop_column_application_services_state_last_txn.sql.postgres +17 -0
  842. synapse/storage/schema/main/delta/72/04drop_column_application_services_state_last_txn.sql.sqlite +40 -0
  843. synapse/storage/schema/main/delta/72/05receipts_event_stream_ordering.sql +38 -0
  844. synapse/storage/schema/main/delta/72/05remove_unstable_private_read_receipts.sql +38 -0
  845. synapse/storage/schema/main/delta/72/06add_consent_ts_to_users.sql +35 -0
  846. synapse/storage/schema/main/delta/72/06thread_notifications.sql +49 -0
  847. synapse/storage/schema/main/delta/72/07force_update_current_state_events_membership.py +67 -0
  848. synapse/storage/schema/main/delta/72/07thread_receipts.sql.postgres +30 -0
  849. synapse/storage/schema/main/delta/72/07thread_receipts.sql.sqlite +70 -0
  850. synapse/storage/schema/main/delta/72/08begin_cache_invalidation_seq_at_2.sql.postgres +23 -0
  851. synapse/storage/schema/main/delta/72/08thread_receipts.sql +39 -0
  852. synapse/storage/schema/main/delta/72/09partial_indices.sql.sqlite +56 -0
  853. synapse/storage/schema/main/delta/73/01event_failed_pull_attempts.sql +48 -0
  854. synapse/storage/schema/main/delta/73/02add_pusher_enabled.sql +35 -0
  855. synapse/storage/schema/main/delta/73/02room_id_indexes_for_purging.sql +41 -0
  856. synapse/storage/schema/main/delta/73/03pusher_device_id.sql +39 -0
  857. synapse/storage/schema/main/delta/73/03users_approved_column.sql +39 -0
  858. synapse/storage/schema/main/delta/73/04partial_join_details.sql +42 -0
  859. synapse/storage/schema/main/delta/73/04pending_device_list_updates.sql +47 -0
  860. synapse/storage/schema/main/delta/73/05old_push_actions.sql.postgres +22 -0
  861. synapse/storage/schema/main/delta/73/05old_push_actions.sql.sqlite +24 -0
  862. synapse/storage/schema/main/delta/73/06thread_notifications_thread_id_idx.sql +42 -0
  863. synapse/storage/schema/main/delta/73/08thread_receipts_non_null.sql.postgres +23 -0
  864. synapse/storage/schema/main/delta/73/08thread_receipts_non_null.sql.sqlite +76 -0
  865. synapse/storage/schema/main/delta/73/09partial_joined_via_destination.sql +37 -0
  866. synapse/storage/schema/main/delta/73/09threads_table.sql +49 -0
  867. synapse/storage/schema/main/delta/73/10_update_sqlite_fts4_tokenizer.py +71 -0
  868. synapse/storage/schema/main/delta/73/10login_tokens.sql +54 -0
  869. synapse/storage/schema/main/delta/73/11event_search_room_id_n_distinct.sql.postgres +33 -0
  870. synapse/storage/schema/main/delta/73/12refactor_device_list_outbound_pokes.sql +72 -0
  871. synapse/storage/schema/main/delta/73/13add_device_lists_index.sql +39 -0
  872. synapse/storage/schema/main/delta/73/20_un_partial_stated_room_stream.sql +51 -0
  873. synapse/storage/schema/main/delta/73/21_un_partial_stated_room_stream_seq.sql.postgres +20 -0
  874. synapse/storage/schema/main/delta/73/22_rebuild_user_dir_stats.sql +48 -0
  875. synapse/storage/schema/main/delta/73/22_un_partial_stated_event_stream.sql +53 -0
  876. synapse/storage/schema/main/delta/73/23_fix_thread_index.sql +52 -0
  877. synapse/storage/schema/main/delta/73/23_un_partial_stated_room_stream_seq.sql.postgres +20 -0
  878. synapse/storage/schema/main/delta/73/24_events_jump_to_date_index.sql +36 -0
  879. synapse/storage/schema/main/delta/73/25drop_presence.sql +36 -0
  880. synapse/storage/schema/main/delta/74/01_user_directory_stale_remote_users.sql +58 -0
  881. synapse/storage/schema/main/delta/74/02_set_device_id_for_pushers_bg_update.sql +38 -0
  882. synapse/storage/schema/main/delta/74/03_membership_tables_event_stream_ordering.sql.postgres +29 -0
  883. synapse/storage/schema/main/delta/74/03_membership_tables_event_stream_ordering.sql.sqlite +23 -0
  884. synapse/storage/schema/main/delta/74/03_room_membership_index.sql +38 -0
  885. synapse/storage/schema/main/delta/74/04_delete_e2e_backup_keys_for_deactivated_users.sql +36 -0
  886. synapse/storage/schema/main/delta/74/04_membership_tables_event_stream_ordering_triggers.py +87 -0
  887. synapse/storage/schema/main/delta/74/05_events_txn_id_device_id.sql +72 -0
  888. synapse/storage/schema/main/delta/74/90COMMENTS_destinations.sql.postgres +52 -0
  889. synapse/storage/schema/main/delta/76/01_add_profiles_full_user_id_column.sql +39 -0
  890. synapse/storage/schema/main/delta/76/02_add_user_filters_full_user_id_column.sql +39 -0
  891. synapse/storage/schema/main/delta/76/03_per_user_experimental_features.sql +46 -0
  892. synapse/storage/schema/main/delta/76/04_add_room_forgetter.sql +43 -0
  893. synapse/storage/schema/main/delta/77/01_add_profiles_not_valid_check.sql.postgres +16 -0
  894. synapse/storage/schema/main/delta/77/02_add_user_filters_not_valid_check.sql.postgres +16 -0
  895. synapse/storage/schema/main/delta/77/03bg_populate_full_user_id_profiles.sql +35 -0
  896. synapse/storage/schema/main/delta/77/04bg_populate_full_user_id_user_filters.sql +35 -0
  897. synapse/storage/schema/main/delta/77/05thread_notifications_backfill.sql +67 -0
  898. synapse/storage/schema/main/delta/77/06thread_notifications_not_null.sql.sqlite +102 -0
  899. synapse/storage/schema/main/delta/77/06thread_notifications_not_null_event_push_actions.sql.postgres +27 -0
  900. synapse/storage/schema/main/delta/77/06thread_notifications_not_null_event_push_actions_staging.sql.postgres +27 -0
  901. synapse/storage/schema/main/delta/77/06thread_notifications_not_null_event_push_summary.sql.postgres +29 -0
  902. synapse/storage/schema/main/delta/77/14bg_indices_event_stream_ordering.sql +39 -0
  903. synapse/storage/schema/main/delta/78/01_validate_and_update_profiles.py +99 -0
  904. synapse/storage/schema/main/delta/78/02_validate_and_update_user_filters.py +100 -0
  905. synapse/storage/schema/main/delta/78/03_remove_unused_indexes_user_filters.py +72 -0
  906. synapse/storage/schema/main/delta/78/03event_extremities_constraints.py +65 -0
  907. synapse/storage/schema/main/delta/78/04_add_full_user_id_index_user_filters.py +32 -0
  908. synapse/storage/schema/main/delta/79/03_read_write_locks_triggers.sql.postgres +102 -0
  909. synapse/storage/schema/main/delta/79/03_read_write_locks_triggers.sql.sqlite +72 -0
  910. synapse/storage/schema/main/delta/79/04_mitigate_stream_ordering_update_race.py +70 -0
  911. synapse/storage/schema/main/delta/79/05_read_write_locks_triggers.sql.postgres +69 -0
  912. synapse/storage/schema/main/delta/79/05_read_write_locks_triggers.sql.sqlite +65 -0
  913. synapse/storage/schema/main/delta/80/01_users_alter_locked.sql +35 -0
  914. synapse/storage/schema/main/delta/80/02_read_write_locks_unlogged.sql.postgres +30 -0
  915. synapse/storage/schema/main/delta/80/02_scheduled_tasks.sql +47 -0
  916. synapse/storage/schema/main/delta/80/03_read_write_locks_triggers.sql.postgres +37 -0
  917. synapse/storage/schema/main/delta/80/04_read_write_locks_deadlock.sql.postgres +71 -0
  918. synapse/storage/schema/main/delta/82/02_scheduled_tasks_index.sql +35 -0
  919. synapse/storage/schema/main/delta/82/04_add_indices_for_purging_rooms.sql +39 -0
  920. synapse/storage/schema/main/delta/82/05gaps.sql +44 -0
  921. synapse/storage/schema/main/delta/83/01_drop_old_tables.sql +43 -0
  922. synapse/storage/schema/main/delta/83/03_instance_name_receipts.sql.sqlite +17 -0
  923. synapse/storage/schema/main/delta/83/05_cross_signing_key_update_grant.sql +34 -0
  924. synapse/storage/schema/main/delta/83/06_event_push_summary_room.sql +36 -0
  925. synapse/storage/schema/main/delta/84/01_auth_links_stats.sql.postgres +20 -0
  926. synapse/storage/schema/main/delta/84/02_auth_links_index.sql +16 -0
  927. synapse/storage/schema/main/delta/84/03_auth_links_analyze.sql.postgres +16 -0
  928. synapse/storage/schema/main/delta/84/04_access_token_index.sql +15 -0
  929. synapse/storage/schema/main/delta/85/01_add_suspended.sql +14 -0
  930. synapse/storage/schema/main/delta/85/02_add_instance_names.sql +27 -0
  931. synapse/storage/schema/main/delta/85/03_new_sequences.sql.postgres +54 -0
  932. synapse/storage/schema/main/delta/85/04_cleanup_device_federation_outbox.sql +15 -0
  933. synapse/storage/schema/main/delta/85/05_add_instance_names_converted_pos.sql +16 -0
  934. synapse/storage/schema/main/delta/85/06_add_room_reports.sql +20 -0
  935. synapse/storage/schema/main/delta/86/01_authenticate_media.sql +15 -0
  936. synapse/storage/schema/main/delta/86/02_receipts_event_id_index.sql +15 -0
  937. synapse/storage/schema/main/delta/87/01_sliding_sync_memberships.sql +169 -0
  938. synapse/storage/schema/main/delta/87/02_per_connection_state.sql +81 -0
  939. synapse/storage/schema/main/delta/87/03_current_state_index.sql +19 -0
  940. synapse/storage/schema/main/delta/88/01_add_delayed_events.sql +43 -0
  941. synapse/storage/schema/main/delta/88/01_custom_profile_fields.sql +15 -0
  942. synapse/storage/schema/main/delta/88/02_fix_sliding_sync_membership_snapshots_forgotten_column.sql +21 -0
  943. synapse/storage/schema/main/delta/88/03_add_otk_ts_added_index.sql +18 -0
  944. synapse/storage/schema/main/delta/88/04_current_state_delta_index.sql +18 -0
  945. synapse/storage/schema/main/delta/88/05_drop_old_otks.sql.postgres +19 -0
  946. synapse/storage/schema/main/delta/88/05_drop_old_otks.sql.sqlite +19 -0
  947. synapse/storage/schema/main/delta/88/05_sliding_sync_room_config_index.sql +20 -0
  948. synapse/storage/schema/main/delta/88/06_events_received_ts_index.sql +17 -0
  949. synapse/storage/schema/main/delta/89/01_sliding_sync_membership_snapshot_index.sql +15 -0
  950. synapse/storage/schema/main/delta/90/01_add_column_participant_room_memberships_table.sql +16 -0
  951. synapse/storage/schema/main/delta/91/01_media_hash.sql +28 -0
  952. synapse/storage/schema/main/delta/92/01_remove_trigger.sql.postgres +16 -0
  953. synapse/storage/schema/main/delta/92/01_remove_trigger.sql.sqlite +16 -0
  954. synapse/storage/schema/main/delta/92/02_remove_populate_participant_bg_update.sql +17 -0
  955. synapse/storage/schema/main/delta/92/04_ss_membership_snapshot_idx.sql +16 -0
  956. synapse/storage/schema/main/delta/92/04_thread_subscriptions.sql +59 -0
  957. synapse/storage/schema/main/delta/92/04_thread_subscriptions_seq.sql.postgres +19 -0
  958. synapse/storage/schema/main/delta/92/05_fixup_max_depth_cap.sql +17 -0
  959. synapse/storage/schema/main/delta/92/05_thread_subscriptions_comments.sql.postgres +18 -0
  960. synapse/storage/schema/main/delta/92/06_device_federation_inbox_index.sql +16 -0
  961. synapse/storage/schema/main/delta/92/06_threads_last_sent_stream_ordering_comments.sql.postgres +24 -0
  962. synapse/storage/schema/main/delta/92/07_add_user_reports.sql +22 -0
  963. synapse/storage/schema/main/delta/92/07_event_txn_id_device_id_txn_id2.sql +15 -0
  964. synapse/storage/schema/main/delta/92/08_room_ban_redactions.sql +21 -0
  965. synapse/storage/schema/main/delta/92/08_thread_subscriptions_seq_fixup.sql.postgres +19 -0
  966. synapse/storage/schema/main/delta/92/09_thread_subscriptions_update.sql +20 -0
  967. synapse/storage/schema/main/delta/92/09_thread_subscriptions_update.sql.postgres +18 -0
  968. synapse/storage/schema/main/delta/93/01_add_delayed_events.sql +15 -0
  969. synapse/storage/schema/main/full_schemas/72/full.sql.postgres +1344 -0
  970. synapse/storage/schema/main/full_schemas/72/full.sql.sqlite +646 -0
  971. synapse/storage/schema/state/delta/23/drop_state_index.sql +35 -0
  972. synapse/storage/schema/state/delta/32/remove_state_indices.sql +38 -0
  973. synapse/storage/schema/state/delta/35/add_state_index.sql +36 -0
  974. synapse/storage/schema/state/delta/35/state.sql +41 -0
  975. synapse/storage/schema/state/delta/35/state_dedupe.sql +36 -0
  976. synapse/storage/schema/state/delta/47/state_group_seq.py +38 -0
  977. synapse/storage/schema/state/delta/56/state_group_room_idx.sql +36 -0
  978. synapse/storage/schema/state/delta/61/02state_groups_state_n_distinct.sql.postgres +34 -0
  979. synapse/storage/schema/state/delta/70/08_state_group_edges_unique.sql +36 -0
  980. synapse/storage/schema/state/delta/89/01_state_groups_deletion.sql +39 -0
  981. synapse/storage/schema/state/delta/90/02_delete_unreferenced_state_groups.sql +16 -0
  982. synapse/storage/schema/state/delta/90/03_remove_old_deletion_bg_update.sql +15 -0
  983. synapse/storage/schema/state/full_schemas/72/full.sql.postgres +30 -0
  984. synapse/storage/schema/state/full_schemas/72/full.sql.sqlite +20 -0
  985. synapse/storage/types.py +183 -0
  986. synapse/storage/util/__init__.py +20 -0
  987. synapse/storage/util/id_generators.py +928 -0
  988. synapse/storage/util/partial_state_events_tracker.py +194 -0
  989. synapse/storage/util/sequence.py +315 -0
  990. synapse/streams/__init__.py +43 -0
  991. synapse/streams/config.py +91 -0
  992. synapse/streams/events.py +203 -0
  993. synapse/synapse_rust/__init__.pyi +3 -0
  994. synapse/synapse_rust/acl.pyi +20 -0
  995. synapse/synapse_rust/events.pyi +136 -0
  996. synapse/synapse_rust/http_client.pyi +32 -0
  997. synapse/synapse_rust/push.pyi +86 -0
  998. synapse/synapse_rust/rendezvous.pyi +30 -0
  999. synapse/synapse_rust/segmenter.pyi +1 -0
  1000. synapse/synapse_rust.abi3.so +0 -0
  1001. synapse/types/__init__.py +1600 -0
  1002. synapse/types/handlers/__init__.py +93 -0
  1003. synapse/types/handlers/policy_server.py +16 -0
  1004. synapse/types/handlers/sliding_sync.py +908 -0
  1005. synapse/types/rest/__init__.py +25 -0
  1006. synapse/types/rest/client/__init__.py +413 -0
  1007. synapse/types/state.py +634 -0
  1008. synapse/types/storage/__init__.py +66 -0
  1009. synapse/util/__init__.py +169 -0
  1010. synapse/util/async_helpers.py +1045 -0
  1011. synapse/util/background_queue.py +142 -0
  1012. synapse/util/batching_queue.py +202 -0
  1013. synapse/util/caches/__init__.py +300 -0
  1014. synapse/util/caches/cached_call.py +143 -0
  1015. synapse/util/caches/deferred_cache.py +530 -0
  1016. synapse/util/caches/descriptors.py +692 -0
  1017. synapse/util/caches/dictionary_cache.py +346 -0
  1018. synapse/util/caches/expiringcache.py +249 -0
  1019. synapse/util/caches/lrucache.py +975 -0
  1020. synapse/util/caches/response_cache.py +322 -0
  1021. synapse/util/caches/stream_change_cache.py +370 -0
  1022. synapse/util/caches/treecache.py +189 -0
  1023. synapse/util/caches/ttlcache.py +197 -0
  1024. synapse/util/cancellation.py +63 -0
  1025. synapse/util/check_dependencies.py +335 -0
  1026. synapse/util/clock.py +567 -0
  1027. synapse/util/constants.py +22 -0
  1028. synapse/util/daemonize.py +165 -0
  1029. synapse/util/distributor.py +157 -0
  1030. synapse/util/events.py +134 -0
  1031. synapse/util/file_consumer.py +164 -0
  1032. synapse/util/frozenutils.py +57 -0
  1033. synapse/util/gai_resolver.py +178 -0
  1034. synapse/util/hash.py +38 -0
  1035. synapse/util/httpresourcetree.py +108 -0
  1036. synapse/util/iterutils.py +189 -0
  1037. synapse/util/json.py +56 -0
  1038. synapse/util/linked_list.py +156 -0
  1039. synapse/util/logcontext.py +46 -0
  1040. synapse/util/logformatter.py +28 -0
  1041. synapse/util/macaroons.py +325 -0
  1042. synapse/util/manhole.py +191 -0
  1043. synapse/util/metrics.py +339 -0
  1044. synapse/util/module_loader.py +116 -0
  1045. synapse/util/msisdn.py +51 -0
  1046. synapse/util/patch_inline_callbacks.py +250 -0
  1047. synapse/util/pydantic_models.py +63 -0
  1048. synapse/util/ratelimitutils.py +419 -0
  1049. synapse/util/retryutils.py +339 -0
  1050. synapse/util/rlimit.py +42 -0
  1051. synapse/util/rust.py +133 -0
  1052. synapse/util/sentinel.py +21 -0
  1053. synapse/util/stringutils.py +293 -0
  1054. synapse/util/task_scheduler.py +493 -0
  1055. synapse/util/templates.py +126 -0
  1056. synapse/util/threepids.py +123 -0
  1057. synapse/util/wheel_timer.py +112 -0
  1058. synapse/visibility.py +835 -0
@@ -0,0 +1,1933 @@
1
+ #
2
+ # This file is licensed under the Affero General Public License (AGPL) version 3.
3
+ #
4
+ # Copyright 2015 OpenMarket Ltd
5
+ # Copyright (C) 2023 New Vector, Ltd
6
+ #
7
+ # This program is free software: you can redistribute it and/or modify
8
+ # it under the terms of the GNU Affero General Public License as
9
+ # published by the Free Software Foundation, either version 3 of the
10
+ # License, or (at your option) any later version.
11
+ #
12
+ # See the GNU Affero General Public License for more details:
13
+ # <https://www.gnu.org/licenses/agpl-3.0.html>.
14
+ #
15
+ # Originally licensed under the Apache License, Version 2.0:
16
+ # <http://www.apache.org/licenses/LICENSE-2.0>.
17
+ #
18
+ # [This file includes modifications made by New Vector Limited]
19
+ #
20
+ #
21
+
22
+ """Responsible for storing and fetching push actions / notifications.
23
+
24
+ There are two main uses for push actions:
25
+ 1. Sending out push to a user's device; and
26
+ 2. Tracking per-room per-user notification counts (used in sync requests).
27
+
28
+ For the former we simply use the `event_push_actions` table, which contains all
29
+ the calculated actions for a given user (which were calculated by the
30
+ `BulkPushRuleEvaluator`).
31
+
32
+ For the latter we could simply count the number of rows in `event_push_actions`
33
+ table for a given room/user, but in practice this is *very* heavyweight when
34
+ there were a large number of notifications (due to e.g. the user never reading a
35
+ room). Plus, keeping all push actions indefinitely uses a lot of disk space.
36
+
37
+ To fix these issues, we add a new table `event_push_summary` that tracks
38
+ per-user per-room counts of all notifications that happened before a stream
39
+ ordering S. Thus, to get the notification count for a user / room we can simply
40
+ query a single row in `event_push_summary` and count the number of rows in
41
+ `event_push_actions` with a stream ordering larger than S (and as long as S is
42
+ "recent", the number of rows needing to be scanned will be small).
43
+
44
+ The `event_push_summary` table is updated via a background job that periodically
45
+ chooses a new stream ordering S' (usually the latest stream ordering), counts
46
+ all notifications in `event_push_actions` between the existing S and S', and
47
+ adds them to the existing counts in `event_push_summary`.
48
+
49
+ This allows us to delete old rows from `event_push_actions` once those rows have
50
+ been counted and added to `event_push_summary` (we call this process
51
+ "rotation").
52
+
53
+
54
+ We need to handle when a user sends a read receipt to the room. Again this is
55
+ done as a background process. For each receipt we clear the row in
56
+ `event_push_summary` and count the number of notifications in
57
+ `event_push_actions` that happened after the receipt but before S, and insert
58
+ that count into `event_push_summary` (If the receipt happened *after* S then we
59
+ simply clear the `event_push_summary`.)
60
+
61
+ Note that its possible that if the read receipt is for an old event the relevant
62
+ `event_push_actions` rows will have been rotated and we get the wrong count
63
+ (it'll be too low). We accept this as a rare edge case that is unlikely to
64
+ impact the user much (since the vast majority of read receipts will be for the
65
+ latest event).
66
+
67
+ The last complication is to handle the race where we request the notifications
68
+ counts after a user sends a read receipt into the room, but *before* the
69
+ background update handles the receipt (without any special handling the counts
70
+ would be outdated). We fix this by including in `event_push_summary` the read
71
+ receipt we used when updating `event_push_summary`, and every time we query the
72
+ table we check if that matches the most recent read receipt in the room. If yes,
73
+ continue as above, if not we simply query the `event_push_actions` table
74
+ directly.
75
+
76
+ Since read receipts are almost always for recent events, scanning the
77
+ `event_push_actions` table in this case is unlikely to be a problem. Even if it
78
+ is a problem, it is temporary until the background job handles the new read
79
+ receipt.
80
+ """
81
+
82
+ import logging
83
+ from collections import defaultdict
84
+ from typing import (
85
+ TYPE_CHECKING,
86
+ Collection,
87
+ Mapping,
88
+ cast,
89
+ )
90
+
91
+ import attr
92
+
93
+ from twisted.internet.task import LoopingCall
94
+
95
+ from synapse.api.constants import MAIN_TIMELINE, ReceiptTypes
96
+ from synapse.metrics.background_process_metrics import wrap_as_background_process
97
+ from synapse.storage._base import SQLBaseStore, db_to_json, make_in_list_sql_clause
98
+ from synapse.storage.database import (
99
+ DatabasePool,
100
+ LoggingDatabaseConnection,
101
+ LoggingTransaction,
102
+ PostgresEngine,
103
+ )
104
+ from synapse.storage.databases.main.receipts import ReceiptsWorkerStore
105
+ from synapse.storage.databases.main.stream import StreamWorkerStore
106
+ from synapse.types import JsonDict, StrCollection
107
+ from synapse.util.caches.descriptors import cached
108
+ from synapse.util.json import json_encoder
109
+
110
+ if TYPE_CHECKING:
111
+ from synapse.server import HomeServer
112
+
113
+ logger = logging.getLogger(__name__)
114
+
115
+
116
+ DEFAULT_NOTIF_ACTION: list[dict | str] = [
117
+ "notify",
118
+ {"set_tweak": "highlight", "value": False},
119
+ ]
120
+ DEFAULT_HIGHLIGHT_ACTION: list[dict | str] = [
121
+ "notify",
122
+ {"set_tweak": "sound", "value": "default"},
123
+ {"set_tweak": "highlight"},
124
+ ]
125
+
126
+
127
+ @attr.s(slots=True, auto_attribs=True)
128
+ class _RoomReceipt:
129
+ """
130
+ HttpPushAction instances include the information used to generate HTTP
131
+ requests to a push gateway.
132
+ """
133
+
134
+ unthreaded_stream_ordering: int = 0
135
+ # threaded_stream_ordering includes the main pseudo-thread.
136
+ threaded_stream_ordering: dict[str, int] = attr.Factory(dict)
137
+
138
+ def is_unread(self, thread_id: str, stream_ordering: int) -> bool:
139
+ """Returns True if the stream ordering is unread according to the receipt information."""
140
+
141
+ # Only include push actions with a stream ordering after both the unthreaded
142
+ # and threaded receipt. Properly handles a user without any receipts present.
143
+ return (
144
+ self.unthreaded_stream_ordering < stream_ordering
145
+ and self.threaded_stream_ordering.get(thread_id, 0) < stream_ordering
146
+ )
147
+
148
+
149
+ # A _RoomReceipt with no receipts in it.
150
+ MISSING_ROOM_RECEIPT = _RoomReceipt()
151
+
152
+
153
+ @attr.s(slots=True, frozen=True, auto_attribs=True)
154
+ class HttpPushAction:
155
+ """
156
+ HttpPushAction instances include the information used to generate HTTP
157
+ requests to a push gateway.
158
+ """
159
+
160
+ event_id: str
161
+ room_id: str
162
+ stream_ordering: int
163
+ actions: list[dict | str]
164
+
165
+
166
+ @attr.s(slots=True, frozen=True, auto_attribs=True)
167
+ class EmailPushAction(HttpPushAction):
168
+ """
169
+ EmailPushAction instances include the information used to render an email
170
+ push notification.
171
+ """
172
+
173
+ received_ts: int | None
174
+
175
+
176
+ @attr.s(slots=True, frozen=True, auto_attribs=True)
177
+ class UserPushAction(EmailPushAction):
178
+ """
179
+ UserPushAction instances include the necessary information to respond to
180
+ /notifications requests.
181
+ """
182
+
183
+ topological_ordering: int
184
+ highlight: bool
185
+ profile_tag: str
186
+
187
+
188
+ # TODO This is used as a cached value and is mutable.
189
+ @attr.s(slots=True, auto_attribs=True)
190
+ class NotifCounts:
191
+ """
192
+ The per-user, per-room, per-thread count of notifications. Used by sync and push.
193
+ """
194
+
195
+ notify_count: int = 0
196
+ unread_count: int = 0
197
+ highlight_count: int = 0
198
+
199
+
200
+ @attr.s(slots=True, frozen=True, auto_attribs=True)
201
+ class RoomNotifCounts:
202
+ """
203
+ The per-user, per-room count of notifications. Used by sync and push.
204
+ """
205
+
206
+ main_timeline: NotifCounts
207
+ # Map of thread ID to the notification counts.
208
+ threads: Mapping[str, NotifCounts]
209
+
210
+ @staticmethod
211
+ def empty() -> "RoomNotifCounts":
212
+ return _EMPTY_ROOM_NOTIF_COUNTS
213
+
214
+ def __len__(self) -> int:
215
+ # To properly account for the amount of space in any caches.
216
+ return len(self.threads) + 1
217
+
218
+
219
+ _EMPTY_ROOM_NOTIF_COUNTS = RoomNotifCounts(NotifCounts(), {})
220
+
221
+
222
+ def _serialize_action(actions: Collection[Mapping | str], is_highlight: bool) -> str:
223
+ """Custom serializer for actions. This allows us to "compress" common actions.
224
+
225
+ We use the fact that most users have the same actions for notifs (and for
226
+ highlights).
227
+ We store these default actions as the empty string rather than the full JSON.
228
+ Since the empty string isn't valid JSON there is no risk of this clashing with
229
+ any real JSON actions
230
+ """
231
+ if is_highlight:
232
+ if actions == DEFAULT_HIGHLIGHT_ACTION:
233
+ return "" # We use empty string as the column is non-NULL
234
+ else:
235
+ if actions == DEFAULT_NOTIF_ACTION:
236
+ return ""
237
+ return json_encoder.encode(actions)
238
+
239
+
240
+ def _deserialize_action(actions: str, is_highlight: bool) -> list[dict | str]:
241
+ """Custom deserializer for actions. This allows us to "compress" common actions"""
242
+ if actions:
243
+ return db_to_json(actions)
244
+
245
+ if is_highlight:
246
+ return DEFAULT_HIGHLIGHT_ACTION
247
+ else:
248
+ return DEFAULT_NOTIF_ACTION
249
+
250
+
251
+ class EventPushActionsWorkerStore(ReceiptsWorkerStore, StreamWorkerStore, SQLBaseStore):
252
+ _background_tasks: list[LoopingCall] = []
253
+
254
+ def __init__(
255
+ self,
256
+ database: DatabasePool,
257
+ db_conn: LoggingDatabaseConnection,
258
+ hs: "HomeServer",
259
+ ):
260
+ super().__init__(database, db_conn, hs)
261
+
262
+ # Track when the process started.
263
+ self._started_ts = self.clock.time_msec()
264
+
265
+ # These get correctly set by _find_stream_orderings_for_times_txn
266
+ self.stream_ordering_month_ago: int | None = None
267
+ self.stream_ordering_day_ago: int | None = None
268
+
269
+ cur = db_conn.cursor(txn_name="_find_stream_orderings_for_times_txn")
270
+ self._find_stream_orderings_for_times_txn(cur)
271
+ cur.close()
272
+
273
+ self.clock.looping_call(self._find_stream_orderings_for_times, 10 * 60 * 1000)
274
+
275
+ self._rotate_count = 10000
276
+ self._doing_notif_rotation = False
277
+ if hs.config.worker.run_background_tasks:
278
+ self.clock.looping_call(self._rotate_notifs, 30 * 1000)
279
+
280
+ self.clock.looping_call(
281
+ self._clear_old_push_actions_staging, 30 * 60 * 1000
282
+ )
283
+
284
+ self.db_pool.updates.register_background_index_update(
285
+ "event_push_summary_unique_index2",
286
+ index_name="event_push_summary_unique_index2",
287
+ table="event_push_summary",
288
+ columns=["user_id", "room_id", "thread_id"],
289
+ unique=True,
290
+ )
291
+
292
+ self.db_pool.updates.register_background_validate_constraint(
293
+ "event_push_actions_staging_thread_id",
294
+ constraint_name="event_push_actions_staging_thread_id",
295
+ table="event_push_actions_staging",
296
+ )
297
+ self.db_pool.updates.register_background_validate_constraint(
298
+ "event_push_actions_thread_id",
299
+ constraint_name="event_push_actions_thread_id",
300
+ table="event_push_actions",
301
+ )
302
+ self.db_pool.updates.register_background_validate_constraint(
303
+ "event_push_summary_thread_id",
304
+ constraint_name="event_push_summary_thread_id",
305
+ table="event_push_summary",
306
+ )
307
+
308
+ self.db_pool.updates.register_background_update_handler(
309
+ "event_push_drop_null_thread_id_indexes",
310
+ self._background_drop_null_thread_id_indexes,
311
+ )
312
+
313
+ # Add a room ID index to speed up room deletion
314
+ self.db_pool.updates.register_background_index_update(
315
+ "event_push_summary_index_room_id",
316
+ index_name="event_push_summary_index_room_id",
317
+ table="event_push_summary",
318
+ columns=["room_id"],
319
+ )
320
+
321
+ async def _background_drop_null_thread_id_indexes(
322
+ self, progress: JsonDict, batch_size: int
323
+ ) -> int:
324
+ """
325
+ Drop the indexes used to find null thread_ids for event_push_actions and
326
+ event_push_summary.
327
+ """
328
+
329
+ def drop_null_thread_id_indexes_txn(txn: LoggingTransaction) -> None:
330
+ sql = "DROP INDEX IF EXISTS event_push_actions_thread_id_null"
331
+ logger.debug("[SQL] %s", sql)
332
+ txn.execute(sql)
333
+
334
+ sql = "DROP INDEX IF EXISTS event_push_summary_thread_id_null"
335
+ logger.debug("[SQL] %s", sql)
336
+ txn.execute(sql)
337
+
338
+ await self.db_pool.runInteraction(
339
+ "drop_null_thread_id_indexes_txn",
340
+ drop_null_thread_id_indexes_txn,
341
+ )
342
+ await self.db_pool.updates._end_background_update(
343
+ "event_push_drop_null_thread_id_indexes"
344
+ )
345
+ return 0
346
+
347
+ async def get_unread_counts_by_room_for_user(self, user_id: str) -> dict[str, int]:
348
+ """Get the notification count by room for a user. Only considers notifications,
349
+ not highlight or unread counts, and threads are currently aggregated under their room.
350
+
351
+ This function is intentionally not cached because it is called to calculate the
352
+ unread badge for push notifications and thus the result is expected to change.
353
+
354
+ Note that this function assumes the user is a member of the room. Because
355
+ summary rows are not removed when a user leaves a room, the caller must
356
+ filter out those results from the result.
357
+
358
+ Returns:
359
+ A map of room ID to notification counts for the given user.
360
+ """
361
+ return await self.db_pool.runInteraction(
362
+ "get_unread_counts_by_room_for_user",
363
+ self._get_unread_counts_by_room_for_user_txn,
364
+ user_id,
365
+ )
366
+
367
+ def _get_unread_counts_by_room_for_user_txn(
368
+ self, txn: LoggingTransaction, user_id: str
369
+ ) -> dict[str, int]:
370
+ receipt_types_clause, args = make_in_list_sql_clause(
371
+ self.database_engine,
372
+ "receipt_type",
373
+ (ReceiptTypes.READ, ReceiptTypes.READ_PRIVATE),
374
+ )
375
+ args.extend([user_id, user_id])
376
+
377
+ receipts_cte = f"""
378
+ WITH all_receipts AS (
379
+ SELECT room_id, thread_id, MAX(event_stream_ordering) AS max_receipt_stream_ordering
380
+ FROM receipts_linearized
381
+ WHERE
382
+ {receipt_types_clause}
383
+ AND user_id = ?
384
+ GROUP BY room_id, thread_id
385
+ )
386
+ """
387
+
388
+ receipts_joins = """
389
+ LEFT JOIN (
390
+ SELECT room_id, thread_id,
391
+ max_receipt_stream_ordering AS threaded_receipt_stream_ordering
392
+ FROM all_receipts
393
+ WHERE thread_id IS NOT NULL
394
+ ) AS threaded_receipts USING (room_id, thread_id)
395
+ LEFT JOIN (
396
+ SELECT room_id, thread_id,
397
+ max_receipt_stream_ordering AS unthreaded_receipt_stream_ordering
398
+ FROM all_receipts
399
+ WHERE thread_id IS NULL
400
+ ) AS unthreaded_receipts USING (room_id)
401
+ """
402
+
403
+ # First get summary counts by room / thread for the user. We use the max receipt
404
+ # stream ordering of both threaded & unthreaded receipts to compare against the
405
+ # summary table.
406
+ #
407
+ # PostgreSQL and SQLite differ in comparing scalar numerics.
408
+ if isinstance(self.database_engine, PostgresEngine):
409
+ # GREATEST ignores NULLs.
410
+ max_clause = """GREATEST(
411
+ threaded_receipt_stream_ordering,
412
+ unthreaded_receipt_stream_ordering
413
+ )"""
414
+ else:
415
+ # MAX returns NULL if any are NULL, so COALESCE to 0 first.
416
+ max_clause = """MAX(
417
+ COALESCE(threaded_receipt_stream_ordering, 0),
418
+ COALESCE(unthreaded_receipt_stream_ordering, 0)
419
+ )"""
420
+
421
+ sql = f"""
422
+ {receipts_cte}
423
+ SELECT eps.room_id, eps.thread_id, notif_count
424
+ FROM event_push_summary AS eps
425
+ {receipts_joins}
426
+ WHERE user_id = ?
427
+ AND notif_count != 0
428
+ AND (
429
+ (last_receipt_stream_ordering IS NULL AND stream_ordering > {max_clause})
430
+ OR last_receipt_stream_ordering = {max_clause}
431
+ )
432
+ """
433
+ txn.execute(sql, args)
434
+
435
+ seen_thread_ids = set()
436
+ room_to_count: dict[str, int] = defaultdict(int)
437
+
438
+ for room_id, thread_id, notif_count in txn:
439
+ room_to_count[room_id] += notif_count
440
+ seen_thread_ids.add(thread_id)
441
+
442
+ # Now get any event push actions that haven't been rotated using the same OR
443
+ # join and filter by receipt and event push summary rotated up to stream ordering.
444
+ sql = f"""
445
+ {receipts_cte}
446
+ SELECT epa.room_id, epa.thread_id, COUNT(CASE WHEN epa.notif = 1 THEN 1 END) AS notif_count
447
+ FROM event_push_actions AS epa
448
+ {receipts_joins}
449
+ WHERE user_id = ?
450
+ AND epa.notif = 1
451
+ AND stream_ordering > (SELECT stream_ordering FROM event_push_summary_stream_ordering)
452
+ AND (threaded_receipt_stream_ordering IS NULL OR stream_ordering > threaded_receipt_stream_ordering)
453
+ AND (unthreaded_receipt_stream_ordering IS NULL OR stream_ordering > unthreaded_receipt_stream_ordering)
454
+ GROUP BY epa.room_id, epa.thread_id
455
+ """
456
+ txn.execute(sql, args)
457
+
458
+ for room_id, thread_id, notif_count in txn:
459
+ # Note: only count push actions we have valid summaries for with up to date receipt.
460
+ if thread_id not in seen_thread_ids:
461
+ continue
462
+ room_to_count[room_id] += notif_count
463
+
464
+ thread_id_clause, thread_ids_args = make_in_list_sql_clause(
465
+ self.database_engine, "epa.thread_id", seen_thread_ids
466
+ )
467
+
468
+ # Finally re-check event_push_actions for any rooms not in the summary, ignoring
469
+ # the rotated up-to position. This handles the case where a read receipt has arrived
470
+ # but not been rotated meaning the summary table is out of date, so we go back to
471
+ # the push actions table.
472
+ sql = f"""
473
+ {receipts_cte}
474
+ SELECT epa.room_id, COUNT(CASE WHEN epa.notif = 1 THEN 1 END) AS notif_count
475
+ FROM event_push_actions AS epa
476
+ {receipts_joins}
477
+ WHERE user_id = ?
478
+ AND NOT {thread_id_clause}
479
+ AND epa.notif = 1
480
+ AND (threaded_receipt_stream_ordering IS NULL OR stream_ordering > threaded_receipt_stream_ordering)
481
+ AND (unthreaded_receipt_stream_ordering IS NULL OR stream_ordering > unthreaded_receipt_stream_ordering)
482
+ GROUP BY epa.room_id
483
+ """
484
+
485
+ args.extend(thread_ids_args)
486
+ txn.execute(sql, args)
487
+
488
+ for room_id, notif_count in txn:
489
+ room_to_count[room_id] += notif_count
490
+
491
+ return room_to_count
492
+
493
+ @cached(tree=True, max_entries=5000, iterable=True) # type: ignore[synapse-@cached-mutable]
494
+ async def get_unread_event_push_actions_by_room_for_user(
495
+ self,
496
+ room_id: str,
497
+ user_id: str,
498
+ ) -> RoomNotifCounts:
499
+ """Get the notification count, the highlight count and the unread message count
500
+ for a given user in a given room after their latest read receipt.
501
+
502
+ Note that this function assumes the user to be a current member of the room,
503
+ since it's either called by the sync handler to handle joined room entries, or by
504
+ the HTTP pusher to calculate the badge of unread joined rooms.
505
+
506
+ Args:
507
+ room_id: The room to retrieve the counts in.
508
+ user_id: The user to retrieve the counts for.
509
+
510
+ Returns
511
+ A RoomNotifCounts object containing the notification count, the
512
+ highlight count and the unread message count for both the main timeline
513
+ and threads.
514
+ """
515
+ return await self.db_pool.runInteraction(
516
+ "get_unread_event_push_actions_by_room",
517
+ self._get_unread_counts_by_receipt_txn,
518
+ room_id,
519
+ user_id,
520
+ )
521
+
522
+ def _get_unread_counts_by_receipt_txn(
523
+ self,
524
+ txn: LoggingTransaction,
525
+ room_id: str,
526
+ user_id: str,
527
+ ) -> RoomNotifCounts:
528
+ # Get the stream ordering of the user's latest receipt in the room.
529
+ result = self.get_last_unthreaded_receipt_for_user_txn(
530
+ txn,
531
+ user_id,
532
+ room_id,
533
+ receipt_types=(ReceiptTypes.READ, ReceiptTypes.READ_PRIVATE),
534
+ )
535
+
536
+ if result:
537
+ _, stream_ordering = result
538
+
539
+ else:
540
+ # If the user has no receipts in the room, retrieve the stream ordering for
541
+ # the latest membership event from this user in this room (which we assume is
542
+ # a join).
543
+ event_id = self.db_pool.simple_select_one_onecol_txn(
544
+ txn=txn,
545
+ table="local_current_membership",
546
+ keyvalues={"room_id": room_id, "user_id": user_id},
547
+ retcol="event_id",
548
+ )
549
+
550
+ stream_ordering = self.get_stream_id_for_event_txn(txn, event_id)
551
+
552
+ return self._get_unread_counts_by_pos_txn(
553
+ txn, room_id, user_id, stream_ordering
554
+ )
555
+
556
+ def _get_unread_counts_by_pos_txn(
557
+ self,
558
+ txn: LoggingTransaction,
559
+ room_id: str,
560
+ user_id: str,
561
+ unthreaded_receipt_stream_ordering: int,
562
+ ) -> RoomNotifCounts:
563
+ """Get the number of unread messages for a user/room that have happened
564
+ since the given stream ordering.
565
+
566
+ Args:
567
+ txn: The database transaction.
568
+ room_id: The room ID to get unread counts for.
569
+ user_id: The user ID to get unread counts for.
570
+ unthreaded_receipt_stream_ordering: The stream ordering of the user's latest
571
+ unthreaded receipt in the room. If there are no unthreaded receipts,
572
+ the stream ordering of the user's join event.
573
+
574
+ Returns:
575
+ A RoomNotifCounts object containing the notification count, the
576
+ highlight count and the unread message count for both the main timeline
577
+ and threads.
578
+ """
579
+
580
+ main_counts = NotifCounts()
581
+ thread_counts: dict[str, NotifCounts] = {}
582
+
583
+ def _get_thread(thread_id: str) -> NotifCounts:
584
+ if thread_id == MAIN_TIMELINE:
585
+ return main_counts
586
+ return thread_counts.setdefault(thread_id, NotifCounts())
587
+
588
+ receipt_types_clause, receipts_args = make_in_list_sql_clause(
589
+ self.database_engine,
590
+ "receipt_type",
591
+ (ReceiptTypes.READ, ReceiptTypes.READ_PRIVATE),
592
+ )
593
+
594
+ # First we pull the counts from the summary table.
595
+ #
596
+ # We check that `last_receipt_stream_ordering` matches the stream ordering of the
597
+ # latest receipt for the thread (which may be either the unthreaded read receipt
598
+ # or the threaded read receipt).
599
+ #
600
+ # If it doesn't match then a new read receipt has arrived and we haven't yet
601
+ # updated the counts in `event_push_summary` to reflect that; in that case we
602
+ # simply ignore `event_push_summary` counts.
603
+ #
604
+ # We then do a manual count of all the rows in the `event_push_actions` table
605
+ # for any user/room/thread which did not have a valid summary found.
606
+ #
607
+ # If `last_receipt_stream_ordering` is null then that means it's up-to-date
608
+ # (as the row was written by an older version of Synapse that
609
+ # updated `event_push_summary` synchronously when persisting a new read
610
+ # receipt).
611
+ txn.execute(
612
+ f"""
613
+ SELECT notif_count, COALESCE(unread_count, 0), thread_id
614
+ FROM event_push_summary
615
+ LEFT JOIN (
616
+ SELECT thread_id, MAX(event_stream_ordering) AS threaded_receipt_stream_ordering
617
+ FROM receipts_linearized
618
+ WHERE
619
+ user_id = ?
620
+ AND room_id = ?
621
+ AND event_stream_ordering > ?
622
+ AND {receipt_types_clause}
623
+ GROUP BY thread_id
624
+ ) AS receipts USING (thread_id)
625
+ WHERE room_id = ? AND user_id = ?
626
+ AND (
627
+ (last_receipt_stream_ordering IS NULL AND stream_ordering > COALESCE(threaded_receipt_stream_ordering, ?))
628
+ OR last_receipt_stream_ordering = COALESCE(threaded_receipt_stream_ordering, ?)
629
+ ) AND (notif_count != 0 OR COALESCE(unread_count, 0) != 0)
630
+ """,
631
+ (
632
+ user_id,
633
+ room_id,
634
+ unthreaded_receipt_stream_ordering,
635
+ *receipts_args,
636
+ room_id,
637
+ user_id,
638
+ unthreaded_receipt_stream_ordering,
639
+ unthreaded_receipt_stream_ordering,
640
+ ),
641
+ )
642
+ summarised_threads = set()
643
+ for notif_count, unread_count, thread_id in txn:
644
+ summarised_threads.add(thread_id)
645
+ counts = _get_thread(thread_id)
646
+ counts.notify_count += notif_count
647
+ counts.unread_count += unread_count
648
+
649
+ # Next we need to count highlights, which aren't summarised
650
+ sql = f"""
651
+ SELECT COUNT(*), thread_id FROM event_push_actions
652
+ LEFT JOIN (
653
+ SELECT thread_id, MAX(event_stream_ordering) AS threaded_receipt_stream_ordering
654
+ FROM receipts_linearized
655
+ WHERE
656
+ user_id = ?
657
+ AND room_id = ?
658
+ AND event_stream_ordering > ?
659
+ AND {receipt_types_clause}
660
+ GROUP BY thread_id
661
+ ) AS receipts USING (thread_id)
662
+ WHERE user_id = ?
663
+ AND room_id = ?
664
+ AND stream_ordering > COALESCE(threaded_receipt_stream_ordering, ?)
665
+ AND highlight = 1
666
+ GROUP BY thread_id
667
+ """
668
+ txn.execute(
669
+ sql,
670
+ (
671
+ user_id,
672
+ room_id,
673
+ unthreaded_receipt_stream_ordering,
674
+ *receipts_args,
675
+ user_id,
676
+ room_id,
677
+ unthreaded_receipt_stream_ordering,
678
+ ),
679
+ )
680
+ for highlight_count, thread_id in txn:
681
+ _get_thread(thread_id).highlight_count += highlight_count
682
+
683
+ # For threads which were summarised we need to count actions since the last
684
+ # rotation.
685
+ thread_id_clause, thread_id_args = make_in_list_sql_clause(
686
+ self.database_engine, "thread_id", summarised_threads
687
+ )
688
+
689
+ # The (inclusive) event stream ordering that was previously summarised.
690
+ rotated_upto_stream_ordering = self.db_pool.simple_select_one_onecol_txn(
691
+ txn,
692
+ table="event_push_summary_stream_ordering",
693
+ keyvalues={},
694
+ retcol="stream_ordering",
695
+ )
696
+
697
+ unread_counts = self._get_notif_unread_count_for_user_room(
698
+ txn, room_id, user_id, rotated_upto_stream_ordering
699
+ )
700
+ for notif_count, unread_count, thread_id in unread_counts:
701
+ if thread_id not in summarised_threads:
702
+ continue
703
+
704
+ if thread_id == MAIN_TIMELINE:
705
+ counts.notify_count += notif_count
706
+ counts.unread_count += unread_count
707
+ elif thread_id in thread_counts:
708
+ thread_counts[thread_id].notify_count += notif_count
709
+ thread_counts[thread_id].unread_count += unread_count
710
+ else:
711
+ # Previous thread summaries of 0 are discarded above.
712
+ #
713
+ # TODO If empty summaries are deleted this can be removed.
714
+ thread_counts[thread_id] = NotifCounts(
715
+ notify_count=notif_count,
716
+ unread_count=unread_count,
717
+ highlight_count=0,
718
+ )
719
+
720
+ # Finally we need to count push actions that aren't included in the
721
+ # summary returned above. This might be due to recent events that haven't
722
+ # been summarised yet or the summary is out of date due to a recent read
723
+ # receipt.
724
+ sql = f"""
725
+ SELECT
726
+ COUNT(CASE WHEN notif = 1 THEN 1 END),
727
+ COUNT(CASE WHEN unread = 1 THEN 1 END),
728
+ thread_id
729
+ FROM event_push_actions
730
+ LEFT JOIN (
731
+ SELECT thread_id, MAX(event_stream_ordering) AS threaded_receipt_stream_ordering
732
+ FROM receipts_linearized
733
+ WHERE
734
+ user_id = ?
735
+ AND room_id = ?
736
+ AND event_stream_ordering > ?
737
+ AND {receipt_types_clause}
738
+ GROUP BY thread_id
739
+ ) AS receipts USING (thread_id)
740
+ WHERE user_id = ?
741
+ AND room_id = ?
742
+ AND stream_ordering > COALESCE(threaded_receipt_stream_ordering, ?)
743
+ AND NOT {thread_id_clause}
744
+ GROUP BY thread_id
745
+ """
746
+ txn.execute(
747
+ sql,
748
+ (
749
+ user_id,
750
+ room_id,
751
+ unthreaded_receipt_stream_ordering,
752
+ *receipts_args,
753
+ user_id,
754
+ room_id,
755
+ unthreaded_receipt_stream_ordering,
756
+ *thread_id_args,
757
+ ),
758
+ )
759
+ for notif_count, unread_count, thread_id in txn:
760
+ counts = _get_thread(thread_id)
761
+ counts.notify_count += notif_count
762
+ counts.unread_count += unread_count
763
+
764
+ return RoomNotifCounts(main_counts, thread_counts)
765
+
766
+ def _get_notif_unread_count_for_user_room(
767
+ self,
768
+ txn: LoggingTransaction,
769
+ room_id: str,
770
+ user_id: str,
771
+ stream_ordering: int,
772
+ max_stream_ordering: int | None = None,
773
+ thread_id: str | None = None,
774
+ ) -> list[tuple[int, int, str]]:
775
+ """Returns the notify and unread counts from `event_push_actions` for
776
+ the given user/room in the given range.
777
+
778
+ Does not consult `event_push_summary` table, which may include push
779
+ actions that have been deleted from `event_push_actions` table.
780
+
781
+ Args:
782
+ txn: The database transaction.
783
+ room_id: The room ID to get unread counts for.
784
+ user_id: The user ID to get unread counts for.
785
+ stream_ordering: The (exclusive) minimum stream ordering to consider.
786
+ max_stream_ordering: The (inclusive) maximum stream ordering to consider.
787
+ If this is not given, then no maximum is applied.
788
+ thread_id: The thread ID to fetch unread counts for. If this is not provided
789
+ then the results for *all* threads is returned.
790
+
791
+ Note that if this is provided the resulting list will only have 0 or
792
+ 1 tuples in it.
793
+
794
+ Return:
795
+ A tuple of the notif count and unread count in the given range for
796
+ each thread.
797
+ """
798
+
799
+ # If there have been no events in the room since the stream ordering,
800
+ # there can't be any push actions either.
801
+ if not self._events_stream_cache.has_entity_changed(room_id, stream_ordering):
802
+ return []
803
+
804
+ stream_ordering_clause = ""
805
+ args = [user_id, room_id, stream_ordering]
806
+ if max_stream_ordering is not None:
807
+ stream_ordering_clause = "AND ea.stream_ordering <= ?"
808
+ args.append(max_stream_ordering)
809
+
810
+ # If the max stream ordering is less than the min stream ordering,
811
+ # then obviously there are zero push actions in that range.
812
+ if max_stream_ordering <= stream_ordering:
813
+ return []
814
+
815
+ # Either limit the results to a specific thread or fetch all threads.
816
+ thread_id_clause = ""
817
+ if thread_id is not None:
818
+ thread_id_clause = "AND thread_id = ?"
819
+ args.append(thread_id)
820
+
821
+ sql = f"""
822
+ SELECT
823
+ COUNT(CASE WHEN notif = 1 THEN 1 END),
824
+ COUNT(CASE WHEN unread = 1 THEN 1 END),
825
+ thread_id
826
+ FROM event_push_actions ea
827
+ WHERE user_id = ?
828
+ AND room_id = ?
829
+ AND ea.stream_ordering > ?
830
+ {stream_ordering_clause}
831
+ {thread_id_clause}
832
+ GROUP BY thread_id
833
+ """
834
+
835
+ txn.execute(sql, args)
836
+ return cast(list[tuple[int, int, str]], txn.fetchall())
837
+
838
+ async def get_push_action_users_in_range(
839
+ self, min_stream_ordering: int, max_stream_ordering: int
840
+ ) -> list[str]:
841
+ def f(txn: LoggingTransaction) -> list[str]:
842
+ sql = (
843
+ "SELECT DISTINCT(user_id) FROM event_push_actions WHERE"
844
+ " stream_ordering >= ? AND stream_ordering <= ? AND notif = 1"
845
+ )
846
+ txn.execute(sql, (min_stream_ordering, max_stream_ordering))
847
+ return [r[0] for r in txn]
848
+
849
+ return await self.db_pool.runInteraction("get_push_action_users_in_range", f)
850
+
851
+ def _get_receipts_for_room_and_threads_txn(
852
+ self,
853
+ txn: LoggingTransaction,
854
+ user_id: str,
855
+ room_ids: StrCollection,
856
+ thread_ids: StrCollection,
857
+ ) -> dict[str, _RoomReceipt]:
858
+ """
859
+ Get (private) read receipts for a user in each of the given room IDs
860
+ and thread IDs.
861
+
862
+ Note: The corresponding room ID for each thread must appear in
863
+ `room_ids` arg.
864
+
865
+ Returns:
866
+ A map including all rooms the user is in with a receipt. It maps
867
+ room IDs to _RoomReceipt instances
868
+ """
869
+
870
+ receipt_types_clause, receipts_args = make_in_list_sql_clause(
871
+ self.database_engine,
872
+ "receipt_type",
873
+ (ReceiptTypes.READ, ReceiptTypes.READ_PRIVATE),
874
+ )
875
+
876
+ thread_ids_clause, thread_ids_args = make_in_list_sql_clause(
877
+ self.database_engine,
878
+ "thread_id",
879
+ thread_ids,
880
+ )
881
+
882
+ room_ids_clause, room_ids_args = make_in_list_sql_clause(
883
+ self.database_engine,
884
+ "room_id",
885
+ room_ids,
886
+ )
887
+
888
+ # We use the union of two (almost identical) queries here, the first to
889
+ # fetch the specific thread receipts and the second to fetch the
890
+ # unthreaded receipts.
891
+ #
892
+ # This SQL is optimized to use the indices we have on
893
+ # `receipts_linearized`.
894
+ #
895
+ # We compare room ID and thread IDs independently due to the above,
896
+ # which means that this query might return more rows than we need if the
897
+ # same thread ID appears across different rooms (e.g. 'main' thread ID).
898
+ # This doesn't cause any logic issues, and isn't a performance concern
899
+ # given this function generally gets called with only one room and
900
+ # thread ID.
901
+ sql = f"""
902
+ SELECT room_id, thread_id, MAX(event_stream_ordering)
903
+ FROM receipts_linearized
904
+ WHERE {receipt_types_clause}
905
+ AND {thread_ids_clause}
906
+ AND {room_ids_clause}
907
+ AND user_id = ?
908
+ GROUP BY room_id, thread_id
909
+
910
+ UNION ALL
911
+
912
+ SELECT room_id, thread_id, MAX(stream_ordering)
913
+ FROM receipts_linearized
914
+ INNER JOIN events USING (room_id, event_id)
915
+ WHERE {receipt_types_clause}
916
+ AND {room_ids_clause}
917
+ AND thread_id IS NULL
918
+ AND user_id = ?
919
+ GROUP BY room_id, thread_id
920
+ """
921
+
922
+ args = list(receipts_args)
923
+ args.extend(thread_ids_args)
924
+ args.extend(room_ids_args)
925
+ args.append(user_id)
926
+ args.extend(receipts_args)
927
+ args.extend(room_ids_args)
928
+ args.append(user_id)
929
+
930
+ txn.execute(sql, args)
931
+
932
+ result: dict[str, _RoomReceipt] = {}
933
+ for room_id, thread_id, stream_ordering in txn:
934
+ room_receipt = result.setdefault(room_id, _RoomReceipt())
935
+ if thread_id is None:
936
+ room_receipt.unthreaded_stream_ordering = stream_ordering
937
+ else:
938
+ room_receipt.threaded_stream_ordering[thread_id] = stream_ordering
939
+
940
+ return result
941
+
942
+ async def get_unread_push_actions_for_user_in_range_for_http(
943
+ self,
944
+ user_id: str,
945
+ min_stream_ordering: int,
946
+ max_stream_ordering: int,
947
+ limit: int = 20,
948
+ ) -> list[HttpPushAction]:
949
+ """Get a list of the most recent unread push actions for a given user,
950
+ within the given stream ordering range. Called by the httppusher.
951
+
952
+ Args:
953
+ user_id: The user to fetch push actions for.
954
+ min_stream_ordering: The exclusive lower bound on the
955
+ stream ordering of event push actions to fetch.
956
+ max_stream_ordering: The inclusive upper bound on the
957
+ stream ordering of event push actions to fetch.
958
+ limit: The maximum number of rows to return.
959
+ Returns:
960
+ A list of dicts with the keys "event_id", "room_id", "stream_ordering", "actions".
961
+ The list will be ordered by ascending stream_ordering.
962
+ The list will have between 0~limit entries.
963
+ """
964
+
965
+ def get_push_actions_txn(
966
+ txn: LoggingTransaction,
967
+ ) -> list[tuple[str, str, str, int, str, bool]]:
968
+ sql = """
969
+ SELECT ep.event_id, ep.room_id, ep.thread_id, ep.stream_ordering,
970
+ ep.actions, ep.highlight
971
+ FROM event_push_actions AS ep
972
+ WHERE
973
+ ep.user_id = ?
974
+ AND ep.stream_ordering > ?
975
+ AND ep.stream_ordering <= ?
976
+ AND ep.notif = 1
977
+ ORDER BY ep.stream_ordering ASC LIMIT ?
978
+ """
979
+ txn.execute(sql, (user_id, min_stream_ordering, max_stream_ordering, limit))
980
+ return cast(list[tuple[str, str, str, int, str, bool]], txn.fetchall())
981
+
982
+ push_actions = await self.db_pool.runInteraction(
983
+ "get_unread_push_actions_for_user_in_range_http", get_push_actions_txn
984
+ )
985
+
986
+ room_ids = set()
987
+ thread_ids = []
988
+ for (
989
+ _,
990
+ room_id,
991
+ thread_id,
992
+ _,
993
+ _,
994
+ _,
995
+ ) in push_actions:
996
+ room_ids.add(room_id)
997
+ thread_ids.append(thread_id)
998
+
999
+ receipts_by_room = await self.db_pool.runInteraction(
1000
+ "get_unread_push_actions_for_user_in_range_http_receipts",
1001
+ self._get_receipts_for_room_and_threads_txn,
1002
+ user_id=user_id,
1003
+ room_ids=room_ids,
1004
+ thread_ids=thread_ids,
1005
+ )
1006
+
1007
+ notifs = [
1008
+ HttpPushAction(
1009
+ event_id=event_id,
1010
+ room_id=room_id,
1011
+ stream_ordering=stream_ordering,
1012
+ actions=_deserialize_action(actions, highlight),
1013
+ )
1014
+ for event_id, room_id, thread_id, stream_ordering, actions, highlight in push_actions
1015
+ if receipts_by_room.get(room_id, MISSING_ROOM_RECEIPT).is_unread(
1016
+ thread_id, stream_ordering
1017
+ )
1018
+ ]
1019
+
1020
+ # Now sort it so it's ordered correctly, since currently it will
1021
+ # contain results from the first query, correctly ordered, followed
1022
+ # by results from the second query, but we want them all ordered
1023
+ # by stream_ordering, oldest first.
1024
+ notifs.sort(key=lambda r: r.stream_ordering)
1025
+
1026
+ # Take only up to the limit. We have to stop at the limit because
1027
+ # one of the subqueries may have hit the limit.
1028
+ return notifs[:limit]
1029
+
1030
+ async def get_unread_push_actions_for_user_in_range_for_email(
1031
+ self,
1032
+ user_id: str,
1033
+ min_stream_ordering: int,
1034
+ max_stream_ordering: int,
1035
+ limit: int = 20,
1036
+ ) -> list[EmailPushAction]:
1037
+ """Get a list of the most recent unread push actions for a given user,
1038
+ within the given stream ordering range. Called by the emailpusher
1039
+
1040
+ Args:
1041
+ user_id: The user to fetch push actions for.
1042
+ min_stream_ordering: The exclusive lower bound on the
1043
+ stream ordering of event push actions to fetch.
1044
+ max_stream_ordering: The inclusive upper bound on the
1045
+ stream ordering of event push actions to fetch.
1046
+ limit: The maximum number of rows to return.
1047
+ Returns:
1048
+ A list of dicts with the keys "event_id", "room_id", "stream_ordering", "actions", "received_ts".
1049
+ The list will be ordered by descending received_ts.
1050
+ The list will have between 0~limit entries.
1051
+ """
1052
+
1053
+ def get_push_actions_txn(
1054
+ txn: LoggingTransaction,
1055
+ ) -> list[tuple[str, str, str, int, str, bool, int]]:
1056
+ sql = """
1057
+ SELECT ep.event_id, ep.room_id, ep.thread_id, ep.stream_ordering,
1058
+ ep.actions, ep.highlight, e.received_ts
1059
+ FROM event_push_actions AS ep
1060
+ INNER JOIN events AS e USING (room_id, event_id)
1061
+ WHERE
1062
+ ep.user_id = ?
1063
+ AND ep.stream_ordering > ?
1064
+ AND ep.stream_ordering <= ?
1065
+ AND ep.notif = 1
1066
+ ORDER BY ep.stream_ordering DESC LIMIT ?
1067
+ """
1068
+ txn.execute(sql, (user_id, min_stream_ordering, max_stream_ordering, limit))
1069
+ return cast(list[tuple[str, str, str, int, str, bool, int]], txn.fetchall())
1070
+
1071
+ push_actions = await self.db_pool.runInteraction(
1072
+ "get_unread_push_actions_for_user_in_range_email", get_push_actions_txn
1073
+ )
1074
+
1075
+ room_ids = set()
1076
+ thread_ids = []
1077
+ for (
1078
+ _,
1079
+ room_id,
1080
+ thread_id,
1081
+ _,
1082
+ _,
1083
+ _,
1084
+ _,
1085
+ ) in push_actions:
1086
+ room_ids.add(room_id)
1087
+ thread_ids.append(thread_id)
1088
+
1089
+ receipts_by_room = await self.db_pool.runInteraction(
1090
+ "get_unread_push_actions_for_user_in_range_email_receipts",
1091
+ self._get_receipts_for_room_and_threads_txn,
1092
+ user_id=user_id,
1093
+ room_ids=room_ids,
1094
+ thread_ids=thread_ids,
1095
+ )
1096
+
1097
+ # Make a list of dicts from the two sets of results.
1098
+ notifs = [
1099
+ EmailPushAction(
1100
+ event_id=event_id,
1101
+ room_id=room_id,
1102
+ stream_ordering=stream_ordering,
1103
+ actions=_deserialize_action(actions, highlight),
1104
+ received_ts=received_ts,
1105
+ )
1106
+ for event_id, room_id, thread_id, stream_ordering, actions, highlight, received_ts in push_actions
1107
+ if receipts_by_room.get(room_id, MISSING_ROOM_RECEIPT).is_unread(
1108
+ thread_id, stream_ordering
1109
+ )
1110
+ ]
1111
+
1112
+ # Now sort it so it's ordered correctly, since currently it will
1113
+ # contain results from the first query, correctly ordered, followed
1114
+ # by results from the second query, but we want them all ordered
1115
+ # by received_ts (most recent first)
1116
+ notifs.sort(key=lambda r: -(r.received_ts or 0))
1117
+
1118
+ # Now return the first `limit`
1119
+ return notifs[:limit]
1120
+
1121
+ async def get_if_maybe_push_in_range_for_user(
1122
+ self, user_id: str, min_stream_ordering: int
1123
+ ) -> bool:
1124
+ """A fast check to see if there might be something to push for the
1125
+ user since the given stream ordering. May return false positives.
1126
+
1127
+ Useful to know whether to bother starting a pusher on start up or not.
1128
+
1129
+ Args:
1130
+ user_id
1131
+ min_stream_ordering
1132
+
1133
+ Returns:
1134
+ True if there may be push to process, False if there definitely isn't.
1135
+ """
1136
+
1137
+ def _get_if_maybe_push_in_range_for_user_txn(txn: LoggingTransaction) -> bool:
1138
+ sql = """
1139
+ SELECT 1 FROM event_push_actions
1140
+ WHERE user_id = ? AND stream_ordering > ? AND notif = 1
1141
+ LIMIT 1
1142
+ """
1143
+
1144
+ txn.execute(sql, (user_id, min_stream_ordering))
1145
+ return bool(txn.fetchone())
1146
+
1147
+ return await self.db_pool.runInteraction(
1148
+ "get_if_maybe_push_in_range_for_user",
1149
+ _get_if_maybe_push_in_range_for_user_txn,
1150
+ )
1151
+
1152
+ async def add_push_actions_to_staging(
1153
+ self,
1154
+ event_id: str,
1155
+ user_id_actions: dict[str, Collection[Mapping | str]],
1156
+ count_as_unread: bool,
1157
+ thread_id: str,
1158
+ ) -> None:
1159
+ """Add the push actions for the event to the push action staging area.
1160
+
1161
+ Args:
1162
+ event_id
1163
+ user_id_actions: A mapping of user_id to list of push actions, where
1164
+ an action can either be a string or dict.
1165
+ count_as_unread: Whether this event should increment unread counts.
1166
+ thread_id: The thread this event is parent of, if applicable.
1167
+ """
1168
+ if not user_id_actions:
1169
+ return
1170
+
1171
+ # This is a helper function for generating the necessary tuple that
1172
+ # can be used to insert into the `event_push_actions_staging` table.
1173
+ def _gen_entry(
1174
+ user_id: str, actions: Collection[Mapping | str]
1175
+ ) -> tuple[str, str, str, int, int, int, str, int]:
1176
+ is_highlight = 1 if _action_has_highlight(actions) else 0
1177
+ notif = 1 if "notify" in actions else 0
1178
+ return (
1179
+ event_id, # event_id column
1180
+ user_id, # user_id column
1181
+ _serialize_action(actions, bool(is_highlight)), # actions column
1182
+ notif, # notif column
1183
+ is_highlight, # highlight column
1184
+ int(count_as_unread), # unread column
1185
+ thread_id, # thread_id column
1186
+ self.clock.time_msec(), # inserted_ts column
1187
+ )
1188
+
1189
+ await self.db_pool.simple_insert_many(
1190
+ "event_push_actions_staging",
1191
+ keys=(
1192
+ "event_id",
1193
+ "user_id",
1194
+ "actions",
1195
+ "notif",
1196
+ "highlight",
1197
+ "unread",
1198
+ "thread_id",
1199
+ "inserted_ts",
1200
+ ),
1201
+ values=[
1202
+ _gen_entry(user_id, actions)
1203
+ for user_id, actions in user_id_actions.items()
1204
+ ],
1205
+ desc="add_push_actions_to_staging",
1206
+ )
1207
+
1208
+ async def remove_push_actions_from_staging(self, event_id: str) -> None:
1209
+ """Called if we failed to persist the event to ensure that stale push
1210
+ actions don't build up in the DB
1211
+ """
1212
+
1213
+ try:
1214
+ await self.db_pool.simple_delete(
1215
+ table="event_push_actions_staging",
1216
+ keyvalues={"event_id": event_id},
1217
+ desc="remove_push_actions_from_staging",
1218
+ )
1219
+ except Exception:
1220
+ # this method is called from an exception handler, so propagating
1221
+ # another exception here really isn't helpful - there's nothing
1222
+ # the caller can do about it. Just log the exception and move on.
1223
+ logger.exception(
1224
+ "Error removing push actions after event persistence failure"
1225
+ )
1226
+
1227
+ @wrap_as_background_process("event_push_action_stream_orderings")
1228
+ async def _find_stream_orderings_for_times(self) -> None:
1229
+ await self.db_pool.runInteraction(
1230
+ "_find_stream_orderings_for_times",
1231
+ self._find_stream_orderings_for_times_txn,
1232
+ )
1233
+
1234
+ def _find_stream_orderings_for_times_txn(self, txn: LoggingTransaction) -> None:
1235
+ logger.info("Searching for stream ordering 1 month ago")
1236
+ self.stream_ordering_month_ago = self._find_first_stream_ordering_after_ts_txn(
1237
+ txn, self.clock.time_msec() - 30 * 24 * 60 * 60 * 1000
1238
+ )
1239
+ logger.info(
1240
+ "Found stream ordering 1 month ago: it's %d", self.stream_ordering_month_ago
1241
+ )
1242
+ logger.info("Searching for stream ordering 1 day ago")
1243
+ self.stream_ordering_day_ago = self._find_first_stream_ordering_after_ts_txn(
1244
+ txn, self.clock.time_msec() - 24 * 60 * 60 * 1000
1245
+ )
1246
+ logger.info(
1247
+ "Found stream ordering 1 day ago: it's %d", self.stream_ordering_day_ago
1248
+ )
1249
+
1250
+ async def find_first_stream_ordering_after_ts(self, ts: int) -> int:
1251
+ """Gets the stream ordering corresponding to a given timestamp.
1252
+
1253
+ Specifically, finds the stream_ordering of the first event that was
1254
+ received on or after the timestamp. This is done by a binary search on
1255
+ the events table, since there is no index on received_ts, so is
1256
+ relatively slow.
1257
+
1258
+ Args:
1259
+ ts: timestamp in millis
1260
+
1261
+ Returns:
1262
+ stream ordering of the first event received on/after the timestamp
1263
+ """
1264
+ return await self.db_pool.runInteraction(
1265
+ "_find_first_stream_ordering_after_ts_txn",
1266
+ self._find_first_stream_ordering_after_ts_txn,
1267
+ ts,
1268
+ )
1269
+
1270
+ @staticmethod
1271
+ def _find_first_stream_ordering_after_ts_txn(
1272
+ txn: LoggingTransaction, ts: int
1273
+ ) -> int:
1274
+ """
1275
+ Find the stream_ordering of the first event that was received on or
1276
+ after a given timestamp. This is relatively slow as there is no index
1277
+ on received_ts but we can then use this to delete push actions before
1278
+ this.
1279
+
1280
+ received_ts must necessarily be in the same order as stream_ordering
1281
+ and stream_ordering is indexed, so we manually binary search using
1282
+ stream_ordering
1283
+
1284
+ Args:
1285
+ txn:
1286
+ ts: timestamp to search for
1287
+
1288
+ Returns:
1289
+ The stream ordering
1290
+ """
1291
+ txn.execute("SELECT MAX(stream_ordering) FROM events")
1292
+ max_stream_ordering = cast(tuple[int | None], txn.fetchone())[0]
1293
+
1294
+ if max_stream_ordering is None:
1295
+ return 0
1296
+
1297
+ # We want the first stream_ordering in which received_ts is greater
1298
+ # than or equal to ts. Call this point X.
1299
+ #
1300
+ # We maintain the invariants:
1301
+ #
1302
+ # range_start <= X <= range_end
1303
+ #
1304
+ range_start = 0
1305
+ range_end = max_stream_ordering + 1
1306
+
1307
+ # Given a stream_ordering, look up the timestamp at that
1308
+ # stream_ordering.
1309
+ #
1310
+ # The array may be sparse (we may be missing some stream_orderings).
1311
+ # We treat the gaps as the same as having the same value as the
1312
+ # preceding entry, because we will pick the lowest stream_ordering
1313
+ # which satisfies our requirement of received_ts >= ts.
1314
+ #
1315
+ # For example, if our array of events indexed by stream_ordering is
1316
+ # [10, <none>, 20], we should treat this as being equivalent to
1317
+ # [10, 10, 20].
1318
+ #
1319
+ sql = """
1320
+ SELECT received_ts FROM events
1321
+ WHERE stream_ordering <= ?
1322
+ ORDER BY stream_ordering DESC
1323
+ LIMIT 1
1324
+ """
1325
+
1326
+ while range_end - range_start > 0:
1327
+ middle = (range_end + range_start) // 2
1328
+ txn.execute(sql, (middle,))
1329
+ row = txn.fetchone()
1330
+ if row is None:
1331
+ # no rows with stream_ordering<=middle
1332
+ range_start = middle + 1
1333
+ continue
1334
+
1335
+ middle_ts = row[0]
1336
+ if ts > middle_ts:
1337
+ # we got a timestamp lower than the one we were looking for.
1338
+ # definitely need to look higher: X > middle.
1339
+ range_start = middle + 1
1340
+ else:
1341
+ # we got a timestamp higher than (or the same as) the one we
1342
+ # were looking for. We aren't yet sure about the point we
1343
+ # looked up, but we can be sure that X <= middle.
1344
+ range_end = middle
1345
+
1346
+ return range_end
1347
+
1348
+ async def get_time_of_last_push_action_before(
1349
+ self, stream_ordering: int
1350
+ ) -> int | None:
1351
+ def f(txn: LoggingTransaction) -> tuple[int] | None:
1352
+ sql = """
1353
+ SELECT e.received_ts
1354
+ FROM event_push_actions AS ep
1355
+ JOIN events e ON ep.room_id = e.room_id AND ep.event_id = e.event_id
1356
+ WHERE ep.stream_ordering > ? AND notif = 1
1357
+ ORDER BY ep.stream_ordering ASC
1358
+ LIMIT 1
1359
+ """
1360
+ txn.execute(sql, (stream_ordering,))
1361
+ return cast(tuple[int] | None, txn.fetchone())
1362
+
1363
+ result = await self.db_pool.runInteraction(
1364
+ "get_time_of_last_push_action_before", f
1365
+ )
1366
+ return result[0] if result else None
1367
+
1368
+ @wrap_as_background_process("rotate_notifs")
1369
+ async def _rotate_notifs(self) -> None:
1370
+ if self._doing_notif_rotation or self.stream_ordering_day_ago is None:
1371
+ return
1372
+ self._doing_notif_rotation = True
1373
+
1374
+ try:
1375
+ # First we recalculate push summaries and delete stale push actions
1376
+ # for rooms/users with new receipts.
1377
+ while True:
1378
+ logger.debug("Handling new receipts")
1379
+
1380
+ caught_up = await self.db_pool.runInteraction(
1381
+ "_handle_new_receipts_for_notifs_txn",
1382
+ self._handle_new_receipts_for_notifs_txn,
1383
+ )
1384
+ if caught_up:
1385
+ break
1386
+
1387
+ # Then we update the event push summaries for any new events
1388
+ while True:
1389
+ logger.info("Rotating notifications")
1390
+
1391
+ caught_up = await self.db_pool.runInteraction(
1392
+ "_rotate_notifs", self._rotate_notifs_txn
1393
+ )
1394
+ if caught_up:
1395
+ break
1396
+
1397
+ # Finally we clear out old event push actions.
1398
+ await self._remove_old_push_actions_that_have_rotated()
1399
+ finally:
1400
+ self._doing_notif_rotation = False
1401
+
1402
+ def _handle_new_receipts_for_notifs_txn(self, txn: LoggingTransaction) -> bool:
1403
+ """Check for new read receipts and delete from event push actions.
1404
+
1405
+ Any push actions which predate the user's most recent read receipt are
1406
+ now redundant, so we can remove them from `event_push_actions` and
1407
+ update `event_push_summary`.
1408
+
1409
+ Returns true if all new receipts have been processed.
1410
+ """
1411
+
1412
+ limit = 100
1413
+
1414
+ # The (inclusive) receipt stream ID that was previously processed..
1415
+ min_receipts_stream_id = self.db_pool.simple_select_one_onecol_txn(
1416
+ txn,
1417
+ table="event_push_summary_last_receipt_stream_id",
1418
+ keyvalues={},
1419
+ retcol="stream_id",
1420
+ )
1421
+
1422
+ max_receipts_stream_id = self._receipts_id_gen.get_current_token()
1423
+
1424
+ # The (inclusive) event stream ordering that was previously summarised.
1425
+ old_rotate_stream_ordering = self.db_pool.simple_select_one_onecol_txn(
1426
+ txn,
1427
+ table="event_push_summary_stream_ordering",
1428
+ keyvalues={},
1429
+ retcol="stream_ordering",
1430
+ )
1431
+
1432
+ sql = """
1433
+ SELECT r.stream_id, r.room_id, r.user_id, r.thread_id, r.event_stream_ordering
1434
+ FROM receipts_linearized AS r
1435
+ WHERE ? < r.stream_id AND r.stream_id <= ? AND user_id LIKE ?
1436
+ ORDER BY r.stream_id ASC
1437
+ LIMIT ?
1438
+ """
1439
+
1440
+ # We only want local users, so we add a dodgy filter to the above query
1441
+ # and recheck it below.
1442
+ user_filter = "%:" + self.hs.hostname
1443
+
1444
+ txn.execute(
1445
+ sql,
1446
+ (
1447
+ min_receipts_stream_id,
1448
+ max_receipts_stream_id,
1449
+ user_filter,
1450
+ limit,
1451
+ ),
1452
+ )
1453
+ rows = cast(list[tuple[int, str, str, str | None, int]], txn.fetchall())
1454
+
1455
+ # For each new read receipt we delete push actions from before it and
1456
+ # recalculate the summary.
1457
+ #
1458
+ # Care must be taken of whether it is a threaded or unthreaded receipt.
1459
+ for _, room_id, user_id, thread_id, stream_ordering in rows:
1460
+ # Only handle our own read receipts.
1461
+ if not self.hs.is_mine_id(user_id):
1462
+ continue
1463
+
1464
+ thread_clause = ""
1465
+ thread_args: tuple = ()
1466
+ if thread_id is not None:
1467
+ thread_clause = "AND thread_id = ?"
1468
+ thread_args = (thread_id,)
1469
+
1470
+ # For each new read receipt we delete push actions from before it and
1471
+ # recalculate the summary.
1472
+ txn.execute(
1473
+ f"""
1474
+ DELETE FROM event_push_actions
1475
+ WHERE room_id = ?
1476
+ AND user_id = ?
1477
+ AND stream_ordering <= ?
1478
+ AND highlight = 0
1479
+ {thread_clause}
1480
+ """,
1481
+ (room_id, user_id, stream_ordering, *thread_args),
1482
+ )
1483
+
1484
+ # Fetch the notification counts between the stream ordering of the
1485
+ # latest receipt and what was previously summarised.
1486
+ unread_counts = self._get_notif_unread_count_for_user_room(
1487
+ txn,
1488
+ room_id,
1489
+ user_id,
1490
+ stream_ordering,
1491
+ old_rotate_stream_ordering,
1492
+ thread_id,
1493
+ )
1494
+
1495
+ # For an unthreaded receipt, mark the summary for all threads in the room
1496
+ # as cleared.
1497
+ if thread_id is None:
1498
+ self.db_pool.simple_update_txn(
1499
+ txn,
1500
+ table="event_push_summary",
1501
+ keyvalues={"user_id": user_id, "room_id": room_id},
1502
+ updatevalues={
1503
+ "notif_count": 0,
1504
+ "unread_count": 0,
1505
+ "stream_ordering": old_rotate_stream_ordering,
1506
+ "last_receipt_stream_ordering": stream_ordering,
1507
+ },
1508
+ )
1509
+
1510
+ # For a threaded receipt, we *always* want to update that receipt,
1511
+ # event if there are no new notifications in that thread. This ensures
1512
+ # the stream_ordering & last_receipt_stream_ordering are updated.
1513
+ elif not unread_counts:
1514
+ unread_counts = [(0, 0, thread_id)]
1515
+
1516
+ # Then any updated threads get their notification count and unread
1517
+ # count updated.
1518
+ self.db_pool.simple_update_many_txn(
1519
+ txn,
1520
+ table="event_push_summary",
1521
+ key_names=("room_id", "user_id", "thread_id"),
1522
+ key_values=[(room_id, user_id, row[2]) for row in unread_counts],
1523
+ value_names=(
1524
+ "notif_count",
1525
+ "unread_count",
1526
+ "stream_ordering",
1527
+ "last_receipt_stream_ordering",
1528
+ ),
1529
+ value_values=[
1530
+ (row[0], row[1], old_rotate_stream_ordering, stream_ordering)
1531
+ for row in unread_counts
1532
+ ],
1533
+ )
1534
+
1535
+ # We always update `event_push_summary_last_receipt_stream_id` to
1536
+ # ensure that we don't rescan the same receipts for remote users.
1537
+
1538
+ receipts_last_processed_stream_id = max_receipts_stream_id
1539
+ if len(rows) >= limit:
1540
+ # If we pulled out a limited number of rows we only update the
1541
+ # position to the last receipt we processed, so we continue
1542
+ # processing the rest next iteration.
1543
+ receipts_last_processed_stream_id = rows[-1][0]
1544
+
1545
+ self.db_pool.simple_update_txn(
1546
+ txn,
1547
+ table="event_push_summary_last_receipt_stream_id",
1548
+ keyvalues={},
1549
+ updatevalues={"stream_id": receipts_last_processed_stream_id},
1550
+ )
1551
+
1552
+ return len(rows) < limit
1553
+
1554
+ def _rotate_notifs_txn(self, txn: LoggingTransaction) -> bool:
1555
+ """Archives older notifications (from event_push_actions) into event_push_summary.
1556
+
1557
+ Returns whether the archiving process has caught up or not.
1558
+ """
1559
+
1560
+ # The (inclusive) event stream ordering that was previously summarised.
1561
+ old_rotate_stream_ordering = self.db_pool.simple_select_one_onecol_txn(
1562
+ txn,
1563
+ table="event_push_summary_stream_ordering",
1564
+ keyvalues={},
1565
+ retcol="stream_ordering",
1566
+ )
1567
+
1568
+ # We don't to try and rotate millions of rows at once, so we cap the
1569
+ # maximum stream ordering we'll rotate before.
1570
+ txn.execute(
1571
+ """
1572
+ SELECT stream_ordering FROM event_push_actions
1573
+ WHERE stream_ordering > ?
1574
+ ORDER BY stream_ordering ASC LIMIT 1 OFFSET ?
1575
+ """,
1576
+ (old_rotate_stream_ordering, self._rotate_count),
1577
+ )
1578
+ stream_row = txn.fetchone()
1579
+ if stream_row:
1580
+ (offset_stream_ordering,) = stream_row
1581
+
1582
+ # We need to bound by the current token to ensure that we handle
1583
+ # out-of-order writes correctly.
1584
+ rotate_to_stream_ordering = min(
1585
+ offset_stream_ordering, self._stream_id_gen.get_current_token()
1586
+ )
1587
+ caught_up = False
1588
+ else:
1589
+ rotate_to_stream_ordering = self._stream_id_gen.get_current_token()
1590
+ caught_up = True
1591
+
1592
+ logger.info("Rotating notifications up to: %s", rotate_to_stream_ordering)
1593
+
1594
+ self._rotate_notifs_before_txn(
1595
+ txn, old_rotate_stream_ordering, rotate_to_stream_ordering
1596
+ )
1597
+
1598
+ return caught_up
1599
+
1600
+ def _rotate_notifs_before_txn(
1601
+ self,
1602
+ txn: LoggingTransaction,
1603
+ old_rotate_stream_ordering: int,
1604
+ rotate_to_stream_ordering: int,
1605
+ ) -> None:
1606
+ """Archives older notifications (from event_push_actions) into event_push_summary.
1607
+
1608
+ Any event_push_actions between old_rotate_stream_ordering (exclusive) and
1609
+ rotate_to_stream_ordering (inclusive) will be added to the event_push_summary
1610
+ table.
1611
+
1612
+ Args:
1613
+ txn: The database transaction.
1614
+ old_rotate_stream_ordering: The previous maximum event stream ordering.
1615
+ rotate_to_stream_ordering: The new maximum event stream ordering to summarise.
1616
+ """
1617
+
1618
+ # Calculate the new counts that should be upserted into event_push_summary
1619
+ sql = """
1620
+ SELECT user_id, room_id, thread_id,
1621
+ coalesce(old.%s, 0) + upd.cnt,
1622
+ upd.stream_ordering
1623
+ FROM (
1624
+ SELECT user_id, room_id, thread_id, count(*) as cnt,
1625
+ max(ea.stream_ordering) as stream_ordering
1626
+ FROM event_push_actions AS ea
1627
+ LEFT JOIN event_push_summary AS old USING (user_id, room_id, thread_id)
1628
+ WHERE ? < ea.stream_ordering AND ea.stream_ordering <= ?
1629
+ AND (
1630
+ old.last_receipt_stream_ordering IS NULL
1631
+ OR old.last_receipt_stream_ordering < ea.stream_ordering
1632
+ )
1633
+ AND %s = 1
1634
+ GROUP BY user_id, room_id, thread_id
1635
+ ) AS upd
1636
+ LEFT JOIN event_push_summary AS old USING (user_id, room_id, thread_id)
1637
+ """
1638
+
1639
+ # First get the count of unread messages.
1640
+ txn.execute(
1641
+ sql % ("unread_count", "unread"),
1642
+ (old_rotate_stream_ordering, rotate_to_stream_ordering),
1643
+ )
1644
+
1645
+ # We need to merge results from the two requests (the one that retrieves the
1646
+ # unread count and the one that retrieves the notifications count) into a single
1647
+ # object because we might not have the same amount of rows in each of them. To do
1648
+ # this, we use a dict indexed on the user ID and room ID to make it easier to
1649
+ # populate.
1650
+ summaries: dict[tuple[str, str, str], _EventPushSummary] = {}
1651
+ for row in txn:
1652
+ summaries[(row[0], row[1], row[2])] = _EventPushSummary(
1653
+ unread_count=row[3],
1654
+ stream_ordering=row[4],
1655
+ notif_count=0,
1656
+ )
1657
+
1658
+ # Then get the count of notifications.
1659
+ txn.execute(
1660
+ sql % ("notif_count", "notif"),
1661
+ (old_rotate_stream_ordering, rotate_to_stream_ordering),
1662
+ )
1663
+
1664
+ for row in txn:
1665
+ if (row[0], row[1], row[2]) in summaries:
1666
+ summaries[(row[0], row[1], row[2])].notif_count = row[3]
1667
+ else:
1668
+ # Because the rules on notifying are different than the rules on marking
1669
+ # a message unread, we might end up with messages that notify but aren't
1670
+ # marked unread, so we might not have a summary for this (user, room)
1671
+ # tuple to complete.
1672
+ summaries[(row[0], row[1], row[2])] = _EventPushSummary(
1673
+ unread_count=0,
1674
+ stream_ordering=row[4],
1675
+ notif_count=row[3],
1676
+ )
1677
+
1678
+ logger.info("Rotating notifications, handling %d rows", len(summaries))
1679
+
1680
+ self.db_pool.simple_upsert_many_txn(
1681
+ txn,
1682
+ table="event_push_summary",
1683
+ key_names=("user_id", "room_id", "thread_id"),
1684
+ key_values=list(summaries),
1685
+ value_names=("notif_count", "unread_count", "stream_ordering"),
1686
+ value_values=[
1687
+ (
1688
+ summary.notif_count,
1689
+ summary.unread_count,
1690
+ summary.stream_ordering,
1691
+ )
1692
+ for summary in summaries.values()
1693
+ ],
1694
+ )
1695
+
1696
+ txn.execute(
1697
+ "UPDATE event_push_summary_stream_ordering SET stream_ordering = ?",
1698
+ (rotate_to_stream_ordering,),
1699
+ )
1700
+
1701
+ async def _remove_old_push_actions_that_have_rotated(self) -> None:
1702
+ """
1703
+ Clear out old push actions that have been summarised (and are older than
1704
+ 1 day ago).
1705
+ """
1706
+
1707
+ # We want to clear out anything that is older than a day that *has* already
1708
+ # been rotated.
1709
+ rotated_upto_stream_ordering = await self.db_pool.simple_select_one_onecol(
1710
+ table="event_push_summary_stream_ordering",
1711
+ keyvalues={},
1712
+ retcol="stream_ordering",
1713
+ )
1714
+
1715
+ max_stream_ordering_to_delete = min(
1716
+ rotated_upto_stream_ordering, self.stream_ordering_day_ago
1717
+ )
1718
+
1719
+ def remove_old_push_actions_that_have_rotated_txn(
1720
+ txn: LoggingTransaction,
1721
+ ) -> bool:
1722
+ # We don't want to clear out too much at a time, so we bound our
1723
+ # deletes.
1724
+ batch_size = self._rotate_count
1725
+
1726
+ if isinstance(self.database_engine, PostgresEngine):
1727
+ # Temporarily disable sequential scans in this transaction. We
1728
+ # need to do this as the postgres statistics don't take into
1729
+ # account the `highlight = 0` part when estimating the
1730
+ # distribution of `stream_ordering`. I.e. since we keep old
1731
+ # highlight rows the query planner thinks there are way more old
1732
+ # rows to delete than there actually are.
1733
+ txn.execute("SET LOCAL enable_seqscan=off")
1734
+
1735
+ txn.execute(
1736
+ """
1737
+ SELECT stream_ordering FROM event_push_actions
1738
+ WHERE stream_ordering <= ? AND highlight = 0
1739
+ ORDER BY stream_ordering ASC LIMIT 1 OFFSET ?
1740
+ """,
1741
+ (
1742
+ max_stream_ordering_to_delete,
1743
+ batch_size,
1744
+ ),
1745
+ )
1746
+ stream_row = txn.fetchone()
1747
+
1748
+ if stream_row:
1749
+ (stream_ordering,) = stream_row
1750
+ else:
1751
+ stream_ordering = max_stream_ordering_to_delete
1752
+
1753
+ # We need to use a inclusive bound here to handle the case where a
1754
+ # single stream ordering has more than `batch_size` rows.
1755
+ txn.execute(
1756
+ """
1757
+ DELETE FROM event_push_actions
1758
+ WHERE stream_ordering <= ? AND highlight = 0
1759
+ """,
1760
+ (stream_ordering,),
1761
+ )
1762
+
1763
+ logger.info("Rotating notifications, deleted %s push actions", txn.rowcount)
1764
+
1765
+ return txn.rowcount < batch_size
1766
+
1767
+ while True:
1768
+ done = await self.db_pool.runInteraction(
1769
+ "_remove_old_push_actions_that_have_rotated",
1770
+ remove_old_push_actions_that_have_rotated_txn,
1771
+ )
1772
+ if done:
1773
+ break
1774
+
1775
+ @wrap_as_background_process("_clear_old_push_actions_staging")
1776
+ async def _clear_old_push_actions_staging(self) -> None:
1777
+ """Clear out any old event push actions from the staging table for
1778
+ events that we failed to persist.
1779
+ """
1780
+
1781
+ # We delete anything more than an hour old, on the assumption that we'll
1782
+ # never take more than an hour to persist an event.
1783
+ delete_before_ts = self.clock.time_msec() - 60 * 60 * 1000
1784
+
1785
+ if self._started_ts > delete_before_ts:
1786
+ # We need to wait for at least an hour before we started deleting,
1787
+ # so that we know it's safe to delete rows with NULL `inserted_ts`.
1788
+ return
1789
+
1790
+ # We don't have an index on `inserted_ts`, instead we assume that the
1791
+ # number of "live" rows in `event_push_actions_staging` is small enough
1792
+ # that an infrequent periodic scan won't cause a problem.
1793
+ #
1794
+ # Note: we also delete any columns with NULL `inserted_ts`, this is safe
1795
+ # as we added a default value to new rows and so they must be at least
1796
+ # an hour old.
1797
+ limit = 1000
1798
+ sql = """
1799
+ DELETE FROM event_push_actions_staging WHERE event_id IN (
1800
+ SELECT event_id FROM event_push_actions_staging WHERE
1801
+ inserted_ts < ? OR inserted_ts IS NULL
1802
+ LIMIT ?
1803
+ )
1804
+ """
1805
+
1806
+ def _clear_old_push_actions_staging_txn(txn: LoggingTransaction) -> bool:
1807
+ txn.execute(sql, (delete_before_ts, limit))
1808
+ return txn.rowcount >= limit
1809
+
1810
+ while True:
1811
+ # Returns true if we have more stuff to delete from the table.
1812
+ deleted = await self.db_pool.runInteraction(
1813
+ "_clear_old_push_actions_staging", _clear_old_push_actions_staging_txn
1814
+ )
1815
+
1816
+ if not deleted:
1817
+ return
1818
+
1819
+ # We sleep to ensure that we don't overwhelm the DB.
1820
+ await self.clock.sleep(1.0)
1821
+
1822
+ async def get_push_actions_for_user(
1823
+ self,
1824
+ user_id: str,
1825
+ before: int | None = None,
1826
+ limit: int = 50,
1827
+ only_highlight: bool = False,
1828
+ ) -> list[UserPushAction]:
1829
+ def f(
1830
+ txn: LoggingTransaction,
1831
+ ) -> list[tuple[str, str, int, int, str, bool, str, int]]:
1832
+ before_clause = ""
1833
+ if before:
1834
+ before_clause = "AND epa.stream_ordering < ?"
1835
+ args = [user_id, before, limit]
1836
+ else:
1837
+ args = [user_id, limit]
1838
+
1839
+ if only_highlight:
1840
+ if len(before_clause) > 0:
1841
+ before_clause += " "
1842
+ before_clause += "AND epa.highlight = 1"
1843
+
1844
+ # NB. This assumes event_ids are globally unique since
1845
+ # it makes the query easier to index
1846
+ sql = """
1847
+ SELECT epa.event_id, epa.room_id,
1848
+ epa.stream_ordering, epa.topological_ordering,
1849
+ epa.actions, epa.highlight, epa.profile_tag, e.received_ts
1850
+ FROM event_push_actions epa, events e
1851
+ WHERE epa.event_id = e.event_id
1852
+ AND epa.user_id = ? %s
1853
+ AND epa.notif = 1
1854
+ ORDER BY epa.stream_ordering DESC
1855
+ LIMIT ?
1856
+ """ % (before_clause,)
1857
+ txn.execute(sql, args)
1858
+ return cast(
1859
+ list[tuple[str, str, int, int, str, bool, str, int]], txn.fetchall()
1860
+ )
1861
+
1862
+ push_actions = await self.db_pool.runInteraction("get_push_actions_for_user", f)
1863
+ return [
1864
+ UserPushAction(
1865
+ event_id=row[0],
1866
+ room_id=row[1],
1867
+ stream_ordering=row[2],
1868
+ actions=_deserialize_action(row[4], row[5]),
1869
+ received_ts=row[7],
1870
+ topological_ordering=row[3],
1871
+ highlight=row[5],
1872
+ profile_tag=row[6],
1873
+ )
1874
+ for row in push_actions
1875
+ ]
1876
+
1877
+
1878
+ class EventPushActionsStore(EventPushActionsWorkerStore):
1879
+ EPA_HIGHLIGHT_INDEX = "epa_highlight_index"
1880
+
1881
+ def __init__(
1882
+ self,
1883
+ database: DatabasePool,
1884
+ db_conn: LoggingDatabaseConnection,
1885
+ hs: "HomeServer",
1886
+ ):
1887
+ super().__init__(database, db_conn, hs)
1888
+
1889
+ self.db_pool.updates.register_background_index_update(
1890
+ self.EPA_HIGHLIGHT_INDEX,
1891
+ index_name="event_push_actions_u_highlight",
1892
+ table="event_push_actions",
1893
+ columns=["user_id", "stream_ordering"],
1894
+ )
1895
+
1896
+ self.db_pool.updates.register_background_index_update(
1897
+ "event_push_actions_highlights_index",
1898
+ index_name="event_push_actions_highlights_index",
1899
+ table="event_push_actions",
1900
+ columns=["user_id", "room_id", "topological_ordering", "stream_ordering"],
1901
+ where_clause="highlight=1",
1902
+ )
1903
+
1904
+ # Add index to make deleting old push actions faster.
1905
+ self.db_pool.updates.register_background_index_update(
1906
+ "event_push_actions_stream_highlight_index",
1907
+ index_name="event_push_actions_stream_highlight_index",
1908
+ table="event_push_actions",
1909
+ columns=["highlight", "stream_ordering"],
1910
+ where_clause="highlight=0",
1911
+ )
1912
+
1913
+
1914
+ def _action_has_highlight(actions: Collection[Mapping | str]) -> bool:
1915
+ for action in actions:
1916
+ if not isinstance(action, dict):
1917
+ continue
1918
+
1919
+ if action.get("set_tweak", None) == "highlight":
1920
+ return action.get("value", True)
1921
+
1922
+ return False
1923
+
1924
+
1925
+ @attr.s(slots=True, auto_attribs=True)
1926
+ class _EventPushSummary:
1927
+ """Summary of pending event push actions for a given user in a given room.
1928
+ Used in _rotate_notifs_before_txn to manipulate results from event_push_actions.
1929
+ """
1930
+
1931
+ unread_count: int
1932
+ stream_ordering: int
1933
+ notif_count: int