multiverse/widgets/room_view/
timeline.rs

1use std::sync::Arc;
2
3use imbl::Vector;
4use indexmap::IndexMap;
5use matrix_sdk::ruma::{
6    OwnedUserId, UserId,
7    events::{receipt::Receipt, room::message::MessageType},
8};
9use matrix_sdk_ui::timeline::{
10    MembershipChange, Message, MsgLikeContent, MsgLikeKind, RoomMembershipChange, ThreadSummary,
11    TimelineDetails, TimelineItem, TimelineItemContent, TimelineItemKind, VirtualTimelineItem,
12};
13use ratatui::{prelude::*, widgets::*};
14
15use crate::{ALT_ROW_COLOR, NORMAL_ROW_COLOR, SELECTED_STYLE_FG, TEXT_COLOR};
16
17pub struct TimelineView<'a> {
18    items: &'a Vector<Arc<TimelineItem>>,
19    is_thread: bool,
20}
21
22impl<'a> TimelineView<'a> {
23    pub fn new(items: &'a Vector<Arc<TimelineItem>>, is_thread: bool) -> Self {
24        Self { items, is_thread }
25    }
26}
27
28pub struct TimelineListState {
29    state: ListState,
30    /// An index from a rendered list item to the original timeline item index
31    /// (since some timeline items may not be rendered).
32    list_index_to_item_index: Vec<usize>,
33}
34
35impl Default for TimelineListState {
36    fn default() -> Self {
37        let mut state = ListState::default();
38        state.select_last();
39        Self { state, list_index_to_item_index: Vec::default() }
40    }
41}
42
43impl TimelineListState {
44    pub fn select_next(&mut self) {
45        self.state.select_next();
46    }
47    pub fn select_previous(&mut self) {
48        self.state.select_previous();
49    }
50    pub fn unselect(&mut self) {
51        self.state.select(None);
52    }
53    pub fn selected(&self) -> Option<usize> {
54        let rendered_index = self.state.selected()?;
55        self.list_index_to_item_index.get(rendered_index).copied()
56    }
57}
58
59impl StatefulWidget for &mut TimelineView<'_> {
60    type State = TimelineListState;
61
62    fn render(self, area: Rect, buf: &mut Buffer, timeline_list_state: &mut Self::State)
63    where
64        Self: Sized,
65    {
66        timeline_list_state.list_index_to_item_index.clear();
67
68        let content = self.items.iter().enumerate().filter_map(|(i, item)| {
69            let result = format_timeline_item(item, self.is_thread)?;
70            timeline_list_state.list_index_to_item_index.push(i);
71            Some(result)
72        });
73
74        let list_items = content
75            .enumerate()
76            .map(|(i, line)| {
77                let bg_color = match i % 2 {
78                    0 => NORMAL_ROW_COLOR,
79                    _ => ALT_ROW_COLOR,
80                };
81
82                line.fg(TEXT_COLOR).bg(bg_color)
83            })
84            .collect::<Vec<_>>();
85
86        let list = List::new(list_items)
87            .highlight_spacing(HighlightSpacing::Always)
88            .highlight_symbol(">")
89            .highlight_style(SELECTED_STYLE_FG);
90
91        StatefulWidget::render(list, area, buf, &mut timeline_list_state.state);
92    }
93}
94
95fn format_timeline_item(item: &Arc<TimelineItem>, is_thread: bool) -> Option<ListItem<'_>> {
96    let item = match item.kind() {
97        TimelineItemKind::Event(ev) => {
98            let sender = ev.sender();
99
100            match ev.content() {
101                TimelineItemContent::MsgLike(MsgLikeContent {
102                    kind: MsgLikeKind::Message(message),
103                    ..
104                }) => {
105                    let thread_summary =
106                        if is_thread { None } else { ev.content().thread_summary() };
107                    format_text_message(sender, message, thread_summary, ev.read_receipts())?
108                }
109
110                TimelineItemContent::MsgLike(MsgLikeContent {
111                    kind: MsgLikeKind::Redacted,
112                    ..
113                }) => format!("{sender}: -- redacted --").into(),
114
115                TimelineItemContent::MsgLike(MsgLikeContent {
116                    kind: MsgLikeKind::UnableToDecrypt(_),
117                    ..
118                }) => format!("{sender}: (UTD)").into(),
119
120                TimelineItemContent::MembershipChange(m) => format_membership_change(m)?,
121
122                TimelineItemContent::MsgLike(MsgLikeContent {
123                    kind: MsgLikeKind::Sticker(_),
124                    ..
125                })
126                | TimelineItemContent::MsgLike(MsgLikeContent {
127                    kind: MsgLikeKind::Other(_),
128                    ..
129                })
130                | TimelineItemContent::ProfileChange(_)
131                | TimelineItemContent::OtherState(_)
132                | TimelineItemContent::FailedToParseMessageLike { .. }
133                | TimelineItemContent::FailedToParseState { .. }
134                | TimelineItemContent::MsgLike(MsgLikeContent {
135                    kind: MsgLikeKind::Poll(_), ..
136                })
137                | TimelineItemContent::CallInvite
138                | TimelineItemContent::RtcNotification => {
139                    return None;
140                }
141            }
142        }
143
144        TimelineItemKind::Virtual(virt) => match virt {
145            VirtualTimelineItem::DateDivider(unix_ts) => format!("Date: {unix_ts:?}").into(),
146            VirtualTimelineItem::ReadMarker => "Read marker".to_owned().into(),
147            VirtualTimelineItem::TimelineStart => "🥳 Timeline start! 🥳".to_owned().into(),
148        },
149    };
150
151    Some(item)
152}
153
154fn format_text_message(
155    sender: &UserId,
156    message: &Message,
157    thread_summary: Option<ThreadSummary>,
158    read_receipts: &IndexMap<OwnedUserId, Receipt>,
159) -> Option<ListItem<'static>> {
160    if let MessageType::Text(text) = message.msgtype() {
161        let mut lines = Vec::new();
162        let first_line = Line::from(format!("{}: {}", sender, text.body));
163
164        lines.push(first_line);
165
166        if let Some(thread_summary) = thread_summary {
167            match thread_summary.latest_event {
168                TimelineDetails::Unavailable | TimelineDetails::Pending => {
169                    let thread_line = Line::from("  💬 ...");
170                    lines.push(thread_line);
171                }
172                TimelineDetails::Ready(e) => {
173                    let sender = e.sender;
174                    let content = e.content.as_message().map(|m| m.msgtype());
175
176                    if let Some(MessageType::Text(text)) = content {
177                        let replies = if thread_summary.num_replies == 1 {
178                            "1 reply".to_owned()
179                        } else {
180                            format!("{} replies", { thread_summary.num_replies })
181                        };
182                        let thread_line =
183                            Line::from(format!("  💬 {replies} {sender}: {}", text.body));
184
185                        lines.push(thread_line);
186                    }
187                }
188                TimelineDetails::Error(_) => {}
189            }
190        }
191
192        if !read_receipts.is_empty() {
193            // Read by [5 first users who read it], optionally followed by "and X others".
194            let mut read_by = read_receipts
195                .iter()
196                .take(5)
197                .map(|(user_id, _)| user_id.as_str())
198                .collect::<Vec<_>>()
199                .join(", ");
200            if read_receipts.len() > 5 {
201                let others_count = read_receipts.len() - 5;
202                if others_count == 1 {
203                    read_by.push_str(" and 1 other");
204                } else {
205                    read_by = format!("{read_by} and {others_count} others");
206                }
207            }
208            lines.push(Line::from(format!("  👀 read by {read_by}")));
209        }
210
211        Some(ListItem::from(lines))
212    } else {
213        None
214    }
215}
216
217fn format_membership_change(membership: &RoomMembershipChange) -> Option<ListItem<'static>> {
218    if let Some(change) = membership.change() {
219        let display_name =
220            membership.display_name().unwrap_or_else(|| membership.user_id().to_string());
221
222        let change = match change {
223            MembershipChange::Joined => "has joined the room",
224            MembershipChange::Left => "has left the room",
225            MembershipChange::Banned => "has been banned",
226            MembershipChange::Unbanned => "has been unbanned",
227            MembershipChange::Kicked => "has been kicked from the room",
228            MembershipChange::Invited => "has been invited to the room",
229            MembershipChange::KickedAndBanned => "has been kicked and banned from the room",
230            MembershipChange::InvitationAccepted => "has accepted the invitation to the room",
231            MembershipChange::InvitationRejected => "has rejected the invitation to the room",
232            MembershipChange::Knocked => "knocked on the room",
233            MembershipChange::KnockAccepted => "has accepted a knock on the room",
234            MembershipChange::KnockRetracted => "has retracted a knock on the room",
235            MembershipChange::KnockDenied => "has denied a knock",
236            MembershipChange::None
237            | MembershipChange::Error
238            | MembershipChange::InvitationRevoked
239            | MembershipChange::NotImplemented => "has changed its membership status",
240        };
241
242        Some(format!("{display_name} {change}").into())
243    } else {
244        None
245    }
246}
multiverse/widgets/room_view/timeline.rs

multiverse/widgets/room_view/
timeline.rs
