matrix_sdk_ui/timeline/event_item/content/
reply.rs

1// Copyright 2024 The Matrix.org Foundation C.I.C.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::sync::Arc;
16
17use imbl::Vector;
18use matrix_sdk::deserialized_responses::TimelineEvent;
19use ruma::{OwnedEventId, OwnedUserId};
20use tracing::{debug, instrument, warn};
21
22use super::TimelineItemContent;
23use crate::timeline::{
24    controller::TimelineMetadata,
25    event_handler::TimelineAction,
26    event_item::{EventTimelineItem, Profile, TimelineDetails},
27    traits::RoomDataProvider,
28    Error as TimelineError, TimelineItem,
29};
30
31/// Details about an event being replied to.
32#[derive(Clone, Debug)]
33pub struct InReplyToDetails {
34    /// The ID of the event.
35    pub event_id: OwnedEventId,
36
37    /// The details of the event.
38    ///
39    /// Use [`Timeline::fetch_details_for_event`] to fetch the data if it is
40    /// unavailable.
41    ///
42    /// [`Timeline::fetch_details_for_event`]: crate::Timeline::fetch_details_for_event
43    pub event: TimelineDetails<Box<EmbeddedEvent>>,
44}
45
46impl InReplyToDetails {
47    pub fn new(
48        event_id: OwnedEventId,
49        timeline_items: &Vector<Arc<TimelineItem>>,
50    ) -> InReplyToDetails {
51        let event = timeline_items
52            .iter()
53            .filter_map(|it| it.as_event())
54            .find(|it| it.event_id() == Some(&*event_id))
55            .map(|item| Box::new(EmbeddedEvent::from_timeline_item(item)));
56
57        InReplyToDetails { event_id, event: TimelineDetails::from_initial_value(event) }
58    }
59}
60
61/// An event that is embedded in another event, such as a replied-to event, or a
62/// thread latest event.
63#[derive(Clone, Debug)]
64pub struct EmbeddedEvent {
65    /// The content of the embedded item.
66    pub content: TimelineItemContent,
67    /// The user ID of the sender of the related embedded event.
68    pub sender: OwnedUserId,
69    /// The profile of the sender of the related embedded event.
70    pub sender_profile: TimelineDetails<Profile>,
71}
72
73impl EmbeddedEvent {
74    /// Create a [`EmbeddedEvent`] from a loaded event timeline item.
75    pub fn from_timeline_item(timeline_item: &EventTimelineItem) -> Self {
76        Self {
77            content: timeline_item.content.clone(),
78            sender: timeline_item.sender.clone(),
79            sender_profile: timeline_item.sender_profile.clone(),
80        }
81    }
82
83    #[instrument(skip_all)]
84    pub(in crate::timeline) async fn try_from_timeline_event<P: RoomDataProvider>(
85        timeline_event: TimelineEvent,
86        room_data_provider: &P,
87        meta: &TimelineMetadata,
88    ) -> Result<Option<Self>, TimelineError> {
89        let (raw_event, unable_to_decrypt_info) = match timeline_event.kind {
90            matrix_sdk::deserialized_responses::TimelineEventKind::UnableToDecrypt {
91                utd_info,
92                event,
93            } => (event, Some(utd_info)),
94            _ => (timeline_event.kind.into_raw(), None),
95        };
96
97        let event = match raw_event.deserialize() {
98            Ok(event) => event,
99            Err(err) => {
100                warn!("can't get details, event couldn't be deserialized: {err}");
101                return Err(TimelineError::UnsupportedEvent);
102            }
103        };
104
105        debug!(event_type = %event.event_type(), "got deserialized event");
106
107        // We don't need to fill relation information or process metadata for an
108        // embedded reply.
109        let in_reply_to = None;
110        let thread_root = None;
111        let thread_summary = None;
112
113        let sender = event.sender().to_owned();
114        let action = TimelineAction::from_event(
115            event,
116            &raw_event,
117            room_data_provider,
118            unable_to_decrypt_info,
119            meta,
120            in_reply_to,
121            thread_root,
122            thread_summary,
123        )
124        .await;
125
126        let Some(TimelineAction::AddItem { content }) = action else {
127            // The event can't be represented as a standalone timeline item.
128            return Ok(None);
129        };
130
131        let sender_profile = TimelineDetails::from_initial_value(
132            room_data_provider.profile_from_user_id(&sender).await,
133        );
134
135        Ok(Some(Self { content, sender, sender_profile }))
136    }
137}
matrix_sdk_ui/timeline/event_item/content/reply.rs

matrix_sdk_ui/timeline/event_item/content/
reply.rs
