multiverse/widgets/room_view/
timeline.rs1use 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 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::ProfileChange(_)
127 | TimelineItemContent::OtherState(_)
128 | TimelineItemContent::FailedToParseMessageLike { .. }
129 | TimelineItemContent::FailedToParseState { .. }
130 | TimelineItemContent::MsgLike(MsgLikeContent {
131 kind: MsgLikeKind::Poll(_), ..
132 })
133 | TimelineItemContent::CallInvite
134 | TimelineItemContent::RtcNotification => {
135 return None;
136 }
137 }
138 }
139
140 TimelineItemKind::Virtual(virt) => match virt {
141 VirtualTimelineItem::DateDivider(unix_ts) => format!("Date: {unix_ts:?}").into(),
142 VirtualTimelineItem::ReadMarker => "Read marker".to_owned().into(),
143 VirtualTimelineItem::TimelineStart => "🥳 Timeline start! 🥳".to_owned().into(),
144 },
145 };
146
147 Some(item)
148}
149
150fn format_text_message(
151 sender: &UserId,
152 message: &Message,
153 thread_summary: Option<ThreadSummary>,
154 read_receipts: &IndexMap<OwnedUserId, Receipt>,
155) -> Option<ListItem<'static>> {
156 if let MessageType::Text(text) = message.msgtype() {
157 let mut lines = Vec::new();
158 let first_line = Line::from(format!("{}: {}", sender, text.body));
159
160 lines.push(first_line);
161
162 if let Some(thread_summary) = thread_summary {
163 match thread_summary.latest_event {
164 TimelineDetails::Unavailable | TimelineDetails::Pending => {
165 let thread_line = Line::from(" 💬 ...");
166 lines.push(thread_line);
167 }
168 TimelineDetails::Ready(e) => {
169 let sender = e.sender;
170 let content = e.content.as_message().map(|m| m.msgtype());
171
172 if let Some(MessageType::Text(text)) = content {
173 let replies = if thread_summary.num_replies == 1 {
174 "1 reply".to_owned()
175 } else {
176 format!("{} replies", { thread_summary.num_replies })
177 };
178 let thread_line =
179 Line::from(format!(" 💬 {replies} {sender}: {}", text.body));
180
181 lines.push(thread_line);
182 }
183 }
184 TimelineDetails::Error(_) => {}
185 }
186 }
187
188 if !read_receipts.is_empty() {
189 let mut read_by = read_receipts
191 .iter()
192 .take(5)
193 .map(|(user_id, _)| user_id.as_str())
194 .collect::<Vec<_>>()
195 .join(", ");
196 if read_receipts.len() > 5 {
197 let others_count = read_receipts.len() - 5;
198 if others_count == 1 {
199 read_by.push_str(" and 1 other");
200 } else {
201 read_by = format!("{read_by} and {others_count} others");
202 }
203 }
204 lines.push(Line::from(format!(" 👀 read by {read_by}")));
205 }
206
207 Some(ListItem::from(lines))
208 } else {
209 None
210 }
211}
212
213fn format_membership_change(membership: &RoomMembershipChange) -> Option<ListItem<'static>> {
214 if let Some(change) = membership.change() {
215 let display_name =
216 membership.display_name().unwrap_or_else(|| membership.user_id().to_string());
217
218 let change = match change {
219 MembershipChange::Joined => "has joined the room",
220 MembershipChange::Left => "has left the room",
221 MembershipChange::Banned => "has been banned",
222 MembershipChange::Unbanned => "has been unbanned",
223 MembershipChange::Kicked => "has been kicked from the room",
224 MembershipChange::Invited => "has been invited to the room",
225 MembershipChange::KickedAndBanned => "has been kicked and banned from the room",
226 MembershipChange::InvitationAccepted => "has accepted the invitation to the room",
227 MembershipChange::InvitationRejected => "has rejected the invitation to the room",
228 MembershipChange::Knocked => "knocked on the room",
229 MembershipChange::KnockAccepted => "has accepted a knock on the room",
230 MembershipChange::KnockRetracted => "has retracted a knock on the room",
231 MembershipChange::KnockDenied => "has denied a knock",
232 MembershipChange::None
233 | MembershipChange::Error
234 | MembershipChange::InvitationRevoked
235 | MembershipChange::NotImplemented => "has changed its membership status",
236 };
237
238 Some(format!("{display_name} {change}").into())
239 } else {
240 None
241 }
242}