node_launchpad/components/popup/

change_drive.rs

// Copyright 2024 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under The General Public License (GPL), version 3.
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. Please review the Licences for the specific language governing
// permissions and limitations relating to use of the SAFE Network Software.

use std::{default::Default, path::PathBuf, rc::Rc};

use super::super::utils::centered_rect_fixed;

use color_eyre::Result;
use crossterm::event::{KeyCode, KeyEvent};
use ratatui::{
    layout::{Alignment, Constraint, Direction, Layout, Rect},
    style::{Style, Stylize},
    text::{Line, Span},
    widgets::{
        Block, Borders, HighlightSpacing, List, ListItem, ListState, Padding, Paragraph, Wrap,
    },
};

use crate::{
    action::{Action, OptionsActions},
    components::{
        popup::manage_nodes::{GB, GB_PER_NODE},
        Component,
    },
    config::get_launchpad_nodes_data_dir_path,
    mode::{InputMode, Scene},
    style::{
        clear_area, COOL_GREY, DARK_GUNMETAL, EUCALYPTUS, GHOST_WHITE, INDIGO, LIGHT_PERIWINKLE,
        VIVID_SKY_BLUE,
    },
    system,
};

#[derive(Default)]
enum ChangeDriveState {
    #[default]
    Selection,
    ConfirmChange,
}

#[derive(Default)]
pub struct ChangeDrivePopup {
    active: bool,
    state: ChangeDriveState,
    items: Option<StatefulList<DriveItem>>,
    drive_selection: DriveItem,
    drive_selection_initial_state: DriveItem,
    nodes_to_start: usize,
    storage_mountpoint: PathBuf,
    can_select: bool, // Used to enable the "Change Drive" button based on conditions
}

impl ChangeDrivePopup {
    pub fn new(storage_mountpoint: PathBuf, nodes_to_start: usize) -> Result<Self> {
        debug!("Drive Mountpoint in Config: {:?}", storage_mountpoint);
        Ok(ChangeDrivePopup {
            active: false,
            state: ChangeDriveState::Selection,
            items: None,
            drive_selection: DriveItem::default(),
            drive_selection_initial_state: DriveItem::default(),
            nodes_to_start,
            storage_mountpoint,
            can_select: false,
        })
    }

    // --- Interactions with the List of drives ---

    /// Deselects all drives in the list of items
    ///
    fn deselect_all(&mut self) {
        if let Some(ref mut items) = self.items {
            for item in &mut items.items {
                if item.status != DriveStatus::NotAvailable
                    && item.status != DriveStatus::NotEnoughSpace
                {
                    item.status = DriveStatus::NotSelected;
                }
            }
        }
    }
    /// Assigns to self.drive_selection the selected drive in the list
    ///
    fn assign_drive_selection(&mut self) {
        self.deselect_all();
        if let Some(ref mut items) = self.items {
            if let Some(i) = items.state.selected() {
                items.items[i].status = DriveStatus::Selected;
                self.drive_selection = items.items[i].clone();
            }
        }
    }
    /// Highlights the drive that is currently selected in the list of items.
    ///
    fn select_drive(&mut self) {
        self.deselect_all();
        if let Some(ref mut items) = self.items {
            for (index, item) in items.items.iter_mut().enumerate() {
                if item.mountpoint == self.drive_selection.mountpoint {
                    item.status = DriveStatus::Selected;
                    items.state.select(Some(index));
                    break;
                }
            }
        }
    }
    /// Returns the highlighted drive in the list of items.
    ///
    fn return_selection(&mut self) -> DriveItem {
        if let Some(ref mut items) = self.items {
            if let Some(i) = items.state.selected() {
                return items.items[i].clone();
            }
        }
        DriveItem::default()
    }

    /// Updates the drive items based on the current nodes_to_start value.
    fn update_drive_items(&mut self) -> Result<()> {
        let drives_and_space = system::get_list_of_available_drives_and_available_space()?;
        let drives_items: Vec<DriveItem> = drives_and_space
            .iter()
            .map(|(drive_name, mountpoint, space, available)| {
                let size_str = format!("{:.2} GB", *space as f64 / 1e9);
                let has_enough_space = *space as u128
                    >= (GB_PER_NODE as u128 * GB as u128 * self.nodes_to_start as u128);
                DriveItem {
                    name: drive_name.to_string(),
                    mountpoint: mountpoint.clone(),
                    size: size_str.clone(),
                    status: if *mountpoint == self.storage_mountpoint {
                        self.drive_selection = DriveItem {
                            name: drive_name.to_string(),
                            mountpoint: mountpoint.clone(),
                            size: size_str.clone(),
                            status: DriveStatus::Selected,
                        };
                        DriveStatus::Selected
                    } else if !available {
                        DriveStatus::NotAvailable
                    } else if !has_enough_space {
                        DriveStatus::NotEnoughSpace
                    } else {
                        DriveStatus::NotSelected
                    },
                }
            })
            .collect();
        self.items = Some(StatefulList::with_items(drives_items.clone()));
        debug!("Drives and space: {:?}", drives_and_space);
        debug!("Drives items: {:?}", drives_items);
        Ok(())
    }

    // -- Draw functions --

    // Draws the Drive Selection screen
    fn draw_selection_state(
        &mut self,
        f: &mut crate::tui::Frame<'_>,
        layer_zero: Rect,
        layer_one: Rc<[Rect]>,
    ) -> Paragraph {
        let pop_up_border = Paragraph::new("").block(
            Block::default()
                .borders(Borders::ALL)
                .title(" Select a Drive ")
                .bold()
                .title_style(Style::new().fg(VIVID_SKY_BLUE))
                .padding(Padding::uniform(2))
                .border_style(Style::new().fg(VIVID_SKY_BLUE)),
        );
        clear_area(f, layer_zero);

        let layer_two = Layout::new(
            Direction::Vertical,
            [
                // for the table
                Constraint::Length(10),
                // gap
                Constraint::Length(3),
                // for the buttons
                Constraint::Length(1),
            ],
        )
        .split(layer_one[1]);

        // Drive selector
        let items: Vec<ListItem> = self
            .items
            .as_ref()
            .unwrap()
            .items
            .iter()
            .enumerate()
            .map(|(i, drive_item)| drive_item.to_list_item(i, layer_two[0].width as usize))
            .collect();

        let items = List::new(items)
            .block(Block::default().padding(Padding::uniform(1)))
            .highlight_style(Style::default().bg(INDIGO))
            .highlight_spacing(HighlightSpacing::Always);

        f.render_stateful_widget(items, layer_two[0], &mut self.items.clone().unwrap().state);

        // Dash
        let dash = Block::new()
            .borders(Borders::BOTTOM)
            .border_style(Style::new().fg(GHOST_WHITE));
        f.render_widget(dash, layer_two[1]);

        // Buttons
        let buttons_layer =
            Layout::horizontal(vec![Constraint::Percentage(50), Constraint::Percentage(50)])
                .split(layer_two[2]);

        let button_no = Line::from(vec![Span::styled(
            "Cancel [Esc]",
            Style::default().fg(LIGHT_PERIWINKLE),
        )]);

        f.render_widget(
            Paragraph::new(button_no)
                .block(Block::default().padding(Padding::horizontal(2)))
                .alignment(Alignment::Left),
            buttons_layer[0],
        );

        let button_yes = Line::from(vec![
            Span::styled(
                "Change Drive ",
                if self.can_select {
                    Style::default().fg(EUCALYPTUS)
                } else {
                    Style::default().fg(COOL_GREY)
                },
            ),
            Span::styled("[Enter]", Style::default().fg(LIGHT_PERIWINKLE).bold()),
        ])
        .alignment(Alignment::Right);

        f.render_widget(
            Paragraph::new(button_yes)
                .block(Block::default().padding(Padding::horizontal(2)))
                .alignment(Alignment::Right),
            buttons_layer[1],
        );

        pop_up_border
    }

    // Draws the Confirmation screen
    fn draw_confirm_change_state(
        &mut self,
        f: &mut crate::tui::Frame<'_>,
        layer_zero: Rect,
        layer_one: Rc<[Rect]>,
    ) -> Paragraph {
        let pop_up_border = Paragraph::new("").block(
            Block::default()
                .borders(Borders::ALL)
                .title(" Confirm & Reset ")
                .bold()
                .title_style(Style::new().fg(VIVID_SKY_BLUE))
                .padding(Padding::uniform(2))
                .border_style(Style::new().fg(VIVID_SKY_BLUE))
                .bg(DARK_GUNMETAL),
        );
        clear_area(f, layer_zero);

        let layer_two = Layout::new(
            Direction::Vertical,
            [
                // for the table
                Constraint::Length(10),
                // gap
                Constraint::Length(3),
                // for the buttons
                Constraint::Length(1),
            ],
        )
        .split(layer_one[1]);

        // Text
        let text = vec![
            Line::from(vec![]), // Empty line
            Line::from(vec![]), // Empty line
            Line::from(vec![
                Span::styled("Changing storage to ", Style::default().fg(GHOST_WHITE)),
                Span::styled(
                    format!("{} ", self.drive_selection.name),
                    Style::default().fg(VIVID_SKY_BLUE),
                ),
                Span::styled("will ", Style::default().fg(GHOST_WHITE)),
            ])
            .alignment(Alignment::Center),
            Line::from(vec![Span::styled(
                "reset all nodes.",
                Style::default().fg(GHOST_WHITE),
            )])
            .alignment(Alignment::Center),
            Line::from(vec![]), // Empty line
            Line::from(vec![]), // Empty line
            Line::from(vec![
                Span::styled("You’ll need to ", Style::default().fg(GHOST_WHITE)),
                Span::styled("Add ", Style::default().fg(GHOST_WHITE).bold()),
                Span::styled("and ", Style::default().fg(GHOST_WHITE)),
                Span::styled("Start ", Style::default().fg(GHOST_WHITE).bold()),
                Span::styled(
                    "them again afterwards. Are you sure you want to continue?",
                    Style::default().fg(GHOST_WHITE),
                ),
            ])
            .alignment(Alignment::Center),
        ];
        let paragraph = Paragraph::new(text)
            .wrap(Wrap { trim: false })
            .block(
                Block::default()
                    .borders(Borders::NONE)
                    .padding(Padding::horizontal(2)),
            )
            .alignment(Alignment::Center)
            .style(Style::default().fg(GHOST_WHITE).bg(DARK_GUNMETAL));

        f.render_widget(paragraph, layer_two[0]);

        // Dash
        let dash = Block::new()
            .borders(Borders::BOTTOM)
            .border_style(Style::new().fg(GHOST_WHITE));
        f.render_widget(dash, layer_two[1]);

        // Buttons
        let buttons_layer =
            Layout::horizontal(vec![Constraint::Percentage(30), Constraint::Percentage(70)])
                .split(layer_two[2]);

        let button_no = Line::from(vec![Span::styled(
            "Back [Esc]",
            Style::default().fg(LIGHT_PERIWINKLE),
        )]);

        f.render_widget(
            Paragraph::new(button_no)
                .block(Block::default().padding(Padding::horizontal(2)))
                .alignment(Alignment::Left),
            buttons_layer[0],
        );

        let button_yes = Line::from(vec![
            Span::styled("Yes, change drive ", Style::default().fg(EUCALYPTUS)),
            Span::styled("[Enter]", Style::default().fg(LIGHT_PERIWINKLE).bold()),
        ])
        .alignment(Alignment::Right);

        f.render_widget(
            Paragraph::new(button_yes)
                .block(Block::default().padding(Padding::horizontal(2)))
                .alignment(Alignment::Right),
            buttons_layer[1],
        );

        pop_up_border
    }
}

impl Component for ChangeDrivePopup {
    fn handle_key_events(&mut self, key: KeyEvent) -> Result<Vec<Action>> {
        if !self.active {
            return Ok(vec![]);
        }
        let send_back: Vec<Action> = match &self.state {
            ChangeDriveState::Selection => {
                match key.code {
                    KeyCode::Enter => {
                        // We allow action if we have more than one drive and the action is not
                        // over the drive already selected
                        let drive = self.return_selection();
                        if self.can_select {
                            debug!(
                                "Got Enter and there's a new selection, storing value and switching to Options"
                            );
                            debug!("Drive selected: {:?}", drive.name);
                            self.drive_selection_initial_state = self.drive_selection.clone();
                            self.assign_drive_selection();
                            self.state = ChangeDriveState::ConfirmChange;
                            vec![]
                        } else {
                            debug!("Got Enter, but no new selection. We should not do anything");
                            vec![]
                        }
                    }
                    KeyCode::Esc => {
                        debug!("Got Esc, switching to Options");
                        vec![Action::SwitchScene(Scene::Options)]
                    }
                    KeyCode::Up => {
                        if let Some(ref mut items) = self.items {
                            if items.items.len() > 1 {
                                items.previous();
                                let drive = self.return_selection();
                                self.can_select = drive.mountpoint
                                    != self.drive_selection.mountpoint
                                    && drive.status != DriveStatus::NotAvailable
                                    && drive.status != DriveStatus::NotEnoughSpace;
                            }
                        }
                        vec![]
                    }
                    KeyCode::Down => {
                        if let Some(ref mut items) = self.items {
                            if items.items.len() > 1 {
                                items.next();
                                let drive = self.return_selection();
                                self.can_select = drive.mountpoint
                                    != self.drive_selection.mountpoint
                                    && drive.status != DriveStatus::NotAvailable
                                    && drive.status != DriveStatus::NotEnoughSpace;
                            }
                        }
                        vec![]
                    }
                    _ => {
                        vec![]
                    }
                }
            }
            ChangeDriveState::ConfirmChange => match key.code {
                KeyCode::Enter => {
                    debug!("Got Enter, storing value and switching to Options");
                    // Let's create the data directory for the new drive
                    self.drive_selection = self.return_selection();
                    match get_launchpad_nodes_data_dir_path(&self.drive_selection.mountpoint, true)
                    {
                        Ok(_path) => {
                            // TODO: probably delete the old data directory before switching
                            // Taking in account if it's the default mountpoint
                            // (were the executable is)
                            vec![
                                Action::StoreStorageDrive(
                                    self.drive_selection.mountpoint.clone(),
                                    self.drive_selection.name.clone(),
                                ),
                                Action::OptionsActions(OptionsActions::UpdateStorageDrive(
                                    self.drive_selection.mountpoint.clone(),
                                    self.drive_selection.name.clone(),
                                )),
                                Action::SwitchScene(Scene::Status),
                            ]
                        }
                        Err(e) => {
                            self.drive_selection = self.drive_selection_initial_state.clone();
                            self.state = ChangeDriveState::Selection;
                            error!(
                                "Error creating folder {:?}: {}",
                                self.drive_selection.mountpoint, e
                            );
                            vec![Action::SwitchScene(Scene::Options)]
                        }
                    }
                }
                KeyCode::Esc => {
                    debug!("Got Esc, switching to Options");
                    self.drive_selection = self.drive_selection_initial_state.clone();
                    self.state = ChangeDriveState::Selection;
                    vec![Action::SwitchScene(Scene::Options)]
                }
                _ => {
                    vec![]
                }
            },
        };
        Ok(send_back)
    }

    fn update(&mut self, action: Action) -> Result<Option<Action>> {
        let send_back = match action {
            Action::SwitchScene(scene) => match scene {
                Scene::ChangeDrivePopUp => {
                    self.active = true;
                    self.can_select = false;
                    self.state = ChangeDriveState::Selection;
                    let _ = self.update_drive_items();
                    self.select_drive();
                    Some(Action::SwitchInputMode(InputMode::Entry))
                }
                _ => {
                    self.active = false;
                    None
                }
            },
            // Useful when the user has selected a drive but didn't confirm it
            Action::OptionsActions(OptionsActions::UpdateStorageDrive(mountpoint, drive_name)) => {
                self.drive_selection.mountpoint = mountpoint;
                self.drive_selection.name = drive_name;
                self.select_drive();
                None
            }
            // We need to refresh the list of available drives because of the space
            Action::StoreNodesToStart(ref nodes_to_start) => {
                self.nodes_to_start = *nodes_to_start;
                let _ = self.update_drive_items();
                None
            }
            Action::StoreStorageDrive(mountpoint, _drive_name) => {
                self.storage_mountpoint = mountpoint;
                let _ = self.update_drive_items();
                self.select_drive();
                None
            }

            _ => None,
        };
        Ok(send_back)
    }

    fn draw(&mut self, f: &mut crate::tui::Frame<'_>, area: Rect) -> Result<()> {
        if !self.active {
            return Ok(());
        }

        let layer_zero = centered_rect_fixed(52, 15, area);

        let layer_one = Layout::new(
            Direction::Vertical,
            [
                // Padding from title to the table
                Constraint::Length(1),
                // Table
                Constraint::Min(1),
                // for the pop_up_border
                Constraint::Length(1),
            ],
        )
        .split(layer_zero);

        let pop_up_border: Paragraph = match self.state {
            ChangeDriveState::Selection => self.draw_selection_state(f, layer_zero, layer_one),
            ChangeDriveState::ConfirmChange => {
                self.draw_confirm_change_state(f, layer_zero, layer_one)
            }
        };
        // We render now so the borders are on top of the other widgets
        f.render_widget(pop_up_border, layer_zero);

        Ok(())
    }
}

#[derive(Default, Clone)]
struct StatefulList<T> {
    state: ListState,
    items: Vec<T>,
    last_selected: Option<usize>,
}

impl<T> StatefulList<T> {
    fn with_items(items: Vec<T>) -> Self {
        StatefulList {
            state: ListState::default(),
            items,
            last_selected: None,
        }
    }

    fn next(&mut self) {
        let i = match self.state.selected() {
            Some(i) => {
                if i >= self.items.len() - 1 {
                    0
                } else {
                    i + 1
                }
            }
            None => self.last_selected.unwrap_or(0),
        };
        self.state.select(Some(i));
    }

    fn previous(&mut self) {
        let i = match self.state.selected() {
            Some(i) => {
                if i == 0 {
                    self.items.len() - 1
                } else {
                    i - 1
                }
            }
            None => self.last_selected.unwrap_or(0),
        };
        self.state.select(Some(i));
    }
}

#[derive(Default, Debug, Copy, Clone, PartialEq)]
enum DriveStatus {
    Selected,
    #[default]
    NotSelected,
    NotEnoughSpace,
    NotAvailable,
}

#[derive(Default, Debug, Clone)]
pub struct DriveItem {
    name: String,
    mountpoint: PathBuf,
    size: String,
    status: DriveStatus,
}

impl DriveItem {
    fn to_list_item(&self, _index: usize, width: usize) -> ListItem {
        let spaces = width - self.name.len() - self.size.len() - "   ".len() - 4;
        let line = match self.status {
            DriveStatus::NotSelected => Line::from(vec![
                Span::raw("   "),
                Span::styled(self.name.clone(), Style::default().fg(VIVID_SKY_BLUE)),
                Span::raw(" ".repeat(spaces)),
                Span::styled(self.size.clone(), Style::default().fg(LIGHT_PERIWINKLE)),
            ]),
            DriveStatus::Selected => Line::from(vec![
                Span::styled(" ►", Style::default().fg(EUCALYPTUS)),
                Span::raw(" "),
                Span::styled(self.name.clone(), Style::default().fg(VIVID_SKY_BLUE)),
                Span::raw(" ".repeat(spaces)),
                Span::styled(self.size.clone(), Style::default().fg(GHOST_WHITE)),
            ]),
            DriveStatus::NotEnoughSpace => Line::from(vec![
                Span::raw("   "),
                Span::styled(self.name.clone(), Style::default().fg(COOL_GREY)),
                Span::raw(" ".repeat(spaces)),
                Span::styled(self.size.clone(), Style::default().fg(COOL_GREY)),
            ]),
            DriveStatus::NotAvailable => {
                let legend = "No Access";
                let spaces = width - self.name.len() - legend.len() - "   ".len() - 4;
                Line::from(vec![
                    Span::raw("   "),
                    Span::styled(self.name.clone(), Style::default().fg(COOL_GREY)),
                    Span::raw(" ".repeat(spaces)),
                    Span::styled(legend, Style::default().fg(COOL_GREY)),
                ])
            }
        };

        ListItem::new(line)
    }
}