basalt_tui/

app.rs

use basalt_core::obsidian::{self, create_untitled_dir, create_untitled_note, Note, Vault};
use ratatui::{
    buffer::Buffer,
    crossterm::event::{self, Event, KeyEvent, KeyEventKind},
    layout::{Constraint, Flex, Layout, Rect, Size},
    widgets::{StatefulWidget, Widget},
    DefaultTerminal,
};
use tracing::{debug, error, info, warn};

use std::{
    cell::RefCell,
    fmt::Debug,
    fs,
    io::Result,
    path::{Path, PathBuf},
    time::{Duration, Instant},
};

use crate::{
    command,
    config::{self, Config, Keystroke},
    debug_log::{self, DebugLogModal, DebugLogModalState, LogLevel},
    explorer::{self, Explorer, ExplorerState, Item, Visibility},
    help_modal::{self, HelpModal, HelpModalState},
    input::{self, Input, InputModalState},
    note_editor::{
        self, ast,
        editor::NoteEditor,
        state::{EditMode, NoteEditorState, View},
    },
    outline::{self, Outline, OutlineState},
    splash_modal::{self, SplashModal, SplashModalState},
    statusbar::{StatusBar, StatusBarState},
    stylized_text::{self, FontStyle},
    text_counts::{CharCount, WordCount},
    toast::{self, Toast, TOAST_WIDTH},
    vault_selector_modal::{self, VaultSelectorModal, VaultSelectorModalState},
    vault_watcher::VaultWatcher,
};

const VERSION: &str = env!("CARGO_PKG_VERSION");

const HELP_TEXT: &str = include_str!("./help.txt");

#[derive(Debug, Default, Clone, PartialEq)]
pub enum ScrollAmount {
    #[default]
    One,
    HalfPage,
}

pub fn calc_scroll_amount(scroll_amount: &ScrollAmount, height: usize) -> usize {
    match scroll_amount {
        ScrollAmount::One => 1,
        ScrollAmount::HalfPage => height / 2,
    }
}

#[derive(Default, Clone)]
pub struct AppState<'a> {
    vault: Vault,
    screen_size: Size,
    is_running: bool,
    pending_keys: Vec<Keystroke>,

    active_pane: ActivePane,
    explorer: ExplorerState,
    note_editor: NoteEditorState<'a>,
    outline: OutlineState,
    selected_note: Option<SelectedNote>,
    toasts: Vec<Toast>,

    input_modal: InputModalState,
    splash_modal: SplashModalState<'a>,
    help_modal: HelpModalState,
    vault_selector_modal: VaultSelectorModalState<'a>,
    debug_log_modal: DebugLogModalState,
}

impl<'a> AppState<'a> {
    pub fn vault(&self) -> &Vault {
        &self.vault
    }

    pub fn active_component(&self) -> ActivePane {
        if self.debug_log_modal.visible {
            return ActivePane::DebugLogModal;
        }

        if self.help_modal.visible {
            return ActivePane::HelpModal;
        }

        if self.vault_selector_modal.visible {
            return ActivePane::VaultSelectorModal;
        }

        if self.splash_modal.visible {
            return ActivePane::Splash;
        }

        self.active_pane
    }

    pub fn set_running(&self, is_running: bool) -> Self {
        Self {
            is_running,
            ..self.clone()
        }
    }
}

#[derive(Clone, Debug, PartialEq)]
pub enum Message<'a> {
    Quit,
    Exec(String),
    Spawn(String),
    Resize(Size),
    SetActivePane(ActivePane),
    RefreshVault {
        rename: Option<(PathBuf, PathBuf)>,
        select: Option<PathBuf>,
    },
    RescanVault,
    CreateUntitledNote,
    CreateUntitledFolder,
    OpenVault(&'a Vault),
    SelectNote(SelectedNote),
    UpdateSelectedNoteContent((String, Option<Vec<ast::Node>>)),

    Batch(Vec<Message<'a>>),
    Toast(toast::Message),
    Input(input::Message),
    Splash(splash_modal::Message),
    Explorer(explorer::Message),
    NoteEditor(note_editor::Message),
    Outline(outline::Message),
    HelpModal(help_modal::Message),
    VaultSelectorModal(vault_selector_modal::Message),
    DebugLog(debug_log::Message),
}

#[derive(Debug, Default, Clone, Copy, PartialEq)]
pub enum ActivePane {
    #[default]
    Splash,
    Explorer,
    NoteEditor,
    Outline,
    Input,
    HelpModal,
    VaultSelectorModal,
    DebugLogModal,
}

impl From<ActivePane> for &str {
    fn from(value: ActivePane) -> Self {
        match value {
            ActivePane::Splash => "Splash",
            ActivePane::Explorer => "Explorer",
            ActivePane::NoteEditor => "Note Editor",
            ActivePane::Outline => "Outline",
            ActivePane::Input => "Input",
            ActivePane::HelpModal => "Help",
            ActivePane::VaultSelectorModal => "Vault Selector",
            ActivePane::DebugLogModal => "Debug Log",
        }
    }
}

#[derive(Debug, Default, Clone, PartialEq)]
pub struct SelectedNote {
    name: String,
    path: PathBuf,
    content: String,
}

impl From<Note> for SelectedNote {
    fn from(value: Note) -> Self {
        Self {
            name: value.name().to_string(),
            path: value.path().to_path_buf(),
            content: fs::read_to_string(value.path()).unwrap_or_default(),
        }
    }
}

impl From<&Note> for SelectedNote {
    fn from(value: &Note) -> Self {
        Self {
            name: value.name().to_string(),
            path: value.path().to_path_buf(),
            content: fs::read_to_string(value.path()).unwrap_or_default(),
        }
    }
}

fn help_text(version: &str) -> String {
    HELP_TEXT.replace("%version-notice", version)
}

fn active_config_section<'a>(
    config: &'a Config,
    active: ActivePane,
) -> &'a config::ConfigSection<'a> {
    match active {
        ActivePane::Splash => &config.splash,
        ActivePane::Explorer => &config.explorer,
        ActivePane::Outline => &config.outline,
        ActivePane::HelpModal => &config.help_modal,
        ActivePane::VaultSelectorModal => &config.vault_selector_modal,
        ActivePane::Input => &config.input_modal,
        ActivePane::NoteEditor => &config.note_editor,
        ActivePane::DebugLogModal => &config.debug_log_modal,
    }
}

pub struct App<'a> {
    state: AppState<'a>,
    config: Config<'a>,
    terminal: RefCell<DefaultTerminal>,
    vault_watcher: RefCell<Option<VaultWatcher>>,
}

impl<'a> App<'a> {
    pub fn new(state: AppState<'a>, config: Config<'a>, terminal: DefaultTerminal) -> Self {
        Self {
            state,
            // TODO: Surface toast if read config returns error
            config,
            terminal: RefCell::new(terminal),
            vault_watcher: RefCell::new(None),
        }
    }

    fn ensure_watcher_for(&self, path: &Path) {
        let mut current = self.vault_watcher.borrow_mut();
        let needs_swap = match current.as_ref() {
            Some(watcher) => watcher.path() != path,
            None => !path.as_os_str().is_empty(),
        };
        if !needs_swap {
            return;
        }
        *current = if path.is_dir() {
            VaultWatcher::new(path).ok()
        } else {
            None
        };
    }

    fn watcher_has_changes(&self) -> bool {
        self.vault_watcher
            .borrow()
            .as_ref()
            .is_some_and(|w| w.drain())
    }

    pub fn start(
        terminal: DefaultTerminal,
        vaults: Vec<&Vault>,
        initial_vault: Option<Vault>,
        debug: bool,
        log_level: LogLevel,
    ) -> Result<()> {
        let version = stylized_text::stylize(VERSION, FontStyle::Script);
        let size = terminal.size()?;
        let (config, warnings) = config::load().unwrap();

        let vault = initial_vault.clone().unwrap_or_default();
        let explorer = match &initial_vault {
            Some(v) => ExplorerState::new(&v.name, v.entries(), &config.symbols),
            None => ExplorerState::default(),
        };
        let active_pane = if initial_vault.is_some() {
            ActivePane::Explorer
        } else {
            ActivePane::default()
        };

        let state = AppState {
            vault,
            explorer,
            active_pane,
            screen_size: size,
            help_modal: HelpModalState::new(&help_text(&version)),
            vault_selector_modal: VaultSelectorModalState::new(vaults.clone()),
            splash_modal: SplashModalState::new(&version, vaults, initial_vault.is_none()),
            outline: OutlineState {
                symbols: config.symbols.clone(),
                ..Default::default()
            },
            debug_log_modal: DebugLogModalState {
                visible: debug,
                min_level: log_level,
                ..Default::default()
            },
            toasts: warnings
                .into_iter()
                .map(|message| {
                    warn!(message, "config warning");
                    toast::Toast::warn(&message, Duration::from_secs(5))
                })
                .collect(),
            ..Default::default()
        };

        App::new(state, config, terminal).run()
    }

    fn run(&'a mut self) -> Result<()> {
        self.state.is_running = true;

        let mut state = self.state.clone();
        let config = self.config.clone();

        self.ensure_watcher_for(&state.vault.path);

        let tick_rate = Duration::from_millis(250);
        let mut last_tick = Instant::now();

        while state.is_running {
            self.draw(&mut state)?;

            let timeout = tick_rate.saturating_sub(last_tick.elapsed());

            if event::poll(timeout)? {
                let event = event::read()?;

                let mut message = App::handle_event(&config, &mut state, event);
                while message.is_some() {
                    message = App::update(self.terminal.get_mut(), &config, &mut state, message);
                }
                self.ensure_watcher_for(&state.vault.path);
            }

            if self.watcher_has_changes() {
                let mut message = Some(Message::RescanVault);
                while message.is_some() {
                    message = App::update(self.terminal.get_mut(), &config, &mut state, message);
                }
            }

            if last_tick.elapsed() >= tick_rate {
                App::update(
                    self.terminal.get_mut(),
                    &config,
                    &mut state,
                    Some(Message::Toast(toast::Message::Tick)),
                );
                last_tick = Instant::now();
            }
        }

        Ok(())
    }

    fn draw(&self, state: &mut AppState<'a>) -> Result<()> {
        let mut terminal = self.terminal.borrow_mut();

        terminal.draw(move |frame| {
            let area = frame.area();
            let buf = frame.buffer_mut();
            self.render(area, buf, state);
        })?;

        Ok(())
    }

    fn handle_event(
        config: &'a Config,
        state: &mut AppState<'_>,
        event: Event,
    ) -> Option<Message<'a>> {
        match event {
            Event::Resize(cols, rows) => Some(Message::Resize(Size::new(cols, rows))),
            Event::Key(key_event) if key_event.kind == KeyEventKind::Press => {
                App::handle_key_event(config, state, key_event)
            }
            _ => None,
        }
    }

    fn handle_key_event(
        config: &'a Config,
        state: &mut AppState<'_>,
        key_event: KeyEvent,
    ) -> Option<Message<'a>> {
        match state.active_component() {
            ActivePane::NoteEditor
                if state.note_editor.is_editing() && state.note_editor.insert_mode() =>
            {
                state.pending_keys.clear();
                note_editor::handle_editing_event(key_event).map(Message::NoteEditor)
            }
            ActivePane::Input if state.input_modal.is_editing() => {
                state.pending_keys.clear();
                input::handle_editing_event(key_event).map(Message::Input)
            }
            active => App::handle_pending_keys(
                Keystroke::from(key_event),
                config,
                active,
                &mut state.pending_keys,
            ),
        }
    }

    fn handle_pending_keys(
        key: Keystroke,
        config: &'a Config,
        active: ActivePane,
        pending_keys: &mut Vec<Keystroke>,
    ) -> Option<Message<'a>> {
        pending_keys.push(key.clone());
        let section = active_config_section(config, active);

        let global_message = config.global.sequence_to_message(pending_keys);
        if global_message.is_some() {
            pending_keys.clear();
            return global_message;
        }

        let section_message = section.sequence_to_message(pending_keys);
        if section_message.is_some() {
            pending_keys.clear();
            return section_message;
        }

        let is_sequence_prefix = config.global.is_sequence_prefix(pending_keys)
            || section.is_sequence_prefix(pending_keys);

        if is_sequence_prefix {
            return None;
        }

        let is_sequence = pending_keys.len() > 1;

        pending_keys.clear();
        is_sequence
            .then(|| App::handle_pending_keys(key, config, active, pending_keys))
            .flatten()
    }

    fn update(
        terminal: &mut DefaultTerminal,
        config: &Config,
        state: &mut AppState<'a>,
        message: Option<Message<'a>>,
    ) -> Option<Message<'a>> {
        match message? {
            Message::Batch(messages) => {
                for msg in messages {
                    let mut next = Some(msg);
                    while next.is_some() {
                        next = App::update(terminal, config, state, next);
                    }
                }
            }
            Message::Quit => state.is_running = false,
            Message::Resize(size) => state.screen_size = size,
            Message::RefreshVault { rename, select } => {
                if let Some((old, new)) = &rename {
                    // FIXME: Handle error propagation when wiki link update fails
                    if let Err(error) = obsidian::vault::update_wiki_links(state.vault(), old, new)
                    {
                        warn!(?error, "failed to update wiki links");
                    }
                }
                state.explorer.with_entries(state.vault.entries(), select);
                debug!(?rename, "refreshed vault");

                // Reload the note editor for the currently selected note
                let selected_note = if state
                    .explorer
                    .list_state
                    .selected()
                    .zip(state.explorer.selected_item_index)
                    .is_some_and(|(a, b)| a == b)
                {
                    if let Some(Item::File { note, .. }) = state.explorer.current_item() {
                        Some(SelectedNote::from(note))
                    } else {
                        None
                    }
                } else {
                    state.selected_note.clone()
                };

                if let Some(note) = selected_note {
                    return Some(Message::Batch(vec![
                        Message::SelectNote(note),
                        Message::SetActivePane(ActivePane::Explorer),
                    ]));
                }
                return Some(Message::SetActivePane(ActivePane::Explorer));
            }
            Message::RescanVault => {
                let select = state.selected_note.as_ref().map(|note| note.path.clone());
                state.explorer.with_entries(state.vault.entries(), select);
                debug!("rescanned vault after watcher change");
            }
            Message::CreateUntitledNote => {
                let path = match state.explorer.current_item() {
                    Some(Item::Directory { path, .. }) => path,
                    Some(Item::File { note, .. }) => {
                        note.path().parent().unwrap_or(&state.vault.path)
                    }
                    _ => &state.vault.path,
                };
                match create_untitled_note(path) {
                    Ok(note) => {
                        info!(path = %note.path().display(), "created note");
                        return Some(Message::Batch(vec![
                            Message::Explorer(explorer::Message::Open),
                            Message::RefreshVault {
                                rename: None,
                                select: Some(note.path().to_path_buf()),
                            },
                            Message::Toast(toast::Message::Create(toast::Toast::success(
                                "Note created",
                                Duration::from_secs(2),
                            ))),
                            Message::SelectNote(note.into()),
                        ]));
                    }
                    Err(error) => {
                        error!(?error, "failed to create note");
                        return Some(Message::Toast(toast::Message::Create(toast::Toast::error(
                            "Failed to create a new note",
                            Duration::from_secs(2),
                        ))));
                    }
                }
            }
            Message::CreateUntitledFolder => {
                let path = match state.explorer.current_item() {
                    Some(Item::Directory { path, .. }) => path,
                    Some(Item::File { note, .. }) => {
                        note.path().parent().unwrap_or(&state.vault.path)
                    }
                    _ => &state.vault.path,
                };
                match create_untitled_dir(path) {
                    Ok(note) => {
                        info!(path = %note.path().display(), "created folder");
                        return Some(Message::Batch(vec![
                            Message::Explorer(explorer::Message::Open),
                            Message::RefreshVault {
                                rename: None,
                                select: Some(note.path().to_path_buf()),
                            },
                            Message::Toast(toast::Message::Create(toast::Toast::success(
                                "Folder created",
                                Duration::from_secs(2),
                            ))),
                        ]));
                    }
                    Err(error) => {
                        error!(?error, "failed to create folder");
                        return Some(Message::Toast(toast::Message::Create(toast::Toast::error(
                            "Failed to create a new folder",
                            Duration::from_secs(2),
                        ))));
                    }
                }
            }
            Message::SetActivePane(active_pane) => match active_pane {
                ActivePane::Explorer => {
                    state.active_pane = active_pane;
                    // TODO: use event/message
                    state.explorer.set_active(true);
                }
                ActivePane::NoteEditor => {
                    state.active_pane = active_pane;
                    // TODO: use event/message
                    state.note_editor.set_active(true);
                    if state.explorer.visibility == Visibility::FullWidth {
                        return Some(Message::Explorer(explorer::Message::HidePane));
                    }
                }
                ActivePane::Outline => {
                    state.active_pane = active_pane;
                    // TODO: use event/message
                    state.outline.set_active(true);
                }
                ActivePane::Input => {
                    state.active_pane = active_pane;
                }
                _ => {}
            },
            Message::OpenVault(vault) => {
                info!(vault = %vault.name, "opened vault");
                state.vault = vault.clone();
                state.explorer = ExplorerState::new(&vault.name, vault.entries(), &config.symbols);
                state.note_editor = NoteEditorState::default();
                return Some(Message::SetActivePane(ActivePane::Explorer));
            }
            Message::SelectNote(selected_note) => {
                info!(note = %selected_note.name, "selected note");
                let is_different = state
                    .selected_note
                    .as_ref()
                    .is_some_and(|note| note.content != selected_note.content);
                state.selected_note = Some(selected_note.clone());

                state.note_editor = NoteEditorState::new(
                    &selected_note.content,
                    &selected_note.name,
                    &selected_note.path,
                    &config.symbols,
                );

                let vim_mode = config.vim_mode;
                state.note_editor.set_vim_mode(vim_mode);

                let editor_enabled = config.experimental_editor;
                state.note_editor.set_editor_enabled(editor_enabled);

                if editor_enabled && vim_mode {
                    state.note_editor.set_view(View::Edit(EditMode::Source));
                } else {
                    state.note_editor.set_view(View::Read);
                }

                // TODO: This should be behind an event/message
                state.outline = OutlineState::new(
                    &state.note_editor.ast_nodes,
                    state.note_editor.current_block_idx(),
                    state.outline.is_open(),
                    &config.symbols,
                );

                if state.explorer.visibility == Visibility::FullWidth && is_different {
                    return Some(Message::Explorer(explorer::Message::HidePane));
                }
            }
            Message::UpdateSelectedNoteContent((updated_content, nodes)) => {
                if let Some(selected_note) = state.selected_note.as_mut() {
                    selected_note.content = updated_content;
                    return nodes.map(|nodes| Message::Outline(outline::Message::SetNodes(nodes)));
                }
            }
            Message::Exec(command) => {
                let (note_name, note_path) = state
                    .selected_note
                    .as_ref()
                    .map(|note| (note.name.as_str(), note.path.to_string_lossy()))
                    .unwrap_or_default();

                return command::sync_command(
                    terminal,
                    command,
                    &state.vault.name,
                    note_name,
                    &note_path,
                );
            }

            Message::Spawn(command) => {
                let (note_name, note_path) = state
                    .selected_note
                    .as_ref()
                    .map(|note| (note.name.as_str(), note.path.to_string_lossy()))
                    .unwrap_or_default();

                return command::spawn_command(command, &state.vault.name, note_name, &note_path);
            }

            Message::HelpModal(message) => {
                return help_modal::update(&message, state.screen_size, &mut state.help_modal);
            }
            Message::VaultSelectorModal(message) => {
                return vault_selector_modal::update(&message, &mut state.vault_selector_modal);
            }
            Message::Splash(message) => {
                return splash_modal::update(&message, &mut state.splash_modal);
            }
            Message::Explorer(message) => {
                return explorer::update(&message, state.screen_size, &mut state.explorer);
            }
            Message::Outline(message) => {
                return outline::update(&message, &mut state.outline);
            }
            Message::NoteEditor(message) => {
                return note_editor::update(message, state.screen_size, &mut state.note_editor);
            }
            Message::Input(message) => return input::update(message, &mut state.input_modal),
            Message::DebugLog(message) => {
                return debug_log::update(&message, state.screen_size, &mut state.debug_log_modal);
            }
            Message::Toast(message) => return toast::update(message, &mut state.toasts),
        };

        None
    }

    fn render_splash(&self, area: Rect, buf: &mut Buffer, state: &mut SplashModalState<'a>) {
        let border_modal = self.config.symbols.border_modal.into();
        let vault_active = self.config.symbols.vault_active.clone();
        SplashModal::new(border_modal, vault_active).render(area, buf, state)
    }

    fn render_main(&self, area: Rect, buf: &mut Buffer, state: &mut AppState<'a>) {
        let [content, statusbar] = Layout::vertical([Constraint::Fill(1), Constraint::Length(1)])
            .horizontal_margin(1)
            .areas(area);

        let (left, right) = match state.explorer.visibility {
            Visibility::Hidden => (Constraint::Length(4), Constraint::Fill(1)),
            Visibility::Visible => (Constraint::Length(35), Constraint::Fill(1)),
            Visibility::FullWidth => (Constraint::Fill(1), Constraint::Length(0)),
        };

        let [explorer_pane, note, outline] = Layout::horizontal([
            left,
            right,
            if state.outline.is_open() {
                Constraint::Length(35)
            } else {
                Constraint::Length(4)
            },
        ])
        .areas(content);

        Explorer::new().render(explorer_pane, buf, &mut state.explorer);
        NoteEditor::default().render(note, buf, &mut state.note_editor);
        Outline.render(outline, buf, &mut state.outline);
        let border_modal = self.config.symbols.border_modal.into();
        Input::new(border_modal).render(explorer_pane, buf, &mut state.input_modal);

        let (_, counts) = state
            .selected_note
            .clone()
            .map(|note| {
                let content = note.content.as_str();
                (
                    note.name,
                    (WordCount::from(content), CharCount::from(content)),
                )
            })
            .unzip();

        let (word_count, char_count) = counts.unwrap_or_default();

        let mut status_bar_state = StatusBarState::new(
            state.active_pane.into(),
            word_count.into(),
            char_count.into(),
        );

        let status_bar = StatusBar::new(&self.config.symbols);
        status_bar.render(statusbar, buf, &mut status_bar_state);

        self.render_modals(area, buf, state);
        self.render_toasts(area, buf, state);

        if state.debug_log_modal.visible {
            let border_modal = self.config.symbols.border_modal.into();
            let memory_mb =
                memory_stats::memory_stats().map(|stats| stats.physical_mem as f64 / 1_048_576.0);
            DebugLogModal::new(border_modal, memory_mb).render(
                area,
                buf,
                &mut state.debug_log_modal,
            );
        }
    }

    fn render_modals(&self, area: Rect, buf: &mut Buffer, state: &mut AppState<'a>) {
        if state.splash_modal.visible {
            self.render_splash(area, buf, &mut state.splash_modal);
        }

        if state.vault_selector_modal.visible {
            let border_modal = self.config.symbols.border_modal.into();
            let vault_active = self.config.symbols.vault_active.clone();
            VaultSelectorModal::new(border_modal, vault_active).render(
                area,
                buf,
                &mut state.vault_selector_modal,
            );
        }

        if state.help_modal.visible {
            let border_modal = self.config.symbols.border_modal.into();
            HelpModal::new(border_modal).render(area, buf, &mut state.help_modal);
        }
    }

    fn render_toasts(&self, area: Rect, buf: &mut Buffer, state: &mut AppState<'a>) {
        let [_, toast_area] =
            Layout::horizontal([Constraint::Fill(1), Constraint::Length(TOAST_WIDTH)])
                .horizontal_margin(1)
                .flex(Flex::End)
                .areas(area);

        let mut y_offset: u16 = 0;
        state.toasts.iter().rev().for_each(|toast| {
            let mut toast_area = toast_area;
            toast_area.y += y_offset;
            y_offset += toast.height();
            if toast_area.y >= area.bottom() {
                return;
            }
            let mut toast = toast.clone();
            toast.border_type = self.config.symbols.border_modal.into();
            toast.icon = toast.level_icon(&self.config.symbols);
            toast.render(toast_area, buf)
        });
    }
}

impl<'a> StatefulWidget for &App<'a> {
    type State = AppState<'a>;

    fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State) {
        self.render_main(area, buf, state);
    }
}