fm-tui 0.2.3

FM : a file manager inspired by ranger and dired{n}{n}Config files ~/.config/fm/{n}Documentation https://github.com/qkzk/fm{n}
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

use anyhow::{Context, Result};

use crate::common::{tilde, CONFIG_FOLDER};

const DEFAULT_CONFIG: &str = include_str!("../../config_files/fm/config.yaml");
const DEFAULT_CLI: &str = include_str!("../../config_files/fm/cli.yaml");
const DEFAULT_OPENER: &str = include_str!("../../config_files/fm/opener.yaml");
const DEFAULT_SESSION: &str = include_str!("../../config_files/fm/session.yaml");
const DEFAULT_TUIS: &str = include_str!("../../config_files/fm/tuis.yaml");
const DEFAULT_PREVIEWER: &str = include_str!("../../config_files/fm/previewer.yaml");
const DEFAULT_THEME: &str = include_str!("../../config_files/fm/themes/default.yaml");

const DEFAULT_CONFIGS: [(&str, &str); 7] = [
    ("config.yaml", DEFAULT_CONFIG),
    ("cli.yaml", DEFAULT_CLI),
    ("opener.yaml", DEFAULT_OPENER),
    ("session.yaml", DEFAULT_SESSION),
    ("tuis.yaml", DEFAULT_TUIS),
    ("previewer.yaml", DEFAULT_PREVIEWER),
    ("themes/default.yaml", DEFAULT_THEME),
];

const LOG_FILES: [&str; 3] = [
    "log/fm.log",
    "log/action_logger.log",
    "log/input_history.log",
];

const TRASH_FOLDERS: [&str; 3] = [
    "~/.local/share/Trash/expunged",
    "~/.local/share/Trash/files",
    "~/.local/share/Trash/info",
];

/// Creates the default config if it doesn't exists.
/// Creates the trash folder if it doesn't exists.
///
/// Errors
///
/// It may fail if the user has no write access to $HOME which shouldn't happen in a normal environment.
pub fn make_default_config_files() -> Result<()> {
    create_config_folder()?;
    copy_default_config_files()?;
    create_log_files()?;
    create_trash_folders()?;
    Ok(())
}

/// Creates the config folder in ~/.config/fm
fn create_config_folder() -> std::io::Result<()> {
    let p = tilde(CONFIG_FOLDER);
    std::fs::create_dir_all(p.as_ref())
}

/// Ensure a file content by creating its parent folder and writing the content
/// to the path.
fn ensure_config(path: &std::path::Path, contents: &str) -> Result<()> {
    if !path.exists() {
        std::fs::create_dir_all(path.parent().context("No parent")?)?;
        std::fs::write(path, contents)?;
    }
    Ok(())
}

fn create_log_files() -> Result<()> {
    let dest = std::path::PathBuf::from(tilde(CONFIG_FOLDER).as_ref());

    for rel_log_path in &LOG_FILES {
        let mut path = dest.clone();
        path.push(rel_log_path);
        create_log_file(&path)?;
    }
    Ok(())
}

fn create_log_file(path: &std::path::Path) -> Result<()> {
    if !path.exists() {
        std::fs::create_dir_all(path.parent().context("No parent")?)?;
        std::fs::File::create(path)?;
    }
    Ok(())
}

/// Copy the config files to ~/.config/fm/
fn copy_default_config_files() -> Result<()> {
    let dest = std::path::PathBuf::from(tilde(CONFIG_FOLDER).as_ref());

    for (config_rel_path, contents) in &DEFAULT_CONFIGS {
        let mut path = dest.clone();
        path.push(config_rel_path);
        ensure_config(&path, contents)?;
    }
    Ok(())
}

/// Creates the trash folders:
///  ~.local
///     |- Trash
///          |- expunged/
///          |- files/
///          |- info/
fn create_trash_folders() -> std::io::Result<()> {
    for dir in &TRASH_FOLDERS {
        std::fs::create_dir_all(tilde(dir).as_ref())?;
    }
    Ok(())
}