"]
description = "A simple tui to view & control docker containers"
@@ -15,14 +15,14 @@ categories = ["command-line-utilities"]
anyhow = "1.0"
bollard = "0.14"
cansi = "2.2"
-clap={version="4.1", features = ["derive", "unicode", "color"] }
+clap={version="4.2", features = ["derive", "unicode", "color"] }
crossterm = "0.26"
futures-util = "0.3"
parking_lot = {version= "0.12"}
-tokio = {version = "1.26", features=["full"]}
+tokio = {version = "1.27", features=["full"]}
tracing = "0.1"
tracing-subscriber = "0.3"
-tui = "0.19"
+ratatui = "0.20"
uuid = {version = "1.3", features = ["v4", "fast-rng"]}
[dev-dependencies]
diff --git a/README.md b/README.md
index aa4ee99..11a9d48 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@
- Built in Rust, making heavy use of tui-rs & Bollard
+ Built in Rust, making heavy use of ratatui & Bollard
@@ -27,12 +27,21 @@ cargo install oxker
```
### Docker
-Published on Docker Hub, with images built for `linux/amd64`, `linux/arm64`, and `linux/arm/v6`
+Published on Docker Hub and ghcr.io,
+with images built for `linux/amd64`, `linux/arm64`, and `linux/arm/v6`
+
+**via Docker Hub**
```shell
docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock:ro --pull=always mrjackwills/oxker
```
+**via ghcr.io**
+
+```shell
+docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock:ro --pull=always ghcr.io/mrjackwills/oxker
+```
+
### Nix
Using nix flakes, oxker can be ran directly with
@@ -68,7 +77,7 @@ rm oxker_linux_x86_64.tar.gz oxker
or, for automatic platform selection, download, and installation (to `$HOME/.local/bin`)
-*One should always verify script content before running in a shell*
+*One should always verify script content before running in a shell*
```shell
curl https://raw.githubusercontent.com/mrjackwills/oxker/main/install.sh | bash
diff --git a/src/app_data/container_state.rs b/src/app_data/container_state.rs
index b1e1ba6..974356b 100644
--- a/src/app_data/container_state.rs
+++ b/src/app_data/container_state.rs
@@ -4,7 +4,7 @@ use std::{
fmt,
};
-use tui::{
+use ratatui::{
style::Color,
widgets::{ListItem, ListState},
};
@@ -207,6 +207,7 @@ pub enum DockerControls {
Start,
Stop,
Unpause,
+ Delete,
}
impl DockerControls {
@@ -216,6 +217,7 @@ impl DockerControls {
Self::Restart => Color::Magenta,
Self::Start => Color::Green,
Self::Stop => Color::Red,
+ Self::Delete => Color::Gray,
Self::Unpause => Color::Blue,
}
}
@@ -223,11 +225,11 @@ impl DockerControls {
/// Docker commands available depending on the containers state
pub fn gen_vec(state: State) -> Vec {
match state {
- State::Dead | State::Exited => vec![Self::Start, Self::Restart],
- State::Paused => vec![Self::Unpause, Self::Stop],
- State::Restarting => vec![Self::Stop],
- State::Running => vec![Self::Pause, Self::Restart, Self::Stop],
- _ => vec![],
+ State::Dead | State::Exited => vec![Self::Start, Self::Restart, Self::Delete],
+ State::Paused => vec![Self::Unpause, Self::Stop, Self::Delete],
+ State::Restarting => vec![Self::Stop, Self::Delete],
+ State::Running => vec![Self::Pause, Self::Restart, Self::Stop, Self::Delete],
+ _ => vec![Self::Delete],
}
}
}
@@ -236,6 +238,7 @@ impl fmt::Display for DockerControls {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let disp = match self {
Self::Pause => "pause",
+ Self::Delete => "delete",
Self::Restart => "restart",
Self::Start => "start",
Self::Stop => "stop",
diff --git a/src/app_data/mod.rs b/src/app_data/mod.rs
index 93d5769..fda6cbb 100644
--- a/src/app_data/mod.rs
+++ b/src/app_data/mod.rs
@@ -1,7 +1,7 @@
use bollard::models::ContainerSummary;
use core::fmt;
+use ratatui::widgets::{ListItem, ListState};
use std::time::{SystemTime, UNIX_EPOCH};
-use tui::widgets::{ListItem, ListState};
mod container_state;
@@ -456,6 +456,15 @@ impl AppData {
self.containers.items.iter_mut().find(|i| &i.id == id)
}
+ /// return a mutable container by given id
+ pub fn get_container_name_by_id(&mut self, id: &ContainerId) -> Option {
+ self.containers
+ .items
+ .iter_mut()
+ .find(|i| &i.id == id)
+ .map(|i| i.name.clone())
+ }
+
/// Find the id of the currently selected container.
/// If any containers on system, will always return a ContainerId
/// Only returns None when no containers found.
@@ -532,6 +541,7 @@ impl AppData {
}
}
}
+
// Trim a &String and return String
let trim_owned = |x: &String| x.trim().to_owned();
diff --git a/src/docker_data/message.rs b/src/docker_data/message.rs
index f7de6f5..0a6b67e 100644
--- a/src/docker_data/message.rs
+++ b/src/docker_data/message.rs
@@ -2,11 +2,13 @@ use crate::app_data::ContainerId;
#[derive(Debug, Clone)]
pub enum DockerMessage {
- Update,
- Start(ContainerId),
- Restart(ContainerId),
+ Delete(ContainerId),
+ ConfirmDelete(ContainerId),
Pause(ContainerId),
- Unpause(ContainerId),
- Stop(ContainerId),
Quit,
+ Restart(ContainerId),
+ Start(ContainerId),
+ Stop(ContainerId),
+ Unpause(ContainerId),
+ Update,
}
diff --git a/src/docker_data/mod.rs b/src/docker_data/mod.rs
index 8104ccc..92fd28c 100644
--- a/src/docker_data/mod.rs
+++ b/src/docker_data/mod.rs
@@ -1,5 +1,8 @@
use bollard::{
- container::{ListContainersOptions, LogsOptions, StartContainerOptions, Stats, StatsOptions},
+ container::{
+ ListContainersOptions, LogsOptions, RemoveContainerOptions, StartContainerOptions, Stats,
+ StatsOptions,
+ },
service::ContainerSummary,
Docker,
};
@@ -335,13 +338,14 @@ impl DockerData {
}
/// Handle incoming messages, container controls & all container information update
- /// Spawn dowcker commands off into own thread
+ /// Spawn Docker commands off into own thread
async fn message_handler(&mut self) {
while let Some(message) = self.receiver.recv().await {
let docker = Arc::clone(&self.docker);
let gui_state = Arc::clone(&self.gui_state);
let app_data = Arc::clone(&self.app_data);
let uuid = Uuid::new_v4();
+ // TODO need to refactor these
match message {
DockerMessage::Pause(id) => {
tokio::spawn(async move {
@@ -397,6 +401,31 @@ impl DockerData {
});
self.update_everything().await;
}
+ DockerMessage::Delete(id) => {
+ tokio::spawn(async move {
+ let loading_spin = Self::loading_spin(uuid, &gui_state).await;
+ if docker
+ .remove_container(
+ id.get(),
+ Some(RemoveContainerOptions {
+ v: false,
+ force: true,
+ link: false,
+ }),
+ )
+ .await
+ .is_err()
+ {
+ Self::set_error(&app_data, DockerControls::Stop, &gui_state);
+ }
+ Self::stop_loading_spin(&gui_state, &loading_spin, uuid);
+ });
+ self.update_everything().await;
+ self.gui_state.lock().set_delete_container(None);
+ }
+ DockerMessage::ConfirmDelete(id) => {
+ self.gui_state.lock().set_delete_container(Some(id));
+ }
DockerMessage::Update => self.update_everything().await,
DockerMessage::Quit => {
self.spawns
diff --git a/src/input_handler/mod.rs b/src/input_handler/mod.rs
index bb60bdd..421f86a 100644
--- a/src/input_handler/mod.rs
+++ b/src/input_handler/mod.rs
@@ -8,18 +8,18 @@ use crossterm::{
execute,
};
use parking_lot::Mutex;
+use ratatui::layout::Rect;
use tokio::{
sync::mpsc::{Receiver, Sender},
task::JoinHandle,
};
-use tui::layout::Rect;
mod message;
use crate::{
app_data::{AppData, DockerControls, Header},
app_error::AppError,
docker_data::DockerMessage,
- ui::{GuiState, SelectablePanel, Status, Ui},
+ ui::{DeleteButton, GuiState, SelectablePanel, Status, Ui},
};
pub use message::InputMessages;
@@ -62,13 +62,21 @@ impl InputHandler {
match message {
InputMessages::ButtonPress(key) => self.button_press(key.0, key.1).await,
InputMessages::MouseEvent(mouse_event) => {
- let error_or_help = self
- .gui_state
- .lock()
- .status_contains(&[Status::Error, Status::Help]);
+ let error_or_help = self.gui_state.lock().status_contains(&[
+ Status::Error,
+ Status::Help,
+ Status::DeleteConfirm,
+ ]);
if !error_or_help {
self.mouse_press(mouse_event);
}
+ let delete_confirm = self
+ .gui_state
+ .lock()
+ .status_contains(&[Status::DeleteConfirm]);
+ if delete_confirm {
+ self.button_intersect(mouse_event).await;
+ }
}
}
if !self.is_running.load(Ordering::SeqCst) {
@@ -133,41 +141,59 @@ impl InputHandler {
}
}
+ /// This is executed from the Delete Confirm dialog, and will send an internal message to actually remove the given container
+ async fn confirm_delete(&self) {
+ let id = self.gui_state.lock().get_delete_container();
+ if let Some(id) = id {
+ self.docker_sender
+ .send(DockerMessage::Delete(id))
+ .await
+ .ok();
+ }
+ }
+
+ /// This is executed from the Delete Confirm dialog, and will clear the delete_container information (removes id and closes panel)
+ fn clear_delete(&self) {
+ self.gui_state.lock().set_delete_container(None);
+ }
+
/// Handle any keyboard button events
#[allow(clippy::too_many_lines)]
async fn button_press(&mut self, key_code: KeyCode, key_modififer: KeyModifiers) {
// TODO - refactor this to a single call, maybe return Error, Help or Normal
let contains_error = self.gui_state.lock().status_contains(&[Status::Error]);
let contains_help = self.gui_state.lock().status_contains(&[Status::Help]);
+ let contains_delete = self
+ .gui_state
+ .lock()
+ .status_contains(&[Status::DeleteConfirm]);
- // Quit on Ctrl + c/C
+ // Always just quit on Ctrl + c/C or q/Q
let is_c = || key_code == KeyCode::Char('c') || key_code == KeyCode::Char('C');
- if key_modififer == KeyModifiers::CONTROL && is_c() {
+ let is_q = || key_code == KeyCode::Char('q') || key_code == KeyCode::Char('Q');
+ if key_modififer == KeyModifiers::CONTROL && is_c() || is_q() {
self.quit().await;
}
if contains_error {
- match key_code {
- KeyCode::Char('q' | 'Q') => self.quit().await,
- KeyCode::Char('c' | 'C') => {
- self.app_data.lock().remove_error();
- self.gui_state.lock().status_del(Status::Error);
- }
- _ => (),
+ if let KeyCode::Char('c' | 'C') = key_code {
+ self.app_data.lock().remove_error();
+ self.gui_state.lock().status_del(Status::Error);
}
} else if contains_help {
match key_code {
- KeyCode::Char('q' | 'Q') => self.quit().await,
KeyCode::Char('h' | 'H') => self.gui_state.lock().status_del(Status::Help),
KeyCode::Char('m' | 'M') => self.m_key(),
_ => (),
}
- } else {
- // let abc = KeyEvent::new(KeyCode::Char('d'), KeyModifiers::Ctrl);
+ } else if contains_delete {
+ match key_code {
+ KeyCode::Char('y' | 'Y') => self.confirm_delete().await,
+ KeyCode::Char('n' | 'N') => self.clear_delete(),
+ _ => (),
+ }
+ } else {
match key_code {
- // KeyCode::Ctrl('c') => {
- // self.quit().await;
- // }
KeyCode::Char('0') => self.app_data.lock().reset_sorted(),
KeyCode::Char('1') => self.sort(Header::State),
KeyCode::Char('2') => self.sort(Header::Status),
@@ -178,7 +204,6 @@ impl InputHandler {
KeyCode::Char('7') => self.sort(Header::Image),
KeyCode::Char('8') => self.sort(Header::Rx),
KeyCode::Char('9') => self.sort(Header::Tx),
- KeyCode::Char('q' | 'Q') => self.quit().await,
KeyCode::Char('h' | 'H') => self.gui_state.lock().status_push(Status::Help),
KeyCode::Char('m' | 'M') => self.m_key(),
KeyCode::Tab => {
@@ -251,6 +276,11 @@ impl InputHandler {
};
if let Some(id) = option_id {
match command {
+ DockerControls::Delete => self
+ .docker_sender
+ .send(DockerMessage::ConfirmDelete(id))
+ .await
+ .ok(),
DockerControls::Pause => {
self.docker_sender.send(DockerMessage::Pause(id)).await.ok()
}
@@ -280,6 +310,25 @@ impl InputHandler {
}
}
+ /// Check if a button press interacts with either the yes or no buttons in the delete container confirm window
+ async fn button_intersect(&mut self, mouse_event: MouseEvent) {
+ if mouse_event.kind == MouseEventKind::Down(MouseButton::Left) {
+ let intersect = self.gui_state.lock().button_intersect(Rect::new(
+ mouse_event.column,
+ mouse_event.row,
+ 1,
+ 1,
+ ));
+
+ if let Some(button) = intersect {
+ match button {
+ DeleteButton::Yes => self.confirm_delete().await,
+ DeleteButton::No => self.clear_delete(),
+ }
+ }
+ }
+ }
+
/// Handle mouse button events
fn mouse_press(&mut self, mouse_event: MouseEvent) {
match mouse_event.kind {
diff --git a/src/main.rs b/src/main.rs
index fd99297..29db59b 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -40,7 +40,7 @@ use ui::{GuiState, Status, Ui};
use crate::docker_data::DockerMessage;
-// this is the entry point when running as a Docker Container, and is used, in conjunction with the `CONTAINER_ENV` ENV, to check if we are running as a Docker Container
+/// This is the entry point when running as a Docker Container, and is used, in conjunction with the `CONTAINER_ENV` ENV, to check if we are running as a Docker Container
const ENTRY_POINT: &str = "/app/oxker";
const ENV_KEY: &str = "OXKER_RUNTIME";
const ENV_VALUE: &str = "container";
diff --git a/src/parse_args/mod.rs b/src/parse_args/mod.rs
index 2a881ba..d6c823d 100644
--- a/src/parse_args/mod.rs
+++ b/src/parse_args/mod.rs
@@ -40,7 +40,7 @@ impl CliArgs {
// Quit the program if the docker update argument is 0
// Should maybe change it to check if less than 100
if args.docker_interval == 0 {
- error!("docker args needs to be greater than 0");
+ error!("\"-d\" argument needs to be greater than 0");
process::exit(1)
}
Self {
diff --git a/src/ui/color_match.rs b/src/ui/color_match.rs
index d77a40e..2e349f6 100644
--- a/src/ui/color_match.rs
+++ b/src/ui/color_match.rs
@@ -1,7 +1,7 @@
pub mod log_sanitizer {
use cansi::{v3::categorise_text, Color as CansiColor, Intensity};
- use tui::{
+ use ratatui::{
style::{Color, Modifier, Style},
text::{Span, Spans},
};
diff --git a/src/ui/draw_blocks.rs b/src/ui/draw_blocks.rs
index d09105b..29e5589 100644
--- a/src/ui/draw_blocks.rs
+++ b/src/ui/draw_blocks.rs
@@ -1,7 +1,5 @@
use parking_lot::Mutex;
-use std::default::Default;
-use std::{fmt::Display, sync::Arc};
-use tui::{
+use ratatui::{
backend::Backend,
layout::{Alignment, Constraint, Direction, Layout, Rect},
style::{Color, Modifier, Style},
@@ -13,6 +11,8 @@ use tui::{
},
Frame,
};
+use std::default::Default;
+use std::{fmt::Display, sync::Arc};
use crate::app_data::{Header, SortedOrder};
use crate::ui::Status;
@@ -21,7 +21,7 @@ use crate::{
app_error::AppError,
};
-use super::gui_state::{BoxLocation, Region};
+use super::gui_state::{BoxLocation, DeleteButton, Region};
use super::{GuiState, SelectablePanel};
const NAME_TEXT: &str = r#"
@@ -43,6 +43,14 @@ const MARGIN: &str = " ";
const ARROW: &str = "▶ ";
const CIRCLE: &str = "⚪ ";
+/// From a given &str, return the maximum number of chars on a single line
+fn max_line_width(text: &str) -> usize {
+ text.lines()
+ .map(|i| i.chars().count())
+ .max()
+ .unwrap_or_default()
+}
+
/// Generate block, add a border if is the selected panel,
/// add custom title based on state of each panel
fn generate_block<'a>(
@@ -53,7 +61,7 @@ fn generate_block<'a>(
) -> Block<'a> {
gui_state
.lock()
- .update_heading_map(Region::Panel(panel), area);
+ .update_region_map(Region::Panel(panel), area);
let current_selected_panel = gui_state.lock().selected_panel;
let mut title = match panel {
SelectablePanel::Containers => {
@@ -424,7 +432,7 @@ pub fn heading_bar(
let info_text = format!("( h ) {suffix} help {MARGIN}",);
let info_width = info_text.chars().count();
- let column_width = usize::from(area.width) - info_width;
+ let column_width = usize::from(area.width).saturating_sub(info_width);
let column_width = if column_width > 0 { column_width } else { 1 };
let splits = if has_containers {
vec![
@@ -459,7 +467,7 @@ pub fn heading_bar(
let rect = headers_section[index];
gui_state
.lock()
- .update_heading_map(Region::Header(header), rect);
+ .update_region_map(Region::Header(header), rect);
f.render_widget(paragraph, rect);
}
}
@@ -479,14 +487,6 @@ pub fn heading_bar(
f.render_widget(help_paragraph, split_bar[help_index]);
}
-/// From a given &str, return the maximum number of chars on a single line
-fn max_line_width(text: &str) -> usize {
- text.lines()
- .map(|i| i.chars().count())
- .max()
- .unwrap_or_default()
-}
-
/// Help popup box needs these three pieces of information
struct HelpInfo {
spans: Vec>,
@@ -500,7 +500,7 @@ impl HelpInfo {
spans
.iter()
.flat_map(|x| x.0.iter())
- .map(tui::text::Span::width)
+ .map(ratatui::text::Span::width)
.max()
.unwrap_or(1)
}
@@ -515,12 +515,12 @@ impl HelpInfo {
Span::styled(input.to_owned(), Style::default().fg(color))
}
- /// Span to black text span
+ /// &str to black text span
fn black_span<'a>(input: &str) -> Span<'a> {
Self::span(input, Color::Black)
}
- /// Span to white text span
+ /// &str to white text span
fn white_span<'a>(input: &str) -> Span<'a> {
Self::span(input, Color::White)
}
@@ -559,7 +559,7 @@ impl HelpInfo {
/// Generate the button information span + metadata
fn gen_button() -> Self {
- let button_item = |x: &str| Self::white_span(&format!(" {x} "));
+ let button_item = |x: &str| Self::white_span(&format!(" ( {x} ) "));
let button_desc = |x: &str| Self::black_span(x);
let or = || button_desc("or");
let space = || button_desc(" ");
@@ -567,52 +567,48 @@ impl HelpInfo {
let spans = [
Spans::from(vec![
space(),
- button_item("( tab )"),
+ button_item("tab"),
or(),
- button_item("( shift+tab )"),
+ button_item("shift+tab"),
button_desc("to change panels"),
]),
Spans::from(vec![
space(),
- button_item("( ↑ ↓ )"),
+ button_item("↑ ↓"),
or(),
- button_item("( j k )"),
+ button_item("j k"),
or(),
- button_item("( PgUp PgDown )"),
+ button_item("PgUp PgDown"),
or(),
- button_item("( Home End )"),
+ button_item("Home End"),
button_desc("to change selected line"),
]),
Spans::from(vec![
space(),
- button_item("( enter )"),
+ button_item("enter"),
button_desc("to send docker container command"),
]),
Spans::from(vec![
space(),
- button_item("( h )"),
+ button_item("h"),
button_desc("to toggle this help information"),
]),
+ Spans::from(vec![space(), button_item("0"), button_desc("to stop sort")]),
Spans::from(vec![
space(),
- button_item("( 0 )"),
- button_desc("to stop sort"),
- ]),
- Spans::from(vec![
- space(),
- button_item("( 1 - 9 )"),
+ button_item("1 - 9"),
button_desc("sort by header - or click header"),
]),
Spans::from(vec![
space(),
- button_item("( m )"),
+ button_item("m"),
button_desc(
"to toggle mouse capture - if disabled, text on screen can be selected & copied",
),
]),
Spans::from(vec![
space(),
- button_item("( q )"),
+ button_item("q"),
button_desc("to quit at any time"),
]),
];
@@ -636,8 +632,7 @@ impl HelpInfo {
Spans::from(vec![Span::styled(
REPO.to_owned(),
Style::default()
- .bg(Color::Magenta)
- .fg(Color::Black)
+ .fg(Color::White)
.add_modifier(Modifier::UNDERLINED),
)]),
];
@@ -729,6 +724,117 @@ pub fn help_box(f: &mut Frame<'_, B>) {
f.render_widget(block, area);
}
+/// Draw the delete confirm box in the centre of the screen
+/// take in container id and container name here?
+pub fn delete_confirm(
+ f: &mut Frame<'_, B>,
+ gui_state: &Arc>,
+ name: &str,
+) {
+ let block = Block::default()
+ .title(" Confirm Delete ")
+ .border_type(BorderType::Rounded)
+ .style(Style::default().bg(Color::White).fg(Color::Black))
+ .title_alignment(Alignment::Center)
+ .borders(Borders::ALL);
+
+ let confirm = Spans::from(vec![
+ Span::from("Are you sure you want to delete container: "),
+ Span::styled(
+ name,
+ Style::default().fg(Color::Red).add_modifier(Modifier::BOLD),
+ ),
+ ]);
+
+ let yes_text = " (Y)es ";
+ let no_text = " (N)o ";
+
+ // Find the maximum line width & height, and add some padding
+ let max_line_width = u16::try_from(confirm.width()).unwrap_or(64) + 12;
+ let lines = 8;
+
+ let confirm_para = Paragraph::new(confirm).alignment(Alignment::Center);
+
+ let button_block = || {
+ Block::default()
+ .border_type(BorderType::Rounded)
+ .borders(Borders::ALL)
+ };
+
+ let yes_para = Paragraph::new(yes_text)
+ .alignment(Alignment::Center)
+ .block(button_block());
+ // Need to add some padding for the borders
+ let yes_chars = u16::try_from(yes_text.chars().count() + 2).unwrap_or(9);
+
+ let no_para = Paragraph::new(no_text)
+ .alignment(Alignment::Center)
+ .block(button_block());
+ // Need to add some padding for the borders
+ let no_chars = u16::try_from(no_text.chars().count() + 2).unwrap_or(8);
+
+ let area = popup(
+ lines,
+ max_line_width.into(),
+ f.size(),
+ BoxLocation::MiddleCentre,
+ );
+
+ let split_popup = Layout::default()
+ .direction(Direction::Vertical)
+ .constraints(
+ [
+ Constraint::Min(2),
+ Constraint::Max(1),
+ Constraint::Max(1),
+ Constraint::Max(3),
+ Constraint::Min(1),
+ ]
+ .as_ref(),
+ )
+ .split(area);
+
+ // Should maybe have a differenet button_space IF the f.width() is within 2 chars of no_chars + yes_chars?
+ let button_spacing = (max_line_width - no_chars - yes_chars) / 3;
+
+ let button_spacing = if (button_spacing + max_line_width) > f.size().width {
+ 1
+ } else {
+ button_spacing
+ };
+ let split_buttons = Layout::default()
+ .direction(Direction::Horizontal)
+ .constraints(
+ [
+ Constraint::Max(button_spacing),
+ Constraint::Min(no_chars),
+ Constraint::Max(button_spacing),
+ Constraint::Min(yes_chars),
+ Constraint::Max(button_spacing),
+ ]
+ .as_ref(),
+ )
+ .split(split_popup[3]);
+
+ let no_area = split_buttons[1];
+ let yes_area = split_buttons[3];
+
+ // Insert button areas into region map, so can interact with them on click
+ gui_state
+ .lock()
+ .update_region_map(Region::Delete(DeleteButton::No), no_area);
+
+ gui_state
+ .lock()
+ .update_region_map(Region::Delete(DeleteButton::Yes), yes_area);
+
+ f.render_widget(Clear, area);
+ f.render_widget(block, area);
+ f.render_widget(confirm_para, split_popup[1]);
+ f.render_widget(no_para, no_area);
+ f.render_widget(yes_para, yes_area);
+}
+
/// Draw an error popup over whole screen
pub fn error(f: &mut Frame<'_, B>, error: AppError, seconds: Option) {
let block = Block::default()
@@ -798,11 +904,7 @@ pub fn info(f: &mut Frame<'_, B>, text: String) {
/// draw a box in the one of the BoxLocations, based on max line width + number of lines
fn popup(text_lines: usize, text_width: usize, r: Rect, box_location: BoxLocation) -> Rect {
// Make sure blank_space can't be an negative, as will crash
- let calc = |x: u16, y: usize| {
- (usize::from(x).checked_sub(y).map_or(1usize, |f| f))
- .checked_div(2)
- .map_or(1usize, |f| f)
- };
+ let calc = |x: u16, y: usize| usize::from(x).saturating_sub(y).saturating_div(2);
let blank_vertical = calc(r.height, text_lines);
let blank_horizontal = calc(r.width, text_width);
diff --git a/src/ui/gui_state.rs b/src/ui/gui_state.rs
index 134c112..5a6c128 100644
--- a/src/ui/gui_state.rs
+++ b/src/ui/gui_state.rs
@@ -1,11 +1,11 @@
+use ratatui::layout::{Constraint, Rect};
use std::{
collections::{HashMap, HashSet},
fmt,
};
-use tui::layout::{Constraint, Rect};
use uuid::Uuid;
-use crate::app_data::Header;
+use crate::app_data::{ContainerId, Header};
#[derive(Debug, Default, Clone, Copy, Eq, Hash, PartialEq)]
pub enum SelectablePanel {
@@ -43,6 +43,13 @@ impl SelectablePanel {
pub enum Region {
Panel(SelectablePanel),
Header(Header),
+ Delete(DeleteButton),
+}
+
+#[derive(Debug, Clone, Copy, Eq, Hash, PartialEq)]
+pub enum DeleteButton {
+ Yes,
+ No,
}
#[allow(unused)]
@@ -191,11 +198,13 @@ impl fmt::Display for Loading {
/// The application gui state can be in multiple of these four states at the same time
/// Various functions (e.g input handler), operate differently depending upon current Status
+// Copy
#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq)]
pub enum Status {
Init,
Help,
DockerConnect,
+ DeleteConfirm,
Error,
}
@@ -206,7 +215,9 @@ pub struct GuiState {
is_loading: HashSet,
loading_icon: Loading,
panel_map: HashMap,
+ delete_map: HashMap,
status: HashSet,
+ delete_container: Option,
pub info_box_text: Option,
pub selected_panel: SelectablePanel,
}
@@ -229,6 +240,16 @@ impl GuiState {
}
}
+ /// Check if a given Rect (a clicked area of 1x1), interacts with any known delete button
+ pub fn button_intersect(&mut self, rect: Rect) -> Option {
+ self.delete_map
+ .iter()
+ .filter(|i| i.1.intersects(rect))
+ .collect::>()
+ .get(0)
+ .map(|data| *data.0)
+ }
+
/// Check if a given Rect (a clicked area of 1x1), interacts with any known panels
pub fn header_intersect(&mut self, rect: Rect) -> Option {
self.heading_map
@@ -240,7 +261,7 @@ impl GuiState {
}
/// Insert, or updates header area panel into heading_map
- pub fn update_heading_map(&mut self, region: Region, area: Rect) {
+ pub fn update_region_map(&mut self, region: Region, area: Rect) {
match region {
Region::Header(header) => self
.heading_map
@@ -252,9 +273,31 @@ impl GuiState {
.entry(panel)
.and_modify(|w| *w = area)
.or_insert(area),
+ Region::Delete(button) => self
+ .delete_map
+ .entry(button)
+ .and_modify(|w| *w = area)
+ .or_insert(area),
};
}
+ /// Check if an ContainerId is set in the delete_container field
+ pub fn get_delete_container(&self) -> Option {
+ self.delete_container.clone()
+ }
+
+ /// Set either a ContainerId, or None, to the delete_container field
+ /// If Some, will also insert the DeleteConfirm status into self.status
+ pub fn set_delete_container(&mut self, id: Option) {
+ if id.is_some() {
+ self.status.insert(Status::DeleteConfirm);
+ } else {
+ self.delete_map.clear();
+ self.status.remove(&Status::DeleteConfirm);
+ }
+ self.delete_container = id;
+ }
+
/// Check if the current gui_status contains any of the given status'
/// Don't really like this methodology for gui state, needs a re-think
pub fn status_contains(&self, status: &[Status]) -> bool {
@@ -264,6 +307,9 @@ impl GuiState {
/// Remove a gui_status into the current gui_status HashSet
pub fn status_del(&mut self, status: Status) {
self.status.remove(&status);
+ if status == Status::DeleteConfirm {
+ self.status.remove(&Status::DeleteConfirm);
+ }
}
/// Insert a gui_status into the current gui_status HashSet
diff --git a/src/ui/mod.rs b/src/ui/mod.rs
index 5f9ee65..53ec6a1 100644
--- a/src/ui/mod.rs
+++ b/src/ui/mod.rs
@@ -5,6 +5,11 @@ use crossterm::{
terminal::{disable_raw_mode, enable_raw_mode, EnterAlternateScreen, LeaveAlternateScreen},
};
use parking_lot::Mutex;
+use ratatui::{
+ backend::{Backend, CrosstermBackend},
+ layout::{Constraint, Direction, Layout},
+ Frame, Terminal,
+};
use std::{
io::{self, Stdout, Write},
sync::{atomic::Ordering, Arc},
@@ -13,18 +18,13 @@ use std::{
use std::{sync::atomic::AtomicBool, time::Instant};
use tokio::sync::mpsc::Sender;
use tracing::error;
-use tui::{
- backend::{Backend, CrosstermBackend},
- layout::{Constraint, Direction, Layout},
- Frame, Terminal,
-};
mod color_match;
mod draw_blocks;
mod gui_state;
pub use self::color_match::*;
-pub use self::gui_state::{GuiState, SelectablePanel, Status};
+pub use self::gui_state::{DeleteButton, GuiState, SelectablePanel, Status};
use crate::{
app_data::AppData, app_error::AppError, docker_data::DockerMessage,
input_handler::InputMessages,
@@ -198,20 +198,23 @@ impl Ui {
}
/// Draw the main ui to a frame of the terminal
+/// TODO add a single line area for debug message - if not in release mode, maybe with #[cfg(debug_assertions)] ?
fn draw_frame(
f: &mut Frame<'_, B>,
app_data: &Arc>,
gui_state: &Arc>,
) {
- // set max height for container section, needs +4 to deal with docker commands list and borders
+ // set max height for container section, needs +5 to deal with docker commands list and borders
let height = app_data.lock().get_container_len();
- let height = if height < 12 { height + 4 } else { 12 };
+ let height = if height < 12 { height + 5 } else { 12 };
let column_widths = app_data.lock().get_width();
let has_containers = app_data.lock().get_container_len() > 0;
let has_error = app_data.lock().get_error();
let sorted_by = app_data.lock().get_sorted();
+ let delete_confirm = gui_state.lock().get_delete_container();
+
let show_help = gui_state.lock().status_contains(&[Status::Help]);
let info_text = gui_state.lock().info_box_text.clone();
let loading_icon = gui_state.lock().get_loading();
@@ -274,6 +277,20 @@ fn draw_frame(
gui_state,
);
+ if let Some(id) = delete_confirm {
+ let name = app_data.lock().get_container_name_by_id(&id);
+ name.map_or_else(
+ || {
+ // If a container is deleted outside of oxker but whilst the Delete Confirm dialog is open, it can get caught in kind of a dead lock situation
+ // so if in that unique situation, just clear the delete_container id
+ gui_state.lock().set_delete_container(None);
+ },
+ |name| {
+ draw_blocks::delete_confirm(f, gui_state, &name);
+ },
+ );
+ }
+
// only draw charts if there are containers
if has_containers {
draw_blocks::chart(f, lower_main[1], app_data);