xdg-home-1.1.0/.cargo_vcs_info.json0000644000000001360000000000100125430ustar { "git": { "sha1": "f8f7a5cce4b02701f9e02f66e9ab77a0226bd13e" }, "path_in_vcs": "" }xdg-home-1.1.0/.github/workflows/rust.yml000064400000000000000000000020341046102023000164470ustar 00000000000000name: Rust on: push: branches: ["main"] pull_request: branches: ["main"] env: CARGO_TERM_COLOR: always jobs: test: runs-on: ${{ matrix.os }} strategy: matrix: os: [ubuntu-latest, macos-latest, windows-latest] steps: - uses: actions/checkout@v3 - uses: actions-rs/toolchain@v1 with: toolchain: stable - uses: actions-rs/cargo@v1 with: command: test fmt: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - uses: actions-rs/toolchain@v1 with: toolchain: nightly override: true components: rustfmt - uses: actions-rs/cargo@v1 with: command: fmt args: --all -- --check clippy: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 with: toolchain: nightly override: true components: clippy - uses: actions-rs/cargo@v1 with: command: clippy args: -- -D warnings xdg-home-1.1.0/.gitignore000064400000000000000000000000221046102023000133150ustar 00000000000000target Cargo.lock xdg-home-1.1.0/Cargo.toml0000644000000020650000000000100105440ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] edition = "2021" rust-version = "1.60" name = "xdg-home" version = "1.1.0" authors = ["Zeeshan Ali Khan "] description = "The user's home directory as per XDG Specification" readme = "README.md" keywords = [ "xdg", "home", ] categories = [ "filesystem", "os::unix-apis", "os::windows-apis", ] license = "MIT" repository = "https://github.com/zeenix/xdg-home" [target."cfg(unix)".dependencies.libc] version = "0.2" [target."cfg(windows)".dependencies.winapi] version = "0.3" features = [ "combaseapi", "knownfolders", "shlobj", "winerror", ] xdg-home-1.1.0/Cargo.toml.orig000064400000000000000000000012421046102023000142210ustar 00000000000000[package] name = "xdg-home" version = "1.1.0" edition = "2021" authors = ["Zeeshan Ali Khan "] 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] libc = "0.2" [target.'cfg(windows)'.dependencies] winapi = { version = "0.3", features = [ "combaseapi", "knownfolders", "shlobj", "winerror", ] } xdg-home-1.1.0/LICENSE000064400000000000000000000017771046102023000123540ustar 00000000000000Permission 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. xdg-home-1.1.0/LICENSE-MIT000064400000000000000000000017771046102023000130030ustar 00000000000000Permission 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. xdg-home-1.1.0/README.md000064400000000000000000000014321046102023000126120ustar 00000000000000# 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 xdg-home-1.1.0/src/lib.rs000064400000000000000000000060221046102023000132360ustar 00000000000000#![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 { 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 std::ffi::{CStr, OsStr}; use std::os::unix::ffi::OsStrExt; use std::path::PathBuf; pub(super) fn home_dir() -> Option { let uid = unsafe { libc::geteuid() }; let passwd = unsafe { libc::getpwuid(uid) }; // getpwnam(3): // The getpwnam() and getpwuid() functions return a pointer to a passwd structure, or NULL // if the matching entry is not found or an error occurs. If an error occurs, errno is set // to indicate the error. If one wants to check errno after the call, it should be set to // zero before the call. The return value may point to a static area, and may be overwritten // by subsequent calls to getpwent(3), getpwnam(), or getpwuid(). if passwd.is_null() { return None; } // SAFETY: `getpwuid()` returns either NULL or a valid pointer to a `passwd` structure. let passwd = unsafe { &*passwd }; if passwd.pw_dir.is_null() { return None; } // SAFETY: `getpwuid()->pw_dir` is a valid pointer to a c-string. let home_dir = unsafe { CStr::from_ptr(passwd.pw_dir) }; Some(PathBuf::from(OsStr::from_bytes(home_dir.to_bytes()))) } } #[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 { 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)) } }