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