Skip to main content

multiverse/
main.rs

1#![allow(clippy::large_enum_variant)]
2
3use std::{
4    collections::{HashMap, HashSet},
5    io::{self, Write, stdout},
6    path::{Path, PathBuf},
7    sync::Arc,
8    time::{Duration, Instant},
9};
10
11use clap::Parser;
12use color_eyre::Result;
13use crossterm::{
14    event::{
15        self, DisableMouseCapture, EnableMouseCapture, Event, KeyCode, KeyEvent, KeyModifiers,
16    },
17    execute,
18};
19use futures_util::{StreamExt as _, pin_mut};
20use imbl::Vector;
21use layout::Flex;
22use matrix_sdk::{
23    AuthSession, Client, Room, SqliteCryptoStore, SqliteEventCacheStore, SqliteStateStore,
24    ThreadingSupport,
25    authentication::matrix::MatrixSession,
26    config::StoreConfig,
27    deserialized_responses::TimelineEvent,
28    encryption::{BackupDownloadStrategy, EncryptionSettings},
29    reqwest::Url,
30    ruma::{
31        OwnedEventId, OwnedRoomId, api::client::room::create_room::v3::Request as CreateRoomRequest,
32    },
33    search_index::{SearchIndexGuard, SearchIndexStoreKind},
34};
35use matrix_sdk_base::{RoomStateFilter, event_cache::store::EventCacheStoreLockGuard};
36use matrix_sdk_common::{cross_process_lock::CrossProcessLockConfig, locks::Mutex};
37use matrix_sdk_ui::{
38    Timeline as SdkTimeline,
39    room_list_service::{self, State, filters::new_filter_non_left},
40    sync_service::SyncService,
41    timeline::{RoomExt as _, TimelineFocus, TimelineItem},
42};
43use ratatui::{prelude::*, style::palette::tailwind, widgets::*};
44use throbber_widgets_tui::{Throbber, ThrobberState};
45use tokio::{
46    spawn,
47    sync::mpsc::{Receiver, Sender, channel, error::TryRecvError},
48    task::JoinHandle,
49    time::timeout,
50};
51use tracing::{debug, error, warn};
52use tracing_subscriber::EnvFilter;
53use widgets::{
54    recovery::create_centered_throbber_area, room_view::RoomView, settings::SettingsView,
55};
56
57use crate::widgets::{
58    create_room::CreateRoomView,
59    help::HelpView,
60    room_list::{ExtraRoomInfo, RoomInfos, RoomList, Rooms},
61    search::{
62        indexing::{IndexingMessage, IndexingView},
63        searching::SearchingView,
64    },
65    status::Status,
66};
67
68mod widgets;
69
70const HEADER_BG: Color = tailwind::BLUE.c950;
71const NORMAL_ROW_COLOR: Color = tailwind::SLATE.c950;
72const ALT_ROW_COLOR: Color = tailwind::SLATE.c900;
73const SELECTED_STYLE_FG: Color = tailwind::BLUE.c300;
74const TEXT_COLOR: Color = tailwind::SLATE.c200;
75
76type Timelines = Arc<Mutex<HashMap<OwnedRoomId, Timeline>>>;
77
78#[derive(Debug, Parser)]
79struct Cli {
80    /// The homeserver the client should connect to.
81    server_name: String,
82
83    /// The path where session specific data should be stored.
84    #[clap(default_value = "/tmp/")]
85    session_path: PathBuf,
86
87    /// Set the proxy that should be used for the connection.
88    #[clap(short, long, env = "PROXY")]
89    proxy: Option<Url>,
90
91    /// Whether to *not* reload the `pos`ition sliding sync token from disk at
92    /// start or not, for the room list sliding sync.
93    ///
94    /// Set to false by default (i.e. reload the position from disk).
95    #[clap(short, long, default_value_t = false)]
96    dont_share_pos: bool,
97}
98
99#[derive(Default)]
100pub enum GlobalMode {
101    /// The default mode, no popout screen is opened.
102    #[default]
103    Default,
104    /// Mode where we have opened the help screen.
105    Help,
106    /// Mode where we have opened the settings screen.
107    Settings { view: SettingsView },
108    /// Mode where we are shutting our tasks down and exiting multiverse.
109    Exiting { shutdown_task: JoinHandle<()> },
110    /// Mode where we have opened the create room screen
111    CreateRoom { view: CreateRoomView },
112    /// Mode where we have opened the search screen
113    Searching { view: SearchingView },
114    /// Mode where we have opened the indexing screen
115    Indexing { view: IndexingView },
116}
117
118/// Helper function to create a centered rect using up certain percentage of the
119/// available rect `r`
120fn popup_area(area: Rect, percent_x: u16, percent_y: u16) -> Rect {
121    let vertical = Layout::vertical([Constraint::Percentage(percent_y)]).flex(Flex::Center);
122    let horizontal = Layout::horizontal([Constraint::Percentage(percent_x)]).flex(Flex::Center);
123    let [area] = vertical.areas(area);
124    let [area] = horizontal.areas(area);
125    area
126}
127
128#[tokio::main]
129async fn main() -> Result<()> {
130    let cli = Cli::parse();
131    let file_writer = tracing_appender::rolling::hourly(&cli.session_path, "logs-");
132
133    tracing_subscriber::fmt()
134        .with_env_filter(EnvFilter::from_default_env())
135        .with_ansi(false)
136        .with_writer(file_writer)
137        .init();
138
139    color_eyre::install()?;
140
141    let share_pos = !cli.dont_share_pos;
142    let client = configure_client(cli).await?;
143
144    // Watch for errors in background jobs.
145    spawn({
146        let client = client.clone();
147        async move {
148            let mut recv = client.task_monitor().subscribe();
149            while let Ok(report) = recv.recv().await {
150                error!(name = report.task.name, ?report.reason, "A background task has crashed!");
151            }
152        }
153    });
154
155    let event_cache = client.event_cache();
156    event_cache.config_mut().experimental_auto_backpagination = true;
157    event_cache.subscribe()?;
158
159    let terminal = ratatui::init();
160    execute!(stdout(), EnableMouseCapture)?;
161    let mut app = App::new(client, share_pos).await?;
162
163    app.run(terminal).await
164}
165
166pub struct Timeline {
167    timeline: Arc<SdkTimeline>,
168    items: Arc<Mutex<Vector<Arc<TimelineItem>>>>,
169    task: JoinHandle<()>,
170}
171
172#[derive(Default)]
173pub struct AppState {
174    /// What popup are we showing that is covering the majority of the screen,
175    /// mainly used for help and settings screens.
176    global_mode: GlobalMode,
177
178    /// State for a global throbber.
179    throbber_state: ThrobberState,
180}
181
182struct App {
183    /// Reference to the main SDK client.
184    client: Client,
185
186    /// The sync service used for synchronizing events.
187    sync_service: Arc<SyncService>,
188
189    /// Timelines data structures for each room.
190    timelines: Timelines,
191
192    /// The room list widget on the left-hand side of the screen.
193    room_list: RoomList,
194
195    /// A view displaying the contents of the selected room, the widget on the
196    /// right-hand side of the screen.
197    room_view: RoomView,
198
199    /// Task listening to room list service changes, and spawning timelines.
200    listen_task: JoinHandle<()>,
201
202    /// Task that is indexing events for search.
203    indexing_task: JoinHandle<()>,
204
205    /// Receiver that notifies when indexing is complete.
206    indexing_receiver: Receiver<(bool, IndexingMessage)>,
207
208    /// The status widget at the bottom of the screen.
209    status: Status,
210
211    state: AppState,
212
213    last_tick: Instant,
214}
215
216impl App {
217    const TICK_RATE: Duration = Duration::from_millis(250);
218
219    async fn new(client: Client, share_pos: bool) -> Result<Self> {
220        let sync_service =
221            Arc::new(SyncService::builder(client.clone()).with_share_pos(share_pos).build().await?);
222
223        let rooms = Rooms::default();
224        let room_infos = RoomInfos::default();
225        let timelines = Timelines::default();
226
227        let room_list_service = sync_service.room_list_service();
228        let all_rooms = room_list_service.all_rooms().await?;
229
230        let listen_task = spawn(Self::listen_task(
231            rooms.clone(),
232            room_infos.clone(),
233            timelines.clone(),
234            all_rooms,
235        ));
236
237        // This will sync (with encryption) until an error happens or the program is
238        // stopped.
239        sync_service.start().await;
240
241        let status = Status::new();
242        let room_list =
243            RoomList::new(client.clone(), rooms, room_infos, sync_service.clone(), status.handle());
244
245        let room_view = RoomView::new(client.clone(), timelines.clone(), status.handle());
246
247        let (indexing_sender, indexing_receiver) = channel::<(bool, IndexingMessage)>(1024);
248        let indexing_task =
249            spawn(App::indexing_task(client.clone(), indexing_sender, sync_service.clone()));
250
251        let indexing_view = IndexingView::new();
252
253        Ok(Self {
254            sync_service,
255            timelines,
256            room_list,
257            room_view,
258            client,
259            listen_task,
260            indexing_task,
261            indexing_receiver,
262            status,
263            state: AppState {
264                global_mode: GlobalMode::Indexing { view: indexing_view },
265                ..Default::default()
266            },
267            last_tick: Instant::now(),
268        })
269    }
270
271    async fn listen_task(
272        rooms: Rooms,
273        room_infos: RoomInfos,
274        timelines: Timelines,
275        all_rooms: room_list_service::RoomList,
276    ) {
277        let (stream, entries_controller) = all_rooms.entries_with_dynamic_adapters(50_000);
278        entries_controller.set_filter(Box::new(new_filter_non_left()));
279
280        pin_mut!(stream);
281
282        let mut previous_rooms = HashSet::new();
283
284        while let Some(diffs) = stream.next().await {
285            let all_rooms = {
286                // Apply the diffs to the list of room entries.
287                let mut rooms = rooms.lock();
288
289                for diff in diffs {
290                    diff.apply(&mut rooms);
291                }
292
293                // Collect rooms early to release the room entries list lock.
294                (*rooms).clone()
295            };
296
297            let mut new_rooms = HashMap::new();
298            let mut new_timelines = Vec::new();
299
300            // Update all the room info for all rooms.
301            for room in all_rooms.iter() {
302                let raw_name = room.name();
303                let display_name =
304                    room.cached_display_name().map(|display_name| display_name.to_string());
305                let is_dm = room
306                    .is_direct()
307                    .await
308                    .map_err(|err| {
309                        warn!("couldn't figure whether a room is a DM or not: {err}");
310                    })
311                    .ok();
312                room_infos.lock().insert(
313                    room.room_id().to_owned(),
314                    ExtraRoomInfo { raw_name, display_name, is_dm },
315                );
316            }
317
318            // Initialize all the new rooms.
319            for room in
320                all_rooms.into_iter().filter(|room| !previous_rooms.contains(room.room_id()))
321            {
322                // Initialize the timeline.
323                let Ok(timeline) = room
324                    .timeline_builder()
325                    .with_focus(TimelineFocus::Live { hide_threaded_events: true })
326                    .build()
327                    .await
328                else {
329                    error!("error when creating default timeline");
330                    continue;
331                };
332
333                // Save the timeline in the cache.
334                let (items, stream) = timeline.subscribe().await;
335                let items = Arc::new(Mutex::new(items));
336
337                // Spawn a timeline task that will listen to all the timeline item changes.
338                let i = items.clone();
339                let timeline_task = spawn(async move {
340                    pin_mut!(stream);
341                    let items = i;
342                    while let Some(diffs) = stream.next().await {
343                        let mut items = items.lock();
344
345                        for diff in diffs {
346                            diff.apply(&mut items);
347                        }
348                    }
349                });
350
351                new_timelines.push((
352                    room.room_id().to_owned(),
353                    Timeline { timeline: Arc::new(timeline), items, task: timeline_task },
354                ));
355
356                // Save the room list service room in the cache.
357                new_rooms.insert(room.room_id().to_owned(), room);
358            }
359
360            previous_rooms.extend(new_rooms.into_keys());
361
362            timelines.lock().extend(new_timelines);
363        }
364    }
365
366    async fn wait_for_room_sync(
367        update_sender: &Sender<(bool, IndexingMessage)>,
368        sync_service: Arc<SyncService>,
369    ) {
370        let mut sync_subscriber = sync_service.room_list_service().state();
371
372        // Spin until there are rooms to index
373        while let Some(state) = sync_subscriber.next().await {
374            match state {
375                State::Running => return,
376                State::Terminated { from: _prev } => {
377                    while let Err(e) =
378                        update_sender.send((true, IndexingMessage::Progress(0))).await
379                    {
380                        debug!("Failed to send final message, trying again: {e:?}");
381                    }
382                    return;
383                }
384                _ => {
385                    debug!("Sync service not running. Waiting to start indexing. {state:?}");
386                }
387            }
388        }
389    }
390
391    async fn index_event_cache(
392        client: &Client,
393        update_sender: &Sender<(bool, IndexingMessage)>,
394        store: &EventCacheStoreLockGuard,
395        search_index_guard: &mut SearchIndexGuard<'_>,
396        mut count: usize,
397    ) -> Result<usize, ()> {
398        for room in client.rooms_filtered(RoomStateFilter::JOINED.union(RoomStateFilter::LEFT)) {
399            let room_id = room.room_id();
400
401            let maybe_room_cache = room.event_cache().await;
402            let Ok((room_cache, _drop_handles)) = maybe_room_cache else {
403                warn!("Failed to get RoomEventCache: {maybe_room_cache:?}");
404                continue;
405            };
406
407            let redaction_rules = room.clone_info().room_version_rules_or_default().redaction;
408
409            let maybe_timeline_events = store.get_room_events(room_id, None, None).await;
410            let Ok(timeline_events) = maybe_timeline_events else {
411                warn!("Failed to get room's events: {maybe_timeline_events:?}");
412                continue;
413            };
414
415            let no_of_events = timeline_events.len();
416
417            if let Err(err) = search_index_guard
418                .bulk_handle_timeline_event(
419                    timeline_events.clone().into_iter(),
420                    &room_cache,
421                    room_id,
422                    &redaction_rules,
423                )
424                .await
425            {
426                error!("Failed to handle event for indexing: {err}");
427                let mut error = Some(err);
428                while let Some(err) = error.take() {
429                    if let Err(e) =
430                        update_sender.send((true, IndexingMessage::Error(err.to_string()))).await
431                    {
432                        debug!("Failed to send final error message, trying again: {e:?}");
433                    }
434                }
435                return Err(());
436            }
437
438            count += no_of_events;
439            let _ = update_sender.send((false, IndexingMessage::Progress(count))).await;
440        }
441        Ok(count)
442    }
443
444    async fn index_from_server(
445        client: &Client,
446        update_sender: &Sender<(bool, IndexingMessage)>,
447        search_index_guard: &mut SearchIndexGuard<'_>,
448        mut count: usize,
449    ) -> Result<usize, ()> {
450        let batch_size = 25;
451
452        let mut rooms = client.rooms_filtered(RoomStateFilter::JOINED);
453        let mut idx = 0;
454
455        while !rooms.is_empty() {
456            let room = &rooms[idx];
457
458            let room_id = room.room_id();
459
460            let maybe_room_cache = room.event_cache().await;
461            let Ok((room_cache, _drop_handles)) = maybe_room_cache else {
462                warn!("Failed to get RoomEventCache: {maybe_room_cache:?}");
463                idx = (idx + 1) % rooms.len();
464                continue;
465            };
466
467            let redaction_rules = room.clone_info().room_version_rules_or_default().redaction;
468
469            let Ok(pagination) = room_cache.pagination().run_backwards_until(batch_size).await
470            else {
471                error!("Failed to backpaginate {room_id}");
472                idx = (idx + 1) % rooms.len();
473                continue;
474            };
475
476            let no_of_events = pagination.events.len();
477
478            if let Err(err) = search_index_guard
479                .bulk_handle_timeline_event(
480                    pagination.events.clone().into_iter(),
481                    &room_cache,
482                    room_id,
483                    &redaction_rules,
484                )
485                .await
486            {
487                warn!("Failed to handle event for indexing: {err}");
488                let mut error = Some(err);
489                while let Some(err) = error.take() {
490                    if let Err(e) =
491                        update_sender.send((true, IndexingMessage::Error(err.to_string()))).await
492                    {
493                        debug!("Failed to send final error message, trying again: {e:?}");
494                    }
495                }
496                return Err(());
497            }
498
499            count += no_of_events;
500            let _ = update_sender.send((false, IndexingMessage::Progress(count))).await;
501
502            if pagination.reached_start {
503                rooms.remove(idx);
504                let len = rooms.len();
505                if len > 0 {
506                    idx %= len;
507                }
508            } else {
509                idx = (idx + 1) % rooms.len();
510            }
511        }
512        Ok(count)
513    }
514
515    /// The sender sends (progress, done?, error?).
516    async fn indexing_task(
517        client: Client,
518        update_sender: Sender<(bool, IndexingMessage)>,
519        sync_service: Arc<SyncService>,
520    ) {
521        if timeout(Duration::from_secs(30), App::wait_for_room_sync(&update_sender, sync_service))
522            .await
523            .is_err()
524        {
525            debug!("Waiting for sync to run timed out. Quitting indexing task.");
526            return;
527        }
528
529        let Ok(store) = client.event_cache_store().lock().await else {
530            error!("Failed to get EventCacheStore");
531            return;
532        };
533
534        let mut search_index_guard = client.search_index().lock().await;
535        let count = 0;
536
537        debug!("Start indexing from the event cache.");
538
539        // First index everything in the cache
540        let Ok(count) = App::index_event_cache(
541            &client,
542            &update_sender,
543            store.as_clean().expect("Only one process should access the event cache store"),
544            &mut search_index_guard,
545            count,
546        )
547        .await
548        else {
549            debug!("Quitting index task.");
550            return;
551        };
552
553        // Now index from the server
554        debug!("Start indexing from the server.");
555
556        let Ok(count) =
557            App::index_from_server(&client, &update_sender, &mut search_index_guard, count).await
558        else {
559            debug!("Quitting index task.");
560            return;
561        };
562
563        while let Err(err) = update_sender.send((true, IndexingMessage::Progress(count))).await {
564            debug!("couldn't send final update {err}, trying again.");
565        }
566    }
567
568    fn set_global_mode(&mut self, mode: GlobalMode) {
569        self.state.global_mode = mode;
570    }
571
572    async fn handle_global_event(&mut self, event: Event) -> Result<bool> {
573        use KeyCode::*;
574
575        match event {
576            Event::Key(KeyEvent { code: F(1), modifiers: KeyModifiers::NONE, .. }) => {
577                self.set_global_mode(GlobalMode::Help)
578            }
579
580            Event::Key(KeyEvent { code: F(10), modifiers: KeyModifiers::NONE, .. }) => self
581                .set_global_mode(GlobalMode::Settings {
582                    view: SettingsView::new(self.client.clone(), self.sync_service.clone()),
583                }),
584
585            Event::Key(KeyEvent {
586                code: Char('j') | Down,
587                modifiers: KeyModifiers::CONTROL,
588                ..
589            }) => {
590                self.room_list.next_room().await;
591                let room_id = self.room_list.get_selected_room_id();
592                self.room_view.set_selected_room(room_id);
593            }
594
595            Event::Key(KeyEvent {
596                code: Char('k') | Up, modifiers: KeyModifiers::CONTROL, ..
597            }) => {
598                self.room_list.previous_room().await;
599                let room_id = self.room_list.get_selected_room_id();
600                self.room_view.set_selected_room(room_id);
601            }
602
603            Event::Key(KeyEvent { code: Char('m'), modifiers: KeyModifiers::ALT, .. }) => {
604                self.room_view.mark_as_read().await
605            }
606
607            Event::Key(KeyEvent { code: Char('q'), modifiers: KeyModifiers::CONTROL, .. }) => {
608                if !matches!(self.state.global_mode, GlobalMode::Default) {
609                    self.set_global_mode(GlobalMode::Default);
610                } else {
611                    return Ok(true);
612                }
613            }
614
615            Event::Key(KeyEvent { modifiers: KeyModifiers::CONTROL, code: Char('r'), .. }) => {
616                self.set_global_mode(GlobalMode::CreateRoom { view: CreateRoomView::new() })
617            }
618
619            Event::Key(KeyEvent { modifiers: KeyModifiers::CONTROL, code: Char('s'), .. }) => {
620                self.set_global_mode(GlobalMode::Searching { view: SearchingView::new() })
621            }
622
623            _ => self.room_view.handle_event(event).await,
624        }
625
626        Ok(false)
627    }
628
629    fn on_tick(&mut self) {
630        self.state.throbber_state.calc_next();
631
632        match &mut self.state.global_mode {
633            GlobalMode::Help
634            | GlobalMode::Default
635            | GlobalMode::CreateRoom { .. }
636            | GlobalMode::Searching { .. }
637            | GlobalMode::Exiting { .. } => {}
638            GlobalMode::Settings { view } => {
639                view.on_tick();
640            }
641            GlobalMode::Indexing { view } => {
642                view.on_tick();
643            }
644        }
645    }
646
647    async fn render_loop(&mut self, mut terminal: Terminal<impl Backend>) -> Result<()> {
648        use KeyCode::*;
649
650        let mut check_channel = true;
651
652        loop {
653            if check_channel {
654                match self.indexing_receiver.try_recv() {
655                    Ok((done, message)) => {
656                        if !matches!(message, IndexingMessage::Error(_)) && done {
657                            self.set_global_mode(GlobalMode::Default);
658                        } else if let GlobalMode::Indexing { view } = &mut self.state.global_mode {
659                            view.set_message(message);
660                        }
661                    }
662                    Err(TryRecvError::Disconnected) => check_channel = false,
663                    Err(TryRecvError::Empty) => {}
664                }
665            }
666
667            terminal.draw(|f| f.render_widget(&mut *self, f.area()))?;
668
669            if event::poll(Duration::from_millis(100))? {
670                let event = event::read()?;
671
672                match &mut self.state.global_mode {
673                    GlobalMode::Default => {
674                        if self.handle_global_event(event).await? {
675                            let sync_service = self.sync_service.clone();
676                            let timelines = self.timelines.clone();
677                            let listen_task = self.listen_task.abort_handle();
678                            let indexing_task = self.indexing_task.abort_handle();
679
680                            let shutdown_task = spawn(async move {
681                                sync_service.stop().await;
682
683                                listen_task.abort();
684                                indexing_task.abort();
685
686                                for timeline in timelines.lock().values() {
687                                    timeline.task.abort();
688                                }
689                            });
690
691                            self.set_global_mode(GlobalMode::Exiting { shutdown_task });
692                        }
693                    }
694                    GlobalMode::Help => {
695                        if let Event::Key(key) = event
696                            && let KeyModifiers::NONE = key.modifiers
697                            && let Char('q') | Esc = key.code
698                        {
699                            self.set_global_mode(GlobalMode::Default)
700                        }
701                    }
702                    GlobalMode::Settings { view } => {
703                        if let Event::Key(key) = event
704                            && view.handle_key_press(key).await
705                        {
706                            self.set_global_mode(GlobalMode::Default);
707                        }
708                    }
709                    GlobalMode::CreateRoom { view } => {
710                        if let Event::Key(key) = event
711                            && let KeyModifiers::NONE = key.modifiers
712                        {
713                            match key.code {
714                                Enter => {
715                                    if let Some(room_name) = view.get_text() {
716                                        let mut request = CreateRoomRequest::new();
717                                        request.name = Some(room_name);
718                                        if let Err(err) = self
719                                            .sync_service
720                                            .room_list_service()
721                                            .client()
722                                            .create_room(request)
723                                            .await
724                                        {
725                                            error!("error while creating room: {err:?}");
726                                        }
727                                    }
728                                    self.set_global_mode(GlobalMode::Default);
729                                }
730                                Esc => self.set_global_mode(GlobalMode::Default),
731                                _ => view.handle_key_press(key),
732                            }
733                        }
734                    }
735                    GlobalMode::Searching { view } => {
736                        if let Event::Key(key) = event {
737                            match key.code {
738                                Enter => {
739                                    if let Some(query) = view.get_text() {
740                                        if let Some(room) = self.room_view.room() {
741                                            if let Ok(results) =
742                                                room.search(&query, 100, None).await.inspect_err(|err| {
743                                                    error!("error occurred while searching index: {err:?}");
744                                                })
745                                            {
746                                                let results = get_events_from_event_ids(
747                                                    &room,
748                                                    results,
749                                                )
750                                                .await;
751
752                                                view.results(results);
753                                            }
754                                        } else {
755                                            warn!("No room in view.")
756                                        }
757                                    }
758                                }
759                                Esc => self.set_global_mode(GlobalMode::Default),
760                                Up => view.list_state.previous(),
761                                Down => view.list_state.next(),
762                                _ => view.handle_key_press(key),
763                            }
764                        }
765                    }
766                    GlobalMode::Indexing { .. } => {
767                        if let Event::Key(key) = event
768                            && let KeyModifiers::NONE = key.modifiers
769                            && let Esc = key.code
770                        {
771                            self.indexing_task.abort();
772                            self.set_global_mode(GlobalMode::Default);
773                        }
774                    }
775                    GlobalMode::Exiting { .. } => {}
776                }
777            }
778
779            match &self.state.global_mode {
780                GlobalMode::Default
781                | GlobalMode::Help
782                | GlobalMode::CreateRoom { .. }
783                | GlobalMode::Searching { .. }
784                | GlobalMode::Indexing { .. }
785                | GlobalMode::Settings { .. } => {}
786                GlobalMode::Exiting { shutdown_task } => {
787                    if shutdown_task.is_finished() {
788                        break;
789                    }
790                }
791            }
792
793            if self.last_tick.elapsed() >= Self::TICK_RATE {
794                self.on_tick();
795                self.last_tick = Instant::now();
796            }
797        }
798
799        Ok(())
800    }
801
802    async fn run(&mut self, terminal: Terminal<impl Backend>) -> Result<()> {
803        self.render_loop(terminal).await?;
804
805        // At this point the user has exited the loop, so shut down the application.
806        ratatui::restore();
807        execute!(stdout(), DisableMouseCapture)?;
808
809        Ok(())
810    }
811}
812
813impl Widget for &mut App {
814    /// Render the whole app.
815    fn render(self, area: Rect, buf: &mut Buffer) {
816        // Create a space for header, room list and timeline and the footer.
817        let vertical =
818            Layout::vertical([Constraint::Length(2), Constraint::Min(0), Constraint::Length(1)]);
819        let [header_area, rest_area, status_area] = vertical.areas(area);
820
821        // Create two chunks with equal horizontal screen space. One for the list and
822        // the other for the info block.
823        let horizontal =
824            Layout::horizontal([Constraint::Percentage(25), Constraint::Percentage(75)]);
825        let [room_list_area, room_view_area] = horizontal.areas(rest_area);
826
827        self.render_title(header_area, buf);
828        self.room_list.render(room_list_area, buf);
829        self.room_view.render(room_view_area, buf);
830        self.status.render(status_area, buf, &mut self.state);
831
832        match &mut self.state.global_mode {
833            GlobalMode::Default => {}
834            GlobalMode::Exiting { .. } => {
835                Clear.render(rest_area, buf);
836                let centered = create_centered_throbber_area(area);
837                let throbber = Throbber::default()
838                    .label("Exiting")
839                    .throbber_set(throbber_widgets_tui::BRAILLE_EIGHT_DOUBLE);
840                StatefulWidget::render(throbber, centered, buf, &mut self.state.throbber_state);
841            }
842            GlobalMode::Settings { view } => {
843                view.render(area, buf);
844            }
845            GlobalMode::Help => {
846                let mut help_view = HelpView::new();
847                help_view.render(area, buf);
848            }
849            GlobalMode::CreateRoom { view } => {
850                view.render(area, buf);
851            }
852            GlobalMode::Searching { view } => {
853                view.render(room_view_area, buf);
854            }
855            GlobalMode::Indexing { view } => {
856                view.render(area, buf);
857            }
858        }
859    }
860}
861
862impl App {
863    /// Render the top square (title of the program).
864    fn render_title(&self, area: Rect, buf: &mut Buffer) {
865        Paragraph::new("Multiverse").bold().centered().render(area, buf);
866    }
867}
868
869/// Configure the client so it's ready for sync'ing.
870///
871/// Will log in or reuse a previous session.
872async fn configure_client(cli: Cli) -> Result<Client> {
873    let Cli { server_name, session_path, proxy, dont_share_pos: _ } = cli;
874
875    let mut client_builder = Client::builder()
876        .store_config(
877            StoreConfig::new(CrossProcessLockConfig::multi_process("multiverse"))
878                .crypto_store(SqliteCryptoStore::open(session_path.join("crypto"), None).await?)
879                .state_store(SqliteStateStore::open(session_path.join("state"), None).await?)
880                .event_cache_store(
881                    SqliteEventCacheStore::open(session_path.join("cache"), None).await?,
882                ),
883        )
884        .server_name_or_homeserver_url(&server_name)
885        .with_encryption_settings(EncryptionSettings {
886            auto_enable_cross_signing: true,
887            backup_download_strategy: BackupDownloadStrategy::AfterDecryptionFailure,
888            auto_enable_backups: true,
889        })
890        .with_enable_share_history_on_invite(true)
891        .with_threading_support(ThreadingSupport::Enabled { with_subscriptions: true })
892        .search_index_store(SearchIndexStoreKind::UnencryptedDirectory(
893            session_path.join("indexData"),
894        ));
895
896    if let Some(proxy_url) = proxy {
897        client_builder = client_builder.proxy(proxy_url).disable_ssl_verification();
898    }
899
900    let client = client_builder.build().await?;
901
902    // Try reading a session, otherwise create a new one.
903    log_in_or_restore_session(&client, &session_path).await?;
904
905    Ok(client)
906}
907
908async fn log_in_or_restore_session(client: &Client, session_path: &Path) -> Result<()> {
909    let session_path = session_path.join("session.json");
910
911    if let Ok(serialized) = std::fs::read_to_string(&session_path) {
912        let session: MatrixSession = serde_json::from_str(&serialized)?;
913        client.restore_session(session).await?;
914    } else {
915        login_with_password(client).await?;
916
917        // Immediately save the session to disk.
918        if let Some(session) = client.session() {
919            let AuthSession::Matrix(session) = session else {
920                panic!("unexpected OAuth 2.0 session")
921            };
922            let serialized = serde_json::to_string(&session)?;
923            std::fs::write(session_path, serialized)?;
924
925            println!("saved session");
926        }
927    }
928
929    Ok(())
930}
931
932/// Asks the user of a username and password, and try to login using the matrix
933/// auth with those.
934async fn login_with_password(client: &Client) -> Result<()> {
935    println!("Logging in with username and password…");
936
937    loop {
938        print!("\nUsername: ");
939        stdout().flush().expect("Unable to write to stdout");
940        let mut username = String::new();
941        io::stdin().read_line(&mut username).expect("Unable to read user input");
942        username = username.trim().to_owned();
943
944        let password = rpassword::prompt_password("Password.")?;
945
946        match client.matrix_auth().login_username(&username, password.trim()).await {
947            Ok(_) => {
948                println!("Logged in as {username}");
949                break;
950            }
951            Err(error) => {
952                println!("Error logging in: {error}");
953                println!("Please try again\n");
954            }
955        }
956    }
957
958    Ok(())
959}
960
961async fn get_events_from_event_ids(
962    room: &Room,
963    event_ids: Vec<OwnedEventId>,
964) -> Vec<TimelineEvent> {
965    futures_util::future::join_all(event_ids.iter().map(|event_id| async move {
966        room.load_or_fetch_event(event_id, None)
967            .await
968            .inspect_err(|err| {
969                debug!("Failed to find event {event_id} in event cache and server: {err}");
970            })
971            .ok()
972    }))
973    .await
974    .into_iter()
975    .flatten()
976    .collect::<Vec<TimelineEvent>>()
977}