safeshell 0.1.3

SafeShell: A security tool for shell history management, designed to detect, stash, and clear sensitive commands, ensuring safer terminal sessions.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

use anyhow::Result;
use clap::{crate_name, ArgMatches, Command};

use safeshell::{dialog, ShellContext};

pub fn command() -> Command<'static> {
    Command::new("stash")
        .about("Stash history file")
        .subcommand(Command::new("pop").about("Pop stash history commands"))
        .subcommand(Command::new("restore").about("Restore backup history file"))
}

pub fn run(
    subcommand_matches: &ArgMatches,
    shell_context: &ShellContext,
) -> Result<safeshell::data::CmdExit> {
    match subcommand_matches.subcommand() {
        None => run_stash(shell_context),
        Some(tup) => match tup {
            ("restore", _subcommand_matches) => run_restore(shell_context),
            ("pop", _subcommand_matches) => run_pop(shell_context),
            _ => unreachable!(),
        },
    }
}

fn run_stash(shell_context: &ShellContext) -> Result<safeshell::data::CmdExit> {
    // todo:: check if file exists and remove the unwrap
    if shell_context.is_stash_file_exists()? {
        if let Err(e) = dialog::confirm(
            "Stash file already find. do you want to override? (you can lose all your history \
             commands)",
        ) {
            log::debug!("{:?}", e);
            return Ok(safeshell::data::CmdExit {
                code: exitcode::OK,
                message: None,
            });
        }
    }

    if let Err(err) = shell_context.stash() {
        return Ok(safeshell::data::CmdExit {
            code: 1,
            message: Some(format!("stash failed: {err:?}")),
        });
    }
    Ok(safeshell::data::CmdExit {
        code: 0,
        message: Some(format!(
            "Shell {:?} stash successfully when open a new tab. Run `{} stash pop` to return your \
             history commands",
            shell_context.history.shell,
            crate_name!()
        )),
    })
}

fn run_pop(shell_context: &ShellContext) -> Result<safeshell::data::CmdExit> {
    if !shell_context.is_stash_file_exists()? {
        return Ok(safeshell::data::CmdExit {
            code: 1,
            message: Some("Stash file not found".to_string()),
        });
    }

    if let Err(err) = shell_context.pop() {
        return Ok(safeshell::data::CmdExit {
            code: 1,
            message: Some(format!("stash pop failed: {err:?}")),
        });
    }
    Ok(safeshell::data::CmdExit {
        code: 0,
        message: Some(format!(
            "Shell {:?} history pop successfully when open a new tab. ",
            shell_context.history.shell
        )),
    })
}

pub fn run_restore(shell_context: &ShellContext) -> Result<safeshell::data::CmdExit> {
    let mut backup_files = shell_context.get_backup_files()?;
    if backup_files.is_empty() {
        return Ok(safeshell::data::CmdExit {
            code: exitcode::OK,
            message: Some("backup files not found".to_string()),
        });
    }

    if let Some(file) = shell_context.get_stash_file() {
        backup_files.push(file);
    }

    backup_files.sort_by(|a, b| b.cmp(a));
    let restore_from_path = match dialog::select("select backup file", &backup_files) {
        Ok(selection) => &backup_files[selection],
        Err(_e) => {
            return Ok(safeshell::data::CmdExit {
                code: 0,
                message: None,
            });
        }
    };

    if let Some(e) = shell_context.restore(restore_from_path).err() {
        return Ok(safeshell::data::CmdExit {
            code: 1,
            message: Some(format!("restore failed: {e:?}")),
        });
    }

    Ok(safeshell::data::CmdExit {
        code: exitcode::OK,
        message: Some("History file restored successfully".to_string()),
    })
}