ncspot/src/commands.rs

use std::collections::HashMap;
use std::sync::Arc;
use std::time::Duration;

use crate::application::UserData;
use crate::command::{
    parse, Command, GotoMode, JumpMode, MoveAmount, MoveMode, SeekDirection, ShiftMode, TargetMode,
};
use crate::config::{user_configuration_directory, Config};
use crate::events::EventManager;
use crate::ext_traits::CursiveExt;
use crate::library::Library;
use crate::queue::{Queue, RepeatSetting};
use crate::spotify::{Spotify, VOLUME_PERCENT};
use crate::traits::{IntoBoxedViewExt, ListItem, ViewExt};
use crate::ui::contextmenu::{
    AddToPlaylistMenu, ContextMenu, SelectArtistActionMenu, SelectArtistMenu,
};
use crate::ui::help::HelpView;
use crate::ui::layout::Layout;
use crate::ui::modal::Modal;
use crate::ui::search_results::SearchResultsView;
use cursive::event::{Event, Key};
use cursive::traits::View;
use cursive::views::Dialog;
use cursive::Cursive;
use log::{debug, error, info};
use ncspot::CONFIGURATION_FILE_NAME;
use std::cell::RefCell;

pub enum CommandResult {
    Consumed(Option<String>),
    View(Box<dyn ViewExt>),
    Modal(Box<dyn View>),
    Ignored,
}

pub struct CommandManager {
    aliases: HashMap<String, String>,
    bindings: RefCell<HashMap<String, Vec<Command>>>,
    spotify: Spotify,
    queue: Arc<Queue>,
    library: Arc<Library>,
    config: Arc<Config>,
    events: EventManager,
}

impl CommandManager {
    pub fn new(
        spotify: Spotify,
        queue: Arc<Queue>,
        library: Arc<Library>,
        config: Arc<Config>,
        events: EventManager,
    ) -> Self {
        let bindings = RefCell::new(Self::get_bindings(&config));
        Self {
            aliases: HashMap::new(),
            bindings,
            spotify,
            queue,
            library,
            config,
            events,
        }
    }

    pub fn get_bindings(config: &Config) -> HashMap<String, Vec<Command>> {
        let config = config.values();
        let mut kb = if config.default_keybindings.unwrap_or(true) {
            Self::default_keybindings()
        } else {
            HashMap::new()
        };
        let custom_bindings: Option<HashMap<String, String>> = config.keybindings.clone();

        for (key, commands) in custom_bindings.unwrap_or_default() {
            match parse(&commands) {
                Ok(cmds) => {
                    info!("Custom keybinding: {} -> {:?}", key, cmds);
                    kb.insert(key, cmds);
                }
                Err(err) => {
                    error!(
                        "Invalid command(s) for key {}-\"{}\": {}",
                        key, commands, err
                    );
                }
            }
        }

        kb
    }

    pub fn register_aliases<S: Into<String>>(&mut self, name: S, aliases: Vec<S>) {
        let name = name.into();
        for a in aliases {
            self.aliases.insert(a.into(), name.clone());
        }
    }

    pub fn register_all(&mut self) {
        self.register_aliases("quit", vec!["q", "x"]);
        self.register_aliases("playpause", vec!["pause", "toggleplay", "toggleplayback"]);
        self.register_aliases("repeat", vec!["loop"]);
    }

    fn handle_default_commands(
        &self,
        s: &mut Cursive,
        cmd: &Command,
    ) -> Result<Option<String>, String> {
        match cmd {
            Command::Noop => Ok(None),
            Command::Quit => {
                let queue = self.queue.queue.read().expect("can't readlock queue");
                self.config.with_state_mut(move |mut s| {
                    debug!(
                        "saving state, {} items, current track: {:?}",
                        queue.len(),
                        self.queue.get_current_index()
                    );
                    s.queuestate.queue = queue.clone();
                    s.queuestate.random_order = self.queue.get_random_order();
                    s.queuestate.current_track = self.queue.get_current_index();
                    s.queuestate.track_progress = self.spotify.get_current_progress();
                });
                self.config.save_state();
                s.quit();
                Ok(None)
            }
            Command::Redraw => {
                info!("Redrawing screen");
                s.clear();
                Ok(None)
            }
            Command::Stop => {
                self.queue.stop();
                Ok(None)
            }
            Command::Previous => {
                if self.spotify.get_current_progress() < Duration::from_secs(5) {
                    self.queue.previous();
                } else {
                    self.spotify.seek(0);
                }
                Ok(None)
            }
            Command::Next => {
                self.queue.next(true);
                Ok(None)
            }
            Command::Clear => {
                let queue = self.queue.clone();
                let confirmation = Dialog::text("Clear queue?")
                    .button("Yes", move |s| {
                        s.pop_layer();
                        queue.clear()
                    })
                    .dismiss_button("No");
                s.add_layer(Modal::new(confirmation));
                Ok(None)
            }
            Command::UpdateLibrary => {
                self.library.update_library();
                Ok(None)
            }
            Command::TogglePlay => {
                self.queue.toggleplayback();
                Ok(None)
            }
            Command::Shuffle(mode) => {
                let mode = mode.unwrap_or_else(|| !self.queue.get_shuffle());
                self.queue.set_shuffle(mode);
                Ok(None)
            }
            Command::Repeat(mode) => {
                let mode = mode.unwrap_or_else(|| match self.queue.get_repeat() {
                    RepeatSetting::None => RepeatSetting::RepeatPlaylist,
                    RepeatSetting::RepeatPlaylist => RepeatSetting::RepeatTrack,
                    RepeatSetting::RepeatTrack => RepeatSetting::None,
                });

                self.queue.set_repeat(mode);
                Ok(None)
            }
            Command::Seek(direction) => {
                match *direction {
                    SeekDirection::Relative(rel) => self.spotify.seek_relative(rel),
                    SeekDirection::Absolute(abs) => self.spotify.seek(abs),
                }
                Ok(None)
            }
            Command::VolumeUp(amount) => {
                let volume = self
                    .spotify
                    .volume()
                    .saturating_add(VOLUME_PERCENT * amount);
                self.spotify.set_volume(volume);
                Ok(None)
            }
            Command::VolumeDown(amount) => {
                let volume = self
                    .spotify
                    .volume()
                    .saturating_sub(VOLUME_PERCENT * amount);
                debug!("vol {}", volume);
                self.spotify.set_volume(volume);
                Ok(None)
            }
            Command::Help => {
                let view = Box::new(HelpView::new(self.bindings.borrow().clone()));
                s.call_on_name("main", move |v: &mut Layout| v.push_view(view));
                Ok(None)
            }
            Command::ReloadConfig => {
                self.config.reload().map_err(|_| {
                    format!(
                        "Failed to reload configuration. Fix errors in {} and try again.",
                        user_configuration_directory()
                            .map(|ref mut path| {
                                path.push(CONFIGURATION_FILE_NAME);
                                path.to_string_lossy().to_string()
                            })
                            .expect("configuration directory expected but not found")
                    )
                })?;

                // update theme
                let theme = self.config.build_theme();
                s.set_theme(theme);

                // update bindings
                self.unregister_keybindings(s);
                self.bindings.replace(Self::get_bindings(&self.config));
                self.register_keybindings(s);
                Ok(None)
            }
            Command::NewPlaylist(name) => {
                match self.spotify.api.create_playlist(name, None, None) {
                    Some(_) => self.library.update_library(),
                    None => error!("could not create playlist {}", name),
                }
                Ok(None)
            }
            Command::Search(term) => {
                let view = if !term.is_empty() {
                    Some(SearchResultsView::new(
                        term.clone(),
                        self.events.clone(),
                        self.queue.clone(),
                        self.library.clone(),
                    ))
                } else {
                    None
                };
                s.call_on_name("main", |v: &mut Layout| {
                    v.set_screen("search");
                    if let Some(results) = view {
                        v.push_view(results.into_boxed_view_ext())
                    }
                });
                Ok(None)
            }
            Command::Logout => {
                self.spotify.shutdown();

                let mut credentials_path = crate::config::cache_path("librespot");
                credentials_path.push("credentials.json");
                std::fs::remove_file(credentials_path).unwrap();

                s.quit();
                Ok(None)
            }
            Command::Execute(cmd) => {
                log::info!("Executing command: {}", cmd);
                let cmd = std::ffi::CString::new(cmd.clone()).unwrap();
                let result = unsafe { libc::system(cmd.as_ptr()) };
                log::info!("Exit code: {}", result);
                Ok(None)
            }
            Command::Reconnect => {
                self.spotify.shutdown();
                Ok(None)
            }
            Command::AddCurrent => {
                if let Some(track) = self.queue.get_current() {
                    if let Some(track) = track.track() {
                        let dialog = ContextMenu::add_track_dialog(
                            self.library.clone(),
                            self.queue.get_spotify(),
                            track,
                        );
                        s.add_layer(dialog);
                    }
                }
                Ok(None)
            }
            Command::SaveCurrent => {
                if let Some(mut track) = self.queue.get_current() {
                    track.save(&self.library);
                }
                Ok(None)
            }

            Command::Queue
            | Command::PlayNext
            | Command::Play
            | Command::Save
            | Command::SaveQueue
            | Command::Add
            | Command::Delete
            | Command::Focus(_)
            | Command::Back
            | Command::Open(_)
            | Command::Goto(_)
            | Command::Move(_, _)
            | Command::Shift(_, _)
            | Command::Jump(_)
            | Command::Insert(_)
            | Command::ShowRecommendations(_)
            | Command::Sort(_, _) => Err(format!(
                "The command \"{}\" is unsupported in this view",
                cmd.basename()
            )),
            #[cfg(feature = "share_clipboard")]
            Command::Share(_) => Err(format!(
                "The command \"{}\" is unsupported in this view",
                cmd.basename()
            )),
        }
    }

    fn handle_callbacks(&self, s: &mut Cursive, cmd: &Command) -> Result<Option<String>, String> {
        let local = if let Some(mut contextmenu) = s.find_name::<ContextMenu>("contextmenu") {
            contextmenu.on_command(s, cmd)?
        } else if let Some(mut add_track_menu) = s.find_name::<AddToPlaylistMenu>("addtrackmenu") {
            add_track_menu.on_command(s, cmd)?
        } else if let Some(mut select_artist) = s.find_name::<SelectArtistMenu>("selectartist") {
            select_artist.on_command(s, cmd)?
        } else if let Some(mut select_artist_action) =
            s.find_name::<SelectArtistActionMenu>("selectartistaction")
        {
            select_artist_action.on_command(s, cmd)?
        } else {
            s.on_layout(|siv, mut l| l.on_command(siv, cmd))?
        };

        if let CommandResult::Consumed(output) = local {
            Ok(output)
        } else if let CommandResult::Modal(modal) = local {
            s.add_layer(modal);
            Ok(None)
        } else if let CommandResult::View(view) = local {
            s.call_on_name("main", move |v: &mut Layout| {
                v.push_view(view);
            });

            Ok(None)
        } else {
            self.handle_default_commands(s, cmd)
        }
    }

    pub fn handle(&self, s: &mut Cursive, cmd: Command) {
        let result = self.handle_callbacks(s, &cmd);

        s.call_on_name("main", |v: &mut Layout| {
            v.set_result(result);
        });

        s.on_event(Event::Refresh);
    }

    pub fn register_keybinding<E: Into<cursive::event::Event>>(
        &self,
        cursive: &mut Cursive,
        event: E,
        commands: Vec<Command>,
    ) {
        cursive.add_global_callback(event, move |s| {
            if let Some(data) = s.user_data::<UserData>().cloned() {
                for command in commands.clone().into_iter() {
                    data.cmd.handle(s, command);
                }
            }
        });
    }

    pub fn unregister_keybindings(&self, cursive: &mut Cursive) {
        let kb = self.bindings.borrow();

        for (k, _v) in kb.iter() {
            if let Some(binding) = Self::parse_keybinding(k) {
                cursive.clear_global_callbacks(binding);
            }
        }
    }

    pub fn register_keybindings(&self, cursive: &mut Cursive) {
        let kb = self.bindings.borrow();

        for (k, v) in kb.iter() {
            if let Some(binding) = Self::parse_keybinding(k) {
                self.register_keybinding(cursive, binding, v.clone());
            } else {
                error!("Could not parse keybinding: \"{}\"", k);
            }
        }
    }

    fn default_keybindings() -> HashMap<String, Vec<Command>> {
        let mut kb = HashMap::new();

        kb.insert("q".into(), vec![Command::Quit]);
        kb.insert("Ctrl+l".into(), vec![Command::Redraw]);
        kb.insert("Shift+p".into(), vec![Command::TogglePlay]);
        kb.insert("Shift+u".into(), vec![Command::UpdateLibrary]);
        kb.insert("Shift+s".into(), vec![Command::Stop]);
        kb.insert("<".into(), vec![Command::Previous]);
        kb.insert(">".into(), vec![Command::Next]);
        kb.insert("c".into(), vec![Command::Clear]);
        kb.insert(
            "Space".into(),
            vec![
                Command::Queue,
                Command::Move(MoveMode::Down, Default::default()),
            ],
        );
        kb.insert(
            ".".into(),
            vec![
                Command::PlayNext,
                Command::Move(MoveMode::Down, Default::default()),
            ],
        );
        kb.insert("Enter".into(), vec![Command::Play]);
        kb.insert("n".into(), vec![Command::Jump(JumpMode::Next)]);
        kb.insert("Shift+n".into(), vec![Command::Jump(JumpMode::Previous)]);
        kb.insert("s".into(), vec![Command::Save]);
        kb.insert("Ctrl+s".into(), vec![Command::SaveQueue]);
        kb.insert("d".into(), vec![Command::Delete]);
        kb.insert(
            "f".into(),
            vec![Command::Seek(SeekDirection::Relative(1000))],
        );
        kb.insert(
            "b".into(),
            vec![Command::Seek(SeekDirection::Relative(-1000))],
        );
        kb.insert(
            "Shift+f".into(),
            vec![Command::Seek(SeekDirection::Relative(10000))],
        );
        kb.insert(
            "Shift+b".into(),
            vec![Command::Seek(SeekDirection::Relative(-10000))],
        );
        kb.insert("+".into(), vec![Command::VolumeUp(1)]);
        kb.insert("]".into(), vec![Command::VolumeUp(5)]);
        kb.insert("-".into(), vec![Command::VolumeDown(1)]);
        kb.insert("[".into(), vec![Command::VolumeDown(5)]);

        kb.insert("r".into(), vec![Command::Repeat(None)]);
        kb.insert("z".into(), vec![Command::Shuffle(None)]);

        #[cfg(feature = "share_clipboard")]
        {
            kb.insert("x".into(), vec![Command::Share(TargetMode::Selected)]);
            kb.insert("Shift+x".into(), vec![Command::Share(TargetMode::Current)]);
        }

        kb.insert("F1".into(), vec![Command::Focus("queue".into())]);
        kb.insert("F2".into(), vec![Command::Focus("search".into())]);
        kb.insert("F3".into(), vec![Command::Focus("library".into())]);
        #[cfg(feature = "cover")]
        kb.insert("F8".into(), vec![Command::Focus("cover".into())]);
        kb.insert("?".into(), vec![Command::Help]);
        kb.insert("Backspace".into(), vec![Command::Back]);

        kb.insert("o".into(), vec![Command::Open(TargetMode::Selected)]);
        kb.insert("Shift+o".into(), vec![Command::Open(TargetMode::Current)]);
        kb.insert("a".into(), vec![Command::Goto(GotoMode::Album)]);
        kb.insert("Shift+a".into(), vec![Command::Goto(GotoMode::Artist)]);

        kb.insert(
            "m".into(),
            vec![Command::ShowRecommendations(TargetMode::Selected)],
        );
        kb.insert(
            "Shift+m".into(),
            vec![Command::ShowRecommendations(TargetMode::Current)],
        );

        kb.insert(
            "Up".into(),
            vec![Command::Move(MoveMode::Up, Default::default())],
        );
        kb.insert(
            "p".into(),
            vec![Command::Move(MoveMode::Playing, Default::default())],
        );
        kb.insert(
            "Down".into(),
            vec![Command::Move(MoveMode::Down, Default::default())],
        );
        kb.insert(
            "Left".into(),
            vec![Command::Move(MoveMode::Left, Default::default())],
        );
        kb.insert(
            "Right".into(),
            vec![Command::Move(MoveMode::Right, Default::default())],
        );
        kb.insert(
            "PageUp".into(),
            vec![Command::Move(MoveMode::Up, MoveAmount::Integer(5))],
        );
        kb.insert(
            "PageDown".into(),
            vec![Command::Move(MoveMode::Down, MoveAmount::Integer(5))],
        );
        kb.insert(
            "Home".into(),
            vec![Command::Move(MoveMode::Up, MoveAmount::Extreme)],
        );
        kb.insert(
            "End".into(),
            vec![Command::Move(MoveMode::Down, MoveAmount::Extreme)],
        );
        kb.insert(
            "k".into(),
            vec![Command::Move(MoveMode::Up, Default::default())],
        );
        kb.insert(
            "j".into(),
            vec![Command::Move(MoveMode::Down, Default::default())],
        );
        kb.insert(
            "h".into(),
            vec![Command::Move(MoveMode::Left, Default::default())],
        );
        kb.insert(
            "l".into(),
            vec![Command::Move(MoveMode::Right, Default::default())],
        );

        kb.insert(
            "Ctrl+p".into(),
            vec![Command::Move(MoveMode::Up, Default::default())],
        );
        kb.insert(
            "Ctrl+n".into(),
            vec![Command::Move(MoveMode::Down, Default::default())],
        );
        kb.insert(
            "Ctrl+a".into(),
            vec![Command::Move(MoveMode::Left, Default::default())],
        );
        kb.insert(
            "Ctrl+e".into(),
            vec![Command::Move(MoveMode::Right, Default::default())],
        );

        kb.insert("Shift+Up".into(), vec![Command::Shift(ShiftMode::Up, None)]);
        kb.insert(
            "Shift+Down".into(),
            vec![Command::Shift(ShiftMode::Down, None)],
        );

        #[cfg(feature = "share_clipboard")]
        kb.insert(
            "Ctrl+v".into(),
            vec![Command::Insert(crate::command::InsertSource::Clipboard)],
        );

        kb
    }

    fn parse_key(key: &str) -> Event {
        match key {
            "Enter" => Event::Key(Key::Enter),
            "Space" => Event::Char(" ".chars().next().unwrap()),
            "Tab" => Event::Key(Key::Tab),
            "Backspace" => Event::Key(Key::Backspace),
            "Esc" => Event::Key(Key::Esc),
            "Left" => Event::Key(Key::Left),
            "Right" => Event::Key(Key::Right),
            "Up" => Event::Key(Key::Up),
            "Down" => Event::Key(Key::Down),
            "Ins" => Event::Key(Key::Ins),
            "Del" => Event::Key(Key::Del),
            "Home" => Event::Key(Key::Home),
            "End" => Event::Key(Key::End),
            "PageUp" => Event::Key(Key::PageUp),
            "PageDown" => Event::Key(Key::PageDown),
            "PauseBreak" => Event::Key(Key::PauseBreak),
            "NumpadCenter" => Event::Key(Key::NumpadCenter),
            "F0" => Event::Key(Key::F0),
            "F1" => Event::Key(Key::F1),
            "F2" => Event::Key(Key::F2),
            "F3" => Event::Key(Key::F3),
            "F4" => Event::Key(Key::F4),
            "F5" => Event::Key(Key::F5),
            "F6" => Event::Key(Key::F6),
            "F7" => Event::Key(Key::F7),
            "F8" => Event::Key(Key::F8),
            "F9" => Event::Key(Key::F9),
            "F10" => Event::Key(Key::F10),
            "F11" => Event::Key(Key::F11),
            "F12" => Event::Key(Key::F12),
            s => Event::Char(s.chars().next().unwrap()),
        }
    }

    fn parse_keybinding(kb: &str) -> Option<cursive::event::Event> {
        let mut split = kb.split('+');
        if kb != "+" && split.clone().count() == 2 {
            let modifier = split.next().unwrap();
            let key = split.next().unwrap();
            let parsed = Self::parse_key(key);
            if let Event::Key(parsed) = parsed {
                match modifier {
                    "Shift" => Some(Event::Shift(parsed)),
                    "Alt" => Some(Event::Alt(parsed)),
                    "Ctrl" => Some(Event::Ctrl(parsed)),
                    _ => None,
                }
            } else if let Event::Char(parsed) = parsed {
                match modifier {
                    "Shift" => Some(Event::Char(parsed.to_uppercase().next().unwrap())),
                    "Alt" => Some(Event::AltChar(parsed)),
                    "Ctrl" => Some(Event::CtrlChar(parsed)),
                    _ => None,
                }
            } else {
                None
            }
        } else {
            Some(Self::parse_key(kb))
        }
    }
}