concord 2.2.1

A terminal user interface client for Discord
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
use std::{collections::HashSet, time::Instant};

use crate::discord::ids::marker::{GuildMarker, UserMarker};

use crate::discord::{
    AppCommand, AppEvent, DownloadAttachmentSource, ForumPostArchiveState, MentionInfo,
    MessageSnapshotInfo, VoiceConnectionStatus,
};
use crate::logging;

mod channels;
mod composer;
mod dashboard;
mod diagnostics;
mod discord_ui;
mod emoji;
mod guilds;
mod layout_cache;
mod member_grouping;
mod message_history_refresh;
mod message_layout;
mod message_render;
mod message_viewport;
mod model;
mod navigation;
mod options;
mod pane_filter;
mod popups;
mod presentation;
mod request_tracking;
mod runtime_state;
mod scroll;
mod subscriptions;
mod toast;
mod user;
mod voice_actions;

use composer::ComposerUiState;
use discord_ui::DiscordUiState;
use layout_cache::{LayoutCacheState, MessageRowContentMetrics, MessageRowContentMetricsCacheKey};
use message_history_refresh::MessageHistoryRefreshState;
use message_render::{add_literal_mention_highlights, normalize_text_highlights};
use message_viewport::{MessageViewportState, ThreadReturnTarget};
use navigation::{ActiveGuildScope, FolderKey, NavigationState};
use options::SettingsState;
use pane_filter::PaneFilterState;
use popups::{ModalPopup, PopupUiState};
use request_tracking::RequestTrackingState;
use runtime_state::{RuntimeUiState, ToastMessage, VoiceConnectionUiState};
use scroll::clamp_selected_index;

pub use composer::{
    CommandPickerEntry, EmojiPickerEntry, MAX_MENTION_PICKER_VISIBLE, MentionPickerEntry,
    MentionPickerTarget,
};
pub use dashboard::DashboardState;
pub use member_grouping::{MemberEntry, MemberGroup};
pub use message_viewport::MessagePaneSource;
pub use model::{
    AttachmentViewerItem, ChannelActionItem, ChannelPaneEntry, ChannelSearchSuggestionItem,
    ChannelSwitcherItem, ChannelThreadItem, EmojiReactionItem, FORUM_POST_CARD_HEIGHT, FocusPane,
    GuildActionItem, GuildPaneEntry, MemberActionItem, MemberSearchResultItem, MessageActionItem,
    MessageActionKind, MessageSearchResultItem, MuteActionDurationItem, PollVotePickerItem,
    SearchFieldView, SearchPopupMode, SearchPopupView, SearchResultItem, SearchSuggestionItem,
    ThreadMessagePreview, ThreadSummary,
};
pub use model::{ChannelActionKind, GuildActionKind, MemberActionKind, MessageUrlItem};
pub use options::DisplayOptionItem;
pub(in crate::tui) use popups::ActiveModalPopupKind;
pub use popups::{
    AttachmentViewerZoom, EmojiReactionPickerState, MessageActionMenuState, MessageUrlPickerState,
    PollVotePickerState, ReactionUsersPopupState, UserProfileSettingsField, UserProfileSettingsTab,
};
pub use presentation::{discord_color, folder_color, presence_color, presence_marker};

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum ToastKind {
    Success,
    Error,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct ToastView<'a> {
    pub text: &'a str,
    pub kind: ToastKind,
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub(crate) struct DesktopNotification {
    pub title: String,
    pub body: String,
}

fn message_notification_body(
    content: Option<&str>,
    sticker_count: usize,
    attachment_count: usize,
    embed_count: usize,
) -> String {
    let content = content.unwrap_or_default().trim();
    if !content.is_empty() {
        let single_line = content.split_whitespace().collect::<Vec<_>>().join(" ");
        return truncate_notification_text(&single_line, 200);
    }
    if attachment_count > 0 {
        return format!("sent {attachment_count} attachment(s)");
    }
    if sticker_count > 0 {
        return format!("sent {sticker_count} sticker(s)");
    }
    if embed_count > 0 {
        return format!("sent {embed_count} embed(s)");
    }
    "sent a message".to_owned()
}

fn truncate_notification_text(value: &str, max_chars: usize) -> String {
    let mut chars = value.chars();
    let truncated: String = chars.by_ref().take(max_chars).collect();
    if chars.next().is_some() {
        format!("{truncated}...")
    } else {
        truncated
    }
}

impl DashboardState {
    #[cfg(test)]
    pub fn push_event(&mut self, event: AppEvent) {
        self.push_event_inner(event, true);
    }

    pub fn push_effect(&mut self, event: AppEvent) {
        if let AppEvent::ChannelUpsert(channel) = &event {
            self.record_thread_channel_upserted(channel);
            return;
        }
        self.push_event_inner(event, false);
    }

    fn push_event_inner(&mut self, event: AppEvent, apply_discord: bool) {
        // Two layered behaviours run on every event:
        //
        // * Auto-scroll: when the user is already viewing the latest message
        //   (the bottom of the last message is visible in the viewport, even
        //   if the cursor is parked on an older one), keep the viewport
        //   tracking the latest after the event applies. The cursor is
        //   preserved by message id.
        // * Auto-follow: a superset of auto-scroll that also moves the
        //   cursor to the new latest message. Triggers only when the user
        //   was already following the latest message. Self-sent messages no longer force-follow.
        //   If the user is reading older history, sending a message keeps the
        //   viewport parked.
        //
        // Both modes share `message_auto_follow`. It means the next render
        // should align the viewport to the bottom. Auto-follow also jumps
        // the cursor.
        let was_auto_follow = self.messages.message_auto_follow;
        let was_at_latest = was_auto_follow || self.is_viewport_at_latest_message();
        let was_cursor_on_last = self.cursor_on_last_message();
        let was_following_cursor = was_at_latest && was_cursor_on_last;
        let user_just_sent = self.event_is_self_message_in_active_channel(&event);
        let active_new_message = self.active_channel_message_create(&event);
        let preserve_selection = !was_following_cursor;
        let preserve_scroll = !(was_at_latest || was_following_cursor);
        let selected_message_id = preserve_selection
            .then(|| {
                self.messages()
                    .get(self.selected_message())
                    .map(|message| message.id)
            })
            .flatten();
        let scroll_message_id = preserve_scroll
            .then(|| {
                self.messages()
                    .get(self.messages.message_scroll)
                    .map(|message| message.id)
            })
            .flatten();
        let mut channel_cursor_id = self.selected_channel_cursor_id();

        match &event {
            AppEvent::Ready { user, user_id } => {
                self.discord.current_user = Some(user.clone());
                self.discord.current_user_id = *user_id;
                self.runtime.gateway_error = None;
            }
            AppEvent::GatewayError { message } => {
                logging::error("tui", message);
                self.runtime.gateway_error = Some(message.clone());
                self.show_error_toast(message, Instant::now());
            }
            AppEvent::CurrentUserCapabilities { has_nitro } => {
                self.discord.current_user_has_nitro = Some(*has_nitro);
            }
            AppEvent::ApplicationCommandsLoaded { guild_id, commands } => {
                self.discord
                    .application_commands
                    .insert(*guild_id, commands.clone());
                self.refresh_active_mention_query();
            }
            AppEvent::AttachmentDownloadCompleted { path, source }
                if *source == DownloadAttachmentSource::AttachmentViewer =>
            {
                self.record_attachment_viewer_download_completed(path);
            }
            AppEvent::UpdateAvailable { latest_version } => {
                self.discord.update_available_version = Some(latest_version.clone());
            }
            AppEvent::ReactionUsersLoaded {
                channel_id,
                message_id,
                reactions,
            } => {
                self.popups.modal = Some(ModalPopup::ReactionUsers(ReactionUsersPopupState::new(
                    *channel_id,
                    *message_id,
                    reactions.clone(),
                )));
            }
            AppEvent::MessageHistoryLoadFailed { .. } => {}
            AppEvent::ForumPostsLoaded {
                channel_id,
                archive_state,
                offset,
                next_offset: _,
                threads,
                has_more,
                ..
            } => {
                self.record_forum_posts_loaded(
                    *channel_id,
                    *archive_state,
                    *offset,
                    threads,
                    *has_more,
                );
            }
            AppEvent::MessageSearchLoaded { .. } | AppEvent::MessageSearchLoadFailed { .. } => {
                self.record_search_event(&event);
            }
            AppEvent::MessageHistoryLoaded { .. }
            | AppEvent::MessageHistoryCatchUpLoaded { .. } => {}
            AppEvent::MessageHistoryRefreshed { channel_id, .. } => {
                self.record_message_history_refreshed(*channel_id);
            }
            AppEvent::UserProfileLoaded { guild_id, profile } => {
                self.record_user_profile_update_succeeded(profile.user_id, *guild_id);
            }
            AppEvent::UserProfileLoadFailed {
                user_id,
                guild_id,
                message,
            } => {
                if let Some(popup) = self.popups.user_profile_popup_mut()
                    && popup.user_id == *user_id
                    && popup.guild_id == *guild_id
                {
                    popup.load_error = Some(message.clone());
                    if popup.settings.saving {
                        popup.settings.saving = false;
                        popup.settings.status = Some(format!(
                            "Save succeeded, but profile reload failed: {message}"
                        ));
                    }
                }
            }
            AppEvent::UserProfileUpdateFailed {
                user_id,
                guild_id,
                message,
            } => {
                self.record_user_profile_update_failed(*user_id, *guild_id, message);
            }
            AppEvent::ActivateChannel { channel_id } => {
                let channel_id = *channel_id;
                let scope =
                    self.discord
                        .cache
                        .channel(channel_id)
                        .map(|channel| match channel.guild_id {
                            Some(guild_id) => ActiveGuildScope::Guild(guild_id),
                            None => ActiveGuildScope::DirectMessages,
                        });
                if let Some(scope) = scope {
                    self.activate_guild(scope);
                    self.activate_channel(channel_id);
                    self.navigation.channel_keep_selection_visible = true;
                    channel_cursor_id = Some(channel_id);
                }
            }
            AppEvent::VoiceConnectionStatusChanged {
                guild_id,
                channel_id,
                status,
                message,
            } => match status {
                VoiceConnectionStatus::Connecting => {
                    self.runtime.voice_connection = Some(VoiceConnectionUiState {
                        guild_id: *guild_id,
                        channel_id: *channel_id,
                    });
                    self.show_success_toast(
                        message.as_deref().unwrap_or("Voice join requested"),
                        Instant::now(),
                    );
                }
                VoiceConnectionStatus::Connected => {
                    self.runtime.voice_connection = Some(VoiceConnectionUiState {
                        guild_id: *guild_id,
                        channel_id: *channel_id,
                    });
                    self.show_success_toast(
                        message.as_deref().unwrap_or("Voice connected"),
                        Instant::now(),
                    );
                }
                VoiceConnectionStatus::Disconnected => {
                    if self
                        .runtime
                        .voice_connection
                        .is_some_and(|voice| voice.guild_id == *guild_id)
                    {
                        self.runtime.voice_connection = None;
                    }
                    self.show_success_toast(
                        message.as_deref().unwrap_or("Voice leave requested"),
                        Instant::now(),
                    );
                }
                VoiceConnectionStatus::Failed => {
                    if self
                        .runtime
                        .voice_connection
                        .is_some_and(|voice| voice.guild_id == *guild_id)
                    {
                        self.runtime.voice_connection = None;
                    }
                    self.show_error_toast(
                        message.as_deref().unwrap_or("Voice request failed"),
                        Instant::now(),
                    );
                }
            },
            AppEvent::ChannelUpsert(channel) => {
                self.record_thread_channel_upserted(channel);
            }
            _ => {}
        }
        if apply_discord {
            let discord_event = self.discord_event_for_apply(&event);
            self.discord.cache.apply_event(&discord_event);
            if Self::event_affects_message_row_content_metrics(&discord_event) {
                self.clear_message_row_content_metrics_cache();
            }
        }
        if matches!(
            &event,
            AppEvent::CurrentUserCapabilities { .. } | AppEvent::GuildEmojisUpdate { .. }
        ) {
            self.refresh_composer_emoji_candidates_for_current_query();
        }
        self.clamp_active_selection();
        self.restore_channel_cursor(channel_cursor_id);
        self.clamp_selection_indices();
        self.clear_missing_new_messages_marker();
        let in_message_view = self.message_pane_supports_auto_follow();
        let should_follow = was_following_cursor && in_message_view;
        let should_scroll = should_follow || (was_at_latest && in_message_view);
        if should_follow {
            self.follow_latest_message();
        } else {
            self.restore_message_position(selected_message_id, scroll_message_id);
        }
        if should_scroll {
            // Keep the bottom-align intent across to the next render so
            // `clamp_message_viewport_for_image_previews` snaps to the new
            // last message even when only the viewport (not the cursor)
            // moves.
            self.messages.message_auto_follow = true;
            self.clear_new_messages_marker();
            if let Some((channel_id, _)) = active_new_message {
                if user_just_sent {
                    self.messages.unread_divider_last_acked_id = None;
                    self.messages.pending_unread_anchor_scroll = false;
                } else {
                    self.schedule_channel_ack(channel_id);
                }
            }
        } else if in_message_view
            && !was_at_latest
            && !user_just_sent
            && self.messages.new_messages_marker_message_id.is_none()
        {
            self.messages.new_messages_marker_message_id =
                active_new_message.map(|(_, message_id)| message_id);
        }
        if let AppEvent::MessageHistoryAroundLoaded {
            channel_id,
            message_id,
            ..
        } = &event
        {
            self.select_loaded_referenced_message(*channel_id, *message_id);
        }
        self.clamp_list_viewports();
        self.clamp_message_viewport();
        if !should_scroll {
            self.refresh_message_auto_follow();
        }
    }
}

#[cfg(test)]
mod tests;