First commit

Author: zeenix

.gitignore

@@ -0,0 +1,2 @@
+target
+Cargo.lock

Cargo.toml

@@ -0,0 +1,26 @@
+[package]
+name = "xdg-home"
+version = "1.0.0"
+edition = "2021"
+authors = ["Zeeshan Ali Khan <[email protected]>"]
+rust-version = "1.60"
+
+description = "The user's home directory as per XDG Specification"
+repository = "https://github.com/zeenix/xdg-home"
+license = "MIT"
+keywords = ["xdg", "home"]
+categories = ["filesystem", "os::unix-apis", "os::windows-apis"]
+readme = "README.md"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[target.'cfg(unix)'.dependencies]
+nix = { version = "0.26.2", features = ["user"], default-features = false }
+
+[target.'cfg(windows)'.dependencies]
+winapi = { version = "0.3", features = [
+  "combaseapi",
+  "knownfolders",
+  "shlobj",
+  "winerror",
+] }

LICENSE

@@ -0,0 +1 @@
+LICENSE-MIT

LICENSE-MIT

@@ -0,0 +1,23 @@
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,25 @@
+# xdg-home
+
+Gets the user's home directory as per [XDG Base Directory Specification][xdg].
+
+This is almost the same as [`home`] (and [`dirs`]) crate, except it honors `HOME` environment
+variable on the Windows platform as well, which is conformant to the XDG Base Directory
+Specification.
+
+Use it where the XDG Base Directory Specification is applicable, such as in [D-Bus] code.
+
+## Example
+
+```rust
+use xdg_home::home_dir;
+
+let home = home_dir().unwrap();
+assert!(home.is_absolute());
+assert!(home.exists());
+println!("Home directory: {}", home.display());
+```
+
+[xdg]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
+[`home`]: https://crates.io/crates/home
+[`dirs`]: https://crates.io/crates/dirs
+[D-Bus]: https://dbus.freedesktop.org/doc/dbus-specification.html

src/lib.rs

@@ -0,0 +1,82 @@
+#![doc = include_str!("../README.md")]
+#![doc(test(attr(
+    warn(unused),
+    deny(warnings),
+    // W/o this, we seem to get some bogus warning about `extern crate ..`.
+    allow(unused_extern_crates),
+)))]
+
+use std::path::PathBuf;
+
+/// Get the path of the current user's home directory.
+///
+/// See the library documentation for more information.
+pub fn home_dir() -> Option<PathBuf> {
+    match std::env::var("HOME") {
+        Ok(home) => Some(home.into()),
+        Err(_) => {
+            #[cfg(unix)]
+            {
+                unix::home_dir()
+            }
+
+            #[cfg(windows)]
+            {
+                win32::home_dir()
+            }
+        }
+    }
+}
+
+#[cfg(unix)]
+mod unix {
+    use nix::unistd::{Uid, User};
+    use std::path::PathBuf;
+
+    pub(super) fn home_dir() -> Option<PathBuf> {
+        let uid = Uid::effective();
+
+        User::from_uid(uid).ok().flatten().map(|u| u.dir)
+    }
+}
+
+#[cfg(windows)]
+mod win32 {
+    use std::{path::PathBuf, ptr};
+
+    use winapi::{
+        shared::winerror::S_OK,
+        um::{
+            combaseapi::CoTaskMemFree, knownfolders::FOLDERID_Profile, shlobj::SHGetKnownFolderPath,
+        },
+    };
+
+    pub(super) fn home_dir() -> Option<PathBuf> {
+        let mut psz_path = ptr::null_mut();
+        let res = unsafe {
+            SHGetKnownFolderPath(
+                &FOLDERID_Profile,
+                0,
+                ptr::null_mut(),
+                &mut psz_path as *mut _,
+            )
+        };
+        if res != S_OK {
+            return None;
+        }
+
+        // Determine the length of the UTF-16 string.
+        let mut len = 0;
+        // SAFETY: `psz_path` guaranteed to be a valid pointer to a null-terminated UTF-16 string.
+        while unsafe { *(psz_path as *const u16).offset(len) } != 0 {
+            len += 1;
+        }
+        let slice = unsafe { std::slice::from_raw_parts(psz_path, len as usize) };
+        let path = String::from_utf16(slice).ok()?;
+        unsafe {
+            CoTaskMemFree(psz_path as *mut _);
+        }
+
+        Some(PathBuf::from(path))
+    }
+}