Skip to main content

tuwunel_service/rooms/timeline/
purge.rs

1//! Selectively removes historical accepted events from a room timeline.
2//!
3//! Purging preserves state events and leaves forward-extremity mappings
4//! untouched while coordinating deletion from search, relation, and
5//! redaction-retention indexes. Selection follows room stream order rather
6//! than graph depth.
7
8use futures::TryStreamExt;
9use ruma::{RoomId, api::Direction, events::TimelineEventType};
10use tuwunel_core::{Result, implement, trace, utils::stream::TryReadyExt};
11use tuwunel_matrix::{
12	Event,
13	pdu::{PduCount, PduEvent},
14};
15
16use super::{ExtractBody, RawPduId, bias_count};
17
18/// Purges eligible room history strictly before a timeline count.
19///
20/// State events are preserved, and locally sent events remain unless
21/// `delete_local_events` is set. Forward extremities are untouched, while
22/// search, relation, and retained-original data are removed for each deleted
23/// event; an error can stop the operation after partial progress.
24#[implement(super::Service)]
25pub async fn purge_history(
26	&self,
27	room_id: &RoomId,
28	until: PduCount,
29	delete_local_events: bool,
30) -> Result<usize> {
31	let shortroomid = self
32		.services
33		.short
34		.get_shortroomid(room_id)
35		.await?;
36
37	let start = self
38		.count_to_id(room_id, PduCount::min(), Direction::Forward)
39		.await?;
40
41	let prefix = start.shortroomid();
42
43	self.db
44		.pduid_pdu
45		.raw_stream_from(&start)
46		.ready_try_take_while(move |kv| {
47			let (key, _) = *kv;
48			Ok(key.starts_with(&prefix) && RawPduId::from(key).pdu_count() < until)
49		})
50		.try_fold(0_usize, async |purged, (key, value)| {
51			let pdu = serde_json::from_slice::<PduEvent>(value)?;
52
53			if pdu.state_key.is_some()
54				|| (!delete_local_events && self.services.globals.user_is_local(&pdu.sender))
55			{
56				return Ok(purged);
57			}
58
59			let mut txn = self.db.db.txn();
60
61			let raw_id = RawPduId::from(key);
62			let count = raw_id.pdu_count();
63			let event_id = pdu.event_id.clone();
64			let ts: u64 = pdu.origin_server_ts.into();
65
66			txn.del_raw(&self.db.pduid_pdu, key);
67			txn.del_raw(&self.db.eventid_pduid, &event_id);
68			txn.del_raw(&self.db.eventid_outlierpdu, &event_id);
69
70			let room_id_ts_id = (room_id, ts, bias_count(raw_id.count()));
71			txn.del(&self.db.roomid_tscount_pducount, room_id_ts_id);
72
73			txn.execute();
74
75			if pdu.kind == TimelineEventType::RoomMessage
76				&& let Ok(ExtractBody { body: Some(body) }) = pdu.get_content()
77			{
78				self.services
79					.search
80					.deindex_pdu(shortroomid, &raw_id, &body);
81			}
82
83			self.services
84				.pdu_metadata
85				.purge_event_relations(shortroomid, count, room_id, &event_id)
86				.await;
87
88			self.services.retention.purge_original(&event_id);
89
90			trace!(?event_id, ?room_id, "Purged");
91
92			Ok(purged.saturating_add(1))
93		})
94		.await
95}