jao 0.3.4

Discover and run workspace scripts from a simple CLI
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

use std::fs;
use std::io::ErrorKind;
use std::path::{Path, PathBuf};

use serde::{Deserialize, Serialize};

use crate::{JaoError, JaoResult};

/// Serializes and writes `contents` to the `~/.jao` storage area.
///
/// `file_path` can be relative to the storage root or an absolute path inside
/// that root. Paths outside the storage root are rejected.
pub(crate) fn write_to_storage<C>(file_path: impl AsRef<Path>, contents: &C) -> JaoResult<()>
where
    C: Serialize,
{
    let canonical_file_path = canonicalise_within(get_or_init_jao_storage_dir()?, file_path)?;
    let content = toml::to_string_pretty(contents)?;
    fs::write(canonical_file_path, content)?;
    Ok(())
}

/// Loads and deserializes a value from the `~/.jao` storage area.
///
/// Returns `Ok(None)` when the resolved file does not exist. Paths outside the
/// storage root are rejected.
pub(crate) fn load_from_storage<C>(file_path: impl AsRef<Path>) -> JaoResult<Option<C>>
where
    C: for<'a> Deserialize<'a>,
{
    let canonical_file_path = canonicalise_within(get_or_init_jao_storage_dir()?, file_path)?;
    if !canonical_file_path.exists() {
        Ok(None)
    } else {
        Ok(Some(toml::from_str(&fs::read_to_string(canonical_file_path)?)?))
    }
}

fn get_or_init_jao_storage_dir() -> JaoResult<PathBuf> {
    let jao_storage_dir = home::home_dir()
        .ok_or(JaoError::StorageDirUnavailable)?
        .join(".jao");

    fs::create_dir_all(&jao_storage_dir)?;

    Ok(jao_storage_dir)
}

fn canonicalise_within(safe_root: impl AsRef<Path>, path_to_canonicalise: impl AsRef<Path>) -> JaoResult<PathBuf> {
    let canonical_root = fs::canonicalize(safe_root)?;

    let path_to_canonicalise = path_to_canonicalise.as_ref();

    let path_to_canonicalise = if path_to_canonicalise.is_absolute() {
        path_to_canonicalise.to_path_buf()
    } else {
        canonical_root.join(path_to_canonicalise)
    };

    let canonical_file_path = match fs::canonicalize(&path_to_canonicalise) {
        Ok(canonical) => canonical,
        Err(error) if error.kind() == ErrorKind::NotFound => {
            let Some(parent) = path_to_canonicalise.parent() else {
                return Err(JaoError::InvalidStoragePath { path: path_to_canonicalise });
            };

            let canonical_parent = fs::canonicalize(parent)?;
            let Some(file_name) = path_to_canonicalise.file_name() else {
                return Err(JaoError::InvalidStoragePath { path: path_to_canonicalise });
            };

            canonical_parent.join(file_name)
        }
        Err(error) => return Err(error.into()),
    };

    if !canonical_file_path.starts_with(&canonical_root) {
        return Err(JaoError::InvalidStoragePath { path: path_to_canonicalise });
    }

    Ok(canonical_file_path)
}