dirs_sys/
lib.rs

1#[macro_use]
2extern crate cfg_if;
3
4use std::ffi::OsString;
5use std::path::PathBuf;
6use std::env;
7
8// we don't need to explicitly handle empty strings in the code above,
9// because an empty string is not considered to be a absolute path here.
10pub fn is_absolute_path(path: OsString) -> Option<PathBuf> {
11    let path = PathBuf::from(path);
12    if path.is_absolute() {
13        Some(path)
14    } else {
15        None
16    }
17}
18
19
20cfg_if! { if #[cfg(all(unix, not(target_os = "redox")))] {
21
22extern crate libc;
23
24use std::ffi::CStr;
25use std::mem;
26use std::os::unix::ffi::OsStringExt;
27use std::ptr;
28
29// https://github.com/rust-lang/rust/blob/master/src/libstd/sys/unix/os.rs#L498
30pub fn home_dir() -> Option<PathBuf> {
31    return env::var_os("HOME")
32        .and_then(|h| if h.is_empty() { None } else { Some(h) })
33        .or_else(|| unsafe { fallback() })
34        .map(PathBuf::from);
35
36    #[cfg(any(target_os = "android", target_os = "ios", target_os = "emscripten"))]
37    unsafe fn fallback() -> Option<OsString> {
38        None
39    }
40    #[cfg(not(any(target_os = "android", target_os = "ios", target_os = "emscripten")))]
41    unsafe fn fallback() -> Option<OsString> {
42        let amt = match libc::sysconf(libc::_SC_GETPW_R_SIZE_MAX) {
43            n if n < 0 => 512 as usize,
44            n => n as usize,
45        };
46        let mut buf = Vec::with_capacity(amt);
47        let mut passwd: libc::passwd = mem::zeroed();
48        let mut result = ptr::null_mut();
49        match libc::getpwuid_r(
50            libc::getuid(),
51            &mut passwd,
52            buf.as_mut_ptr(),
53            buf.capacity(),
54            &mut result,
55        ) {
56            0 if !result.is_null() => {
57                let ptr = passwd.pw_dir as *const _;
58                let bytes = CStr::from_ptr(ptr).to_bytes();
59                if bytes.is_empty() {
60                    None
61                } else {
62                    Some(OsStringExt::from_vec(bytes.to_vec()))
63                }
64            }
65            _ => None,
66        }
67    }
68}
69
70}}
71
72
73cfg_if! { if #[cfg(target_os = "redox")] {
74
75extern crate redox_users;
76
77use self::redox_users::All;
78use self::redox_users::AllUsers;
79use self::redox_users::Config;
80
81pub fn home_dir() -> Option<PathBuf> {
82    let current_uid = redox_users::get_uid().ok()?;
83    let users = AllUsers::new(Config::default()).ok()?;
84    let user = users.get_by_id(current_uid)?;
85
86    Some(PathBuf::from(user.home.clone()))
87}
88
89}}
90
91cfg_if! { if #[cfg(all(unix, not(any(target_os = "macos", target_os = "ios"))))] {
92
93mod xdg_user_dirs;
94
95use std::path::Path;
96
97use std::collections::HashMap;
98
99fn user_dir_file(home_dir: &Path) -> PathBuf {
100    env::var_os("XDG_CONFIG_HOME").and_then(is_absolute_path).unwrap_or_else(|| home_dir.join(".config")).join("user-dirs.dirs")
101}
102
103// this could be optimized further to not create a map and instead retrieve the requested path only
104pub fn user_dir(user_dir_name: &str) -> Option<PathBuf> {
105    if let Some(home_dir) = home_dir() {
106        xdg_user_dirs::single(&home_dir, &user_dir_file(&home_dir), user_dir_name).remove(user_dir_name)
107    } else {
108        None
109    }
110}
111
112pub fn user_dirs(home_dir_path: &Path) -> HashMap<String, PathBuf> {
113    xdg_user_dirs::all(home_dir_path, &user_dir_file(home_dir_path))
114}
115}}
116
117
118cfg_if! { if #[cfg(target_os = "windows")] {
119
120extern crate winapi;
121use self::winapi::shared::winerror;
122use self::winapi::um::combaseapi;
123use self::winapi::um::knownfolders;
124use self::winapi::um::shlobj;
125use self::winapi::um::shtypes;
126use self::winapi::um::winbase;
127use self::winapi::um::winnt;
128
129pub fn known_folder(folder_id: shtypes::REFKNOWNFOLDERID) -> Option<PathBuf> {
130    unsafe {
131        let mut path_ptr: winnt::PWSTR = std::ptr::null_mut();
132        let result = shlobj::SHGetKnownFolderPath(folder_id, 0, std::ptr::null_mut(), &mut path_ptr);
133        if result == winerror::S_OK {
134            let len = winbase::lstrlenW(path_ptr) as usize;
135            let path = std::slice::from_raw_parts(path_ptr, len);
136            let ostr: std::ffi::OsString = std::os::windows::ffi::OsStringExt::from_wide(path);
137            combaseapi::CoTaskMemFree(path_ptr as *mut winapi::ctypes::c_void);
138            Some(PathBuf::from(ostr))
139        } else {
140            None
141        }
142    }
143}
144
145pub fn known_folder_profile() -> Option<PathBuf> {
146    known_folder(&knownfolders::FOLDERID_Profile)
147}
148
149pub fn known_folder_roaming_app_data() -> Option<PathBuf> {
150    known_folder(&knownfolders::FOLDERID_RoamingAppData)
151}
152
153pub fn known_folder_local_app_data() -> Option<PathBuf> {
154    known_folder(&knownfolders::FOLDERID_LocalAppData)
155}
156
157pub fn known_folder_music() -> Option<PathBuf> {
158    known_folder(&knownfolders::FOLDERID_Music)
159}
160
161pub fn known_folder_desktop() -> Option<PathBuf> {
162    known_folder(&knownfolders::FOLDERID_Desktop)
163}
164
165pub fn known_folder_documents() -> Option<PathBuf> {
166    known_folder(&knownfolders::FOLDERID_Documents)
167}
168
169pub fn known_folder_downloads() -> Option<PathBuf> {
170    known_folder(&knownfolders::FOLDERID_Downloads)
171}
172
173pub fn known_folder_pictures() -> Option<PathBuf> {
174    known_folder(&knownfolders::FOLDERID_Pictures)
175}
176
177pub fn known_folder_public() -> Option<PathBuf> {
178    known_folder(&knownfolders::FOLDERID_Public)
179}
180pub fn known_folder_templates() -> Option<PathBuf> {
181    known_folder(&knownfolders::FOLDERID_Templates)
182}
183pub fn known_folder_videos() -> Option<PathBuf> {
184    known_folder(&knownfolders::FOLDERID_Videos)
185}
186
187}}