pathos 0.3.0

A natural API for handling OS-specific user or system directories, including iOS and Android.
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
118
119
120
121
122
123
124
125
126
127
128
129

use crate::Error;
use std::env::{split_paths, var_os};
use std::path::PathBuf;

#[inline(always)]
pub fn home_dir() -> Result<PathBuf, Error> {
    #[allow(deprecated)]
    std::env::home_dir().ok_or_else(|| Error::NotFound("Home"))
}

#[inline(always)]
pub fn data_home() -> Result<PathBuf, Error> {
    let value = var_os("XDG_DATA_HOME")
        .map(|x| PathBuf::from(x))
        .filter(|x| x.is_absolute());

    match value {
        Some(v) => Ok(v),
        None => home_dir().map(|x| x.join(".local/share")),
    }
}

#[inline(always)]
pub fn config_home() -> Result<PathBuf, Error> {
    let value = var_os("XDG_CONFIG_HOME")
        .map(|x| PathBuf::from(x))
        .filter(|x| x.is_absolute());

    match value {
        Some(v) => Ok(v),
        None => home_dir().map(|x| x.join(".config")),
    }
}

#[inline(always)]
pub fn data_dirs() -> Vec<PathBuf> {
    var_os("XDG_DATA_DIRS")
        .map(|x| split_paths(&x).filter(|x| x.is_absolute()).collect())
        .unwrap_or_else(|| {
            vec![
                PathBuf::from("/usr/local/share/"),
                PathBuf::from("/usr/share/"),
            ]
        })
}

#[inline(always)]
pub fn config_dirs() -> Vec<PathBuf> {
    var_os("XDG_CONFIG_DIRS")
        .map(|x| split_paths(&x).filter(|x| x.is_absolute()).collect())
        .unwrap_or_else(|| vec![PathBuf::from("/etc/xdg/")])
}

#[inline(always)]
pub fn cache_home() -> Result<PathBuf, Error> {
    let value = var_os("XDG_CACHE_HOME")
        .map(|x| PathBuf::from(x))
        .filter(|x| x.is_absolute());

    match value {
        Some(v) => Ok(v),
        None => home_dir().map(|x| x.join(".cache")),
    }
}

#[cfg(unix)]
#[derive(Debug, Clone, thiserror::Error)]
pub enum RuntimeDirError {
    #[error("XDG_RUNTIME_DIR environment variable is not defined.")]
    Undefined,

    #[error("Could not resolve metadata for XDG_RUNTIME_DIR.")]
    Metadata(#[from] eieio::Error),

    #[error("Invalid ownership. Requires ownership by {}, got: {0}.")]
    InvalidOwnership(u32, u32),

    #[error("Invalid access mode. Requires 0700, got {0:o}.")]
    InvalidAccessMode(u32),
}

#[cfg(unix)]
#[inline(always)]
pub fn runtime_dir() -> Result<PathBuf, RuntimeDirError> {
    let dir = var_os("XDG_RUNTIME_DIR")
        .map(|x| PathBuf::from(x))
        .filter(|x| x.is_absolute())
        .ok_or_else(|| RuntimeDirError::Undefined)?;

    use std::os::unix::fs::MetadataExt;

    let meta = std::fs::metadata(&dir).map_err(eieio::Error::from)?;

    let uid = unsafe { libc::getuid() };
    if meta.uid() != uid {
        return Err(RuntimeDirError::InvalidOwnership(uid, meta.uid()));
    }

    if meta.mode() != 0o700 {
        return Err(RuntimeDirError::InvalidAccessMode(meta.mode()));
    }

    Ok(dir)
}

// #[inline]
// pub fn app_data_dir<P: AsRef<Path>>(prefix: P) -> Result<PathBuf, Error> {
//     data_home().map(|x| x.join(prefix.as_ref()))
// }

// #[inline]
// pub fn app_config_dir<P: AsRef<Path>>(prefix: P) -> Result<PathBuf, Error> {
//     config_home().map(|x| x.join(prefix.as_ref()))
// }

// #[inline]
// pub fn app_log_dir<P: AsRef<Path>>(prefix: P) -> Result<PathBuf, Error> {
//     data_home().map(|x| x.join(prefix.as_ref()).join("log"))
// }

// #[inline]
// pub fn app_cache_dir<P: AsRef<Path>>(prefix: P) -> Result<PathBuf, Error> {
//     cache_home().map(|x| x.join(prefix.as_ref()))
// }

// #[inline]
// pub fn app_temporary_dir<P: AsRef<Path>>(prefix: P) -> Result<PathBuf, Error> {
//     cache_home().map(|x| x.join(prefix.as_ref()).join("tmp"))
// }