add target path popup for file download in UI

Author: Panaetius

coman/src/app/ids.rs

@@ -8,6 +8,7 @@ pub enum Id {
     InfoPopup,
     ErrorPopup,
     LoginPopup,
+    DownloadPopup,
     SystemSelectPopup,
     FileView,
 }

coman/src/app/messages.rs

@@ -1,3 +1,5 @@
+use std::path::PathBuf;
+
 use crate::{app::user_events::UserEvent, cscs::api_client::System};
 
 #[derive(Debug, PartialEq)]
@@ -27,6 +29,12 @@ pub enum LoginPopupMsg {
     LoginDone(String, String),
 }
 #[derive(Debug, PartialEq)]
+pub enum DownloadPopupMsg {
+    Opened(PathBuf),
+    PathSet(PathBuf, PathBuf),
+    Closed,
+}
+#[derive(Debug, PartialEq)]
 pub enum SystemSelectMsg {
     Opened(Vec<System>),
     Closed,
@@ -57,6 +65,7 @@ pub enum Msg {
     InfoPopup(InfoPopupMsg),
     ErrorPopup(ErrorPopupMsg),
     LoginPopup(LoginPopupMsg),
+    DownloadPopup(DownloadPopupMsg),
     SystemSelectPopup(SystemSelectMsg),
     Error(String),
     Info(String),

coman/src/app/model.rs

@@ -13,17 +13,23 @@ use tuirealm::{
 use crate::{
     app::{
         ids::Id,
-        messages::{CscsMsg, ErrorPopupMsg, InfoPopupMsg, JobMsg, LoginPopupMsg, MenuMsg, Msg, SystemSelectMsg, View},
+        messages::{
+            CscsMsg, DownloadPopupMsg, ErrorPopupMsg, InfoPopupMsg, JobMsg, LoginPopupMsg, MenuMsg, Msg,
+            SystemSelectMsg, View,
+        },
         user_events::{CscsEvent, UserEvent},
     },
     components::{
-        context_menu::ContextMenu, error_popup::ErrorPopup, info_popup::InfoPopup, login_popup::LoginPopup,
-        system_select_popup::SystemSelectPopup, workload_list::WorkloadList,
+        context_menu::ContextMenu, download_popup::DownloadTargetInput, error_popup::ErrorPopup, info_popup::InfoPopup,
+        login_popup::LoginPopup, system_select_popup::SystemSelectPopup, workload_list::WorkloadList,
         workload_log::WorkloadLog,
     },
-    cscs::handlers::{cscs_login, cscs_system_set},
+    cscs::{
+        handlers::{cscs_login, cscs_system_set},
+        ports::TreeAction,
+    },
     trace_dbg,
-    util::ui::draw_area_in_absolute,
+    util::ui::{draw_area_in_absolute, draw_area_in_absolute_fixed_height},
 };
 
 pub struct Model<T>
@@ -54,6 +60,9 @@ where
 
     /// Allows creating user events based on messages
     pub user_event_tx: mpsc::Sender<UserEvent>,
+
+    /// Allows interacting with the file Api
+    pub file_tree_tx: mpsc::Sender<TreeAction>,
 }
 
 impl<T> Model<T>
@@ -67,6 +76,7 @@ where
         select_system_tx: mpsc::Sender<()>,
         job_log_tx: mpsc::Sender<Option<usize>>,
         user_event_tx: mpsc::Sender<UserEvent>,
+        file_tree_tx: mpsc::Sender<TreeAction>,
     ) -> Self {
         Self {
             app,
@@ -78,6 +88,7 @@ where
             select_system_tx,
             job_log_tx,
             user_event_tx,
+            file_tree_tx,
         }
     }
 
@@ -125,6 +136,10 @@ where
                         let popup = draw_area_in_absolute(f.area(), 10);
                         f.render_widget(Clear, popup);
                         app.view(&Id::SystemSelectPopup, f, popup);
+                    } else if app.mounted(&Id::DownloadPopup) {
+                        let popup = draw_area_in_absolute_fixed_height(f.area(), 10, 3);
+                        f.render_widget(Clear, popup);
+                        app.view(&Id::DownloadPopup, f, popup);
                     }
                 })
                 .is_ok()
@@ -227,6 +242,38 @@ where
             }
         }
     }
+    fn handle_download_popup_msg(&mut self, msg: DownloadPopupMsg) -> Option<Msg> {
+        match msg {
+            DownloadPopupMsg::Opened(remote_path) => {
+                if self.app.mounted(&Id::DownloadPopup) {
+                    assert!(self.app.umount(&Id::DownloadPopup).is_ok());
+                }
+                assert!(
+                    self.app
+                        .mount(
+                            Id::DownloadPopup,
+                            Box::new(DownloadTargetInput::new(remote_path)),
+                            vec![]
+                        )
+                        .is_ok()
+                );
+                assert!(self.app.active(&Id::DownloadPopup).is_ok());
+                None
+            }
+            DownloadPopupMsg::PathSet(remote, local) => {
+                assert!(self.app.umount(&Id::DownloadPopup).is_ok());
+                let file_tx = self.file_tree_tx.clone();
+                tokio::spawn(async move {
+                    file_tx.send(TreeAction::Download(remote, local)).await.unwrap();
+                });
+                None
+            }
+            DownloadPopupMsg::Closed => {
+                assert!(self.app.umount(&Id::DownloadPopup).is_ok());
+                None
+            }
+        }
+    }
     fn handle_menu_msg(&mut self, msg: MenuMsg) -> Option<Msg> {
         match msg {
             MenuMsg::Opened => {
@@ -328,6 +375,7 @@ where
                 Msg::Menu(menu_msg) => self.handle_menu_msg(menu_msg),
                 Msg::ErrorPopup(popup_msg) => self.handle_error_popup_msg(popup_msg),
                 Msg::InfoPopup(popup_msg) => self.handle_info_popup_msg(popup_msg),
+                Msg::DownloadPopup(popup_msg) => self.handle_download_popup_msg(popup_msg),
                 Msg::Cscs(CscsMsg::Login(client_id, client_secret)) => {
                     let event_tx = self.user_event_tx.clone();
                     let error_tx = self.error_tx.clone();

coman/src/app/user_events.rs

@@ -1,5 +1,3 @@
-use std::path::PathBuf;
-
 use crate::{
     app::messages::View,
     cscs::api_client::{Job, PathEntry, System},
@@ -16,8 +14,8 @@ pub enum CscsEvent {
 #[derive(Debug, Eq, Clone, PartialEq, PartialOrd, Ord)]
 pub enum FileEvent {
     List(String, Vec<PathEntry>), // Id, Subpaths
-    DownloadFile(PathBuf),
     DownloadCurrentFile,
+    DownloadSuccessful,
 }
 #[derive(Debug, Eq, Clone, PartialOrd, Ord)]
 pub enum UserEvent {

coman/src/components/context_menu.rs

@@ -8,7 +8,7 @@ use tuirealm::{
 
 use crate::app::{
     messages::{MenuMsg, Msg, View},
-    user_events::UserEvent,
+    user_events::{FileEvent, UserEvent},
 };
 
 #[derive(MockComponent)]
@@ -42,9 +42,8 @@ impl ContextMenu {
             .add_row()
             .add_col(TextSpan::from("Switch System").fg(Color::Cyan))
             .add_row()
-            // TODO: removed until we add a popup to set the target path for downloads
-            // .add_col(TextSpan::from("Download").fg(Color::Cyan))
-            // .add_row()
+            .add_col(TextSpan::from("Download").fg(Color::Cyan))
+            .add_row()
             .add_col(TextSpan::from("Quit").fg(Color::Cyan))
             .add_row()
             .build()
@@ -53,10 +52,10 @@ impl ContextMenu {
         match index {
             0 => Some(Msg::Menu(MenuMsg::CscsLogin)),
             1 => Some(Msg::Menu(MenuMsg::CscsSwitchSystem)),
-            // 2 => Some(Msg::Menu(MenuMsg::Event(UserEvent::File(
-            //     FileEvent::DownloadCurrentFile,
-            // )))),
-            2 => Some(Msg::AppClose),
+            2 => Some(Msg::Menu(MenuMsg::Event(UserEvent::File(
+                FileEvent::DownloadCurrentFile,
+            )))),
+            3 => Some(Msg::AppClose),
             _ => Some(Msg::Menu(MenuMsg::Closed)),
         }
     }

coman/src/components/download_popup.rs

@@ -0,0 +1,81 @@
+use std::path::PathBuf;
+
+use tui_realm_stdlib::Input;
+use tuirealm::{
+    Component, Event, MockComponent, State, StateValue,
+    command::{Cmd, CmdResult, Direction, Position},
+    event::{Key, KeyEvent, KeyModifiers},
+    props::{Alignment, BorderType, Borders, Color, InputType, Style},
+};
+
+use crate::app::{
+    messages::{DownloadPopupMsg, Msg},
+    user_events::UserEvent,
+};
+
+#[derive(MockComponent)]
+pub struct DownloadTargetInput {
+    component: Input,
+    remote_path: PathBuf,
+}
+
+impl DownloadTargetInput {
+    pub fn new(remote_path: PathBuf) -> Self {
+        Self {
+            component: Input::default()
+                .borders(Borders::default().modifiers(BorderType::Thick).color(Color::Green))
+                .input_type(InputType::Custom(
+                    |path| {
+                        let path = PathBuf::from(path);
+                        let parent = path.parent();
+                        match parent {
+                            Some(parent) => parent.exists() && path.to_str().is_some(),
+                            None => false,
+                        }
+                    },
+                    |_, _| true,
+                ))
+                .title("Download Target Path", Alignment::Left)
+                .invalid_style(Style::default().fg(Color::Red)),
+            remote_path,
+        }
+    }
+}
+
+impl Component<Msg, UserEvent> for DownloadTargetInput {
+    fn on(&mut self, ev: tuirealm::Event<UserEvent>) -> Option<Msg> {
+        let _ = match ev {
+            Event::Keyboard(KeyEvent { code: Key::Left, .. }) => self.perform(Cmd::Move(Direction::Left)),
+            Event::Keyboard(KeyEvent { code: Key::Right, .. }) => self.perform(Cmd::Move(Direction::Right)),
+            Event::Keyboard(KeyEvent { code: Key::Home, .. }) => self.perform(Cmd::GoTo(Position::Begin)),
+            Event::Keyboard(KeyEvent { code: Key::End, .. }) => self.perform(Cmd::GoTo(Position::End)),
+            Event::Keyboard(KeyEvent { code: Key::Delete, .. }) => self.perform(Cmd::Cancel),
+            Event::Keyboard(KeyEvent {
+                code: Key::Backspace, ..
+            }) => self.perform(Cmd::Delete),
+            Event::Keyboard(KeyEvent {
+                code: Key::Char(ch),
+                modifiers: KeyModifiers::NONE,
+            }) => self.perform(Cmd::Type(ch)),
+            Event::Keyboard(KeyEvent {
+                code: Key::Enter,
+                modifiers: KeyModifiers::NONE,
+            }) => {
+                if let State::One(StateValue::String(target)) = self.state() {
+                    let target = PathBuf::from(target);
+                    return Some(Msg::DownloadPopup(DownloadPopupMsg::PathSet(
+                        self.remote_path.clone(),
+                        target,
+                    )));
+                }
+
+                CmdResult::None
+            }
+            Event::Keyboard(KeyEvent { code: Key::Esc, .. }) => {
+                return Some(Msg::DownloadPopup(DownloadPopupMsg::Closed));
+            }
+            _ => CmdResult::None,
+        };
+        Some(Msg::None)
+    }
+}

coman/src/components/file_tree.rs

@@ -1,4 +1,4 @@
-use std::iter;
+use std::{iter, path::PathBuf};
 
 use tokio::sync::mpsc;
 use tui_realm_treeview::{Node, NodeValue, TREE_CMD_CLOSE, TREE_CMD_OPEN, Tree, TreeView};
@@ -11,11 +11,10 @@ use tuirealm::{
 
 use crate::{
     app::{
-        messages::Msg,
+        messages::{DownloadPopupMsg, Msg},
         user_events::{FileEvent, UserEvent},
     },
     cscs::{api_client::PathType, ports::TreeAction},
-    trace_dbg,
 };
 
 #[derive(Debug, PartialEq, PartialOrd, Ord, Eq, Clone)]
@@ -57,7 +56,7 @@ impl FileTree {
 
         // Load root node
         let tree_tx = file_tree_tx.clone();
-        tokio::spawn(async move { tree_tx.send(TreeAction::List("/".to_owned())).await.unwrap() });
+        tokio::spawn(async move { tree_tx.send(TreeAction::List(PathBuf::from("/"))).await.unwrap() });
 
         Self {
             component: TreeView::default()
@@ -98,7 +97,7 @@ impl Component<Msg, UserEvent> for FileTree {
                             // try loading children if there are none
                             let tree_tx = self.file_tree_tx.clone();
                             tokio::spawn(async move {
-                                tree_tx.send(TreeAction::List(current_id)).await.unwrap();
+                                tree_tx.send(TreeAction::List(PathBuf::from(current_id))).await.unwrap();
                             });
                             CmdResult::None
                         } else {
@@ -149,11 +148,8 @@ impl Component<Msg, UserEvent> for FileTree {
             }
             Event::User(UserEvent::File(FileEvent::DownloadCurrentFile)) => {
                 if let State::One(StateValue::String(id)) = self.state() {
-                    trace_dbg!("download current file");
-                    let tree_tx = self.file_tree_tx.clone();
-                    tokio::spawn(async move {
-                        tree_tx.send(TreeAction::Download(id)).await.unwrap();
-                    });
+                    let path = PathBuf::from(id);
+                    return Some(Msg::DownloadPopup(DownloadPopupMsg::Opened(path)));
                 }
                 CmdResult::None
             }

coman/src/components/global_listener.rs

@@ -5,8 +5,8 @@ use tuirealm::{
 };
 
 use crate::app::{
-    messages::{MenuMsg, Msg, SystemSelectMsg, View},
-    user_events::{CscsEvent, UserEvent},
+    messages::{InfoPopupMsg, MenuMsg, Msg, SystemSelectMsg, View},
+    user_events::{CscsEvent, FileEvent, UserEvent},
 };
 
 #[derive(Default, MockComponent)]
@@ -46,6 +46,9 @@ impl Component<Msg, UserEvent> for GlobalListener {
             Event::User(UserEvent::Cscs(CscsEvent::SelectSystemList(systems))) => {
                 Some(Msg::SystemSelectPopup(SystemSelectMsg::Opened(systems)))
             }
+            Event::User(UserEvent::File(FileEvent::DownloadSuccessful)) => Some(Msg::InfoPopup(InfoPopupMsg::Opened(
+                "File successfully downloaded".to_owned(),
+            ))),
             _ => None,
         }
     }

coman/src/components/mod.rs

@@ -1,4 +1,5 @@
 pub(crate) mod context_menu;
+pub(crate) mod download_popup;
 pub(crate) mod error_popup;
 pub(crate) mod file_tree;
 pub(crate) mod global_listener;

coman/src/config.rs

@@ -8,7 +8,6 @@ use eyre::eyre;
 use lazy_static::lazy_static;
 use serde::{Deserialize, Serialize};
 
-
 const DEFAULT_CONFIG_TOML: &str = include_str!("../.config/config.toml");
 
 #[derive(Clone, Debug, Serialize, Deserialize, Default)]