ruma_events/room/
redaction.rs

Help
1//! Types for the [`m.room.redaction`] event.
2//!
3//! [`m.room.redaction`]: https://spec.matrix.org/latest/client-server-api/#mroomredaction
4
5use as_variant::as_variant;
6use js_int::Int;
7#[cfg(feature = "canonical-json")]
8use ruma_common::canonical_json::RedactionEvent;
9use ruma_common::{
10    room_version_rules::RedactionRules, serde::CanBeEmpty, EventId, MilliSecondsSinceUnixEpoch,
11    OwnedEventId, OwnedRoomId, OwnedTransactionId, OwnedUserId, RoomId, RoomVersionId, UserId,
12};
13use ruma_macros::{Event, EventContent};
14use serde::{Deserialize, Serialize};
15use tracing::error;
16
17use crate::{
18    BundledMessageLikeRelations, EventContent, MessageLikeEventType, RedactContent,
19    RedactedMessageLikeEventContent, RedactedUnsigned, StaticEventContent,
20};
21
22mod event_serde;
23
24/// A possibly-redacted redaction event.
25#[allow(clippy::exhaustive_enums)]
26#[derive(Clone, Debug)]
27pub enum RoomRedactionEvent {
28    /// Original, unredacted form of the event.
29    Original(OriginalRoomRedactionEvent),
30
31    /// Redacted form of the event with minimal fields.
32    Redacted(RedactedRoomRedactionEvent),
33}
34
35/// A possibly-redacted redaction event without a `room_id`.
36#[allow(clippy::exhaustive_enums)]
37#[derive(Clone, Debug)]
38pub enum SyncRoomRedactionEvent {
39    /// Original, unredacted form of the event.
40    Original(OriginalSyncRoomRedactionEvent),
41
42    /// Redacted form of the event with minimal fields.
43    Redacted(RedactedSyncRoomRedactionEvent),
44}
45
46/// Redaction event.
47#[derive(Clone, Debug)]
48#[allow(clippy::exhaustive_structs)]
49pub struct OriginalRoomRedactionEvent {
50    /// Data specific to the event type.
51    pub content: RoomRedactionEventContent,
52
53    /// The ID of the event that was redacted.
54    ///
55    /// This field is required in room versions prior to 11.
56    pub redacts: Option<OwnedEventId>,
57
58    /// The globally unique event identifier for the user who sent the event.
59    pub event_id: OwnedEventId,
60
61    /// The fully-qualified ID of the user who sent this event.
62    pub sender: OwnedUserId,
63
64    /// Timestamp in milliseconds on originating homeserver when this event was sent.
65    pub origin_server_ts: MilliSecondsSinceUnixEpoch,
66
67    /// The ID of the room associated with this event.
68    pub room_id: OwnedRoomId,
69
70    /// Additional key-value pairs not signed by the homeserver.
71    pub unsigned: RoomRedactionUnsigned,
72}
73
74impl From<OriginalRoomRedactionEvent> for OriginalSyncRoomRedactionEvent {
75    fn from(value: OriginalRoomRedactionEvent) -> Self {
76        let OriginalRoomRedactionEvent {
77            content,
78            redacts,
79            event_id,
80            sender,
81            origin_server_ts,
82            unsigned,
83            ..
84        } = value;
85
86        Self { content, redacts, event_id, sender, origin_server_ts, unsigned }
87    }
88}
89
90/// Redacted redaction event.
91#[derive(Clone, Debug, Event)]
92#[allow(clippy::exhaustive_structs)]
93pub struct RedactedRoomRedactionEvent {
94    /// Data specific to the event type.
95    pub content: RedactedRoomRedactionEventContent,
96
97    /// The globally unique event identifier for the user who sent the event.
98    pub event_id: OwnedEventId,
99
100    /// The fully-qualified ID of the user who sent this event.
101    pub sender: OwnedUserId,
102
103    /// Timestamp in milliseconds on originating homeserver when this event was sent.
104    pub origin_server_ts: MilliSecondsSinceUnixEpoch,
105
106    /// The ID of the room associated with this event.
107    pub room_id: OwnedRoomId,
108
109    /// Additional key-value pairs not signed by the homeserver.
110    pub unsigned: RedactedUnsigned,
111}
112
113/// Redaction event without a `room_id`.
114#[derive(Clone, Debug)]
115#[allow(clippy::exhaustive_structs)]
116pub struct OriginalSyncRoomRedactionEvent {
117    /// Data specific to the event type.
118    pub content: RoomRedactionEventContent,
119
120    /// The ID of the event that was redacted.
121    ///
122    /// This field is required in room versions prior to 11.
123    pub redacts: Option<OwnedEventId>,
124
125    /// The globally unique event identifier for the user who sent the event.
126    pub event_id: OwnedEventId,
127
128    /// The fully-qualified ID of the user who sent this event.
129    pub sender: OwnedUserId,
130
131    /// Timestamp in milliseconds on originating homeserver when this event was sent.
132    pub origin_server_ts: MilliSecondsSinceUnixEpoch,
133
134    /// Additional key-value pairs not signed by the homeserver.
135    pub unsigned: RoomRedactionUnsigned,
136}
137
138impl OriginalSyncRoomRedactionEvent {
139    /// Convert this sync event into a full event, one with a `room_id` field.
140    pub fn into_full_event(self, room_id: OwnedRoomId) -> OriginalRoomRedactionEvent {
141        let Self { content, redacts, event_id, sender, origin_server_ts, unsigned } = self;
142
143        OriginalRoomRedactionEvent {
144            content,
145            redacts,
146            event_id,
147            sender,
148            origin_server_ts,
149            room_id,
150            unsigned,
151        }
152    }
153
154    pub(crate) fn into_maybe_redacted(self) -> SyncRoomRedactionEvent {
155        SyncRoomRedactionEvent::Original(self)
156    }
157}
158
159/// Redacted redaction event without a `room_id`.
160#[derive(Clone, Debug, Event)]
161#[allow(clippy::exhaustive_structs)]
162pub struct RedactedSyncRoomRedactionEvent {
163    /// Data specific to the event type.
164    pub content: RedactedRoomRedactionEventContent,
165
166    /// The globally unique event identifier for the user who sent the event.
167    pub event_id: OwnedEventId,
168
169    /// The fully-qualified ID of the user who sent this event.
170    pub sender: OwnedUserId,
171
172    /// Timestamp in milliseconds on originating homeserver when this event was sent.
173    pub origin_server_ts: MilliSecondsSinceUnixEpoch,
174
175    /// Additional key-value pairs not signed by the homeserver.
176    pub unsigned: RedactedUnsigned,
177}
178
179/// A redaction of an event.
180#[derive(Clone, Debug, Default, Deserialize, Serialize, EventContent)]
181#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
182#[ruma_event(type = "m.room.redaction", kind = MessageLike, custom_redacted)]
183pub struct RoomRedactionEventContent {
184    /// The ID of the event that was redacted.
185    ///
186    /// This field is required starting from room version 11.
187    #[serde(skip_serializing_if = "Option::is_none")]
188    pub redacts: Option<OwnedEventId>,
189
190    /// The reason for the redaction, if any.
191    #[serde(skip_serializing_if = "Option::is_none")]
192    pub reason: Option<String>,
193}
194
195impl RoomRedactionEventContent {
196    /// Creates an empty `RoomRedactionEventContent` according to room versions 1 through 10.
197    pub fn new_v1() -> Self {
198        Self::default()
199    }
200
201    /// Creates a `RoomRedactionEventContent` with the required `redacts` field introduced in room
202    /// version 11.
203    pub fn new_v11(redacts: OwnedEventId) -> Self {
204        Self { redacts: Some(redacts), ..Default::default() }
205    }
206
207    /// Add the given reason to this `RoomRedactionEventContent`.
208    pub fn with_reason(mut self, reason: String) -> Self {
209        self.reason = Some(reason);
210        self
211    }
212}
213
214impl RedactContent for RoomRedactionEventContent {
215    type Redacted = RedactedRoomRedactionEventContent;
216
217    fn redact(self, rules: &RedactionRules) -> Self::Redacted {
218        let redacts = self.redacts.filter(|_| rules.keep_room_redaction_redacts);
219        RedactedRoomRedactionEventContent { redacts }
220    }
221}
222
223/// A redacted redaction event.
224#[derive(Clone, Debug, Default, Deserialize, Serialize)]
225#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
226pub struct RedactedRoomRedactionEventContent {
227    /// The ID of the event that was redacted.
228    ///
229    /// This field is required starting from room version 11.
230    #[serde(skip_serializing_if = "Option::is_none")]
231    pub redacts: Option<OwnedEventId>,
232}
233
234impl EventContent for RedactedRoomRedactionEventContent {
235    type EventType = MessageLikeEventType;
236
237    fn event_type(&self) -> Self::EventType {
238        MessageLikeEventType::RoomRedaction
239    }
240}
241
242impl StaticEventContent for RedactedRoomRedactionEventContent {
243    const TYPE: &'static str = "m.room.redaction";
244}
245
246impl RedactedMessageLikeEventContent for RedactedRoomRedactionEventContent {}
247
248impl RoomRedactionEvent {
249    /// Returns the `type` of this event.
250    pub fn event_type(&self) -> MessageLikeEventType {
251        match self {
252            Self::Original(ev) => ev.content.event_type(),
253            Self::Redacted(ev) => ev.content.event_type(),
254        }
255    }
256
257    /// Returns this event's `event_id` field.
258    pub fn event_id(&self) -> &EventId {
259        match self {
260            Self::Original(ev) => &ev.event_id,
261            Self::Redacted(ev) => &ev.event_id,
262        }
263    }
264
265    /// Returns this event's `sender` field.
266    pub fn sender(&self) -> &UserId {
267        match self {
268            Self::Original(ev) => &ev.sender,
269            Self::Redacted(ev) => &ev.sender,
270        }
271    }
272
273    /// Returns this event's `origin_server_ts` field.
274    pub fn origin_server_ts(&self) -> MilliSecondsSinceUnixEpoch {
275        match self {
276            Self::Original(ev) => ev.origin_server_ts,
277            Self::Redacted(ev) => ev.origin_server_ts,
278        }
279    }
280
281    /// Returns this event's `room_id` field.
282    pub fn room_id(&self) -> &RoomId {
283        match self {
284            Self::Original(ev) => &ev.room_id,
285            Self::Redacted(ev) => &ev.room_id,
286        }
287    }
288
289    /// Returns the ID of the event that this event redacts, according to the given room version.
290    ///
291    /// # Panics
292    ///
293    /// Panics if this is a non-redacted event and both `redacts` field are `None`, which is only
294    /// possible if the event was modified after being deserialized.
295    pub fn redacts(&self, room_version: &RoomVersionId) -> Option<&EventId> {
296        match self {
297            Self::Original(ev) => Some(ev.redacts(room_version)),
298            Self::Redacted(ev) => ev.content.redacts.as_deref(),
299        }
300    }
301
302    /// Get the inner `RoomRedactionEvent` if this is an unredacted event.
303    pub fn as_original(&self) -> Option<&OriginalRoomRedactionEvent> {
304        as_variant!(self, Self::Original)
305    }
306}
307
308impl SyncRoomRedactionEvent {
309    /// Returns the `type` of this event.
310    pub fn event_type(&self) -> MessageLikeEventType {
311        match self {
312            Self::Original(ev) => ev.content.event_type(),
313            Self::Redacted(ev) => ev.content.event_type(),
314        }
315    }
316
317    /// Returns this event's `event_id` field.
318    pub fn event_id(&self) -> &EventId {
319        match self {
320            Self::Original(ev) => &ev.event_id,
321            Self::Redacted(ev) => &ev.event_id,
322        }
323    }
324
325    /// Returns this event's `sender` field.
326    pub fn sender(&self) -> &UserId {
327        match self {
328            Self::Original(ev) => &ev.sender,
329            Self::Redacted(ev) => &ev.sender,
330        }
331    }
332
333    /// Returns this event's `origin_server_ts` field.
334    pub fn origin_server_ts(&self) -> MilliSecondsSinceUnixEpoch {
335        match self {
336            Self::Original(ev) => ev.origin_server_ts,
337            Self::Redacted(ev) => ev.origin_server_ts,
338        }
339    }
340
341    /// Returns the ID of the event that this event redacts, according to the given room version.
342    ///
343    /// # Panics
344    ///
345    /// Panics if this is a non-redacted event and both `redacts` field are `None`, which is only
346    /// possible if the event was modified after being deserialized.
347    pub fn redacts(&self, room_version: &RoomVersionId) -> Option<&EventId> {
348        match self {
349            Self::Original(ev) => Some(ev.redacts(room_version)),
350            Self::Redacted(ev) => ev.content.redacts.as_deref(),
351        }
352    }
353
354    /// Get the inner `SyncRoomRedactionEvent` if this is an unredacted event.
355    pub fn as_original(&self) -> Option<&OriginalSyncRoomRedactionEvent> {
356        as_variant!(self, Self::Original)
357    }
358
359    /// Convert this sync event into a full event (one with a `room_id` field).
360    pub fn into_full_event(self, room_id: OwnedRoomId) -> RoomRedactionEvent {
361        match self {
362            Self::Original(ev) => RoomRedactionEvent::Original(ev.into_full_event(room_id)),
363            Self::Redacted(ev) => RoomRedactionEvent::Redacted(ev.into_full_event(room_id)),
364        }
365    }
366}
367
368impl From<RoomRedactionEvent> for SyncRoomRedactionEvent {
369    fn from(full: RoomRedactionEvent) -> Self {
370        match full {
371            RoomRedactionEvent::Original(ev) => Self::Original(ev.into()),
372            RoomRedactionEvent::Redacted(ev) => Self::Redacted(ev.into()),
373        }
374    }
375}
376
377impl OriginalRoomRedactionEvent {
378    /// Returns the ID of the event that this event redacts, according to the proper `redacts` field
379    /// for the given room version.
380    ///
381    /// If the `redacts` field is not the proper one for the given room version, this falls back to
382    /// the one that is available.
383    ///
384    /// # Panics
385    ///
386    /// Panics if both `redacts` field are `None`, which is only possible if the event was modified
387    /// after being deserialized.
388    pub fn redacts(&self, room_version: &RoomVersionId) -> &EventId {
389        redacts(room_version, self.redacts.as_deref(), self.content.redacts.as_deref())
390    }
391}
392
393impl OriginalSyncRoomRedactionEvent {
394    /// Returns the ID of the event that this event redacts, according to the proper `redacts` field
395    /// for the given room version.
396    ///
397    /// If the `redacts` field is not the proper one for the given room version, this falls back to
398    /// the one that is available.
399    ///
400    /// # Panics
401    ///
402    /// Panics if both `redacts` field are `None`, which is only possible if the event was modified
403    /// after being deserialized.
404    pub fn redacts(&self, room_version: &RoomVersionId) -> &EventId {
405        redacts(room_version, self.redacts.as_deref(), self.content.redacts.as_deref())
406    }
407}
408
409#[cfg(feature = "canonical-json")]
410impl RedactionEvent for OriginalRoomRedactionEvent {}
411#[cfg(feature = "canonical-json")]
412impl RedactionEvent for OriginalSyncRoomRedactionEvent {}
413#[cfg(feature = "canonical-json")]
414impl RedactionEvent for RoomRedactionEvent {}
415#[cfg(feature = "canonical-json")]
416impl RedactionEvent for SyncRoomRedactionEvent {}
417
418/// Extra information about a redaction that is not incorporated into the event's hash.
419#[derive(Clone, Debug, Deserialize)]
420#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
421pub struct RoomRedactionUnsigned {
422    /// The time in milliseconds that has elapsed since the event was sent.
423    ///
424    /// This field is generated by the local homeserver, and may be incorrect if the local time on
425    /// at least one of the two servers is out of sync, which can cause the age to either be
426    /// negative or greater than it actually is.
427    pub age: Option<Int>,
428
429    /// The client-supplied transaction ID, if the client being given the event is the same one
430    /// which sent it.
431    pub transaction_id: Option<OwnedTransactionId>,
432
433    /// [Bundled aggregations] of related child events.
434    ///
435    /// [Bundled aggregations]: https://spec.matrix.org/latest/client-server-api/#aggregations-of-child-events
436    #[serde(rename = "m.relations", default)]
437    pub relations: BundledMessageLikeRelations<OriginalSyncRoomRedactionEvent>,
438}
439
440impl RoomRedactionUnsigned {
441    /// Create a new `Unsigned` with fields set to `None`.
442    pub fn new() -> Self {
443        Self { age: None, transaction_id: None, relations: BundledMessageLikeRelations::default() }
444    }
445}
446
447impl Default for RoomRedactionUnsigned {
448    fn default() -> Self {
449        Self::new()
450    }
451}
452
453impl CanBeEmpty for RoomRedactionUnsigned {
454    /// Whether this unsigned data is empty (all fields are `None`).
455    ///
456    /// This method is used to determine whether to skip serializing the `unsigned` field in room
457    /// events. Do not use it to determine whether an incoming `unsigned` field was present - it
458    /// could still have been present but contained none of the known fields.
459    fn is_empty(&self) -> bool {
460        self.age.is_none() && self.transaction_id.is_none() && self.relations.is_empty()
461    }
462}
463
464/// Returns the value of the proper `redacts` field for the given room version.
465///
466/// If the `redacts` field is not the proper one for the given room version, this falls back to
467/// the one that is available.
468///
469/// # Panics
470///
471/// Panics if both `redacts` and `content_redacts` are `None`.
472fn redacts<'a>(
473    room_version: &'_ RoomVersionId,
474    redacts: Option<&'a EventId>,
475    content_redacts: Option<&'a EventId>,
476) -> &'a EventId {
477    match room_version {
478            RoomVersionId::V1
479            | RoomVersionId::V2
480            | RoomVersionId::V3
481            | RoomVersionId::V4
482            | RoomVersionId::V5
483            | RoomVersionId::V6
484            | RoomVersionId::V7
485            | RoomVersionId::V8
486            | RoomVersionId::V9
487            | RoomVersionId::V10 => redacts
488                .or_else(|| {
489                    error!("Redacts field at event level not available, falling back to the one inside content");
490                    content_redacts
491        })
492                .expect("At least one redacts field is set"),
493            _ => content_redacts
494                .or_else(|| {
495                    error!("Redacts field inside content not available, falling back to the one at the event level");
496                    redacts
497        })
498                .expect("At least one redacts field is set"),
499        }
500}
ruma_events/room/redaction.rs

ruma_events/room/
redaction.rs
